Gestao de terceiros (third)

2.0info: 1.76.2 Gestao de terceiros description: Serviço do backend do Gestão de Terceiros do Ronda senior X x-senior-domain: Gestão de Acesso e Segurança x-senior-domain-path: sam x-senior-service-path: third 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/samsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /third/queries/healthcheck: post: description: Endpoint para verificação da saúde do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Status geral do healthcheck checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Itens verificados no healthcheck 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Endpoint para verificação da saúde do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Status geral do healthcheck checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Itens verificados no healthcheck 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/getPersonFromDocument: post: description: Busca pessoa por documento\nNão é necessário recursos.\n\n###Permissões:\n-serão estabelecidas através do número do contrato.\n###Utilização:\n-Usuários terceiros. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – document – documentTypeId properties: document: type: string description: Documento documentTypeId: type: integer format: int64 description: Identificador do Tipo de Documento responses: 200: description: Ok schema: type: object required: – person properties: person: type: object allOf: – #/definitions/personRecord description: Pessoa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca pessoa por documento\nNão é necessário recursos.\n\n###Permissões:\n-serão estabelecidas através do número do contrato.\n###Utilização:\n-Usuários terceiros. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: document description: Documento in: query required: true type: string – name: documentTypeId description: Identificador do Tipo de Documento in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – person properties: person: type: object allOf: – #/definitions/personRecord description: Pessoa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/getPerson: post: description: Busca pessoa por ID\n\nNão é necessário recursos.\n\n###Permissões:\n-serão estabelecidas através do número do contrato.\n\n###Utilização:\n-Usuários terceiros. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – personId – contractId properties: personId: type: integer format: int64 description: ID da pessoa contractId: type: integer format: int64 description: Contrato responses: 200: description: Ok schema: type: object required: – person properties: person: type: object allOf: – #/definitions/personRecord description: Informações da pessoa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca pessoa por ID\n\nNão é necessário recursos.\n\n###Permissões:\n-serão estabelecidas através do número do contrato.\n\n###Utilização:\n-Usuários terceiros. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: personId description: ID da pessoa in: query required: true type: integer format: int64 – name: contractId description: Contrato in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – person properties: person: type: object allOf: – #/definitions/personRecord description: Informações da pessoa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/getContract: post: description: Retorna os contratos que o usuário tem permissão (e-mail logado deve ser o e-mail do responsável pelo contrato) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: string description: Filtros default: size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Número da página minimum: 0 default: 0 orderby: type: string description: Ordenação default: responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/contract minimum: 1 description: Lista de contratos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os contratos que o usuário tem permissão (e-mail logado deve ser o e-mail do responsável pelo contrato) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filter description: Filtros in: query type: string – name: size description: Quantidade de registros por página in: query type: integer format: int64 – name: offset description: Número da página in: query type: integer format: int64 – name: orderby description: Ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/contract minimum: 1 description: Lista de contratos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/getThird: post: description: Retorna os colaboradores terceiros que o usuário tem permissão (e-mail logado deve ser o e-mail do responsável pelo contrato) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: contractNumber: type: string description: Filtros default: description: type: string description: Descrição default: approvalStatus: type: string description: Status aprovação default: name: type: string description: Nome default: document: type: string description: Documento default: contractTypeId: type: integer format: int64 description: Id do Tipo de Contrato bondValidityFilter: type: string allOf: – #/definitions/bondValidityFilter description: Tipo de vigência contractorCompanyBranchId: type: integer format: int64 description: Id da Estrutura Organizacional do Tipo Filial thirdPartyCompanyId: type: integer format: int64 description: Id da Empresa Terceira activityPerformedId: type: integer format: int64 description: Id da atividade exercida lastModificationDate: type: string format: date-time description: Data da Última Alteração size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Número da página minimum: 0 default: 0 orderby: type: string description: Ordenação default: responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contractPerson properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contractPerson: type: array items: type: object allOf: – #/definitions/getContractPersonPageableRecord minimum: 1 description: Lista de contratos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/getContractPersonBond: post: description: Retorna todos os vínculos com contratos do colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: personId: type: integer format: int64 description: ID do colaborador contractNumber: type: string description: Número do contrato companyName: type: string description: Nome da empresa tradeName: type: string description: Nome fantasia description: type: string description: Descrição do contrato startDate: type: string format: date description: Início do vínculo endDate: type: string format: date description: Término do vínculo approvalStatus: type: string allOf: – #/definitions/approvalStatusType description: Etapa de aprovação onlyCurrent: type: boolean description: Apenas os vigentes default: false size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Número da página minimum: 0 default: 0 orderby: type: string description: Ordenação default: description responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contractPersonBondRecordList properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contractPersonBondRecordList: type: array items: type: object allOf: – #/definitions/contractPersonBondRecord minimum: 1 description: Lista de vinculos com contratos do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/getThirdPartyCompanyDocumentStatus: post: description: Retorna o status dos documentos da empresa terceira tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – thirdPartyCompanyId properties: thirdPartyCompanyId: type: integer format: int64 description: ID da empresa terceira contractId: type: integer format: int64 description: ID do contrato documentDisplayFilter: type: string allOf: – #/definitions/documentDisplayFilter description: Filtro de exibição de documentos para o revisor size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Número da página minimum: 0 default: 0 orderby: type: string description: Ordenação default: responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/documentStatusRecord minimum: 1 description: Lista dos status dos documentos da empresa terceira 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/getContractDocumentStatus: post: description: Retorna o status dos documentos exigidos no contrato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contractId properties: contractId: type: integer format: int64 description: ID do contrato documentDisplay: type: string allOf: – #/definitions/documentDisplayFilter description: Filtro de exibição de documentos para o revisor size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Número da página minimum: 0 default: 0 orderby: type: string description: Ordenação default: responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/documentStatusRecord minimum: 1 description: Lista dos status dos documentos exigidos no contrato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/getDocumentAttachments: post: description: Retorna as urls dos arquivos de anexo do documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentAssociationId – demandType properties: documentAssociationId: type: integer format: int64 description: ID da associação do documento com a empresa terceira, com o contrato ou com a pessoa demandType: type: string allOf: – #/definitions/demandType description: Tipo da exigência responses: 200: description: Ok schema: type: object required: – getDocumentAttachmentResult properties: getDocumentAttachmentResult: type: array items: type: object allOf: – #/definitions/getDocumentAttachmentResultRecord minimum: 1 description: Urls dos arquivos de anexos do documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/getThirdDocumentStatus: post: description: Retorna o status dos documentos do colaborador terceiro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contractId – personId properties: contractId: type: integer format: int64 description: ID do contrato personId: type: integer format: int64 description: ID da pessoa contractPersonId: type: integer format: int64 description: ID do vínculo documentDisplayFilter: type: string allOf: – #/definitions/documentDisplayFilter description: Filtro de exibição de documentos para o revisor size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Número da página minimum: 0 default: 0 orderby: type: string description: Ordenação default: responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/documentStatusRecord minimum: 1 description: Lista dos status dos documentos do colaborador terceiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/getContractPersonReview: post: description: Retorna os dados para revisão do vínculo da pessoa com o contrato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contractPersonId properties: contractPersonId: type: integer format: int64 description: ID do vínculo da pessoa com o contrato responses: 200: description: Ok schema: type: object required: – contractPerson properties: contractPerson: type: object allOf: – #/definitions/contractPersonRecord description: Dados para revisão do vínculo da pessoa com o contrato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados para revisão do vínculo da pessoa com o contrato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: contractPersonId description: ID do vínculo da pessoa com o contrato in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – contractPerson properties: contractPerson: type: object allOf: – #/definitions/contractPersonRecord description: Dados para revisão do vínculo da pessoa com o contrato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/getProcessesList: post: description: Obtém os processos ativos que o usuário logado tem algum tipo de permissão. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – serviceAction properties: serviceAction: type: string description: Tipo de Ação que indica quais processos serão listado processFilterType: type: string description: Filtro por tipo de processo tagFilter: type: string description: Tag para filtro onlyActiveProcesses: type: boolean description: Apenas retorna processos ativos default: true serviceEventStartDate: type: string format: date description: A partir de qual data buscar eventos de serviços externos responses: 200: description: Ok schema: type: object properties: processes: type: array items: type: object allOf: – #/definitions/serviceProcess description: Lista de Processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os processos ativos que o usuário logado tem algum tipo de permissão. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: serviceAction description: Tipo de Ação que indica quais processos serão listado in: query required: true type: string – name: processFilterType description: Filtro por tipo de processo in: query type: string – name: tagFilter description: Tag para filtro in: query type: string – name: onlyActiveProcesses description: Apenas retorna processos ativos in: query type: boolean – name: serviceEventStartDate description: A partir de qual data buscar eventos de serviços externos in: query type: string format: date responses: 200: description: Ok schema: type: object properties: processes: type: array items: type: object allOf: – #/definitions/serviceProcess description: Lista de Processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/getDocumentRangeItens: post: description: Retorna os Itens de Abrangência do Documento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: integer format: int64 description: Valor para busca por identificador de um registro parameters: type: array items: type: object allOf: – #/definitions/searchParametersItens description: Nome e valor de outros campos filtros responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/rangeItens minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/getContractRangeItens: post: description: Retorna os Itens de Abrangência do Contrato tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: integer format: int64 description: Valor para busca por identificador de um registro parameters: type: array items: type: object allOf: – #/definitions/searchParametersItens description: Nome e valor de outros campos filtros responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/rangeItens minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/thirdPartyCompanyLookup: post: description: Retorna uma lista de empresas terceiras para ser utilizado no componente Lookup tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: string description: Filtro de pesquisa displayfields: type: string description: Display fields size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Índice da página (inicia em zero) minimum: 0 default: 0 orderby: type: string description: Parâmetro de ordenação default: responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/thirdPartyCompanyRecord minimum: 1 description: Lista de papéis grupos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de empresas terceiras para ser utilizado no componente Lookup tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filter description: Filtro de pesquisa in: query type: string – name: displayfields description: Display fields in: query type: string – name: size description: Quantidade de registros por página in: query type: integer format: int64 – name: offset description: Índice da página (inicia em zero) in: query type: integer format: int64 – name: orderby description: Parâmetro de ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/thirdPartyCompanyRecord minimum: 1 description: Lista de papéis grupos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/getThirdPartyCompanyRangeItens: post: description: Retorna os Itens de Abrangência da Empresa Terceira tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: integer format: int64 description: Valor para busca por identificador de um registro parameters: type: array items: type: object allOf: – #/definitions/searchParametersItens description: Nome e valor de outros campos filtros responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/rangeItens minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/getContractTypeRangeItens: post: description: Retorna os Itens de Abrangência de Tipo de Contrato tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: integer format: int64 description: Valor para busca por identificador de um registro parameters: type: array items: type: object allOf: – #/definitions/searchParametersItens description: Nome e valor de outros campos filtros responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/rangeItens minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/getInformationBPMRequest: post: description: Retorna as informações da solicitação do BPM para o contrato tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – bpmRequestId properties: bpmRequestId: type: integer format: int64 description: ID da solicitação do BPM responses: 200: description: Ok schema: type: object required: – bpmRequestId – nameResponsableTask – requestStatus – creationDate – startDate – expirationDate – requesterName properties: bpmRequestId: type: integer format: int64 description: ID da solicitação do BPM nameResponsableTask: type: string description: Nome do responsável atual da tarefa requestStatus: type: string allOf: – #/definitions/requestStatus description: Status da requisicao creationDate: type: string format: date description: Data de criação do processo startDate: type: string format: date description: Data de início da tarefa/processo expirationDate: type: string format: date description: Data de expiração da tarefa/processo requesterName: type: string description: Nome do solicitante 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações da solicitação do BPM para o contrato tags: – Queries x-senior-visibility: PUBLIC parameters: – name: bpmRequestId description: ID da solicitação do BPM in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – bpmRequestId – nameResponsableTask – requestStatus – creationDate – startDate – expirationDate – requesterName properties: bpmRequestId: type: integer format: int64 description: ID da solicitação do BPM nameResponsableTask: type: string description: Nome do responsável atual da tarefa requestStatus: type: string allOf: – #/definitions/requestStatus description: Status da requisicao creationDate: type: string format: date description: Data de criação do processo startDate: type: string format: date description: Data de início da tarefa/processo expirationDate: type: string format: date description: Data de expiração da tarefa/processo requesterName: type: string description: Nome do solicitante 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/getComments: post: description: Retorna os comantários de uma solicitação do BPM tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – demandType – id properties: demandType: type: string allOf: – #/definitions/demandType description: Tipo da exigência id: type: integer format: int64 description: Id Empresa/Contrato/Vinculo responses: 200: description: Ok schema: type: object required: – comments properties: comments: type: array items: type: object allOf: – #/definitions/commentsRecord minimum: 1 description: Comentários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/getBondsAvailableToPostpone: post: description: Retorna a quantidade de vínculos que possuem a mesma data fim e id do contrato informado tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – contractId properties: contractId: type: integer format: int64 description: Id do contrato do vínculo responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: integer format: int64 description: Quantidade de vínculos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de vínculos que possuem a mesma data fim e id do contrato informado tags: – Queries x-senior-visibility: PUBLIC parameters: – name: contractId description: Id do contrato do vínculo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: integer format: int64 description: Quantidade de vínculos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/queries/organizationalStructureLookup: post: description: Retorna uma lista de estruturas organizacionas para ser utilizado no componente Lookup tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: string description: Filtro de pesquisa displayfields: type: string description: Display fields size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Índice da página (inicia em zero) minimum: 0 default: 0 orderby: type: string description: Parâmetro de ordenação default: responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/organizationalStructureRecord minimum: 1 description: Lista de papéis grupos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de estruturas organizacionas para ser utilizado no componente Lookup tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filter description: Filtro de pesquisa in: query type: string – name: displayfields description: Display fields in: query type: string – name: size description: Quantidade de registros por página in: query type: integer format: int64 – name: offset description: Índice da página (inicia em zero) in: query type: integer format: int64 – name: orderby description: Parâmetro de ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/organizationalStructureRecord minimum: 1 description: Lista de papéis grupos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/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 /third/queries/exportThirdPartyCompany: 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 /third/queries/exportContract: 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 /third/queries/exportDocument: 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 /third/queries/exportContractRequirement: 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 /third/queries/exportContractPerson: 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 /third/queries/exportOrganizationalStructureType: 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 /third/queries/exportOrganizationalStructure: 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 /third/queries/exportThirdPersonRole: 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 /third/queries/exportPersonRole: 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 /third/queries/exportPersonRoleSuspension: 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 /third/queries/exportRole: 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 /third/queries/exportContractDocument: 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 /third/queries/exportThirdDocument: 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 /third/queries/exportThirdPartyCompanyDocument: 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 /third/queries/exportThirdDocumentAttachment: 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 /third/queries/exportCompanyDocumentAttachment: 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 /third/queries/exportContractDocumentAttachment: 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 /third/queries/exportPersonDocumentRequest: 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 /third/queries/exportContractConfiguration: 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 /third/queries/exportContractConfigurationRequirement: 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 /third/queries/exportActivityPerformed: 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 /third/queries/exportActivityPerformedRequirement: 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 /third/queries/exportCommentThirdDocument: 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 /third/queries/exportCommentContractDocument: 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 /third/queries/exportCommentThirdPartyCompanyDocument: 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 /third/queries/exportContractType: 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 /third/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 /third/actions/registerUser: post: description: Register a new user on the database tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contractId properties: contractId: type: integer format: int64 description: Id do contrato responses: 200: description: Ok schema: type: object required: – user properties: user: type: object allOf: – #/definitions/userOutput description: The user created 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/createThird: post: description: Cria colaborador de empresa terceira com documentos\nNão é necessário recursos.\n###Utilização:\n-Usuários terceiros. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – person properties: person: type: object allOf: – #/definitions/personRecord description: Pessoa responses: 200: description: Ok schema: type: object allOf: – #/definitions/personRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/updateThird: post: description: Edita um colaborador de empresa terceira com documentos\nNão é necessário recursos.\n###Utilização:\n-Usuários terceiros. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – person properties: person: type: object allOf: – #/definitions/personRecord description: Pessoa responses: 200: description: Ok schema: type: object allOf: – #/definitions/personRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/associateContractPerson: post: description: Associar pessoas a um contrato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – personId – contractList properties: personId: type: integer format: int64 description: ID da Pessoa startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final contractList: type: array items: type: object allOf: – #/definitions/contract minimum: 1 description: Lista de contratos activityPerformed: type: object allOf: – #/definitions/activityPerformed description: ID da atividade exercida responses: 200: description: Ok schema: type: object required: – contractPersonList properties: contractPersonList: type: array items: type: object allOf: – #/definitions/contractPerson minimum: 1 description: Lista de contratos de pessoas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/editContractPerson: post: description: Editar pessoas associadas a um contrato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/contractPerson responses: 200: description: Ok schema: type: object allOf: – #/definitions/contractPerson 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/disassociateContractPerson: post: description: Desassociar pessoa do contrato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: ID responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/sendExpiredDocumentsEmail: post: description: Enviar e-mail com documentos com a data de validade expirada tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/sendDocumentsToExpireEmail: post: description: Enviar e-mail com documentos prestes a vencer tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/blockThird: post: description: Busca contratos vigentes e envia o bloqueio de terceiros caso haja documentos de terceiros, contratos ou empresas vencidos tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/createThirdPartyDocument: post: description: Cria o documento do colaborador terceiro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – personId – contractId – documentId – document properties: personId: type: integer format: int64 description: ID da pessoa contractId: type: integer format: int64 description: ID do contrato documentId: type: integer format: int64 description: ID do documento document: type: string maxLength: 50 description: Documento endDate: type: string format: date description: Data de validade issuanceDate: type: string format: date description: Data de emissão approvalStatus: type: string allOf: – #/definitions/approvalStatusType description: Status de aprovação originDocumentRequirement: type: string allOf: – #/definitions/originDocumentRequirement description: Exigido Por responses: 200: description: Ok schema: type: object required: – thirdDocument properties: thirdDocument: type: object allOf: – #/definitions/thirdDocument description: Pessoa Documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/createLinkContractPerson: post: description: Serviço para criar vínculos com contratos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contractPersonRegisterRecordList properties: contractPersonRegisterRecordList: type: array items: type: object allOf: – #/definitions/contractPersonRegisterRecord minimum: 1 description: Lista de pessoas e contratos a serem vínculados responses: 200: description: Ok schema: type: object required: – contractPersonRegisterFeedbackRecordList properties: contractPersonRegisterFeedbackRecordList: type: array items: type: object allOf: – #/definitions/contractPersonRegisterFeedbackRecord minimum: 1 description: Resultado das dos vínculos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/duplicateContract: post: description: Duplica os dados de um contrato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: ID do contrato que irá ser duplicado responses: 200: description: Ok schema: type: object allOf: – #/definitions/contract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/updateThirdPartyDocument: post: description: Edita o documento do colaborador terceiro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – personId – contractId – documentId – document properties: id: type: integer format: int64 description: ID do documento do colaborador terceiro personId: type: integer format: int64 description: ID da pessoa contractId: type: integer format: int64 description: ID do contrato documentId: type: integer format: int64 description: ID do documento document: type: string maxLength: 50 description: Documento endDate: type: string format: date description: Data de validade issuanceDate: type: string format: date description: Data de emissão approvalStatus: type: string allOf: – #/definitions/approvalStatusType description: Status de aprovação responses: 200: description: Ok schema: type: object required: – thirdDocument properties: thirdDocument: type: object allOf: – #/definitions/thirdDocument description: Pessoa Documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/sendThirdInformation: post: description: Endpoint para confirmemail tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contractPersonId properties: contractPersonId: type: integer format: int64 description: Contrato pessoa ID responses: 200: description: Ok schema: type: object required: – contractPerson properties: contractPerson: type: object allOf: – #/definitions/contractPerson description: Contrato pessoa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/sendThirdPartyCompanyInformation: post: description: Envia os documentos da empresa para validação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – thirdPartyCompanyId properties: thirdPartyCompanyId: type: integer format: int64 description: ID da Empresa responses: 200: description: Ok schema: type: object required: – thirdPartyCompany properties: thirdPartyCompany: type: object allOf: – #/definitions/thirdPartyCompany description: Empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/sendContractInformation: post: description: Envia os documentos do contrato para validação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contractId properties: contractId: type: integer format: int64 description: ID do Contrato responses: 200: description: Ok schema: type: object required: – contract properties: contract: type: object allOf: – #/definitions/contract description: Contrato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/deleteThirdPartyDocument: post: description: Apaga o documento do colaborador terceiro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – contractId properties: id: type: integer format: int64 description: ID do documento do colaborador terceiro contractId: type: integer format: int64 description: ID do contrato responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/postponedContractPersonsBond: post: description: Atualiza a data fim dos vínculos, que possuem a mesma data fim informada no parâmetro oldContractExpirationDate e que pertencem ao contrato informado no parâmetro id tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – oldContractExpirationDate properties: id: type: integer format: int64 description: ID do contrato oldContractExpirationDate: type: string format: date description: Data fim do contrato responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/commitDocumentAttachment: post: description: Commita o arquivo do anexo do documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentAssociationId – demandType – bpmAttachmentId properties: documentAssociationId: type: integer format: int64 description: ID da associação do documento com a empresa terceira, com o contrato ou com a pessoa demandType: type: string allOf: – #/definitions/demandType description: Tipo da exigência bpmAttachmentId: type: string description: ID do anexo no BPM responses: 200: description: Ok schema: type: object required: – commitDocumentAttachmentResult properties: commitDocumentAttachmentResult: type: object allOf: – #/definitions/commitDocumentAttachmentResultRecord description: Url para envio do anexo do documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/deleteDocumentAttachment: post: description: Exclui um arquivo de anexo do documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentAssociationId – demandType – bpmAttachmentId properties: documentAssociationId: type: integer format: int64 description: ID da associação do documento com a empresa terceira, com o contrato ou com a pessoa demandType: type: string allOf: – #/definitions/demandType description: Tipo da exigência bpmAttachmentId: type: string description: ID do anexo no BPM responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/processDocumentStatus: post: description: Processo para atualizar o status dos documentos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: contractId: type: integer format: int64 description: ID do contrato demandType: type: string allOf: – #/definitions/demandType description: Tipo da exigência responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/approvalStatusPersonDocument: post: description: Aprova o documento da pessoa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – thirdDocumentId – contractId – contractPersonId properties: thirdDocumentId: type: integer format: int64 description: ID da pessoa documento contractId: type: integer format: int64 description: ID do contrato contractPersonId: type: integer format: int64 description: ID do contrato pessoa responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/rejectStatusPersonDocument: post: description: Rejeita o documento da pessoa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – thirdDocumentId – contractId – contractPersonId properties: thirdDocumentId: type: integer format: int64 description: ID do documento da pessoa contractId: type: integer format: int64 description: ID do contrato contractPersonId: type: integer format: int64 description: ID do contrato pessoa responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/approvalStatusContractDocument: post: description: Aprova o documento do contrato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contractDocumentId properties: contractDocumentId: type: integer format: int64 description: ID do contrato documento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/rejectStatusContractDocument: post: description: Rejeita o documento do contrato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contractDocumentId properties: contractDocumentId: type: integer format: int64 description: ID do documento do contrato responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/approvalStatusThirdPartyCompanyDocument: post: description: Aprova o documento da empresa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – thirdPartyCompanyDocumentId properties: thirdPartyCompanyDocumentId: type: integer format: int64 description: ID do documento da empresa terceira responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/actions/rejectStatusThirdPartyCompanyDocument: post: description: Rejeita o documento da empresa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – thirdPartyCompanyDocumentId properties: thirdPartyCompanyDocumentId: type: integer format: int64 description: ID do documento da empresa terceira responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/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 /third/actions/importThirdPartyCompany: 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 /third/actions/importContract: 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 /third/actions/importDocument: 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 /third/actions/importContractRequirement: 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 /third/actions/importContractPerson: 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 /third/actions/importOrganizationalStructureType: 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 /third/actions/importOrganizationalStructure: 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 /third/actions/importThirdPersonRole: 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 /third/actions/importPersonRole: 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 /third/actions/importPersonRoleSuspension: 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 /third/actions/importRole: 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 /third/actions/importContractDocument: 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 /third/actions/importThirdDocument: 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 /third/actions/importThirdPartyCompanyDocument: 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 /third/actions/importThirdDocumentAttachment: 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 /third/actions/importCompanyDocumentAttachment: 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 /third/actions/importContractDocumentAttachment: 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 /third/actions/importPersonDocumentRequest: 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 /third/actions/importContractConfiguration: 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 /third/actions/importContractConfigurationRequirement: 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 /third/actions/importActivityPerformed: 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 /third/actions/importActivityPerformedRequirement: 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 /third/actions/importCommentThirdDocument: 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 /third/actions/importCommentContractDocument: 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 /third/actions/importCommentThirdPartyCompanyDocument: 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 /third/actions/importContractType: 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 /third/events/contractCreated: post: description: Quando um contrato é criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – contract properties: contract: type: object allOf: – #/definitions/contract description: Referência ao contrato criado responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /third/events/importThirdPartyCompanyEvent: 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 /third/events/exportThirdPartyCompanyEvent: 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 /third/events/importContractEvent: 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 /third/events/exportContractEvent: 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 /third/events/importDocumentEvent: 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 /third/events/exportDocumentEvent: 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 /third/events/importContractRequirementEvent: 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 /third/events/exportContractRequirementEvent: 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 /third/events/importContractPersonEvent: 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 /third/events/exportContractPersonEvent: 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 /third/events/importOrganizationalStructureTypeEvent: 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 /third/events/exportOrganizationalStructureTypeEvent: 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 /third/events/importOrganizationalStructureEvent: 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 /third/events/exportOrganizationalStructureEvent: 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 /third/events/importThirdPersonRoleEvent: 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 /third/events/exportThirdPersonRoleEvent: 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 /third/events/importPersonRoleEvent: 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 /third/events/exportPersonRoleEvent: 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 /third/events/importPersonRoleSuspensionEvent: 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 /third/events/exportPersonRoleSuspensionEvent: 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 /third/events/importRoleEvent: 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 /third/events/exportRoleEvent: 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 /third/events/importContractDocumentEvent: 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 /third/events/exportContractDocumentEvent: 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 /third/events/importThirdDocumentEvent: 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 /third/events/exportThirdDocumentEvent: 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 /third/events/importThirdPartyCompanyDocumentEvent: 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 /third/events/exportThirdPartyCompanyDocumentEvent: 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 /third/events/importThirdDocumentAttachmentEvent: 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 /third/events/exportThirdDocumentAttachmentEvent: 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 /third/events/importCompanyDocumentAttachmentEvent: 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 /third/events/exportCompanyDocumentAttachmentEvent: 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 /third/events/importContractDocumentAttachmentEvent: 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 /third/events/exportContractDocumentAttachmentEvent: 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 /third/events/importPersonDocumentRequestEvent: 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 /third/events/exportPersonDocumentRequestEvent: 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 /third/events/importContractConfigurationEvent: 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 /third/events/exportContractConfigurationEvent: 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 /third/events/importContractConfigurationRequirementEvent: 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 /third/events/exportContractConfigurationRequirementEvent: 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 /third/events/importActivityPerformedEvent: 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 /third/events/exportActivityPerformedEvent: 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 /third/events/importActivityPerformedRequirementEvent: 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 /third/events/exportActivityPerformedRequirementEvent: 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 /third/events/importCommentThirdDocumentEvent: 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 /third/events/exportCommentThirdDocumentEvent: 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 /third/events/importCommentContractDocumentEvent: 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 /third/events/exportCommentContractDocumentEvent: 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 /third/events/importCommentThirdPartyCompanyDocumentEvent: 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 /third/events/exportCommentThirdPartyCompanyDocumentEvent: 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 /third/events/importContractTypeEvent: 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 /third/events/exportContractTypeEvent: 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 /third/entities/contract: 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/contract responses: 200: description: The created resource schema: #/definitions/contract 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/contract responses: 200: description: The created resource schema: #/definitions/contract 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: array items: #/definitions/contract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/contract/{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/contract responses: 200: description: Ok schema: #/definitions/contract 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/contract responses: 200: description: Ok schema: #/definitions/contract 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/contract 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 /third/entities/contract/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contract responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/document: 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/document responses: 200: description: The created resource schema: #/definitions/document 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/document responses: 200: description: The created resource schema: #/definitions/document 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: array items: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/document/{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/document responses: 200: description: Ok schema: #/definitions/document 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/document responses: 200: description: Ok schema: #/definitions/document 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/document 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 /third/entities/document/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/document responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/contractRequirement: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contractRequirement responses: 200: description: The created resource schema: #/definitions/contractRequirement 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contractRequirement responses: 200: description: The created resource schema: #/definitions/contractRequirement 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/contractRequirement 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/contractRequirement/{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/contractRequirement responses: 200: description: Ok schema: #/definitions/contractRequirement 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contractRequirement responses: 200: description: Ok schema: #/definitions/contractRequirement 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contractRequirement 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/contractRequirement/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contractRequirement responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/contractPerson: 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/contractPerson responses: 200: description: The created resource schema: #/definitions/contractPerson 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/contractPerson responses: 200: description: The created resource schema: #/definitions/contractPerson 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: array items: #/definitions/contractPerson 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/contractPerson/{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/contractPerson responses: 200: description: Ok schema: #/definitions/contractPerson 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/contractPerson responses: 200: description: Ok schema: #/definitions/contractPerson 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/contractPerson 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 /third/entities/contractPerson/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contractPerson responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/contractDocument: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contractDocument responses: 200: description: The created resource schema: #/definitions/contractDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contractDocument responses: 200: description: The created resource schema: #/definitions/contractDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/contractDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/contractDocument/{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/contractDocument responses: 200: description: Ok schema: #/definitions/contractDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contractDocument responses: 200: description: Ok schema: #/definitions/contractDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contractDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/contractDocument/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contractDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/thirdDocument: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/thirdDocument responses: 200: description: The created resource schema: #/definitions/thirdDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/thirdDocument responses: 200: description: The created resource schema: #/definitions/thirdDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/thirdDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/thirdDocument/{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/thirdDocument responses: 200: description: Ok schema: #/definitions/thirdDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/thirdDocument responses: 200: description: Ok schema: #/definitions/thirdDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/thirdDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/thirdDocument/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/thirdDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/thirdPartyCompanyDocument: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/thirdPartyCompanyDocument responses: 200: description: The created resource schema: #/definitions/thirdPartyCompanyDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/thirdPartyCompanyDocument responses: 200: description: The created resource schema: #/definitions/thirdPartyCompanyDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/thirdPartyCompanyDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/thirdPartyCompanyDocument/{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/thirdPartyCompanyDocument responses: 200: description: Ok schema: #/definitions/thirdPartyCompanyDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/thirdPartyCompanyDocument responses: 200: description: Ok schema: #/definitions/thirdPartyCompanyDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/thirdPartyCompanyDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/thirdPartyCompanyDocument/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/thirdPartyCompanyDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/contractConfiguration: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contractConfiguration responses: 200: description: The created resource schema: #/definitions/contractConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contractConfiguration responses: 200: description: The created resource schema: #/definitions/contractConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/contractConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/contractConfiguration/{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/contractConfiguration responses: 200: description: Ok schema: #/definitions/contractConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contractConfiguration responses: 200: description: Ok schema: #/definitions/contractConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contractConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/contractConfiguration/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contractConfiguration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/contractConfigurationRequirement: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contractConfigurationRequirement responses: 200: description: The created resource schema: #/definitions/contractConfigurationRequirement 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contractConfigurationRequirement responses: 200: description: The created resource schema: #/definitions/contractConfigurationRequirement 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/contractConfigurationRequirement 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/contractConfigurationRequirement/{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/contractConfigurationRequirement responses: 200: description: Ok schema: #/definitions/contractConfigurationRequirement 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contractConfigurationRequirement responses: 200: description: Ok schema: #/definitions/contractConfigurationRequirement 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contractConfigurationRequirement 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/contractConfigurationRequirement/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contractConfigurationRequirement responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/activityPerformed: 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/activityPerformed responses: 200: description: The created resource schema: #/definitions/activityPerformed 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/activityPerformed responses: 200: description: The created resource schema: #/definitions/activityPerformed 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: array items: #/definitions/activityPerformed 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/activityPerformed/{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/activityPerformed responses: 200: description: Ok schema: #/definitions/activityPerformed 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/activityPerformed responses: 200: description: Ok schema: #/definitions/activityPerformed 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/activityPerformed 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 /third/entities/activityPerformed/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/activityPerformed responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/activityPerformedRequirement: 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/activityPerformedRequirement responses: 200: description: The created resource schema: #/definitions/activityPerformedRequirement 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/activityPerformedRequirement responses: 200: description: The created resource schema: #/definitions/activityPerformedRequirement 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: array items: #/definitions/activityPerformedRequirement 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/activityPerformedRequirement/{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/activityPerformedRequirement responses: 200: description: Ok schema: #/definitions/activityPerformedRequirement 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/activityPerformedRequirement responses: 200: description: Ok schema: #/definitions/activityPerformedRequirement 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/activityPerformedRequirement 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 /third/entities/activityPerformedRequirement/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/activityPerformedRequirement responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/commentThirdDocument: 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/commentThirdDocument responses: 200: description: The created resource schema: #/definitions/commentThirdDocument 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/commentThirdDocument responses: 200: description: The created resource schema: #/definitions/commentThirdDocument 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: array items: #/definitions/commentThirdDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/commentThirdDocument/{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/commentThirdDocument responses: 200: description: Ok schema: #/definitions/commentThirdDocument 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/commentThirdDocument responses: 200: description: Ok schema: #/definitions/commentThirdDocument 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/commentThirdDocument 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 /third/entities/commentThirdDocument/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/commentThirdDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/commentContractDocument: 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/commentContractDocument responses: 200: description: The created resource schema: #/definitions/commentContractDocument 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/commentContractDocument responses: 200: description: The created resource schema: #/definitions/commentContractDocument 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: array items: #/definitions/commentContractDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/commentContractDocument/{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/commentContractDocument responses: 200: description: Ok schema: #/definitions/commentContractDocument 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/commentContractDocument responses: 200: description: Ok schema: #/definitions/commentContractDocument 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/commentContractDocument 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 /third/entities/commentContractDocument/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/commentContractDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/commentThirdPartyCompanyDocument: 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/commentThirdPartyCompanyDocument responses: 200: description: The created resource schema: #/definitions/commentThirdPartyCompanyDocument 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/commentThirdPartyCompanyDocument responses: 200: description: The created resource schema: #/definitions/commentThirdPartyCompanyDocument 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: array items: #/definitions/commentThirdPartyCompanyDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/commentThirdPartyCompanyDocument/{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/commentThirdPartyCompanyDocument responses: 200: description: Ok schema: #/definitions/commentThirdPartyCompanyDocument 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/commentThirdPartyCompanyDocument responses: 200: description: Ok schema: #/definitions/commentThirdPartyCompanyDocument 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/commentThirdPartyCompanyDocument 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 /third/entities/commentThirdPartyCompanyDocument/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/commentThirdPartyCompanyDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/contractType: 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/contractType responses: 200: description: The created resource schema: #/definitions/contractType 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/contractType responses: 200: description: The created resource schema: #/definitions/contractType 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: array items: #/definitions/contractType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /third/entities/contractType/{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/contractType responses: 200: description: Ok schema: #/definitions/contractType 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/contractType responses: 200: description: Ok schema: #/definitions/contractType 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/contractType 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 /third/entities/contractType/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contractType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: statusHistoric: description: Status de um Histórico type: string enum: – FUTURE – PRESENT – PAST healthcheckStatus: description: Status do healthcheck type: string enum: – UP – DOWN expirationTypeDocument: description: Tipo de validade do documento type: string enum: – WITHOUT – PERIOD – DOCUMENT_DATE periodType: description: Tipo de Período type: string enum: – DAY – MONTH – YEAR personSituationType: description: Situação da pessoa type: string enum: – ACTIVE – BLOCKED approvalStatusType: description: Status da aprovação do contrato type: string enum: – DRAFT – LOGIN_SENT – REGISTRATION_IN_PROGRESS – PENDING_APPROVAL – WAITING_FOR_ADJUSTMENTS – APPROVED phoneType: description: Tipo do telefone type: string enum: – UNDEFINED – WORK – MOBILE – HOME – OTHERS gender: description: Sexo type: string enum: – UNKNOWN – MALE – FEMALE demandType: description: Tipo das exigências type: string enum: – Third_Party_Collaborator – Contract – Third_Party_Company documentStatusType: description: Status do documento type: string enum: – PENDING – CURRENT – EXPIRED originDocumentRequirement: description: Origem da exigência do documento type: string enum: – CONTRACT – ACTIVITY_PERFORMED recordStatusType: description: Status da gravação do vínculo de pessoa contrato type: string enum: – SUCCESS – FAILURE requestStatus: description: Status da requisicao type: string enum: – IN_PROGRESS – COMPLETED – CANCELED documentDisplayFilter: description: Filtro de exibição de documentos para o revisor type: string enum: – VIEW_ALL – REGISTERED – NOT_REGISTERED bondValidityFilter: description: Filtro de de vinculos type: string enum: – FINALIZED – CURRENT – FUTURES – ALL_BOND userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR healthcheckItem: description: Item verificado no healthcheck type: object required: – name – status properties: name: type: string description: Nome do item status: type: string allOf: – #/definitions/healthcheckStatus description: Status da saúde userOutput: description: Usuário criado no register user type: object required: – user – fullName – email – contractId – newUser properties: user: type: string description: Usuário fullName: type: string description: Nome completo email: type: string description: Email contractId: type: integer format: int64 description: ID do contrato newUser: type: boolean description: Novo usuário personRecord: description: Pessoa type: object required: – documents properties: id: type: integer format: int64 description: ID name: type: string description: Nome situation: type: string allOf: – #/definitions/personSituationType description: Situação da pessoa documents: type: array items: type: object allOf: – #/definitions/documentRecord minimum: 1 description: Documento registerDate: type: string format: date-time description: Data de Cadastro gender: type: string allOf: – #/definitions/gender description: Sexo nationality: type: string description: Nacionalidade birthday: type: string format: date description: Data de Nascimento phones: type: array items: type: object allOf: – #/definitions/phoneRecord description: Telefone emails: type: array items: type: object allOf: – #/definitions/emailRecord description: Email lastModificationDate: type: string format: date-time description: Data da Última Alteração address: type: string maxLength: 200 description: Endereço district: type: string maxLength: 75 description: Bairro city: type: string maxLength: 30 description: Cidade federalState: type: string maxLength: 30 description: Estado zipCode: type: string maxLength: 20 description: Código Postal personSituation: type: object allOf: – #/definitions/personSituationRecord description: Dados da situação da pessoa custom: type: string format: byte description: Campos customizados da pessoa documentRecord: description: Documento type: object required: – documentType – document properties: id: type: integer format: int64 description: ID documentType: type: object allOf: – #/definitions/documentTypeRecord description: Tipo de documento document: type: string description: Documento documentTypeRecord: description: Tipo de documento type: object required: – id – name – label – required properties: id: type: integer format: int64 description: ID name: type: string description: Nome do tipo de documento label: type: string description: Label do documento mask: type: string description: Máscara do documento required: type: boolean description: Documento obrigatório phoneRecord: description: Telefone type: object required: – number – phoneType properties: id: type: integer format: int64 description: Id do telefone preferential: type: boolean description: Telefone preferencial default: false idd: type: integer format: int64 description: DDI/IDD (International Direct Dialing) minimum: 0 maximum: 999 number: type: string maxLength: 25 description: Número do Telefone phoneExtension: type: string maxLength: 5 description: Ramal phoneType: type: string allOf: – #/definitions/phoneType description: Tipo emailRecord: description: Email type: object required: – email properties: id: type: integer format: int64 description: Id do email preferential: type: boolean description: Email preferencial default: false email: type: string maxLength: 100 description: Email getContractPersonPageableRecord: description: Contrato pessoa type: object required: – contractPersonId – documentTypeId – contractId – description – contractNumber – name – document – mask – approvalStatus – documentLabel – activityPerformed – startDate properties: contractPersonId: type: integer format: int64 description: ID do contrato pessoa documentTypeId: type: integer format: int64 description: ID do tipo de documento contractId: type: integer format: int64 description: ID do contrato description: type: string description: Descrição contractNumber: type: string description: Número do contrato name: type: string description: Nome do colaborador document: type: string description: Documento do terceiro mask: type: string description: Máscara do documento do terceiro approvalStatus: type: string allOf: – #/definitions/approvalStatusType description: Etapa de aprovação do vínculo documentLabel: type: string description: Rótulo do documento do terceiro contractType: type: object allOf: – #/definitions/contractTypeRecord description: Tipo de contrato informado no contrato contractorCompanyBranch: type: object allOf: – #/definitions/organizationalStructure description: Estrutura Organizacional do Tipo Filial expirationDate: type: string format: date description: Data do próximo documento a vencer activityPerformed: type: object allOf: – #/definitions/activityPerformedRecord description: Atividade Exercida do vínculo thirdPartyCompany: type: object allOf: – #/definitions/thirdPartyCompanyRecord description: Empresa terceira startDate: type: string format: date description: Data início endDate: type: string format: date description: Data fim documentStatusRecord: description: Record do status do documento type: object required: – documentId – documentName – requiredDocument – expirationTypeDocument – documentStatus properties: documentId: type: integer format: int64 description: ID do documento documentName: type: string description: Nome do documento requiredDocument: type: boolean description: Documento obrigatório expirationTypeDocument: type: string allOf: – #/definitions/expirationTypeDocument description: Tipo de validade do documento periodType: type: string allOf: – #/definitions/periodType description: Tipo de período period: type: integer format: int64 description: Período documentStatus: type: string allOf: – #/definitions/documentStatusType description: Status do documento thirdPartyCompanyDocumentId: type: integer format: int64 description: ID da associação da empresa terceira com o documento contractDocumentId: type: integer format: int64 description: ID da associação do contrato com o documento personDocumentRequestId: type: integer format: int64 description: ID da solicitação de documento da pessoa document: type: string description: Documento issuanceDate: type: string format: date description: Data de emissão endDate: type: string format: date description: Data de validade approvalStatus: type: string allOf: – #/definitions/approvalStatusType description: Status da aprovação do documento contractRequirementId: type: integer format: int64 description: ID associação do contrato com a exigência documentPersonId: type: integer format: int64 description: ID associação do documento com a pessoa hasAttachment: type: boolean description: Tem anexo default: false thirdPartyCompany: type: object allOf: – #/definitions/thirdPartyCompany description: Empresa terceira requirementBy: type: string description: Exigido por originDocumentRequirement: type: string allOf: – #/definitions/originDocumentRequirement description: Origem da exigência do documento contractPersonBondRecord: description: Record do vinculo com contrato do colaborador type: object properties: contractPersonId: type: integer format: int64 description: ID do vinculo de contrato e pessoa thirdPartyCompanyId: type: integer format: int64 description: ID empresa terceira contractId: type: integer format: int64 description: ID contrato companyName: type: string description: Nome da empresa terceira tradeName: type: string description: Nome fantasia da empresa terceira description: type: string description: Descrição do contrato contractNumber: type: string description: Número do contrato startDate: type: string format: date description: Data início endDate: type: string format: date description: Data fim approvalStatus: type: string allOf: – #/definitions/approvalStatusType description: Status de aprovação commitDocumentAttachmentResultRecord: description: Record do resultado do commit do anexo do documento type: object required: – documentAttachmentId – bpmAttachmentId – document properties: documentAttachmentId: type: integer format: int64 description: ID do anexo do documento bpmAttachmentId: type: string description: ID do anexo no BPM document: type: string description: Documento getDocumentAttachmentResultRecord: description: Record do resultado da consulta de anexo do documento type: object properties: bpmAttachmentId: type: string description: ID do anexo no BPM url: type: string description: Url do arquivo name: type: string description: Nome do arquivo anexado organizationalStructureTypeRecord: description: Tipo estrutura organizacional type: object properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome organizationalStructureRecord: description: Estrutura organizacional type: object properties: id: type: integer format: int64 description: ID parent: type: integer format: int64 description: Estrutura organizacional pai organizationalStructureType: type: object allOf: – #/definitions/organizationalStructureTypeRecord description: Tipo da estrutura organizacional description: type: string maxLength: 200 description: Descrição integrated: type: boolean description: Integrado com GAS thirdPartyCompanyRecord: description: Empresa Terceira type: object properties: id: type: integer format: int64 description: ID tradeName: type: string maxLength: 100 description: Nome Fantasia companyName: type: string maxLength: 100 description: Razão Social document: type: string maxLength: 18 description: Documento approvalStatus: type: string allOf: – #/definitions/approvalStatusType description: Status de aprovação bpmRequestId: type: integer format: int64 description: ID da solicitação do BPM workflowProcessId: type: integer format: int64 description: Id do processo de workflow zipCode: type: string maxLength: 10 description: Código Postal country: type: string maxLength: 30 description: Nacionalidade federalState: type: string maxLength: 2 description: Estado city: type: string maxLength: 30 description: Cidade district: type: string maxLength: 75 description: Bairro address: type: string maxLength: 100 description: Endereço complement: type: string maxLength: 30 description: Complemento number: type: integer format: int64 description: Número maximum: 1000000 email: type: string maxLength: 100 description: Email phone: type: string maxLength: 25 description: Telefone stateRegistration: type: string maxLength: 20 description: Inscrição Estadual integratedWithGAS: type: boolean description: Possui integração com Ronda Senior default: false custom: type: string format: byte description: Campos customizados da empresa terceira contractRecord: description: Contrato type: object required: – defaultRole properties: id: type: integer format: int64 description: ID description: type: string maxLength: 100 description: Descrição contractNumber: type: string maxLength: 100 description: Número do contrato thirdPartyCompany: type: object allOf: – #/definitions/thirdPartyCompanyRecord description: Empresa terceira startDate: type: string format: date description: Data início endDate: type: string format: date description: Data fim situation: type: boolean description: Situação responsibleName: type: string maxLength: 100 description: Nome do responsável email: type: string maxLength: 100 description: Email phone: type: string maxLength: 12 description: Telefone workflowProcessId: type: integer format: int64 description: Id do processo de workflow approvalStatus: type: string allOf: – #/definitions/approvalStatusType description: Status de aprovação bpmRequestId: type: integer format: int64 description: ID da solicitação do BPM organizationalStructureId: type: integer format: int64 description: Estrutura Organizacional defaultLocation: type: object allOf: – #/definitions/organizationalStructure description: Local padrão standardScale: type: integer format: int64 description: Escala padrão contractorCompanyBranch: type: object allOf: – #/definitions/organizationalStructure description: Estrutura Organizacional do Tipo Filial defaultRole: type: object allOf: – #/definitions/role description: Papel padrão contractPersonRecord: description: Contrato Pessoa type: object properties: id: type: integer format: int64 description: ID contract: type: object allOf: – #/definitions/contractRecord description: Contrato person: type: object allOf: – #/definitions/personRecord description: Pessoa startDate: type: string format: date description: Data início endDate: type: string format: date description: Data fim approvalStatus: type: string allOf: – #/definitions/approvalStatusType description: Status de aprovação bpmRequestId: type: integer format: int64 description: ID da solicitação do BPM activityPerformed: type: object allOf: – #/definitions/activityPerformedRecord description: Atividade exercida observationActivityPerformed: type: string description: Observação atividade exercida contractType: type: object allOf: – #/definitions/contractTypeRecord description: Tipo de contrato contractorCompanyBranch: type: object allOf: – #/definitions/organizationalStructure description: ID da Estrutura Organizacional do Tipo Filial personSituationRecord: description: Situação da pessoa type: object properties: id: type: integer format: int64 description: ID personId: type: integer format: int64 description: ID da pessoa blockDate: type: string format: date-time description: Data do bloqueio blockReason: type: string maxLength: 2000 description: Motivo do bloqueio serviceProcess: description: type: object required: – processId – processName – description properties: processId: type: integer format: int64 description: Identificador do Processo processName: type: string description: Nome do Processo description: type: string description: Descrição do processo activityPerformedRecord: description: Atividade Exercida type: object properties: id: type: integer format: int64 description: ID da atividade exercida name: type: string maxLength: 100 description: Nome da atividade active: type: boolean description: Está ativo default: true contractTypeRecord: description: Tipo de contrato type: object required: – name properties: id: type: integer format: int64 description: ID name: type: string maxLength: 100 description: Nome active: type: boolean description: Está ativo default: true documentRequirement: description: type: object properties: id: type: integer format: int64 description: ID do documento requiredDocument: type: boolean description: Documento obrigatório expirationTypeDocument: type: string allOf: – #/definitions/expirationTypeDocument description: Tipo vencimento periodType: type: string allOf: – #/definitions/periodType description: Tipo periodo period: type: integer format: int64 description: Periodo originDocumentRequirement: type: string allOf: – #/definitions/originDocumentRequirement description: Tipo exigencia a ser tratada contractPersonRegisterRecord: description: Record de entrada para criação de registros de pessoa-contrato type: object required: – personId – contractId – startDate properties: personId: type: integer format: int64 description: Id da pessoa contractId: type: integer format: int64 description: Id do contrato startDate: type: string format: date description: Data inicial do vínculo endDate: type: string format: date description: Data final do vínculo contractPersonRegisterFeedbackRecord: description: Record de saída para a criação de registros de pessoa-contrato type: object required: – personId – contractId – recordStatusType – message – personExists properties: personId: type: integer format: int64 description: Id da pessoa contractId: type: integer format: int64 description: Id do contrato recordStatusType: type: string allOf: – #/definitions/recordStatusType description: Status da gravação message: type: string description: Mensagem de retorno personExists: type: boolean description: Flag pessoa existe rangeItens: description: Itens da Abrangência type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Valor armazenado no filtro searchParametersItens: description: Parâmetros de Pesquisa da Abrangência type: object required: – key – value properties: key: type: string description: Nome do campo filtro que está sendo enviado como parâmetro value: type: string description: Valor do campo filtro que está sendo enviado como parâmetro commentsRecord: description: Comentários type: object properties: id: type: integer format: int64 description: ID userName: type: string description: Usuário do comentário created: type: string format: date-time description: Data da criação updated: type: string format: date-time description: Data da atualização comment: type: string description: Comentário processInstanceID: type: integer format: int64 description: Id do processo thirdPartyCompany: description: Empresa Terceira (Entidade externa) type: object required: – tradeName – companyName – document properties: id: type: integer format: int64 description: ID tradeName: type: string maxLength: 100 description: Nome Fantasia companyName: type: string maxLength: 100 description: Razão Social document: type: string maxLength: 18 description: Documento approvalStatus: type: string allOf: – #/definitions/approvalStatusType description: Status de aprovação bpmRequestId: type: integer format: int64 description: ID da solicitação do BPM workflowProcessId: type: integer format: int64 description: Id do processo de workflow createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: contract: description: Contratos type: object required: – description – contractNumber – thirdPartyCompany – startDate properties: id: type: integer format: int64 description: ID description: type: string maxLength: 100 description: Descrição contractNumber: type: string maxLength: 100 description: Número do contrato thirdPartyCompany: type: object allOf: – #/definitions/thirdPartyCompany description: Empresa terceira startDate: type: string format: date description: Data início endDate: type: string format: date description: Data fim situation: type: boolean description: Situação responsibleName: type: string maxLength: 100 description: Nome do responsável login: type: string maxLength: 50 description: Login email: type: string maxLength: 100 description: Email phone: type: string maxLength: 12 description: Telefone workflowProcessId: type: integer format: int64 description: Id do processo de workflow approvalStatus: type: string allOf: – #/definitions/approvalStatusType description: Status de aprovação bpmRequestId: type: integer format: int64 description: ID da solicitação do BPM organizationalStructureId: type: integer format: int64 description: Estrutura Organizacional integratedWithGAS: type: boolean description: Possui integração com Ronda Senior default: false defaultLocation: type: object allOf: – #/definitions/organizationalStructure description: Local padrão standardScale: type: integer format: int64 description: Escala padrão minimum: 1 contractorCompanyBranch: type: object allOf: – #/definitions/organizationalStructure description: ID da Estrutura Organizacional do Tipo Filial defaultRole: type: object allOf: – #/definitions/role description: Papel padrão contractType: type: object allOf: – #/definitions/contractType description: Tipo de contrato createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: document: description: Documento type: object required: – documentName properties: id: type: integer format: int64 description: ID documentName: type: string maxLength: 100 description: Nome documento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: contractRequirement: description: Contrato Exigencia type: object required: – contract – document – requiredDocument – expirationTypeDocument – demandType properties: id: type: integer format: int64 description: ID contract: type: object allOf: – #/definitions/contract description: Contrato document: type: object allOf: – #/definitions/document description: Documento requiredDocument: type: boolean description: Documento obrigatório expirationTypeDocument: type: string allOf: – #/definitions/expirationTypeDocument description: Tipo de validade do documento periodType: type: string allOf: – #/definitions/periodType description: Tipo de período period: type: integer format: int64 description: Período minimum: 0 maximum: 30000 demandType: type: string allOf: – #/definitions/demandType description: Tipo das exigências createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: contractPerson: description: Contrato Pessoa type: object required: – contractId – personId – startDate properties: id: type: integer format: int64 description: ID contractId: type: integer format: int64 description: Contrato personId: type: integer format: int64 description: Pessoa startDate: type: string format: date description: Data início endDate: type: string format: date description: Data fim approvalStatus: type: string allOf: – #/definitions/approvalStatusType description: Status de aprovação bpmRequestId: type: integer format: int64 description: ID da solicitação do BPM approvedBond: type: boolean description: Vínculo aprovado observationActivityPerformed: type: string maxLength: 60 description: Observação atividade exercida activityPerformed: type: object allOf: – #/definitions/activityPerformed description: Atividade Exercida lastIntegratorError: type: string maxLength: 100 description: Último erro do integrador createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: organizationalStructureType: description: Tipo estrutura organizacional (Entidade externa) type: object required: – name properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome organizationalStructure: description: Estrutura organizacional (Entidade externa) type: object required: – parent – organizationalStructureType – description – integrated properties: id: type: integer format: int64 description: ID parent: type: integer format: int64 description: Estrutura organizacional pai organizationalStructureType: type: object allOf: – #/definitions/organizationalStructureType description: Tipo da estrutura organizacional description: type: string maxLength: 200 description: Descrição integrated: type: boolean description: Integrado com GAS thirdPersonRole: description: GT Pessoa Papel type: object required: – personRoleId – contractPerson properties: id: type: integer format: int64 description: ID personRoleId: type: object allOf: – #/definitions/personRole description: ID Pessoa Papel contractPerson: type: object allOf: – #/definitions/contractPerson description: Contrato Pessoa personRole: description: Pessoa papel (Entidade externa) type: object required: – startDate properties: id: type: integer format: int64 description: ID person: type: integer format: int64 description: Pessoa role: type: object allOf: – #/definitions/role description: Papel startDate: type: string format: date-time description: Data Início endDate: type: string format: date-time description: Data Fim status: type: string allOf: – #/definitions/statusHistoric description: Status integratedWithGAS: type: boolean description: Integrado com GAS observation: type: string description: Observação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: personRoleSuspension: description: Papéis Suspensos da Pessoa (Entidade externa) type: object required: – startDate – justification properties: id: type: integer format: int64 description: ID personRole: type: object allOf: – #/definitions/personRole description: Ligação Pessoa Papel startDate: type: string format: date-time description: Data Início endDate: type: string format: date-time description: Data Fim justification: type: string maxLength: 500 description: Justificativa status: type: string allOf: – #/definitions/statusHistoric description: Status personId: type: integer format: int64 description: ID da Pessoa role: description: Papel (Entidade externa) type: object required: – name properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: contractDocument: description: Contrato documento type: object required: – contractId – documentId – document properties: id: type: integer format: int64 description: ID contractId: type: integer format: int64 description: Contrato documentId: type: integer format: int64 description: Documento id document: type: string maxLength: 50 description: Documento endDate: type: string format: date description: Data de validade issuanceDate: type: string format: date description: Data de emissão approvalStatus: type: string allOf: – #/definitions/approvalStatusType description: Status de aprovação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: thirdDocument: description: Pessoa documento type: object required: – document properties: id: type: integer format: int64 description: ID personId: type: integer format: int64 description: Pessoa documentId: type: integer format: int64 description: Documento id document: type: string maxLength: 50 description: Documento issuanceDate: type: string format: date description: Data de emissão thirdPartyCompany: type: object allOf: – #/definitions/thirdPartyCompany description: Empresa terceira createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: thirdPartyCompanyDocument: description: Documento Empresa Terceira type: object required: – thirdPartyCompanyId – documentId – document properties: id: type: integer format: int64 description: ID thirdPartyCompanyId: type: integer format: int64 description: Empresa terceira documentId: type: integer format: int64 description: Documento id document: type: string maxLength: 50 description: Documento endDate: type: string format: date description: Data de validade issuanceDate: type: string format: date description: Data de emissão approvalStatus: type: string allOf: – #/definitions/approvalStatusType description: Status de aprovação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: thirdDocumentAttachment: description: Anexo do documento da pessoa type: object required: – thirdDocument – bpmAttachmentId properties: id: type: integer format: int64 description: ID thirdDocument: type: object allOf: – #/definitions/thirdDocument description: Pessoa documento bpmAttachmentId: type: string description: ID do anexo do BPM createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: companyDocumentAttachment: description: Anexo do documento da empresa type: object required: – thirdPartyCompanyDocument – bpmAttachmentId properties: id: type: integer format: int64 description: ID thirdPartyCompanyDocument: type: object allOf: – #/definitions/thirdPartyCompanyDocument description: Empresa documento bpmAttachmentId: type: string description: ID do anexo do BPM createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: contractDocumentAttachment: description: Anexo do documento do contrato type: object required: – contractDocument – bpmAttachmentId properties: id: type: integer format: int64 description: ID contractDocument: type: object allOf: – #/definitions/contractDocument description: Contrato documento bpmAttachmentId: type: string description: ID do anexo do BPM createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: personDocumentRequest: description: Solicitação de documento da pessoa type: object required: – contract – thirdDocument – approvalStatus – thirdPartyCompany – personId properties: id: type: integer format: int64 description: ID contract: type: object allOf: – #/definitions/contract description: Contrato thirdDocument: type: object allOf: – #/definitions/thirdDocument description: Documento pessoa approvalStatus: type: string allOf: – #/definitions/approvalStatusType description: Status aprovação thirdPartyCompany: type: object allOf: – #/definitions/thirdPartyCompany description: Empresa terceira personId: type: integer format: int64 description: Pessoa endDate: type: string format: date description: Data de validade do documento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: contractConfiguration: description: Configuração Padrão de Contrato type: object required: – name properties: id: type: integer format: int64 description: ID name: type: string maxLength: 100 description: Nome workflowProcessId: type: integer format: int64 description: Id do processo de workflow defaultLocation: type: integer format: int64 description: Local padrão – ID da Estrutura Organizacional do Tipo Local do Organograma standardScale: type: integer format: int64 description: Escala padrão – ID da Escala na G5 contractorCompanyBranch: type: integer format: int64 description: Filial Padrão – ID da Estrutura Organizacional do Tipo Filial role: type: object allOf: – #/definitions/role description: Papel padrão do contrato createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: contractConfigurationRequirement: description: Exigência da Configuração Padrão de Contrato type: object required: – contractConfiguration – document – requiredDocument – expirationTypeDocument – demandType properties: id: type: integer format: int64 description: ID contractConfiguration: type: object allOf: – #/definitions/contractConfiguration description: Contrato document: type: object allOf: – #/definitions/document description: Documento requiredDocument: type: boolean description: Documento obrigatório expirationTypeDocument: type: string allOf: – #/definitions/expirationTypeDocument description: Tipo de validade do documento periodType: type: string allOf: – #/definitions/periodType description: Tipo de período period: type: integer format: int64 description: Período minimum: 0 maximum: 30000 demandType: type: string allOf: – #/definitions/demandType description: Tipo das exigências createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: activityPerformed: description: Atividade exercida type: object required: – name properties: id: type: integer format: int64 description: ID name: type: string maxLength: 100 description: Nome active: type: boolean description: Está ativo default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: activityPerformedRequirement: description: Atividade exercida exigência type: object required: – activityPerformed – document – requiredDocument – expirationTypeDocument properties: id: type: integer format: int64 description: ID activityPerformed: type: object allOf: – #/definitions/activityPerformed description: Atividade exercida document: type: object allOf: – #/definitions/document description: Documento requiredDocument: type: boolean description: Documento obrigatório expirationTypeDocument: type: string allOf: – #/definitions/expirationTypeDocument description: Tipo de validade do documento periodType: type: string allOf: – #/definitions/periodType description: Tipo de período period: type: integer format: int64 description: Período createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: commentThirdDocument: description: Comentário para o documento do colaborador type: object required: – thirdDocument – comment – contract – contractPerson properties: id: type: integer format: int64 description: ID thirdDocument: type: object allOf: – #/definitions/thirdDocument description: Documento do colaborador comment: type: string maxLength: 500 description: Comentário contract: type: object allOf: – #/definitions/contract description: Contrato contractPerson: type: object allOf: – #/definitions/contractPerson description: Vínculo do contrato com colaborador createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: commentContractDocument: description: Comentário para o documento do contrato type: object required: – contractDocument – comment properties: id: type: integer format: int64 description: ID contractDocument: type: object allOf: – #/definitions/contractDocument description: Documento do contrato comment: type: string maxLength: 500 description: Comentário createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: commentThirdPartyCompanyDocument: description: Comentário para o documento da empresa terceira type: object required: – thirdPartyCompanyDocument – comment properties: id: type: integer format: int64 description: ID thirdPartyCompanyDocument: type: object allOf: – #/definitions/thirdPartyCompanyDocument description: Documento da empresa terceira comment: type: string maxLength: 500 description: Comentário createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: contractType: description: Tipo de contrato type: object required: – name properties: id: type: integer format: int64 description: ID name: type: string maxLength: 100 description: Nome active: type: boolean description: Está ativo default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service 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