signature

2.0info: 2.0.0 signature x-senior-domain: hcm_offboarding x-senior-domain-path: hcm_offboarding x-senior-service-path: signature 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/hcm_offboardingsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /signature/queries/healthcheck: post: description: Verificação de integridade 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 da integridade checks: type: object allOf: – #/definitions/integrityComponentDTO description: Verificação dos componentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verificação de integridade 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 da integridade checks: type: object allOf: – #/definitions/integrityComponentDTO description: Verificação dos componentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/queries/getDismissalRequestSigners: post: description: Listar assinantes do desligamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: dismissalRequestId: type: string description: Identificador da solicitação de desligamento responses: 200: description: Ok schema: type: object required: – signers properties: signers: type: array items: type: object allOf: – #/definitions/requestSignerData minimum: 1 description: Assinantes do desligamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar assinantes do desligamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dismissalRequestId description: Identificador da solicitação de desligamento in: query type: string responses: 200: description: Ok schema: type: object required: – signers properties: signers: type: array items: type: object allOf: – #/definitions/requestSignerData minimum: 1 description: Assinantes do desligamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/queries/getDocumentTemplatesForRequest: post: description: Listar modelos de documentos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: dismissalRequestId: type: string description: Identificador da solicitação de desligamento responses: 200: description: Ok schema: type: object required: – templates properties: employeeData: type: object allOf: – #/definitions/documentTemplateEmployeeData description: Informações do colaborador templates: type: array items: type: object allOf: – #/definitions/requestDocumentTemplate minimum: 1 description: Modelos de documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar modelos de documentos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dismissalRequestId description: Identificador da solicitação de desligamento in: query type: string responses: 200: description: Ok schema: type: object required: – templates properties: employeeData: type: object allOf: – #/definitions/documentTemplateEmployeeData description: Informações do colaborador templates: type: array items: type: object allOf: – #/definitions/requestDocumentTemplate minimum: 1 description: Modelos de documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/queries/getSignersByDismissalRequestId: post: description: Recupera lista de assinantes por solicitação de desligamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dismissalRequestId properties: dismissalRequestId: type: string maxLength: 36 description: Identificador da solicitação de desligamento responses: 200: description: Ok schema: type: object properties: signers: type: array items: type: object allOf: – #/definitions/signerData description: Lista de assinantes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Recupera lista de assinantes por solicitação de desligamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dismissalRequestId description: Identificador da solicitação de desligamento in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object properties: signers: type: array items: type: object allOf: – #/definitions/signerData description: Lista de assinantes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/queries/getAllConnectorConfigurations: post: description: Recupera lista de configurações de conectores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object properties: connectorConfigurations: type: array items: type: object allOf: – #/definitions/connectorConfigurationDTO description: Configurações dos conectores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Recupera lista de configurações de conectores tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object properties: connectorConfigurations: type: array items: type: object allOf: – #/definitions/connectorConfigurationDTO description: Configurações dos conectores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/queries/getDismissalRequestAttachments: post: description: Recupera lista de anexos da solicitação de desligamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dismissalRequestId properties: dismissalRequestId: type: string maxLength: 36 description: Identificador da solicitação de desligamento responses: 200: description: Ok schema: type: object properties: attachments: type: array items: type: object allOf: – #/definitions/dismissalRequestAttachmentDTO description: Lista de anexos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Recupera lista de anexos da solicitação de desligamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dismissalRequestId description: Identificador da solicitação de desligamento in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object properties: attachments: type: array items: type: object allOf: – #/definitions/dismissalRequestAttachmentDTO description: Lista de anexos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/queries/getEmployeesToBeSigners: post: description: Recupera lista de colobadores que podem se tornar assinantes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dismissalRequestId properties: dismissalRequestId: type: string maxLength: 36 description: Identificador da solicitação de desligamento pageNumber: type: integer format: int64 description: Paginação – número da página pageSize: type: integer format: int64 description: Paginação – tamanho da página nameFilter: type: string description: Filtro de busca por nome do colaborador responses: 200: description: Ok schema: type: object properties: employees: type: array items: type: object allOf: – #/definitions/employeeSignerData description: Lista de colaboradores total: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Recupera lista de colobadores que podem se tornar assinantes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dismissalRequestId description: Identificador da solicitação de desligamento in: query required: true type: string maxLength: 36 – name: pageNumber description: Paginação – número da página in: query type: integer format: int64 – name: pageSize description: Paginação – tamanho da página in: query type: integer format: int64 – name: nameFilter description: Filtro de busca por nome do colaborador in: query type: string responses: 200: description: Ok schema: type: object properties: employees: type: array items: type: object allOf: – #/definitions/employeeSignerData description: Lista de colaboradores total: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/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 /signature/queries/exportAttachment: 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 /signature/queries/exportDismissalRequest: 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 /signature/queries/exportCompany: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/queries/exportSigner: 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 /signature/queries/exportConnectorConfiguration: 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 /signature/queries/exportEnvelope: 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 /signature/queries/exportEnvelopeDocument: 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 /signature/queries/exportEnvelopeSigner: 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 /signature/queries/exportEnvelopeConnector: 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 /signature/queries/exportDocumentTemplate: 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 /signature/queries/exportFieldTemplate: 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 /signature/queries/exportDocumentDraft: 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 /signature/queries/exportDocumentDraftHistory: 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 /signature/queries/exportDocumentType: 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 /signature/queries/exportDismissalRequestAttachment: 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 /signature/queries/exportPerson: 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 /signature/queries/exportEmployee: 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 /signature/queries/exportSignerDismissalRequestAttachment: 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 /signature/queries/exportSignerDocumentTemplate: 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 /signature/queries/exportRg: 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 /signature/queries/exportCtps: 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 /signature/queries/exportPersonRg: 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 /signature/queries/exportPersonCtps: 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 /signature/queries/exportPhoneContact: 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 /signature/queries/exportPersonPhoneContact: 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 /signature/queries/exportGeoCountry: 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 /signature/queries/exportState: 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 /signature/queries/exportCity: 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 /signature/queries/exportNeighborhood: 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 /signature/queries/exportAddress: 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 /signature/queries/exportPersonAddress: 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 /signature/queries/exportEmployeePhoneContact: 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 /signature/queries/exportEmail: 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 /signature/queries/exportEmployeeEmail: 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 /signature/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 /signature/actions/requestUpload: post: description: Solicitação para realizar o upload de um arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: array items: type: string minimum: 1 description: Nome do arquivo que será carregado responses: 200: description: Ok schema: type: object required: – uploads properties: uploads: type: array items: type: object allOf: – #/definitions/fileUploadedData minimum: 1 description: Dados para upload de arquivos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/requestAccess: post: description: Solicitar acesso ao arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: requestAccess: type: array items: type: object allOf: – #/definitions/requestAccessInputData description: Dados para solicitação de acesso ao arquivo responses: 200: description: Ok schema: type: object properties: accessData: type: array items: type: object allOf: – #/definitions/requestAccessData description: Dados de resposta para solicitação de acesso ao arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/requestGedDocumentAccess: post: description: Solicitar aceso downlaod documeno GED tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: requestAccess: type: array items: type: object allOf: – #/definitions/requestAccessInputData description: Dados para solicitação de acesso ao arquivo responses: 200: description: Ok schema: type: object properties: accessData: type: array items: type: object allOf: – #/definitions/requestAccessData description: Dados de resposta para solicitação de acesso ao arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/addAttachments: post: description: Adicionar anexos para assinatura tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentsData properties: documentsData: type: object allOf: – #/definitions/documentsData description: Dados dos documentos a serem adicionados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/removeAttachments: post: description: Remover anexos da assinatura tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dismissalRequestAttachmentIds properties: dismissalRequestAttachmentIds: type: array items: type: string minimum: 1 description: Identificadores dos anexos a serem removidos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/getDocumentListByType: post: description: Listar documentos externos anexados na solicitação de desligamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – attachmentType properties: dismissalRequestId: type: string description: Identificador da solicitação de desligamento attachmentType: type: string allOf: – #/definitions/enumAttachmentType description: Enumerador do tipo do anexo responses: 200: description: Ok schema: type: object properties: documents: type: array items: type: object allOf: – #/definitions/externalDocument description: Documentos externos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/deleteDocumentById: post: description: Deletar documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: documentId: type: string description: Identificador do documento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/addSignerDocument: post: description: Configurar assintante e documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – signerIds – dismissalRequestAttachmentIds properties: signerIds: type: array items: type: string minimum: 1 description: Identificador do assinante dismissalRequestAttachmentIds: type: array items: type: string minimum: 1 description: Identificador do anexo da solicitação de desligamento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/addSignerDocumentTemplate: post: description: Configurar assintante e modelo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – signerIds – documentTemplateIds – dismissalRequestId properties: signerIds: type: array items: type: string minimum: 1 description: Identificador do assinante documentTemplateIds: type: array items: type: string minimum: 1 description: Identificador do anexo da solicitação de desligamento dismissalRequestId: type: string maxLength: 36 description: Identificador da solicitação de desligamento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/removeSignerDocument: post: description: Remover configuração de assintante e aocumento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – signerIds – dismissalRequestAttachmentId properties: signerIds: type: array items: type: string minimum: 1 description: Identificador dos assinantes dismissalRequestAttachmentId: type: string maxLength: 36 description: Identificador do anexo da solicitação de desligamento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/removeSignerDocumentTemplate: post: description: Remover configuração de assintante e modelo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – signerIds – documentTemplateId – dismissalRequestId properties: signerIds: type: array items: type: string minimum: 1 description: Identificador dos assinantes documentTemplateId: type: string maxLength: 36 description: Identificador do modelo de documento dismissalRequestId: type: string maxLength: 36 description: Identificador da solicitação de desligamento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/addSigner: post: description: Adicionar assinante na assinatura tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: signerData: type: object allOf: – #/definitions/signerData description: Dados do assinante responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/removeSigner: post: description: Remover assinante da assinatura tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – signerId properties: signerId: type: string maxLength: 36 description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/addDocumentTemplate: post: description: Adicionar template de documento para assinatura tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: documentTemplateData: type: object allOf: – #/definitions/documentTemplateData description: Dados do template de documento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/removeDocumentTemplate: post: description: Remover template de documento para assinatura tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentTemplateId properties: documentTemplateId: type: string maxLength: 36 description: Identificador do template de documento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/addDocumentDraft: post: description: Inlcuir rascunho de template de documento para solicitação de desligamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: documentDraftData: type: object allOf: – #/definitions/documentDraftData description: Dados do rascunho do template de documento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/signDocumentsRequest: post: description: Solicitar assinatura dos documentos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dismissalRequestId – instructions – demandGeolocation – dismissalRequestAttachmentIds properties: dismissalRequestId: type: string maxLength: 36 description: Identificaçador da solicitação de desligamento instructions: type: string description: Instruções para os assinantes demandGeolocation: type: boolean description: Exigir geolocalização dismissalRequestAttachmentIds: type: array items: type: string minimum: 1 description: Identificadores dos documentos a serem assinados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/getCategoriesTypeConnector: post: description: Recuperar categorias de conectores disponíveis no GED tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object properties: categories: type: array items: type: object allOf: – #/definitions/connectorCategoryDTO description: Categorias do conector 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/getConnectors: post: description: Recuperar conectores disponíveis no GED tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: name: type: string description: Nome do Conector categoryIds: type: array items: type: string description: Categoria do Conector responses: 200: description: Ok schema: type: object properties: connectors: type: array items: type: object allOf: – #/definitions/connectorDTO description: Conectores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/validateDocumentDraft: post: description: Validar rascunho do documento para geração do arquivo final tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentDraftId – documentsData properties: documentDraftId: type: string maxLength: 36 description: Identificador do rascunho do documento documentsData: type: object allOf: – #/definitions/documentsData description: Dados dos documentos a serem adicionados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/invalidateDocumentDraft: post: description: Invalidar rascunho do documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentDraftId properties: documentDraftId: type: string maxLength: 36 description: Identificador do rascunho do documento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/removeDocumentDraft: post: description: Remover rascunho do documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentDraftId properties: documentDraftId: type: string maxLength: 36 description: Identificador do rascunho do documento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/addConnectorConfiguration: post: description: Adicionar configuração de conector tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – connectorCategory – gedConnectorId – country properties: connectorCategory: type: string allOf: – #/definitions/connectorCategory description: Identificador da categoria do conector gedConnectorId: type: string description: Identificador na plataforma country: type: string allOf: – #/definitions/country description: País description: type: string description: Descrição da configuração do conector responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/removeConnectorConfiguration: post: description: Remover configuração de conector tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – connectorConfigurationId properties: connectorConfigurationId: type: string maxLength: 36 description: Identificador da configuração do conector responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/getGedStatusEnvelope: post: description: Recuperar status do envelope no GED tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeGedId properties: envelopeGedId: type: string description: Identificador do envelope no GED responses: 200: description: Ok schema: type: object properties: envelopeStatus: type: object allOf: – #/definitions/gedEnvelopeStatusDTO description: Status do envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/cancelEnvelope: post: description: Realiza o cancelamento de um envelope em progresso tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId – reason properties: envelopeId: type: string maxLength: 36 description: Identificador do envelope reason: type: string description: Motivo do cancelamento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/saveDocumentType: post: description: Criar tipo de documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: name: type: string maxLength: 255 description: Nome do tipo do documento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/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 /signature/actions/importAttachment: 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 /signature/actions/importDismissalRequest: 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 /signature/actions/importCompany: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/actions/importSigner: 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 /signature/actions/importConnectorConfiguration: 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 /signature/actions/importEnvelope: 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 /signature/actions/importEnvelopeDocument: 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 /signature/actions/importEnvelopeSigner: 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 /signature/actions/importEnvelopeConnector: 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 /signature/actions/importDocumentTemplate: 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 /signature/actions/importFieldTemplate: 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 /signature/actions/importDocumentDraft: 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 /signature/actions/importDocumentDraftHistory: 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 /signature/actions/importDocumentType: 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 /signature/actions/importDismissalRequestAttachment: 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 /signature/actions/importPerson: 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 /signature/actions/importEmployee: 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 /signature/actions/importSignerDismissalRequestAttachment: 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 /signature/actions/importSignerDocumentTemplate: 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 /signature/actions/importRg: 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 /signature/actions/importCtps: 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 /signature/actions/importPersonRg: 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 /signature/actions/importPersonCtps: 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 /signature/actions/importPhoneContact: 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 /signature/actions/importPersonPhoneContact: 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 /signature/actions/importGeoCountry: 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 /signature/actions/importState: 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 /signature/actions/importCity: 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 /signature/actions/importNeighborhood: 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 /signature/actions/importAddress: 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 /signature/actions/importPersonAddress: 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 /signature/actions/importEmployeePhoneContact: 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 /signature/actions/importEmail: 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 /signature/actions/importEmployeeEmail: 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 /signature/events/importAttachmentEvent: 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 /signature/events/exportAttachmentEvent: 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 /signature/events/importDismissalRequestEvent: 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 /signature/events/exportDismissalRequestEvent: 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 /signature/events/importCompanyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /signature/events/exportCompanyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /signature/events/importSignerEvent: 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 /signature/events/exportSignerEvent: 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 /signature/events/importConnectorConfigurationEvent: 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 /signature/events/exportConnectorConfigurationEvent: 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 /signature/events/importEnvelopeEvent: 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 /signature/events/exportEnvelopeEvent: 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 /signature/events/importEnvelopeDocumentEvent: 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 /signature/events/exportEnvelopeDocumentEvent: 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 /signature/events/importEnvelopeSignerEvent: 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 /signature/events/exportEnvelopeSignerEvent: 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 /signature/events/importEnvelopeConnectorEvent: 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 /signature/events/exportEnvelopeConnectorEvent: 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 /signature/events/importDocumentTemplateEvent: 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 /signature/events/exportDocumentTemplateEvent: 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 /signature/events/importFieldTemplateEvent: 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 /signature/events/exportFieldTemplateEvent: 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 /signature/events/importDocumentDraftEvent: 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 /signature/events/exportDocumentDraftEvent: 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 /signature/events/importDocumentDraftHistoryEvent: 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 /signature/events/exportDocumentDraftHistoryEvent: 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 /signature/events/importDocumentTypeEvent: 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 /signature/events/exportDocumentTypeEvent: 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 /signature/events/importDismissalRequestAttachmentEvent: 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 /signature/events/exportDismissalRequestAttachmentEvent: 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 /signature/events/importPersonEvent: 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 /signature/events/exportPersonEvent: 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 /signature/events/importEmployeeEvent: 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 /signature/events/exportEmployeeEvent: 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 /signature/events/importSignerDismissalRequestAttachmentEvent: 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 /signature/events/exportSignerDismissalRequestAttachmentEvent: 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 /signature/events/importSignerDocumentTemplateEvent: 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 /signature/events/exportSignerDocumentTemplateEvent: 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 /signature/events/importRgEvent: 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 /signature/events/exportRgEvent: 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 /signature/events/importCtpsEvent: 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 /signature/events/exportCtpsEvent: 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 /signature/events/importPersonRgEvent: 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 /signature/events/exportPersonRgEvent: 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 /signature/events/importPersonCtpsEvent: 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 /signature/events/exportPersonCtpsEvent: 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 /signature/events/importPhoneContactEvent: 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 /signature/events/exportPhoneContactEvent: 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 /signature/events/importPersonPhoneContactEvent: 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 /signature/events/exportPersonPhoneContactEvent: 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 /signature/events/importGeoCountryEvent: 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 /signature/events/exportGeoCountryEvent: 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 /signature/events/importStateEvent: 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 /signature/events/exportStateEvent: 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 /signature/events/importCityEvent: 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 /signature/events/exportCityEvent: 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 /signature/events/importNeighborhoodEvent: 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 /signature/events/exportNeighborhoodEvent: 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 /signature/events/importAddressEvent: 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 /signature/events/exportAddressEvent: 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 /signature/events/importPersonAddressEvent: 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 /signature/events/exportPersonAddressEvent: 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 /signature/events/importEmployeePhoneContactEvent: 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 /signature/events/exportEmployeePhoneContactEvent: 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 /signature/events/importEmailEvent: 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 /signature/events/exportEmailEvent: 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 /signature/events/importEmployeeEmailEvent: 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 /signature/events/exportEmployeeEmailEvent: 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 /signature/entities/attachment: 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/attachment responses: 200: description: The created resource schema: #/definitions/attachment 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/attachment responses: 200: description: The created resource schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/attachment/{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/editAttachment responses: 200: description: Ok schema: #/definitions/editAttachment 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/attachment responses: 200: description: Ok schema: #/definitions/attachment 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/attachment 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 /signature/entities/attachment/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/attachment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/dismissalRequest: 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/dismissalRequest responses: 200: description: The created resource schema: #/definitions/dismissalRequest 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/dismissalRequest responses: 200: description: The created resource schema: #/definitions/dismissalRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/dismissalRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/dismissalRequest/{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/editDismissalRequest responses: 200: description: Ok schema: #/definitions/editDismissalRequest 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/dismissalRequest responses: 200: description: Ok schema: #/definitions/dismissalRequest 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/dismissalRequest 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 /signature/entities/dismissalRequest/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dismissalRequest responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/company: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/company/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editCompany responses: 200: description: Ok schema: #/definitions/editCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/company/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/company responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/signer: 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/signer responses: 200: description: The created resource schema: #/definitions/signer 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/signer responses: 200: description: The created resource schema: #/definitions/signer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/signer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/signer/{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/editSigner responses: 200: description: Ok schema: #/definitions/editSigner 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/signer responses: 200: description: Ok schema: #/definitions/signer 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/signer 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 /signature/entities/signer/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/signer responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/connectorConfiguration: 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/connectorConfiguration responses: 200: description: The created resource schema: #/definitions/connectorConfiguration 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/connectorConfiguration responses: 200: description: The created resource schema: #/definitions/connectorConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/connectorConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/connectorConfiguration/{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/editConnectorConfiguration responses: 200: description: Ok schema: #/definitions/editConnectorConfiguration 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/connectorConfiguration responses: 200: description: Ok schema: #/definitions/connectorConfiguration 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/connectorConfiguration 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 /signature/entities/connectorConfiguration/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/connectorConfiguration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/envelope: 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/envelope responses: 200: description: The created resource schema: #/definitions/envelope 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/envelope responses: 200: description: The created resource schema: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/envelope/{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/editEnvelope responses: 200: description: Ok schema: #/definitions/editEnvelope 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/envelope responses: 200: description: Ok schema: #/definitions/envelope 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/envelope 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 /signature/entities/envelope/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelope responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/envelopeDocument: 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/envelopeDocument responses: 200: description: The created resource schema: #/definitions/envelopeDocument 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/envelopeDocument responses: 200: description: The created resource schema: #/definitions/envelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/envelopeDocument/{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/editEnvelopeDocument responses: 200: description: Ok schema: #/definitions/editEnvelopeDocument 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/envelopeDocument responses: 200: description: Ok schema: #/definitions/envelopeDocument 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/envelopeDocument 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 /signature/entities/envelopeDocument/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/envelopeSigner: 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/envelopeSigner responses: 200: description: The created resource schema: #/definitions/envelopeSigner 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/envelopeSigner responses: 200: description: The created resource schema: #/definitions/envelopeSigner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeSigner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/envelopeSigner/{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/editEnvelopeSigner responses: 200: description: Ok schema: #/definitions/editEnvelopeSigner 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/envelopeSigner responses: 200: description: Ok schema: #/definitions/envelopeSigner 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/envelopeSigner 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 /signature/entities/envelopeSigner/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeSigner responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/envelopeConnector: 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/envelopeConnector responses: 200: description: The created resource schema: #/definitions/envelopeConnector 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/envelopeConnector responses: 200: description: The created resource schema: #/definitions/envelopeConnector 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeConnector 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/envelopeConnector/{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/editEnvelopeConnector responses: 200: description: Ok schema: #/definitions/editEnvelopeConnector 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/envelopeConnector responses: 200: description: Ok schema: #/definitions/envelopeConnector 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/envelopeConnector 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 /signature/entities/envelopeConnector/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeConnector responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/documentTemplate: 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/documentTemplate responses: 200: description: The created resource schema: #/definitions/documentTemplate 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/documentTemplate responses: 200: description: The created resource schema: #/definitions/documentTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/documentTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/documentTemplate/{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/editDocumentTemplate responses: 200: description: Ok schema: #/definitions/editDocumentTemplate 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/documentTemplate responses: 200: description: Ok schema: #/definitions/documentTemplate 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/documentTemplate 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 /signature/entities/documentTemplate/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentTemplate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/fieldTemplate: 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/fieldTemplate responses: 200: description: The created resource schema: #/definitions/fieldTemplate 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/fieldTemplate responses: 200: description: The created resource schema: #/definitions/fieldTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/fieldTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/fieldTemplate/{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/editFieldTemplate responses: 200: description: Ok schema: #/definitions/editFieldTemplate 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/fieldTemplate responses: 200: description: Ok schema: #/definitions/fieldTemplate 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/fieldTemplate 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 /signature/entities/fieldTemplate/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/fieldTemplate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/documentDraft: 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/documentDraft responses: 200: description: The created resource schema: #/definitions/documentDraft 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/documentDraft responses: 200: description: The created resource schema: #/definitions/documentDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/documentDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/documentDraft/{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/editDocumentDraft responses: 200: description: Ok schema: #/definitions/editDocumentDraft 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/documentDraft responses: 200: description: Ok schema: #/definitions/documentDraft 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/documentDraft 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 /signature/entities/documentDraft/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentDraft responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/documentDraftHistory: 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/documentDraftHistory responses: 200: description: The created resource schema: #/definitions/documentDraftHistory 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/documentDraftHistory responses: 200: description: The created resource schema: #/definitions/documentDraftHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/documentDraftHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/documentDraftHistory/{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/editDocumentDraftHistory responses: 200: description: Ok schema: #/definitions/editDocumentDraftHistory 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/documentDraftHistory responses: 200: description: Ok schema: #/definitions/documentDraftHistory 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/documentDraftHistory 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 /signature/entities/documentDraftHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentDraftHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/documentType: 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/documentType responses: 200: description: The created resource schema: #/definitions/documentType 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/documentType responses: 200: description: The created resource schema: #/definitions/documentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/documentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/documentType/{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/editDocumentType responses: 200: description: Ok schema: #/definitions/editDocumentType 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/documentType responses: 200: description: Ok schema: #/definitions/documentType 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/documentType 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 /signature/entities/documentType/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/dismissalRequestAttachment: 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/dismissalRequestAttachment responses: 200: description: The created resource schema: #/definitions/dismissalRequestAttachment 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/dismissalRequestAttachment responses: 200: description: The created resource schema: #/definitions/dismissalRequestAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/dismissalRequestAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/dismissalRequestAttachment/{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/editDismissalRequestAttachment responses: 200: description: Ok schema: #/definitions/editDismissalRequestAttachment 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/dismissalRequestAttachment responses: 200: description: Ok schema: #/definitions/dismissalRequestAttachment 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/dismissalRequestAttachment 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 /signature/entities/dismissalRequestAttachment/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dismissalRequestAttachment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/person: 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/person responses: 200: description: The created resource schema: #/definitions/person 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/person responses: 200: description: The created resource schema: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/person/{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/editPerson responses: 200: description: Ok schema: #/definitions/editPerson 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/person responses: 200: description: Ok schema: #/definitions/person 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/person 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 /signature/entities/person/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/person responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/employee: 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/employee responses: 200: description: The created resource schema: #/definitions/employee 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/employee responses: 200: description: The created resource schema: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/employee/{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/editEmployee responses: 200: description: Ok schema: #/definitions/editEmployee 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/employee responses: 200: description: Ok schema: #/definitions/employee 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/employee 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 /signature/entities/person/{parentId}/employees: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/employee responses: 200: description: The created resources schema: type: array items: #/definitions/employee 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/employee responses: 200: description: The created resources schema: type: array items: #/definitions/employee 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: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/person/{parentId}/employees/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEmployee responses: 200: description: Ok schema: #/definitions/editEmployee 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employee responses: 200: description: Ok schema: #/definitions/employee 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employee 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/employee/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employee responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/signerDismissalRequestAttachment: 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/signerDismissalRequestAttachment responses: 200: description: The created resource schema: #/definitions/signerDismissalRequestAttachment 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/signerDismissalRequestAttachment responses: 200: description: The created resource schema: #/definitions/signerDismissalRequestAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/signerDismissalRequestAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/signerDismissalRequestAttachment/{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/editSignerDismissalRequestAttachment responses: 200: description: Ok schema: #/definitions/editSignerDismissalRequestAttachment 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/signerDismissalRequestAttachment responses: 200: description: Ok schema: #/definitions/signerDismissalRequestAttachment 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/signerDismissalRequestAttachment 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 /signature/entities/signerDismissalRequestAttachment/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/signerDismissalRequestAttachment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/signerDocumentTemplate: 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/signerDocumentTemplate responses: 200: description: The created resource schema: #/definitions/signerDocumentTemplate 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/signerDocumentTemplate responses: 200: description: The created resource schema: #/definitions/signerDocumentTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/signerDocumentTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/signerDocumentTemplate/{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/editSignerDocumentTemplate responses: 200: description: Ok schema: #/definitions/editSignerDocumentTemplate 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/signerDocumentTemplate responses: 200: description: Ok schema: #/definitions/signerDocumentTemplate 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/signerDocumentTemplate 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 /signature/entities/signerDocumentTemplate/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/signerDocumentTemplate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/rg: 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/rg responses: 200: description: The created resource schema: #/definitions/rg 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/rg responses: 200: description: The created resource schema: #/definitions/rg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/rg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/rg/{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/editRg responses: 200: description: Ok schema: #/definitions/editRg 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/rg responses: 200: description: Ok schema: #/definitions/rg 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/rg 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 /signature/entities/rg/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/rg responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/ctps: 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/ctps responses: 200: description: The created resource schema: #/definitions/ctps 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/ctps responses: 200: description: The created resource schema: #/definitions/ctps 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/ctps 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/ctps/{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/editCtps responses: 200: description: Ok schema: #/definitions/editCtps 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/ctps responses: 200: description: Ok schema: #/definitions/ctps 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/ctps 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 /signature/entities/ctps/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/ctps responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/personRg: 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/personRg responses: 200: description: The created resource schema: #/definitions/personRg 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/personRg responses: 200: description: The created resource schema: #/definitions/personRg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/personRg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/personRg/{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/editPersonRg responses: 200: description: Ok schema: #/definitions/editPersonRg 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/personRg responses: 200: description: Ok schema: #/definitions/personRg 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/personRg 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 /signature/entities/person/{parentId}/rgs: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/personRg responses: 200: description: The created resources schema: type: array items: #/definitions/personRg 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/personRg responses: 200: description: The created resources schema: type: array items: #/definitions/personRg 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: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/personRg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/person/{parentId}/rgs/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editPersonRg responses: 200: description: Ok schema: #/definitions/editPersonRg 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personRg responses: 200: description: Ok schema: #/definitions/personRg 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personRg 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/personRg/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/personRg responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/personCtps: 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/personCtps responses: 200: description: The created resource schema: #/definitions/personCtps 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/personCtps responses: 200: description: The created resource schema: #/definitions/personCtps 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/personCtps 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/personCtps/{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/editPersonCtps responses: 200: description: Ok schema: #/definitions/editPersonCtps 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/personCtps responses: 200: description: Ok schema: #/definitions/personCtps 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/personCtps 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 /signature/entities/person/{parentId}/ctpsEntities: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/personCtps responses: 200: description: The created resources schema: type: array items: #/definitions/personCtps 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/personCtps responses: 200: description: The created resources schema: type: array items: #/definitions/personCtps 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: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/personCtps 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/person/{parentId}/ctpsEntities/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editPersonCtps responses: 200: description: Ok schema: #/definitions/editPersonCtps 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personCtps responses: 200: description: Ok schema: #/definitions/personCtps 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personCtps 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/personCtps/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/personCtps responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/phoneContact: 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/phoneContact responses: 200: description: The created resource schema: #/definitions/phoneContact 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/phoneContact responses: 200: description: The created resource schema: #/definitions/phoneContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/phoneContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/phoneContact/{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/editPhoneContact responses: 200: description: Ok schema: #/definitions/editPhoneContact 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/phoneContact responses: 200: description: Ok schema: #/definitions/phoneContact 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/phoneContact 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 /signature/entities/phoneContact/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/phoneContact responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/personPhoneContact: 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/personPhoneContact responses: 200: description: The created resource schema: #/definitions/personPhoneContact 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/personPhoneContact responses: 200: description: The created resource schema: #/definitions/personPhoneContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/personPhoneContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/personPhoneContact/{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/editPersonPhoneContact responses: 200: description: Ok schema: #/definitions/editPersonPhoneContact 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/personPhoneContact responses: 200: description: Ok schema: #/definitions/personPhoneContact 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/personPhoneContact 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 /signature/entities/person/{parentId}/personPhoneContacts: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/personPhoneContact responses: 200: description: The created resources schema: type: array items: #/definitions/personPhoneContact 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/personPhoneContact responses: 200: description: The created resources schema: type: array items: #/definitions/personPhoneContact 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: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/personPhoneContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/person/{parentId}/personPhoneContacts/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editPersonPhoneContact responses: 200: description: Ok schema: #/definitions/editPersonPhoneContact 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personPhoneContact responses: 200: description: Ok schema: #/definitions/personPhoneContact 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personPhoneContact 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/personPhoneContact/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/personPhoneContact responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/geoCountry: 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/geoCountry responses: 200: description: The created resource schema: #/definitions/geoCountry 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/geoCountry responses: 200: description: The created resource schema: #/definitions/geoCountry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/geoCountry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/geoCountry/{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/editGeoCountry responses: 200: description: Ok schema: #/definitions/editGeoCountry 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/geoCountry responses: 200: description: Ok schema: #/definitions/geoCountry 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/geoCountry 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 /signature/entities/geoCountry/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/geoCountry responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/state: 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/state responses: 200: description: The created resource schema: #/definitions/state 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/state responses: 200: description: The created resource schema: #/definitions/state 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/state 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/state/{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/editState responses: 200: description: Ok schema: #/definitions/editState 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/state responses: 200: description: Ok schema: #/definitions/state 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/state 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 /signature/entities/state/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/state responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/city: 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/city responses: 200: description: The created resource schema: #/definitions/city 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/city responses: 200: description: The created resource schema: #/definitions/city 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/city 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/city/{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/editCity responses: 200: description: Ok schema: #/definitions/editCity 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/city responses: 200: description: Ok schema: #/definitions/city 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/city 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 /signature/entities/city/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/city responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/neighborhood: 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/neighborhood responses: 200: description: The created resource schema: #/definitions/neighborhood 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/neighborhood responses: 200: description: The created resource schema: #/definitions/neighborhood 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/neighborhood 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/neighborhood/{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/editNeighborhood responses: 200: description: Ok schema: #/definitions/editNeighborhood 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/neighborhood responses: 200: description: Ok schema: #/definitions/neighborhood 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/neighborhood 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 /signature/entities/neighborhood/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/neighborhood responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/address: 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/address responses: 200: description: The created resource schema: #/definitions/address 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/address responses: 200: description: The created resource schema: #/definitions/address 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/address 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/address/{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/editAddress responses: 200: description: Ok schema: #/definitions/editAddress 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/address responses: 200: description: Ok schema: #/definitions/address 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/address 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 /signature/entities/address/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/address responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/personAddress: 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/personAddress responses: 200: description: The created resource schema: #/definitions/personAddress 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/personAddress responses: 200: description: The created resource schema: #/definitions/personAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/personAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/personAddress/{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/editPersonAddress responses: 200: description: Ok schema: #/definitions/editPersonAddress 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/personAddress responses: 200: description: Ok schema: #/definitions/personAddress 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/personAddress 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 /signature/entities/person/{parentId}/addresses: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/personAddress responses: 200: description: The created resources schema: type: array items: #/definitions/personAddress 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/personAddress responses: 200: description: The created resources schema: type: array items: #/definitions/personAddress 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: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/personAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/person/{parentId}/addresses/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editPersonAddress responses: 200: description: Ok schema: #/definitions/editPersonAddress 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personAddress responses: 200: description: Ok schema: #/definitions/personAddress 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personAddress 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/personAddress/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/personAddress responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/employeePhoneContact: 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/employeePhoneContact responses: 200: description: The created resource schema: #/definitions/employeePhoneContact 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/employeePhoneContact responses: 200: description: The created resource schema: #/definitions/employeePhoneContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeePhoneContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/employeePhoneContact/{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/editEmployeePhoneContact responses: 200: description: Ok schema: #/definitions/editEmployeePhoneContact 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/employeePhoneContact responses: 200: description: Ok schema: #/definitions/employeePhoneContact 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/employeePhoneContact 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 /signature/entities/employee/{parentId}/phoneContacts: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/employeePhoneContact responses: 200: description: The created resources schema: type: array items: #/definitions/employeePhoneContact 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/employeePhoneContact responses: 200: description: The created resources schema: type: array items: #/definitions/employeePhoneContact 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: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeePhoneContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/employee/{parentId}/phoneContacts/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEmployeePhoneContact responses: 200: description: Ok schema: #/definitions/editEmployeePhoneContact 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeePhoneContact responses: 200: description: Ok schema: #/definitions/employeePhoneContact 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employeePhoneContact 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/employeePhoneContact/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeePhoneContact responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/email: 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/email responses: 200: description: The created resource schema: #/definitions/email 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/email responses: 200: description: The created resource schema: #/definitions/email 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/email 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/email/{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/editEmail responses: 200: description: Ok schema: #/definitions/editEmail 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/email responses: 200: description: Ok schema: #/definitions/email 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/email 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 /signature/entities/person/{parentId}/emails: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/email responses: 200: description: The created resources schema: type: array items: #/definitions/email 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/email responses: 200: description: The created resources schema: type: array items: #/definitions/email 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: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/email 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/person/{parentId}/emails/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEmail responses: 200: description: Ok schema: #/definitions/editEmail 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/email responses: 200: description: Ok schema: #/definitions/email 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/email 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/email/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/email responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/employeeEmail: 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/employeeEmail responses: 200: description: The created resource schema: #/definitions/employeeEmail 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/employeeEmail responses: 200: description: The created resource schema: #/definitions/employeeEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/employeeEmail/{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/editEmployeeEmail responses: 200: description: Ok schema: #/definitions/editEmployeeEmail 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/employeeEmail responses: 200: description: Ok schema: #/definitions/employeeEmail 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/employeeEmail 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 /signature/entities/employee/{parentId}/emails: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/employeeEmail responses: 200: description: The created resources schema: type: array items: #/definitions/employeeEmail 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/employeeEmail responses: 200: description: The created resources schema: type: array items: #/definitions/employeeEmail 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: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/employee/{parentId}/emails/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEmployeeEmail responses: 200: description: Ok schema: #/definitions/editEmployeeEmail 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeeEmail responses: 200: description: Ok schema: #/definitions/employeeEmail 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employeeEmail 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signature/entities/employeeEmail/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeEmail responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthcheckStatus: type: string enum: – UP – DOWN description: Status da integridade: * `UP` – Saudável * `DOWN` – Ruim connectorCategory: type: string enum: – SMS – WPP description: Categorias do conector: * `SMS` – SMS * `WPP` – WhatsApp country: type: string enum: – BRAZIL – COLOMBIA description: Países: * `BRAZIL` – Brasil * `COLOMBIA` – Colômbia replicationStatus: type: string enum: – PENDING – ERROR – SUCCESS description: Status da replicação: * `PENDING` – Pendente * `ERROR` – Erro * `SUCCESS` – Sucesso documentStatus: type: string enum: – PROCESSING – IN_SIGNATURE – PARTIAL_IN_SIGNATURE – CANCELED – SIGNED – FAILURE_PROCESSING_FILE – EXPIRED_GED – SIGNED_PARTIAL – DECLINED description: Situação do documento: * `PROCESSING` – Processando * `IN_SIGNATURE` – Em Assinatura * `PARTIAL_IN_SIGNATURE` – Em Assinatura * `CANCELED` – Cancelado * `SIGNED` – Assinado * `FAILURE_PROCESSING_FILE` – Falha na integração do arquivo * `EXPIRED_GED` – Expirado no GED * `SIGNED_PARTIAL` – Um ou mais documentos não foram assinados * `DECLINED` – Recusado pelo assinante envelopeStatus: type: string enum: – PENDING – FAILED_TO_LOAD – FAILED_TO_WRITE_PDF – WAITING_DOCUMENTS – COMPLETED – CANCELED – DRAFT – EXPIRED description: Status do envelope: * `PENDING` – Envelope pendente * `FAILED_TO_LOAD` – Falha ao enviar documentos * `FAILED_TO_WRITE_PDF` – Falha ao finalizar o envelope e escrever PDF * `WAITING_DOCUMENTS` – Esperando envio dos documentos * `COMPLETED` – Envelope completo * `CANCELED` – Envelope cancelado * `DRAFT` – Envelope em rascunho * `EXPIRED` – Envelope expirado enumFieldType: type: string enum: – IDENTIFICATION – ADDRESS – CONTACT – CONTRACT description: Tipo de campo: * `IDENTIFICATION` – Identificacao * `ADDRESS` – Endereço * `CONTACT` – Contato * `CONTRACT` – Contrato enumFieldSubType: type: string enum: – DOCUMENT – FULLNAME – FIRSTNAME – LASTNAME – CODE – ADDRESS – DISTRICT – CITY – COUNTRY – ZIPCODE – PHONE – COUNTRYCODE – LOCALCODE – EMAIL – HIREDATE – NOTICEDATE description: Subtipo de campo: * `DOCUMENT` – Documento * `FULLNAME` – Nome Completo * `FIRSTNAME` – Nome * `LASTNAME` – Sobrenome * `CODE` – Código * `ADDRESS` – Endereço * `DISTRICT` – Bairro * `CITY` – Cidade * `COUNTRY` – País * `ZIPCODE` – Cep * `PHONE` – Telefone * `COUNTRYCODE` – Código de país * `LOCALCODE` – Código de área * `EMAIL` – E-mail * `HIREDATE` – Data de admissão * `NOTICEDATE` – Data do aviso prévio enumFieldCategory: type: string enum: – COMPANY – EMPLOYEE description: Categoria de campo: * `COMPANY` – Empresa * `EMPLOYEE` – Colaborador enumAttachmentType: type: string enum: – COMPLEMENTARY_DOCUMENT – MANUAL_SIGNATURE – TEMPLATE_SIGNATURE – EXTERNALLY_SIGNED description: Tipo de anexo: * `COMPLEMENTARY_DOCUMENT` – Anexo complementar * `MANUAL_SIGNATURE` – Anexo enviado manualmente * `TEMPLATE_SIGNATURE` – Anexo gerado a partir de um template * `EXTERNALLY_SIGNED` – Anexo assinado externamente addressType: type: string enum: – OTHERS – AIRPORT – LANE – AREA – AVENUE – BALNEARY – BLOCK – FIELD – FARMSTEAD – COLOGNE – CONDOMINIUM – SET – DISTRICT – TERRACE – SEASON – ROAD – SHANTYTOWN – FARM – MARKET – GALLERY – GRANJA – GARDEN – SLOPE – LAKE – LAGOON – LONG – ALLOTMENT – HILL – CORE – PARK – FOOTBRIDGE – COURTYARD – SQUARE – BEACH – COURT – NOOK – RESIDENTIAL – HIGHWAY – STREET – SECTOR – SITE – BYSTREET – EXCERPT – CLOVER – VALLEY – PATH – VIA – VIADUCT – ALLEY – VILLAGE – ACCESS – CAMP – LOCALACCESS – CHURCHYARD – SPECIALAREA – RIGHTMARGINALAVENUE – LEFTMARGINALAVENUE – RINGROAD – LATERROADBETWEEN – ARTERY – HIGH_VALUE – SHORTCUT – GREENAREA – CONTOURAVENUE – MARGINALAVENUE – OLDAVENUE – ALLEYWAY – HOLE – BELVEDERE – BALLOON – BLOCKS – BULEVAR – FOREST – BOULEVARD – LOW_VALUE – PIER – SIDEWALK – WAY – CHANNEL – CHAPADAO – BICYCLEPATH – CIRCULARROAD – HOUSINGCOMPLEX – ROADCOMPLEX – COMMUNITY – HALL – STREAM – CONTOUR – DESCENT – DETOUR – BETWEENBLOCK – INTERMUNICIPALROAD – COVE – PRIVATEENTRANCE – BETWEENQUARTER – LADDER – STAIRCASE – STATEHIGHWAY – VICINALROAD – ROADCONNECTION – MUNICIPALROAD – ROADTOSERFDOM – OLDROAD – LATERROAD – STADIUM – OFFICE – PRIVATEROAD – PARKING – EVANGELICAL – LOFTY – INDUSTRIALAXIS – RAILROAD – SOURCE – STRONG – HOUSINGNUCLEUS – ISLAND – UNDETERMINED – ISLET – WINDOW – LOT – MARKETPLACE – MARINA – MODULE – PROJECTION – MOUNT – RURALNUCLEUS – KNOLL – PARALLEL – TOUR – SPORTSSQUARE – STOP – RESTAREA – TIP – PROLONGING – CITYPARK – RESIDENTIALPARK – PASSAGE – PEDESTRIANWALKWAY – UNDERGROUNDPASSAGE – BRIDGE – PORT – FIFTH – FARMS – INTEGRATIONSTREET – LINKSTREET – PRIVATESTREET – OLDSTREET – BRANCH – PLAYGROUND – RETREAT – STRAIGHT – SIDESTREET – RAMP – RODORING – KNEECAP – PEDESTRIANSTREET – MARGIN – RETURN – ROUNDABOUT – SECONDAVENUE – BONDAGE – UPLOADING – TRENCH – TERMINAL – TUNNEL – PRIVATEBYSTREET – OLDBYSTREET – UNITY – COLLECTORROAD – LOCALWAY – ACCESSWAY – DITCH – COASTALWAY – EXPRESSWAY – HIGHROAD – COASTALROAD – WALKWAY – VARIANT – ZIGZAG description: Tipo de endereço: * `OTHERS` – 0 – Outros * `AIRPORT` – 1 – Aeroporto * `LANE` – 2 – Alameda * `AREA` – 3 – Area * `AVENUE` – 4 – Avenida * `BALNEARY` – 5 – Balneário * `BLOCK` – 6 – Bloco * `FIELD` – 7 – Campo * `FARMSTEAD` – 8 – Chácara * `COLOGNE` – 9 – Colônia * `CONDOMINIUM` – 10 – Condomínio * `SET` – 11 – Conjunto * `DISTRICT` – 12 – Distrito * `TERRACE` – 13 – Esplanada * `SEASON` – 14 – Estação * `ROAD` – 15 – Estrada * `SHANTYTOWN` – 16 – Favela * `FARM` – 17 – Fazenda * `MARKET` – 18 – Feira * `GALLERY` – 19 – Galeria * `GRANJA` – 20 – Granja * `GARDEN` – 21 – Jardim * `SLOPE` – 22 – Ladeira * `LAKE` – 23 – Lago * `LAGOON` – 24 – Lagoa * `LONG` – 25 – Largo * `ALLOTMENT` – 26 – Loteamento * `HILL` – 27 – Morro * `CORE` – 28 – Núcleo * `PARK` – 29 – Parque * `FOOTBRIDGE` – 30 – Passarela * `COURTYARD` – 31 – Pátio * `SQUARE` – 32 – Praça * `BEACH` – 33 – Praia * `COURT` – 34 – Quadra * `NOOK` – 35 – Recanto * `RESIDENTIAL` – 36 – Residencial * `HIGHWAY` – 37 – Rodovia * `STREET` – 38 – Rua * `SECTOR` – 39 – Setor * `SITE` – 40 – Sítio * `BYSTREET` – 41 – Travessa * `EXCERPT` – 42 – Trecho * `CLOVER` – 43 – Trevo * `VALLEY` – 44 – Vale * `PATH` – 45 – Vereda * `VIA` – 46 – Via * `VIADUCT` – 47 – Viaduto * `ALLEY` – 48 – Viela * `VILLAGE` – 49 – Vila * `ACCESS` – 50 – Acesso * `CAMP` – 51 – Acampamento * `LOCALACCESS` – 52 – Acesso Local * `CHURCHYARD` – 53 – Adro * `SPECIALAREA` – 54 – Área Especial * `RIGHTMARGINALAVENUE` – 55 – Avenida Marginal Direita * `LEFTMARGINALAVENUE` – 56 – Avenida Marginal Esquerda * `RINGROAD` – 57 – Anel Viário * `LATERROADBETWEEN` – 58 – Antiga Estrada * `ARTERY` – 59 – Artéria * `HIGH_VALUE` – 60 – Alto * `SHORTCUT` – 61 – Atalho * `GREENAREA` – 62 – Área Verde * `CONTOURAVENUE` – 63 – Avenida Contorno * `MARGINALAVENUE` – 64 – Avenida Marginal * `OLDAVENUE` – 65 – Avenida Velha * `ALLEYWAY` – 66 – Beco * `HOLE` – 67 – Buraco * `BELVEDERE` – 68 – Belvedere * `BALLOON` – 69 – Balão * `BLOCKS` – 70 – Blocos * `BULEVAR` – 71 – Bulevar * `FOREST` – 72 – Bosque * `BOULEVARD` – 73 – Boulevard * `LOW_VALUE` – 74 – Baixa * `PIER` – 75 – Cais * `SIDEWALK` – 76 – Calçada * `WAY` – 77 – Caminho * `CHANNEL` – 78 – Canal * `CHAPADAO` – 79 – Chapadão * `BICYCLEPATH` – 80 – Ciclovia * `CIRCULARROAD` – 81 – Circular * `HOUSINGCOMPLEX` – 82 – Conjunto Mutirão * `ROADCOMPLEX` – 83 – Complexo Viário * `COMMUNITY` – 84 – Comunidade * `HALL` – 85 – Corredor * `STREAM` – 86 – Córrego * `CONTOUR` – 87 – Contorno * `DESCENT` – 88 – Descida * `DETOUR` – 89 – Desvio * `BETWEENBLOCK` – 90 – Entre Bloco * `INTERMUNICIPALROAD` – 91 – Estrada Intermunicipal * `COVE` – 92 – Enseada * `PRIVATEENTRANCE` – 93 – Entrada Particular * `BETWEENQUARTER` – 94 – Entre Quadra * `LADDER` – 95 – Escada * `STAIRCASE` – 96 – Escadaria * `STATEHIGHWAY` – 97 – Estrada Estadual * `VICINALROAD` – 98 – Estrada Vicinal * `ROADCONNECTION` – 99 – Estrada de Ligação * `MUNICIPALROAD` – 100 – Estrada Municipal * `ROADTOSERFDOM` – 101 – Estrada de Servidão * `OLDROAD` – 102 – Estrada Velha * `LATERROAD` – 103 – Estrada Antiga * `STADIUM` – 104 – Estádio * `OFFICE` – 105 – Estância * `PRIVATEROAD` – 106 – Estrada Particular * `PARKING` – 107 – Estacionamento * `EVANGELICAL` – 108 – Evangélica * `LOFTY` – 109 – Elevada * `INDUSTRIALAXIS` – 110 – Eixo Industrial * `RAILROAD` – 111 – Ferrovia * `SOURCE` – 112 – Fonte * `STRONG` – 113 – Forte * `HOUSINGNUCLEUS` – 114 – Núcleo Habitacional * `ISLAND` – 115 – Ilha * `UNDETERMINED` – 116 – Indeterminado * `ISLET` – 117 – Ilhota * `WINDOW` – 118 – Jardinete * `LOT` – 119 – Lote * `MARKETPLACE` – 120 – Mercado * `MARINA` – 121 – Marina * `MODULE` – 122 – Módulo * `PROJECTION` – 123 – Projeção * `MOUNT` – 124 – Monte * `RURALNUCLEUS` – 125 – Núcleo Rural * `KNOLL` – 126 – Outeiro * `PARALLEL` – 127 – Paralela * `TOUR` – 128 – Passeio * `SPORTSSQUARE` – 129 – Praça de Esportes * `STOP` – 130 – Parada * `RESTAREA` – 131 – Paradouro * `TIP` – 132 – Ponta * `PROLONGING` – 133 – Prolongamento * `CITYPARK` – 134 – Parque Municipal * `RESIDENTIALPARK` – 135 – Parque Residencial * `PASSAGE` – 136 – Passagem * `PEDESTRIANWALKWAY` – 137 – Passagem de Pedestre * `UNDERGROUNDPASSAGE` – 138 – Passagem Subterrânea * `BRIDGE` – 139 – Ponte * `PORT` – 140 – Porto * `FIFTH` – 141 – Quinta * `FARMS` – 142 – Quintas * `INTEGRATIONSTREET` – 143 – Rua Integração * `LINKSTREET` – 144 – Rua de Ligação * `PRIVATESTREET` – 145 – Rua Particular * `OLDSTREET` – 146 – Rua Velha * `BRANCH` – 147 – Ramal * `PLAYGROUND` – 148 – Recreio * `RETREAT` – 149 – Retiro * `STRAIGHT` – 150 – Reta * `SIDESTREET` – 151 – Ruela * `RAMP` – 152 – Rampa * `RODORING` – 153 – Rodo Anel * `KNEECAP` – 154 – Rótula * `PEDESTRIANSTREET` – 155 – Rua de Pedestre * `MARGIN` – 156 – Margem * `RETURN` – 157 – Retorno * `ROUNDABOUT` – 158 – Rotatória * `SECONDAVENUE` – 159 – Segunda Avenida * `BONDAGE` – 160 – Servidão * `UPLOADING` – 161 – Subida * `TRENCH` – 162 – Trincheira * `TERMINAL` – 163 – Terminal * `TUNNEL` – 164 – Túnel * `PRIVATEBYSTREET` – 165 – Travessa Particular * `OLDBYSTREET` – 166 – Travessa Velha * `UNITY` – 167 – Unidade * `COLLECTORROAD` – 168 – Via Coletora * `LOCALWAY` – 169 – Via Local * `ACCESSWAY` – 170 – Via de Acesso * `DITCH` – 171 – Vala * `COASTALWAY` – 172 – Via Costeira * `EXPRESSWAY` – 173 – Via Expressa * `HIGHROAD` – 174 – Via Elevado * `COASTALROAD` – 175 – Via Litorânea * `WALKWAY` – 176 – Via de Pedestre * `VARIANT` – 177 – Variante * `ZIGZAG` – 178 – Zigue-Zague userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error integrityComponentDTO: description: Componente de integridade type: object required: – name – status properties: name: type: string maxLength: 32 description: Nome do componente status: type: string allOf: – #/definitions/healthcheckStatus description: Status da integridade documentsData: description: Dados de novo documento type: object required: – dismissalRequestId – employeeId – attachmentType – attachments properties: dismissalRequestId: type: string maxLength: 36 description: Identificador da solicitação de desligamento employeeId: type: string maxLength: 36 description: Identificador do criador do documento attachmentType: type: string allOf: – #/definitions/enumAttachmentType description: Tipo de Anexo attachments: type: array items: type: object allOf: – #/definitions/fileUploadedData minimum: 1 description: Conteúdo do documento signatureRequestData: description: Dados de solicitacão de assinatura type: object required: – documentIdList – dismissalRequestId – signerIdList properties: documentIdList: type: array items: type: string minimum: 1 description: Identificadores dos documento dismissalRequestId: type: string maxLength: 36 description: Identificador da solicitação de desligamento signerIdList: type: array items: type: string minimum: 1 description: Identificadores dos assinantes instructions: type: string maxLength: 512 description: Instruções para assinatura demandGeolocation: type: boolean description: Exigir geolocalização default: false gedSignerStatusDTO: description: Dados de status de assinatura do assinante type: object required: – email – status properties: email: type: string maxLength: 36 description: Identificador do assinante status: type: string maxLength: 32 description: Status da assinatura gedSignatureUrlDTO: description: Url de assinatura do envelope type: object required: – url – email properties: url: type: string maxLength: 256 description: Url para assinatura email: type: string description: E-mail gedEnvelopeStatusDTO: description: Dados de status de assinatura do envelope type: object required: – envelopeId – status – signerStatusList – documentIdList – signatureUrlList properties: envelopeId: type: string description: Identificador do envelope status: type: string description: Status do envelope signerStatusList: type: array items: type: object allOf: – #/definitions/gedSignerStatusDTO minimum: 1 description: Status dos assinantes documentIdList: type: array items: type: string minimum: 1 description: Identificadores dos documentos signatureUrlList: type: array items: type: object allOf: – #/definitions/gedSignatureUrlDTO minimum: 1 description: Url de assinatura fileUploadedData: description: Dados para upload de arquivo type: object required: – fileId – fileName – version – locationURI properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) fileName: type: string description: Nome do arquivo type: string description: Versão do arquivo locationURI: type: string description: URI onde o upload deve ser realizado externalDocument: description: Documentos externos associados a solicitação de desligamento type: object required: – sentAt properties: id: type: string description: Identificador fileName: type: string description: Nome do arquivo sentBy: type: string description: Enviado por sentAt: type: string format: date-time description: Data e hora size: type: integer format: int64 description: Tamanho (bytes) requestSignerData: description: Dados do assinante do desligamento type: object properties: id: type: string description: Identificador Único name: type: string description: Nome email: type: string description: Email phone: type: string description: Telefone isInternal: type: boolean description: Determina se assinante interno default: false sendEnable: type: boolean description: Habilita envio default: false sendMail: type: boolean description: Envio por e-mail default: false sendSMS: type: boolean description: Envio por SMS default: false sendWPP: type: boolean description: Envio por WhatsApp default: false sendPlatform: type: boolean description: Envio por Plataforma default: false requestDocumentTemplate: description: Dados do modelo de um documento type: object properties: id: type: string description: Identificador Único created: type: boolean description: Criado na solicitação default: false validated: type: boolean description: Validado default: false name: type: string description: Nome do template documentType: type: string description: Tipo do documento content: type: string description: Conteudo signerData: description: Dados de um assinante type: object required: – name – email – phone properties: id: type: string description: Identificador do assinante. dismissalRequestId: type: string maxLength: 36 description: Identificador da Solicitação de desligamento. name: type: string description: Nome do assinante. birthDay: type: string format: date description: Data de Nascimento cpf: type: string description: CPF email: type: string description: E-mail do assinante username: type: string description: Usuário do assinante phone: type: string description: Telefone do assinante isInternal: type: boolean description: Determina se assinante interno default: false sendEnable: type: boolean description: Habilita envio default: false sendMail: type: boolean description: Envio por e-mail default: false sendSMS: type: boolean description: Envio por SMS default: false sendWPP: type: boolean description: Envio por WhatsApp default: false sendPlatform: type: boolean description: Envio por Plataforma default: false employeeId: type: string description: Identificador do colabor interno documentTemplateData: description: Dados de template de documento type: object required: – name – active properties: documentTemplateId: type: string maxLength: 36 description: Identificador do template de documento name: type: string description: Descrição do template de documento active: type: boolean description: Indifica se está ativo documentDraftData: description: Dados de rascunho do template do documento type: object required: – dismissalRequestId – documentTemplateId properties: dismissalRequestId: type: string maxLength: 36 description: Identificador da solicitação de desligamento documentTemplateId: type: string maxLength: 36 description: Identificador do template de documento connectorCategoryDTO: description: Dados de categoria do conector type: object required: – id – name properties: id: type: string description: Identificador da categoria do conector name: type: string description: Descrição da categoria do conector connectorDTO: description: Dados de conector type: object required: – id – name properties: id: type: string description: Identificador do conector name: type: string description: Nome do conector categories: type: array items: type: object allOf: – #/definitions/connectorCategoryDTO description: Categoria do conector connectorConfigurationDTO: description: Dados de configuração do conector type: object required: – id – gedConnectorId properties: id: type: string description: Identificador da configuração do conector category: type: string allOf: – #/definitions/connectorCategory description: Categoria de conector gedConnectorId: type: string description: Identificador na plataforma country: type: string allOf: – #/definitions/country description: País requestAccessInputData: description: Dados para solicitação de acesso ao arquivo type: object required: – fileId – fileName properties: fileId: type: string description: Identificador do arquivo fileName: type: string description: Nome do arquivo requestAccessData: description: Dados de resposta para solicitação de acesso ao arquivo type: object required: – fileId – fileName – uri properties: fileId: type: string description: Identificador do arquivo fileName: type: string description: Nome do arquivo uri: type: string description: URI de acesso ao arquivo envelopeSignerDTO: description: Detalhes do assinante do envelope type: object required: – signerId – name – email – phone properties: signerId: type: string description: Identificador do assinante name: type: string description: Nome do assinante email: type: string description: E-mail do assinante phone: type: string description: Telefone do assinante status: type: string allOf: – #/definitions/documentStatus description: Status da assinatura do documento signedDate: type: string format: date-time description: Data da assinatura envelopeDocumentDTO: description: Detalhes do envelope type: object required: – envelopeId – gedEnvelopeId – name properties: envelopeId: type: string description: Identificador do envelope gedEnvelopeId: type: string description: Identificador do envelope no GED status: type: string allOf: – #/definitions/envelopeStatus description: Status do envelope reason: type: string description: Motivo name: type: string description: Nome do envelope signers: type: array items: type: object allOf: – #/definitions/envelopeSignerDTO description: Assinantes do Envelope dismissalRequestAttachmentDTO: description: Detalhes do documento anexo type: object required: – dismissalRequestId – dismissalRequestAttachmentId – attachmentId – fileName – fileId – version – signersCount – signaturesCount properties: dismissalRequestId: type: string description: Identificador da solicitação de desligamento dismissalRequestAttachmentId: type: string description: Identificador do anexo na solicitação de desligamento attachmentId: type: string description: Identificador do anexo fileName: type: string description: Nome do arquivo fileId: type: string description: Identificado do arquivo fileSize: type: integer format: int64 description: Tamanho do arquivo type: string description: Versão do arquivo gedDocumentId: type: string description: Identificador do documento no GED gedDocumentVersion: type: string description: Versão do documento no GED attachmentType: type: string allOf: – #/definitions/enumAttachmentType description: Indicativo se pode ser assinado signersCount: type: integer format: int64 description: Quantidade de assinantes signaturesCount: type: integer format: int64 description: Quantidade de assinaturas envelope: type: object allOf: – #/definitions/envelopeDocumentDTO description: Indicador se está em envelope para assinatura documentTemplateEmployeeData: description: Dados do colaborador para template de documento type: object required: – person – company properties: person: type: object allOf: – #/definitions/personCustomData description: Dados da pessoa company: type: object allOf: – #/definitions/companyCustomData description: Dados da empresa personCustomData: description: Dados customizados da pessoa type: object properties: fullName: type: string description: Nome completo address: type: string description: Endereço phone: type: string description: Telefone email: type: string description: E-mail cpf: type: string description: CPF rg: type: string description: RG ctps: type: string description: CTPS companyCustomData: description: Dados customizados da empresa type: object properties: name: type: string description: Nome da empresa cnpj: type: string description: CNPJ address: type: string description: Endereço employeeSignerData: description: Detales do colaborador que pode se tornar assinante type: object properties: employeeId: type: string description: Identificador do colaborador name: type: string description: Nome do colaborador email: type: string description: E-mail do colaborador phone: type: string description: Telefone do colaborador cpf: type: string description: CPF birthDay: type: string format: date description: Data de nascimento username: type: string description: Usuário do colaborador attachment: description: Anexo type: object required: – name – fileId – location – version properties: id: type: string format: uuid description: Identificador único name: type: string description: Nome do arquivo fileId: type: string description: Identificador do arquivo location: type: string description: Local do arquivo type: string description: Versão do arquivo gedDocumentId: type: string description: Identificador do documento no GED gedTicket: type: string description: Identificador do ticket no GED fileSize: type: integer format: int64 description: Tamanho do arquivo gedDocumentVersion: type: string description: Versão do documento no GED createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAttachment: type: object required: – id allOf: – #/definitions/attachment dismissalRequest: description: Solicitação de desligamento type: object properties: id: type: string format: uuid description: Identificador único da solicitação de desligamento employee: type: object allOf: – #/definitions/employee description: Colaborador createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDismissalRequest: type: object required: – id allOf: – #/definitions/dismissalRequest company: description: Empresa type: object properties: id: type: string format: uuid description: Identificador único da empresa name: type: string description: Nome da empresa code: type: integer format: int64 description: Código da empresa headquarter: type: object allOf: – #/definitions/company description: Sede da empresa cnpj: type: string description: CNPJ place: type: object allOf: – #/definitions/address description: Endereço createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCompany: type: object required: – id allOf: – #/definitions/company signer: description: Assinante type: object required: – name – email – phone properties: id: type: string format: uuid description: Identificador do assinante. dismissalRequest: type: object allOf: – #/definitions/dismissalRequest description: Identificador da Solicitação de desligamento. name: type: string maxLength: 255 description: Nome do assinante. cpf: type: string description: CPF birthDay: type: string format: date description: Data de Nascimento username: type: string maxLength: 255 description: Usuário do assinante email: type: string maxLength: 255 description: E-mail do assinante phone: type: string maxLength: 20 description: Telefone do assinante isInternal: type: boolean description: Determina se assinante interno default: false sendMail: type: boolean description: Envio por e-mail default: false sendSMS: type: boolean description: Envio por SMS default: false sendWPP: type: boolean description: Envio por WhatsApp default: false sendPlatform: type: boolean description: Envio por Plataforma default: false employee: type: object allOf: – #/definitions/employee description: Colaborador createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editSigner: type: object required: – id allOf: – #/definitions/signer connectorConfiguration: description: Configuração do conector type: object required: – category – gedConnectorId – country properties: id: type: string format: uuid description: Identificador category: type: string allOf: – #/definitions/connectorCategory description: Categoria de conector gedConnectorId: type: string description: Identificador na plataforma country: type: string allOf: – #/definitions/country description: País description: type: string description: Descrição da configuração do conector createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editConnectorConfiguration: type: object required: – id allOf: – #/definitions/connectorConfiguration envelope: description: Envelope type: object required: – name – instructions – demandGeolocation – status – reason properties: id: type: string format: uuid description: Identificador do envelope. name: type: string maxLength: 255 description: Nome do envelope dismissalRequest: type: object allOf: – #/definitions/dismissalRequest description: Identificador da solicitação de desligamento. instructions: type: string description: Instruções para o assinante. demandGeolocation: type: boolean description: Indicativo Geolocalização gedTicketId: type: string maxLength: 50 description: ID de referencia do ticket de processamento no GED gedEnvelopeId: type: string maxLength: 50 description: ID de referencia do envelope no GED status: type: string allOf: – #/definitions/envelopeStatus description: Status do envelope reason: type: string description: Motivo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelope: type: object required: – id allOf: – #/definitions/envelope envelopeDocument: description: Documento do envelope type: object required: – envelope – attachment properties: id: type: string format: uuid description: Identificador único envelope: type: object allOf: – #/definitions/envelope description: Identificador do envelope attachment: type: object allOf: – #/definitions/attachment description: Identificador documento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeDocument: type: object required: – id allOf: – #/definitions/envelopeDocument envelopeSigner: description: Assinante do envelope type: object required: – envelope – signer – status properties: id: type: string format: uuid description: Identificador único envelope: type: object allOf: – #/definitions/envelope description: Identificador do envelope signer: type: object allOf: – #/definitions/signer description: Identificador do assinante status: type: string allOf: – #/definitions/documentStatus description: Status createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeSigner: type: object required: – id allOf: – #/definitions/envelopeSigner envelopeConnector: description: Conector do envelope type: object required: – envelope – connector properties: id: type: string format: uuid description: Identificador único envelope: type: object allOf: – #/definitions/envelope description: Identificador do envelope connector: type: object allOf: – #/definitions/connectorConfiguration description: Identificador do conector createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeConnector: type: object required: – id allOf: – #/definitions/envelopeConnector documentTemplate: description: Template de documento type: object required: – name – active – fileName – fileId – content properties: id: type: string format: uuid description: Identificador do template name: type: string maxLength: 255 description: Nome do template active: type: boolean description: Status de ativo/inativo documentType: type: object allOf: – #/definitions/documentType description: Tipo de documento fileName: type: string maxLength: 255 description: Nome do arquivo fileId: type: string maxLength: 255 description: Identificador do arquivo content: type: string description: Conteúdo do template createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDocumentTemplate: type: object required: – id allOf: – #/definitions/documentTemplate fieldTemplate: description: Campo de template type: object required: – name – country – type – subType – category – field properties: id: type: string format: uuid description: Identificador do campo documentTemplate: type: object allOf: – #/definitions/documentTemplate description: Identificador do template name: type: string maxLength: 255 description: Nome do campo country: type: string allOf: – #/definitions/country description: País type: type: string allOf: – #/definitions/enumFieldType description: Tipo de campo subType: type: string allOf: – #/definitions/enumFieldSubType description: Subtipo de campo category: type: string allOf: – #/definitions/enumFieldCategory description: Categoria de campo field: type: string maxLength: 255 description: Campo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editFieldTemplate: type: object required: – id allOf: – #/definitions/fieldTemplate documentDraft: description: Rascunho de documento type: object required: – validated properties: id: type: string format: uuid description: Identificador do rascunho dismissalRequest: type: object allOf: – #/definitions/dismissalRequest description: Solicitação de desligamento documentTemplate: type: object allOf: – #/definitions/documentTemplate description: Modelo de documento validated: type: boolean description: Status de validação content: type: string description: Conteúdo attachment: type: object allOf: – #/definitions/attachment description: Anexo do documento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDocumentDraft: type: object required: – id allOf: – #/definitions/documentDraft documentDraftHistory: description: Historico de rascunho de documento type: object required: – modifiedAt – modifiedBy properties: id: type: string format: uuid description: Identificador do histórico de rascunho documentDraft: type: object allOf: – #/definitions/documentDraft description: Rascunho de documento modifiedAt: type: string format: date-time description: Data da modificação modifiedBy: type: string description: Identificador do modificador content: type: string description: Conteúdo do rascunho attachment: type: object allOf: – #/definitions/attachment description: Anexo do documento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDocumentDraftHistory: type: object required: – id allOf: – #/definitions/documentDraftHistory documentType: description: Tipo de documento type: object required: – name properties: id: type: string format: uuid description: Identificador único name: type: string maxLength: 255 description: Nome tipo do documento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDocumentType: type: object required: – id allOf: – #/definitions/documentType dismissalRequestAttachment: description: Anexo da solicitação de desligamento type: object properties: id: type: string format: uuid description: Identificador único dismissalRequest: type: object allOf: – #/definitions/dismissalRequest description: Solicitação de desligamento attachment: type: object allOf: – #/definitions/attachment description: Anexo associado attachmentType: type: string allOf: – #/definitions/enumAttachmentType description: Indicativo se pode ser assinado sentBy: type: object allOf: – #/definitions/employee description: Identificador do criador do anexo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDismissalRequestAttachment: type: object required: – id allOf: – #/definitions/dismissalRequestAttachment person: description: Pessoa type: object required: – fullname properties: id: type: string format: uuid description: Identificador único fullname: type: string description: Nome externalId: type: string format: uuid description: Identificador externo userName: type: string description: Nome usuário cpf: type: string description: CPF birthday: type: string format: date description: Data de nascimento rgs: type: array items: type: object allOf: – #/definitions/personRg description: RG ctpsEntities: type: array items: type: object allOf: – #/definitions/personCtps description: CTPS emails: type: array items: type: object allOf: – #/definitions/email description: Emails personPhoneContacts: type: array items: type: object allOf: – #/definitions/personPhoneContact description: Telefones employees: type: array items: type: object allOf: – #/definitions/employee description: Colaboradores addresses: type: array items: type: object allOf: – #/definitions/personAddress description: Endereços createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editPerson: type: object required: – id allOf: – #/definitions/person employee: description: Colaborador type: object properties: id: type: string format: uuid description: Identificador único externalId: type: string format: uuid description: Identificador externo person: type: object allOf: – #/definitions/person description: Pessoa company: type: object allOf: – #/definitions/company description: Empresa emails: type: array items: type: object allOf: – #/definitions/employeeEmail description: Emails phoneContacts: type: array items: type: object allOf: – #/definitions/employeePhoneContact description: Contatos telefônicos createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployee: type: object required: – id allOf: – #/definitions/employee signerDismissalRequestAttachment: description: Configuração de Documentos Externos com Assinantes type: object properties: id: type: string format: uuid description: Identificador único dismissalRequestAttachment: type: object allOf: – #/definitions/dismissalRequestAttachment description: Solicitação de desligamento signer: type: object allOf: – #/definitions/signer description: Assinante createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editSignerDismissalRequestAttachment: type: object required: – id allOf: – #/definitions/signerDismissalRequestAttachment signerDocumentTemplate: description: Configuração de Modelos de Documentos com Assinantes type: object properties: id: type: string format: uuid description: Identificador único documentTemplate: type: object allOf: – #/definitions/documentTemplate description: Modelo de documento signer: type: object allOf: – #/definitions/signer description: Assinante dismissalRequest: type: object allOf: – #/definitions/dismissalRequest description: Solicitação de desligamento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editSignerDocumentTemplate: type: object required: – id allOf: – #/definitions/signerDocumentTemplate rg: description: RG type: object required: – externalId – repStatus properties: id: type: string format: uuid description: Identificador único do RG externalId: type: string format: uuid description: Identificador externo do RG repStatus: type: string allOf: – #/definitions/replicationStatus description: Status da replicação number: type: string description: Número do RG issuer: type: string description: Órgão expedidor issuingstate: type: string description: UF de expedição issueddate: type: string format: date description: Data de expedição createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editRg: type: object required: – id allOf: – #/definitions/rg ctps: description: CTPS type: object required: – externalId – repStatus properties: id: type: string format: uuid description: Identificador único da CTPS externalId: type: string format: uuid description: Identificador externo da CTPS repStatus: type: string allOf: – #/definitions/replicationStatus description: Status da replicação number: type: string description: Número da CTPS serie: type: string description: Série da CTPS seriedigit: type: string description: Dígito da série state: type: string description: UF da CTPS issueddate: type: string format: date description: Data de expedição validatedate: type: string format: date description: Data de validação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCtps: type: object required: – id allOf: – #/definitions/ctps personRg: description: RG da Pessoa type: object required: – repStatus properties: id: type: string format: uuid description: Identificador único do RG da pessoa repStatus: type: string allOf: – #/definitions/replicationStatus description: Status da replicação person: type: object allOf: – #/definitions/person description: Pessoa rg: type: object allOf: – #/definitions/rg description: RG createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editPersonRg: type: object required: – id allOf: – #/definitions/personRg personCtps: description: CTPS da Pessoa type: object required: – repStatus properties: id: type: string format: uuid description: Identificador único da CTPS da pessoa repStatus: type: string allOf: – #/definitions/replicationStatus description: Status da replicação person: type: object allOf: – #/definitions/person description: Pessoa ctps: type: object allOf: – #/definitions/ctps description: CTPS createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editPersonCtps: type: object required: – id allOf: – #/definitions/personCtps phoneContact: description: Telefone de contato type: object required: – externalId – repStatus – localCode – number properties: id: type: string format: uuid description: Identificador único do telefone de contato externalId: type: string format: uuid description: Identificador externo do telefone de contato repStatus: type: string allOf: – #/definitions/replicationStatus description: Status da replicação carrier: type: string description: Operadora do telefone countryCode: type: integer format: int64 description: Código do país extention: type: string description: Ramal localCode: type: integer format: int64 description: Código de área number: type: string description: Número do telefone createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editPhoneContact: type: object required: – id allOf: – #/definitions/phoneContact personPhoneContact: description: Contato telefônico da pessoa type: object required: – externalId – repStatus – phoneContact properties: id: type: string format: uuid description: Identificador único do telefone de contato da pessoa externalId: type: string format: uuid description: Identificador externo do telefone de contato da pessoa repStatus: type: string allOf: – #/definitions/replicationStatus description: Status da replicação phoneContact: type: object allOf: – #/definitions/phoneContact description: Contato person: type: object allOf: – #/definitions/person description: Pessoa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editPersonPhoneContact: type: object required: – id allOf: – #/definitions/personPhoneContact geoCountry: description: País type: object required: – externalId – repStatus properties: id: type: string format: uuid description: Identificador único do país externalId: type: string format: uuid description: Identificador externo do país repStatus: type: string allOf: – #/definitions/replicationStatus description: Status da replicação name: type: string description: Nome do país code: type: integer format: int64 description: Código do país createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editGeoCountry: type: object required: – id allOf: – #/definitions/geoCountry state: description: Estado type: object required: – externalId – repStatus properties: id: type: string format: uuid description: Identificador único do estado externalId: type: string format: uuid description: Identificador externo do estado repStatus: type: string allOf: – #/definitions/replicationStatus description: Status da replicação name: type: string description: Nome do estado code: type: string description: Código do estado country: type: object allOf: – #/definitions/geoCountry description: País createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editState: type: object required: – id allOf: – #/definitions/state city: description: Cidade type: object required: – externalId – repStatus properties: id: type: string format: uuid description: Identificador único da cidade externalId: type: string format: uuid description: Identificador externo da cidade repStatus: type: string allOf: – #/definitions/replicationStatus description: Status da replicação name: type: string description: Nome da cidade code: type: integer format: int64 description: Código da cidade state: type: object allOf: – #/definitions/state description: Estado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCity: type: object required: – id allOf: – #/definitions/city neighborhood: description: Bairro type: object required: – externalId – repStatus properties: id: type: string format: uuid description: Identificador único do bairro externalId: type: string format: uuid description: Identificador externo do bairro repStatus: type: string allOf: – #/definitions/replicationStatus description: Status da replicação name: type: string description: Nome do bairro code: type: string description: Código do bairro city: type: object allOf: – #/definitions/city description: Cidade createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editNeighborhood: type: object required: – id allOf: – #/definitions/neighborhood address: description: Endereço type: object required: – externalId – repStatus properties: id: type: string format: uuid description: Identificador único do endereço externalId: type: string format: uuid description: Identificador externo do endereço repStatus: type: string allOf: – #/definitions/replicationStatus description: Status da replicação additional: type: string description: Adicional address: type: string description: Endereço number: type: string description: Número postalCode: type: string description: CEP neighborhood: type: string description: Bairro neighborhoodId: type: object allOf: – #/definitions/neighborhood description: Entidade do bairro city: type: object allOf: – #/definitions/city description: Cidade addressType: type: string allOf: – #/definitions/addressType description: Tipo de endereço updateDate: type: string format: date description: Data de atualização createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAddress: type: object required: – id allOf: – #/definitions/address personAddress: description: Endereço da pessoa type: object required: – externalId – repStatus properties: id: type: string format: uuid description: Identificador único do endereço da pessoa externalId: type: string format: uuid description: Identificador externo do endereço da pessoa repStatus: type: string allOf: – #/definitions/replicationStatus description: Status da replicação person: type: object allOf: – #/definitions/person description: Pessoa address: type: object allOf: – #/definitions/address description: Endereço createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editPersonAddress: type: object required: – id allOf: – #/definitions/personAddress employeePhoneContact: description: Contato telefônico do colaborador type: object required: – externalId – phoneContact properties: id: type: string format: uuid description: Identificador único do telefone de contato do colaborador externalId: type: string format: uuid description: Identificador externo do telefone de contato do colaborador phoneContact: type: object allOf: – #/definitions/phoneContact description: Contato employee: type: object allOf: – #/definitions/employee description: Colaborador createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeePhoneContact: type: object required: – id allOf: – #/definitions/employeePhoneContact email: description: Email pessoal do Colaborador type: object required: – externalId – repStatus properties: id: type: string format: uuid description: Identificador único do aviso externalId: type: string format: uuid description: ID externo repStatus: type: string allOf: – #/definitions/replicationStatus description: Status da replicação person: type: object allOf: – #/definitions/person description: Pessoa email: type: string description: Email createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmail: type: object required: – id allOf: – #/definitions/email employeeEmail: description: Email corporativo do Colaborador type: object required: – externalId properties: id: type: string format: uuid description: Identificador único do aviso externalId: type: string format: uuid description: ID externo employee: type: object allOf: – #/definitions/employee description: Colaborador email: type: string description: Email Corporativo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeEmail: type: object required: – id allOf: – #/definitions/employeeEmail notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage