2.0info: 7.3.1 Gestão Eletrônica de Documentos description: Gestão Eletrônica de Documentos x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: ecm_ged 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/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /ecm_ged/queries/getSignedDocuments: post: description: Retorna informações necessárias para ver os documentos assinados no envelope tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hashEnvelope properties: hashEnvelope: type: string description: Hash de visualização gerado durante a notificação de finalização da assinatura responses: 200: description: Ok schema: type: object required: – envelopeId – documents properties: envelopeId: type: string description: Id do envelope documents: type: array items: type: object allOf: – #/definitions/documentBasicInfoToView minimum: 1 description: Documentos assinados status: type: string description: Status do envelope authorEmail: type: string description: Email do solicitante createdDate: type: string format: date-time description: Data de criação do envelope expirationDate: type: string format: date-time description: Data de expiração do envelope digitalCertificate: type: string allOf: – #/definitions/digitalCertificateOption description: Certificado digital default: description: Error response schema: #/definitions/genericError get: description: Retorna informações necessárias para ver os documentos assinados no envelope tags: – Queries x-senior-visibility: PRIVATE parameters: – name: hashEnvelope description: Hash de visualização gerado durante a notificação de finalização da assinatura in: query required: true type: string responses: 200: description: Ok schema: type: object required: – envelopeId – documents properties: envelopeId: type: string description: Id do envelope documents: type: array items: type: object allOf: – #/definitions/documentBasicInfoToView minimum: 1 description: Documentos assinados status: type: string description: Status do envelope authorEmail: type: string description: Email do solicitante createdDate: type: string format: date-time description: Data de criação do envelope expirationDate: type: string format: date-time description: Data de expiração do envelope digitalCertificate: type: string allOf: – #/definitions/digitalCertificateOption description: Certificado digital default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getReportDocumentCountByRequester: post: description: Relatório de quantidade de documentos por solicitante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/filterReportByRequester description: Filtro para o relatório size: type: integer format: int64 description: Quantidade de registro por página default: 10 offset: type: integer format: int64 description: Página default: 0 orderByField: type: string allOf: – #/definitions/documentsCountOrderByField description: Indica por qual campo os dados serão ordenados order: type: string allOf: – #/definitions/orderType description: Tipo da ordenação responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/reportDocumentCountByRequester minimum: 1 description: Relatório de quantidade de documentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getSignatureEnvelopeConfiguration: post: description: Retorna as configurações de um envelope de assinatura em andamento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do Envelope de assinatura signer: type: string description: Assinante responses: 200: description: Ok schema: type: object required: – documents – askGeolocation – instructionsToSigner – createdBy – createdDate – signerType – signerSubType – name – status – expirationDate properties: documents: type: array items: type: object allOf: – #/definitions/envelopeDocumentItem minimum: 1 description: Documentos do envelope askGeolocation: type: string allOf: – #/definitions/ask_geolocation description: Solicitar Geolocalização instructionsToSigner: type: string description: Um texto com instruções para o assinante createdBy: type: string description: Quem criou a solicitação de assinatura createdDate: type: string format: date-time description: Data de criação da solicitação de assinatura digitalCertificate: type: string allOf: – #/definitions/digitalCertificateOption description: Certificado Digital mandatoryView: type: boolean description: Visualização obrigatória default: false notificateAuthor: type: boolean description: Notificar autor default: false signerType: type: string allOf: – #/definitions/signerType description: Tipo do signatário signerSubType: type: string allOf: – #/definitions/signerSubType description: Subtipo do signatário name: type: string description: Nome do envelope status: type: string description: Status do envelope expirationDate: type: string format: date-time description: Data de expiração authorEmail: type: string description: Email do solicitante competence: type: string description: Juridisdição do envelope 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Configurações do envelope de assinatura não encontrada default: description: Error response schema: #/definitions/genericError get: description: Retorna as configurações de um envelope de assinatura em andamento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: envelopeId description: Id do Envelope de assinatura in: query required: true type: string – name: signer description: Assinante in: query type: string responses: 200: description: Ok schema: type: object required: – documents – askGeolocation – instructionsToSigner – createdBy – createdDate – signerType – signerSubType – name – status – expirationDate properties: documents: type: array items: type: object allOf: – #/definitions/envelopeDocumentItem minimum: 1 description: Documentos do envelope askGeolocation: type: string allOf: – #/definitions/ask_geolocation description: Solicitar Geolocalização instructionsToSigner: type: string description: Um texto com instruções para o assinante createdBy: type: string description: Quem criou a solicitação de assinatura createdDate: type: string format: date-time description: Data de criação da solicitação de assinatura digitalCertificate: type: string allOf: – #/definitions/digitalCertificateOption description: Certificado Digital mandatoryView: type: boolean description: Visualização obrigatória default: false notificateAuthor: type: boolean description: Notificar autor default: false signerType: type: string allOf: – #/definitions/signerType description: Tipo do signatário signerSubType: type: string allOf: – #/definitions/signerSubType description: Subtipo do signatário name: type: string description: Nome do envelope status: type: string description: Status do envelope expirationDate: type: string format: date-time description: Data de expiração authorEmail: type: string description: Email do solicitante competence: type: string description: Juridisdição do envelope 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Configurações do envelope de assinatura não encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getDocumentVersionSignStatus: post: description: Busca dados de assinatura de um documento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – documentVersionId properties: documentVersionId: type: string description: Id da versao do documento responses: 200: description: Ok schema: type: object allOf: – #/definitions/envelopeSignatureStatus 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Dados da assinatura não encontrado default: description: Error response schema: #/definitions/genericError get: description: Busca dados de assinatura de um documento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: documentVersionId description: Id da versao do documento in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/envelopeSignatureStatus 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Dados da assinatura não encontrado default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getEnvelopeSignStatus: post: description: Busca dados de assinatura de um envelope tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope de assinatura responses: 200: description: Ok schema: type: object allOf: – #/definitions/envelopeSignatureStatus 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Assinatura do envelope não encontrada default: description: Error response schema: #/definitions/genericError get: description: Busca dados de assinatura de um envelope tags: – Queries x-senior-visibility: PUBLIC parameters: – name: envelopeId description: Id do envelope de assinatura in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/envelopeSignatureStatus 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Assinatura do envelope não encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getEnvelopeSignature: post: description: Busca dados de um envelope enviado para assinatura tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope enviado para assinatura responses: 200: description: Ok schema: type: object allOf: – #/definitions/envelopeSignatureDTO 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Assinatura do envelope não encontrada default: description: Error response schema: #/definitions/genericError get: description: Busca dados de um envelope enviado para assinatura tags: – Queries x-senior-visibility: PRIVATE parameters: – name: envelopeId description: Id do envelope enviado para assinatura in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/envelopeSignatureDTO 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Assinatura do envelope não encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getDocumentVersionSignatureConfiguration: post: description: Retorna as configurações de assinatura de uma versão do documento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – documentVersionId properties: documentVersionId: type: string description: Id da versao do documento responses: 200: description: Ok schema: type: object required: – documentVersionIds – signers – instructionsToSigner – askGeolocation properties: documentVersionIds: type: array items: type: string minimum: 1 description: Lista com o id dos documentos signers: type: array items: type: object allOf: – #/definitions/signer minimum: 1 description: Lista com os assinantes instructionsToSigner: type: string description: Um texto com instruções para o assinante askGeolocation: type: string allOf: – #/definitions/ask_geolocation description: Solicitar Geolocalização 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: A versão de documento não foi encontrada default: description: Error response schema: #/definitions/genericError get: description: Retorna as configurações de assinatura de uma versão do documento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: documentVersionId description: Id da versao do documento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – documentVersionIds – signers – instructionsToSigner – askGeolocation properties: documentVersionIds: type: array items: type: string minimum: 1 description: Lista com o id dos documentos signers: type: array items: type: object allOf: – #/definitions/signer minimum: 1 description: Lista com os assinantes instructionsToSigner: type: string description: Um texto com instruções para o assinante askGeolocation: type: string allOf: – #/definitions/ask_geolocation description: Solicitar Geolocalização 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: A versão de documento não foi encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getSignUrls: post: description: Retorna URLs do recurso de assinatura de documentos tags: – Queries x-senior-visibility: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – requestToken – sign properties: requestToken: type: string description: URL para requisição do token de assinatura do usuário sign: type: string description: URL para efetivação de assinatura 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Retorna URLs do recurso de assinatura de documentos tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – requestToken – sign properties: requestToken: type: string description: URL para requisição do token de assinatura do usuário sign: type: string description: URL para efetivação de assinatura 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/requestUpload: post: description: Solicita o upload de um documento\n### Resources:\n- res://senior.com.br/platform/ecm_ged/file\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome que irá corresponder ao arquivo. responses: 200: description: Ok schema: type: object required: – fileUrl – uploadUrl properties: fileUrl: type: string description: Url do arquivo do arquivo. uploadUrl: type: string description: Url onde deverá ocorrer o download do arquivo. 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Solicita o upload de um documento\n### Resources:\n- res://senior.com.br/platform/ecm_ged/file\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: fileName description: Nome que irá corresponder ao arquivo. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – fileUrl – uploadUrl properties: fileUrl: type: string description: Url do arquivo do arquivo. uploadUrl: type: string description: Url onde deverá ocorrer o download do arquivo. 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/newDocumentStatus: post: description: Retorna andamento da criação de arquivo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Ticket para obter o status do documento responses: 200: description: Ok schema: type: object required: – finished properties: finished: type: boolean description: Indica se o processo para novo documento foi finalizado documentId: type: string description: Identificador do Documento se estiver pronto 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Status do documento não encontrado default: description: Error response schema: #/definitions/genericError get: description: Retorna andamento da criação de arquivo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: ticket description: Ticket para obter o status do documento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – finished properties: finished: type: boolean description: Indica se o processo para novo documento foi finalizado documentId: type: string description: Identificador do Documento se estiver pronto 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Status do documento não encontrado default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getPendenciesCount: post: description: API DEPRECIADA: Usar getPendenciesCount na versão 2 | DATA: 2023-04-01 | Lista a quantidade de documentos pendentes, seja de revisão ou de propriedades, por padrão considera o usuário logado tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: user: type: string description: Usuário responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: Quantidade de documentos pendentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Usar getPendenciesCount na versão 2 | DATA: 2023-04-01 | Lista a quantidade de documentos pendentes, seja de revisão ou de propriedades, por padrão considera o usuário logado tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: user description: Usuário in: query type: string responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: Quantidade de documentos pendentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getPendenciesCount__2: post: description: Lista a quantidade de documentos pendentes, seja de revisão ou de propriedades, por padrão considera o usuário logado tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: user: type: string description: Usuário responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: Quantidade de documentos pendentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista a quantidade de documentos pendentes, seja de revisão ou de propriedades, por padrão considera o usuário logado tags: – Queries x-senior-visibility: PUBLIC parameters: – name: user description: Usuário in: query type: string responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: Quantidade de documentos pendentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listPendencies: post: description: API DEPRECIADA: Usar listPendencies na versão 2 | DATA: 2023-04-01 | Lista os documentos pendentes, seja de revisão ou de propriedades, por padrão considera o usuário logado tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: user: type: string description: Usuário responses: 200: description: Ok schema: type: object properties: pendencies: type: array items: type: object allOf: – #/definitions/document description: Documentos pendentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Usar listPendencies na versão 2 | DATA: 2023-04-01 | Lista os documentos pendentes, seja de revisão ou de propriedades, por padrão considera o usuário logado tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: user description: Usuário in: query type: string responses: 200: description: Ok schema: type: object properties: pendencies: type: array items: type: object allOf: – #/definitions/document description: Documentos pendentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listPendencies__2: post: description: Lista os documentos pendentes, seja de revisão ou de propriedades, por padrão considera o usuário logado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: user: type: string description: Usuario offset: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 default: 0 size: type: integer format: int64 description: Quantidade de registros por página default: 100 responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – pendenciesList properties: totalPages: type: integer format: int64 description: Total de páginas disponíveis totalElements: type: integer format: int64 description: Total de Documentos encontrados pendenciesList: type: array items: type: object allOf: – #/definitions/pendencies minimum: 1 description: Lista de documentos com pendencias 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os documentos pendentes, seja de revisão ou de propriedades, por padrão considera o usuário logado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: user description: Usuario in: query type: string – name: offset description: O número da página retornado. A primeira página corresponde ao índice 0 in: query type: integer format: int64 – name: size description: Quantidade de registros por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – pendenciesList properties: totalPages: type: integer format: int64 description: Total de páginas disponíveis totalElements: type: integer format: int64 description: Total de Documentos encontrados pendenciesList: type: array items: type: object allOf: – #/definitions/pendencies minimum: 1 description: Lista de documentos com pendencias 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/folderListPageable: post: description: Lista os documentos e pastas de forma paginada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page – size properties: id: type: string description: Id da pasta para listar (passar null se for a raiz) onlyFolders: type: boolean description: Informar true para listar somente pastas page: type: integer format: int64 description: Índice da página a ser retornada. Padrão 0. size: type: integer format: int64 description: Quantidade de itens que serão exibidos por página. orderByField: type: string allOf: – #/definitions/folderListPageableOrderByField description: Indica por qual campo os dados serão ordenados order: type: string allOf: – #/definitions/orderType description: Tipo da ordenação responses: 200: description: Ok schema: type: object required: – totalFolders – totalDocuments properties: path: type: array items: type: object allOf: – #/definitions/folderPosition description: Localização na árvore files: type: array items: type: object allOf: – #/definitions/file description: Lista de arquivos e pastas totalFolders: type: integer format: int64 description: Total de pastas encontradas totalDocuments: type: integer format: int64 description: Total de documentos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os documentos e pastas de forma paginada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Id da pasta para listar (passar null se for a raiz) in: query type: string – name: onlyFolders description: Informar true para listar somente pastas in: query type: boolean – name: page description: Índice da página a ser retornada. Padrão 0. in: query required: true type: integer format: int64 – name: size description: Quantidade de itens que serão exibidos por página. in: query required: true type: integer format: int64 – name: orderByField description: Indica por qual campo os dados serão ordenados in: query type: string allOf: – #/definitions/folderListPageableOrderByField – name: order description: Tipo da ordenação in: query type: string allOf: – #/definitions/orderType responses: 200: description: Ok schema: type: object required: – totalFolders – totalDocuments properties: path: type: array items: type: object allOf: – #/definitions/folderPosition description: Localização na árvore files: type: array items: type: object allOf: – #/definitions/file description: Lista de arquivos e pastas totalFolders: type: integer format: int64 description: Total de pastas encontradas totalDocuments: type: integer format: int64 description: Total de documentos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listValidDocumentsToSign: post: description: API DEPRECIADA: Usar listValidDocumentsToSign na versão 2 | DATA: 2024-01-12 | Lista os documentos aptos a serem enviados para assinatura eletrônica, sendo: somente arquivos PDF, publicados sem pendências ou revisão e que não estejam em outro processo de assinatura tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page – size properties: id: type: string description: Id da pasta para listar (passar null se for a raiz) page: type: integer format: int64 description: Índice da página a ser retornada. Padrão 0. size: type: integer format: int64 description: Quantidade de itens que serão exibidos por página. orderby: type: string description: Campo para ordenação sort: type: integer format: int64 description: Sentido da ordenação default: 1 responses: 200: description: Ok schema: type: object required: – totalFolders – totalDocuments properties: path: type: array items: type: object allOf: – #/definitions/folderPosition description: Localização na árvore files: type: array items: type: object allOf: – #/definitions/file description: Lista de arquivos e pastas totalFolders: type: integer format: int64 description: Total de pastas encontradas totalDocuments: type: integer format: int64 description: Total de documentos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Usar listValidDocumentsToSign na versão 2 | DATA: 2024-01-12 | Lista os documentos aptos a serem enviados para assinatura eletrônica, sendo: somente arquivos PDF, publicados sem pendências ou revisão e que não estejam em outro processo de assinatura tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: id description: Id da pasta para listar (passar null se for a raiz) in: query type: string – name: page description: Índice da página a ser retornada. Padrão 0. in: query required: true type: integer format: int64 – name: size description: Quantidade de itens que serão exibidos por página. in: query required: true type: integer format: int64 – name: orderby description: Campo para ordenação in: query type: string – name: sort description: Sentido da ordenação in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalFolders – totalDocuments properties: path: type: array items: type: object allOf: – #/definitions/folderPosition description: Localização na árvore files: type: array items: type: object allOf: – #/definitions/file description: Lista de arquivos e pastas totalFolders: type: integer format: int64 description: Total de pastas encontradas totalDocuments: type: integer format: int64 description: Total de documentos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listValidDocumentsToSign__2: post: description: Lista os documentos aptos a serem enviados para assinatura eletrônica, sendo: somente arquivos PDF, publicados sem pendências ou revisão e que não estejam em outro processo de assinatura tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: id: type: string description: Id da pasta para listar (passar null se for a raiz) showSubfolderFiles: type: boolean description: Mostrar todos documentos das subpastas page: type: integer format: int64 description: Index de início da busca default: 0 size: type: integer format: int64 description: Tamanho da busca minimum: 1 maximum: 50 responses: 200: description: Ok schema: type: object required: – files – totalDocuments properties: files: type: array items: type: object allOf: – #/definitions/validDocumentToSign minimum: 1 description: Lista de arquivos e pastas totalDocuments: type: integer format: int64 description: Total de documentos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os documentos aptos a serem enviados para assinatura eletrônica, sendo: somente arquivos PDF, publicados sem pendências ou revisão e que não estejam em outro processo de assinatura tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Id da pasta para listar (passar null se for a raiz) in: query type: string – name: showSubfolderFiles description: Mostrar todos documentos das subpastas in: query type: boolean – name: page description: Index de início da busca in: query type: integer format: int64 – name: size description: Tamanho da busca in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – files – totalDocuments properties: files: type: array items: type: object allOf: – #/definitions/validDocumentToSign minimum: 1 description: Lista de arquivos e pastas totalDocuments: type: integer format: int64 description: Total de documentos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/requestDocumentVersionDownload: post: description: Solicita uma url para download do arquivo de uma determinada versão de documento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – documentVersionId properties: documentVersionId: type: string description: Identificador da versão do documento preview: type: boolean description: Indica se deve busca a versão de pré visualização default: false responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url disponível para download 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do documento 404: description: Documento não encontrado default: description: Error response schema: #/definitions/genericError get: description: Solicita uma url para download do arquivo de uma determinada versão de documento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: documentVersionId description: Identificador da versão do documento in: query required: true type: string – name: preview description: Indica se deve busca a versão de pré visualização in: query type: boolean responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url disponível para download 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do documento 404: description: Documento não encontrado default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/requestDocumentDownload: post: description: Solicita uma url para download do arquivo do documento versão publicada tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: Identificador do documento preview: type: boolean description: Indica se deve busca a versão de pré visualização default: false responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url disponível para download 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do documento 404: description: Documento não encontrado default: description: Error response schema: #/definitions/genericError get: description: Solicita uma url para download do arquivo do documento versão publicada tags: – Queries x-senior-visibility: PUBLIC parameters: – name: documentId description: Identificador do documento in: query required: true type: string – name: preview description: Indica se deve busca a versão de pré visualização in: query type: boolean responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url disponível para download 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do documento 404: description: Documento não encontrado default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/searchDocument: post: description: Pesquisa documentos e pastas com base em uma string tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – searchTerm properties: searchTerm: type: string description: O valor a ser pesquisado offset: type: integer format: int64 description: Index de início da busca default: 0 size: type: integer format: int64 description: Tamanho da busca default: 10 filterType: type: string allOf: – #/definitions/filterType description: Filtro por tipo responses: 200: description: Ok schema: type: object required: – totalElements – totalPages properties: totalElements: type: integer format: int64 description: Total de elementos encontrados totalPages: type: integer format: int64 description: Total de paginas disponiveis searchResult: type: array items: type: object allOf: – #/definitions/searchResult description: Documentos/pastas encontradas na busca 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Pesquisa documentos e pastas com base em uma string tags: – Queries x-senior-visibility: PUBLIC parameters: – name: searchTerm description: O valor a ser pesquisado in: query required: true type: string – name: offset description: Index de início da busca in: query type: integer format: int64 – name: size description: Tamanho da busca in: query type: integer format: int64 – name: filterType description: Filtro por tipo in: query type: string allOf: – #/definitions/filterType responses: 200: description: Ok schema: type: object required: – totalElements – totalPages properties: totalElements: type: integer format: int64 description: Total de elementos encontrados totalPages: type: integer format: int64 description: Total de paginas disponiveis searchResult: type: array items: type: object allOf: – #/definitions/searchResult description: Documentos/pastas encontradas na busca 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/searchDocumentByProperties: post: description: Pesquisa documentos e pastas com base nas propriedades tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Index de início da busca default: 0 size: type: integer format: int64 description: Tamanho da busca minimum: 1 default: 100 filterType: type: string allOf: – #/definitions/filterType description: Filtro por tipo documentName: type: string description: Nome do documento authorName: type: string description: Nome do autor signatureStatus: type: string allOf: – #/definitions/signatureStatus description: Status da assinatura initialDate: type: string format: date description: Data inicial finalDate: type: string format: date description: Data final expInitialDate: type: string format: date description: Data inicial expedição expFinalDate: type: string format: date description: Data final expedição obsInitialDate: type: string format: date description: Data inicial obsolescência obsFinalDate: type: string format: date description: Data final obsolescência fileType: type: string allOf: – #/definitions/mimetypeFilter description: Tipo de documento folderId: type: string description: Id da pasta includeSubfolders: type: boolean description: Incluir subPasta default: false responses: 200: description: Ok schema: type: object required: – totalElements – totalPages properties: totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas disponíveis searchResult: type: array items: type: object allOf: – #/definitions/searchResult description: Documentos/pastas encontradas na busca 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Pesquisa documentos e pastas com base nas propriedades tags: – Queries x-senior-visibility: PUBLIC parameters: – name: offset description: Index de início da busca in: query type: integer format: int64 – name: size description: Tamanho da busca in: query type: integer format: int64 – name: filterType description: Filtro por tipo in: query type: string allOf: – #/definitions/filterType – name: documentName description: Nome do documento in: query type: string – name: authorName description: Nome do autor in: query type: string – name: signatureStatus description: Status da assinatura in: query type: string allOf: – #/definitions/signatureStatus – name: initialDate description: Data inicial in: query type: string format: date – name: finalDate description: Data final in: query type: string format: date – name: expInitialDate description: Data inicial expedição in: query type: string format: date – name: expFinalDate description: Data final expedição in: query type: string format: date – name: obsInitialDate description: Data inicial obsolescência in: query type: string format: date – name: obsFinalDate description: Data final obsolescência in: query type: string format: date – name: fileType description: Tipo de documento in: query type: string allOf: – #/definitions/mimetypeFilter – name: folderId description: Id da pasta in: query type: string – name: includeSubfolders description: Incluir subPasta in: query type: boolean responses: 200: description: Ok schema: type: object required: – totalElements – totalPages properties: totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas disponíveis searchResult: type: array items: type: object allOf: – #/definitions/searchResult description: Documentos/pastas encontradas na busca 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/validateDocumentVersionName: post: description: Valida se existe versao de documento com o nome pesquisado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – versionName – documentId properties: versionName: type: string description: Nome da versao do document documentId: type: string description: Identificador do documento responses: 200: description: Ok schema: type: object required: – valid properties: valid: type: boolean description: Boolean que indica se o nome é valido 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Valida se existe versao de documento com o nome pesquisado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: versionName description: Nome da versao do document in: query required: true type: string – name: documentId description: Identificador do documento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – valid properties: valid: type: boolean description: Boolean que indica se o nome é valido 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getDocumentViewUrl: post: description: Retorna o link de visualização de um documento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: Identificador do documento embedded: type: boolean description: Se o link deve ser montado considerando a view da plataforma default: true responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Url para visualização do documento 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Documento não encontrado default: description: Error response schema: #/definitions/genericError get: description: Retorna o link de visualização de um documento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: documentId description: Identificador do documento in: query required: true type: string – name: embedded description: Se o link deve ser montado considerando a view da plataforma in: query type: boolean responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Url para visualização do documento 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Documento não encontrado default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getDocumentUrlByVersion: post: description: Retorna o link de visualização de um documento através do documentVersionId tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentVersionId properties: documentVersionId: type: string description: Identificador da versão do documento embedded: type: boolean description: Se o link deve ser montado considerando a view da plataforma default: true responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Url para visualização do documento 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Documento não encontrado default: description: Error response schema: #/definitions/genericError get: description: Retorna o link de visualização de um documento através do documentVersionId tags: – Queries x-senior-visibility: PRIVATE parameters: – name: documentVersionId description: Identificador da versão do documento in: query required: true type: string – name: embedded description: Se o link deve ser montado considerando a view da plataforma in: query type: boolean responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Url para visualização do documento 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Documento não encontrado default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getFolderUrl: post: description: Retorna o link de visualização de uma pasta tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – folderId properties: folderId: type: string description: Identificador da pasta embedded: type: boolean description: Se o link deve ser montado considerando a view da plataforma default: true responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Url para visualização da pasta 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Pasta não encontrado default: description: Error response schema: #/definitions/genericError get: description: Retorna o link de visualização de uma pasta tags: – Queries x-senior-visibility: PUBLIC parameters: – name: folderId description: Identificador da pasta in: query required: true type: string – name: embedded description: Se o link deve ser montado considerando a view da plataforma in: query type: boolean responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Url para visualização da pasta 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Pasta não encontrado default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getDocumentVersions: post: description: Retorna todas as versões de um documento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: Id do documento a ser verificado auditing: type: boolean description: Se deve considerar versões minor e patch do documento para auditoria default: false responses: 200: description: Ok schema: type: object required: – documentVersions properties: documentVersions: type: array items: type: object allOf: – #/definitions/documentVersionInfo minimum: 1 description: Versões do documento 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do documento 404: description: Documento não encontrado default: description: Error response schema: #/definitions/genericError get: description: Retorna todas as versões de um documento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: documentId description: Id do documento a ser verificado in: query required: true type: string – name: auditing description: Se deve considerar versões minor e patch do documento para auditoria in: query type: boolean responses: 200: description: Ok schema: type: object required: – documentVersions properties: documentVersions: type: array items: type: object allOf: – #/definitions/documentVersionInfo minimum: 1 description: Versões do documento 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do documento 404: description: Documento não encontrado default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getUser: post: description: Obtém informações a respeito de um determinado usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: username: type: string description: Nome do usuário no formato nome@dominio_tenant responses: 200: description: Ok schema: type: object required: – user properties: user: type: object allOf: – #/definitions/user description: Usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém informações a respeito de um determinado usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: username description: Nome do usuário no formato nome@dominio_tenant in: query type: string responses: 200: description: Ok schema: type: object required: – user properties: user: type: object allOf: – #/definitions/user description: Usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listUsers: post: description: Lista os usuários da plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: Termo para buscar nos campos nome, nome completo e e-mail pageNumber: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 default: 0 pageSize: type: integer format: int64 description: Quantidade de registros por página default: 10 responses: 200: description: Ok schema: type: object required: – users – total properties: users: type: array items: type: object allOf: – #/definitions/user minimum: 1 description: Usuários encontrados total: type: integer format: int64 description: Quantidade total de usuários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os usuários da plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchValue description: Termo para buscar nos campos nome, nome completo e e-mail in: query type: string – name: pageNumber description: O número da página retornado. A primeira página corresponde ao índice 0 in: query type: integer format: int64 – name: pageSize description: Quantidade de registros por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – users – total properties: users: type: array items: type: object allOf: – #/definitions/user minimum: 1 description: Usuários encontrados total: type: integer format: int64 description: Quantidade total de usuários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listUsersFilteringByNames: post: description: Lista os usuários da plataforma filtrando através do nome tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: userNames: type: array items: type: string description: lista de nomes dos usuários no formato nome@dominio_tenant pageNumber: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 default: 0 pageSize: type: integer format: int64 description: Quantidade de registros por página default: 10 responses: 200: description: Ok schema: type: object required: – users properties: users: type: array items: type: object allOf: – #/definitions/user minimum: 1 description: Lista de usuários encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listGroups: post: description: Lista os grupos da plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado no nome do grupo pageNumber: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 default: 0 pageSize: type: integer format: int64 description: Quantidade de registros por página default: 10 responses: 200: description: Ok schema: type: object required: – groups – total properties: groups: type: array items: type: object allOf: – #/definitions/group minimum: 1 description: Grupos encontrados total: type: integer format: int64 description: Quantidade total de grupos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os grupos da plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchValue description: O valor a ser pesquisado no nome do grupo in: query type: string – name: pageNumber description: O número da página retornado. A primeira página corresponde ao índice 0 in: query type: integer format: int64 – name: pageSize description: Quantidade de registros por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – groups – total properties: groups: type: array items: type: object allOf: – #/definitions/group minimum: 1 description: Grupos encontrados total: type: integer format: int64 description: Quantidade total de grupos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listRoles: post: description: Lista os papéis da plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado no nome dos papéis pageNumber: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 default: 0 pageSize: type: integer format: int64 description: Quantidade de registros por página default: 10 responses: 200: description: Ok schema: type: object required: – roles – total properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Papéis encontrados total: type: integer format: int64 description: Quantidade total de papéis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os papéis da plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchValue description: O valor a ser pesquisado no nome dos papéis in: query type: string – name: pageNumber description: O número da página retornado. A primeira página corresponde ao índice 0 in: query type: integer format: int64 – name: pageSize description: Quantidade de registros por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – roles – total properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Papéis encontrados total: type: integer format: int64 description: Quantidade total de papéis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getDocumentVersionSubjects: post: description: Obtém os assuntos de uma versão de um document tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – documentVersionId properties: documentVersionId: type: string description: Identificador da versão do documento responses: 200: description: Ok schema: type: object required: – subjects properties: subjects: type: array items: type: object allOf: – #/definitions/subject minimum: 1 description: Assuntos da versão do documento 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Documento não encontrado default: description: Error response schema: #/definitions/genericError get: description: Obtém os assuntos de uma versão de um document tags: – Queries x-senior-visibility: PUBLIC parameters: – name: documentVersionId description: Identificador da versão do documento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – subjects properties: subjects: type: array items: type: object allOf: – #/definitions/subject minimum: 1 description: Assuntos da versão do documento 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Documento não encontrado default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/verifyDocumentPermissions: post: description: Permite verificar se o usuário corrente possui determinadas permissões no documento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – documentId – permissionsType properties: documentId: type: string description: Id do documento permissionsType: type: array items: type: string allOf: – #/definitions/permissionType minimum: 1 description: Tipo da permissão responses: 200: description: Ok schema: type: object required: – permissions properties: permissions: type: array items: type: object allOf: – #/definitions/verifiedPermission minimum: 1 description: Permissões verificadas 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Documento não encontrado default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/hasFolderPermission: post: description: Permite verificar se o usuário corrente possui alguma permisssão na pasta tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – folderId – permissionsType properties: folderId: type: string description: Id do pasta permissionsType: type: array items: type: string allOf: – #/definitions/permissionType minimum: 1 description: Tipos de permissões à serem verificadas responses: 200: description: Ok schema: type: object required: – hasPermission properties: hasPermission: type: boolean description: Possui permissão 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Diretório não encontrado default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getEnvelopeHistory: post: description: Retorna o histórico de acontecimentos sobre um envelope tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope de assinatura responses: 200: description: Ok schema: type: object required: – signer – envelopeTimeline properties: sendDateToSign: type: string format: date-time description: Data de envio para a assinatura sendEmail: type: boolean description: Envio de e-mail habilitado signer: type: array items: type: object allOf: – #/definitions/signerHistory minimum: 1 description: Histórico do assinante envelopeTimeline: type: array items: type: object allOf: – #/definitions/envelopeTimelineRecord minimum: 1 description: Timeline do envelope 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Envelope não encontrado default: description: Error response schema: #/definitions/genericError get: description: Retorna o histórico de acontecimentos sobre um envelope tags: – Queries x-senior-visibility: PRIVATE parameters: – name: envelopeId description: Id do envelope de assinatura in: query required: true type: string responses: 200: description: Ok schema: type: object required: – signer – envelopeTimeline properties: sendDateToSign: type: string format: date-time description: Data de envio para a assinatura sendEmail: type: boolean description: Envio de e-mail habilitado signer: type: array items: type: object allOf: – #/definitions/signerHistory minimum: 1 description: Histórico do assinante envelopeTimeline: type: array items: type: object allOf: – #/definitions/envelopeTimelineRecord minimum: 1 description: Timeline do envelope 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Envelope não encontrado default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listSignatures: post: description: API DEPRECIADA: Usar listSignatures na versão 2 | DATA: 2024-12-02 | Lista as assinaturas de acordo com filtro tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/signatureManagementFilterPaginationDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/signaturePageableDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listSignatures__2: post: description: Lista as assinaturas de acordo com filtro V2 tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/listSignaturesFilter description: Filtro para o relatório size: type: integer format: int64 description: Quantidade de registro por página default: 10 offset: type: integer format: int64 description: Página default: 0 orderByField: type: string allOf: – #/definitions/listSignaturesOrderByField description: Indica por qual campo os dados serão ordenados order: type: string allOf: – #/definitions/orderType description: Tipo da ordenação responses: 200: description: Ok schema: type: object allOf: – #/definitions/signaturePageable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listSignaturesDocuments: post: description: API DEPRECIADA: Usar listSignaturesDocuments na versão 2 | DATA: 2024-12-02 | Lista os documentos de acordo com o filtro tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/signatureManagementFilterPaginationDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/signaturePageableDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listSignaturesDocuments__2: post: description: Lista os documentos de acordo com o filtro V2 tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/listSignaturesDocumentsFilter description: Filtro para o relatório size: type: integer format: int64 description: Quantidade de registro por página default: 10 offset: type: integer format: int64 description: Página default: 0 orderByField: type: string allOf: – #/definitions/listSignaturesOrderByField description: Indica por qual campo os dados serão ordenados order: type: string allOf: – #/definitions/orderType description: Tipo da ordenação responses: 200: description: Ok schema: type: object allOf: – #/definitions/signaturePageable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getNumberOfEnvelopesByStatus: post: description: API DEPRECIADA: Usar getNumberOfEnvelopesByStatus na versão 2 | DATA: 2024-12-02 | Retorna o número de envelopes por status tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/signatureManagementFilterDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/numberOfEnvelopesByStatusDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getNumberOfEnvelopesByStatus__2: post: description: Retorna o número de envelopes por status V2 tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getNumberOfEnvelopesByStatusFilter responses: 200: description: Ok schema: type: object allOf: – #/definitions/numberOfEnvelopesByStatusDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o número de envelopes por status V2 tags: – Queries x-senior-visibility: PRIVATE parameters: – name: initialDate description: Data inicial obrigatória in: query required: true type: string format: date – name: finalDate description: Data final obrigatória in: query required: true type: string format: date – name: createdBy description: E-mail do solicitante in: query type: string – name: folderId description: Identificador da pasta in: query type: string – name: includeSubfolders description: Incluir sub-pastas in: query type: boolean – name: documentName description: Nome do documento in: query type: string – name: envelopeName description: Nome do envelope in: query type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/numberOfEnvelopesByStatusDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getNumberOfSignaturesByStatus: post: description: API DEPRECIADA: Usar getNumberOfSignaturesByStatus na versão 2 | DATA: 2024-12-02 | Retorna o número de assinaturas por status tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/signatureManagementFilterDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/numberOfSignaturesByStatusDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getNumberOfSignaturesByStatus__2: post: description: Retorna o número de assinaturas por status V2 tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getNumberOfSignaturesByStatusFilter responses: 200: description: Ok schema: type: object allOf: – #/definitions/numberOfSignaturesByStatusDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o número de assinaturas por status V2 tags: – Queries x-senior-visibility: PRIVATE parameters: – name: initialDate description: Data inicial obrigatória in: query required: true type: string format: date – name: finalDate description: Data final obrigatória in: query required: true type: string format: date – name: createdBy description: E-mail do solicitante in: query type: string – name: folderId description: Identificador da pasta in: query type: string – name: includeSubfolders description: Incluir sub-pastas in: query type: boolean – name: documentName description: Nome do documento in: query type: string – name: envelopeName description: Nome do envelope in: query type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/numberOfSignaturesByStatusDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getReportNumberOfEnvelopesByRequester: post: description: Retorna o número de envelopes de acordo com o solicitante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/filterReportByRequester description: Filtro para o relatório size: type: integer format: int64 description: Quantidade de registro por página default: 10 offset: type: integer format: int64 description: Página default: 0 orderByField: type: string allOf: – #/definitions/envelopesRequesterOrderByField description: Indica por qual campo os dados serão ordenados order: type: string allOf: – #/definitions/orderType description: Tipo da ordenação responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de registros contents: type: array items: type: object allOf: – #/definitions/reportNumberOfEnvelopesByRequester minimum: 1 description: Dados dos envelopes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/countListEnvelopes: post: description: Retorna o número de assinaturas por status tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: envelopeName: type: string description: Nome do envelope createdDate: type: string description: Data de criação responses: 200: description: Ok schema: type: object required: – draft – finished – expired – canceled – in_progress – total properties: draft: type: integer format: int64 description: Quantidade em rascunho finished: type: integer format: int64 description: Quantidade finalizados expired: type: integer format: int64 description: Quantidade expirados canceled: type: integer format: int64 description: Quantidade cancelados in_progress: type: integer format: int64 description: Quantidade em progresso total: type: integer format: int64 description: Quantidade total 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o número de assinaturas por status tags: – Queries x-senior-visibility: PRIVATE parameters: – name: envelopeName description: Nome do envelope in: query type: string – name: createdDate description: Data de criação in: query type: string responses: 200: description: Ok schema: type: object required: – draft – finished – expired – canceled – in_progress – total properties: draft: type: integer format: int64 description: Quantidade em rascunho finished: type: integer format: int64 description: Quantidade finalizados expired: type: integer format: int64 description: Quantidade expirados canceled: type: integer format: int64 description: Quantidade cancelados in_progress: type: integer format: int64 description: Quantidade em progresso total: type: integer format: int64 description: Quantidade total 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getConectorEnvelope: post: description: Retorna os conectores do envelope draft tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: ID do envelope draft responses: 200: description: Ok schema: type: object required: – conectors properties: conectors: type: array items: type: object allOf: – #/definitions/conector minimum: 1 description: Conectores do envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os conectores do envelope draft tags: – Queries x-senior-visibility: PRIVATE parameters: – name: envelopeId description: ID do envelope draft in: query required: true type: string responses: 200: description: Ok schema: type: object required: – conectors properties: conectors: type: array items: type: object allOf: – #/definitions/conector minimum: 1 description: Conectores do envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getConectorEnvelopeSignature: post: description: Retorna os conectores do envelope tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: ID do envelope signature responses: 200: description: Ok schema: type: object required: – conectors properties: conectors: type: array items: type: object allOf: – #/definitions/conector minimum: 1 description: Conectores do envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os conectores do envelope tags: – Queries x-senior-visibility: PRIVATE parameters: – name: envelopeId description: ID do envelope signature in: query required: true type: string responses: 200: description: Ok schema: type: object required: – conectors properties: conectors: type: array items: type: object allOf: – #/definitions/conector minimum: 1 description: Conectores do envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getConectors: post: description: Retorna os conectores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – categoryIds properties: categoryIds: type: array items: type: string minimum: 1 description: Lista com os ids das categorias dos conectores, ou vazio para todos os conectores name: type: string description: Filtra os conectores pelo name responses: 200: description: Ok schema: type: object required: – conectors properties: conectors: type: array items: type: object allOf: – #/definitions/conectorRecord minimum: 1 description: Lista com os conectores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getCategories: post: description: Retorna as categorias 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: contents: type: array items: type: object allOf: – #/definitions/conectorCategoryData description: Lista com os conectores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as categorias de conectores tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object properties: contents: type: array items: type: object allOf: – #/definitions/conectorCategoryData description: Lista com os conectores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getConector: post: description: Retorna as informações sobre um conector tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do conector responses: 200: description: Ok schema: type: object required: – templates properties: categories: type: array items: type: object allOf: – #/definitions/conectorCategoryData description: Lista de categorias do conector conector: type: object allOf: – #/definitions/conectorRecord description: Informações sobre o conector inputs: type: array items: type: object allOf: – #/definitions/conectorInputCompleteData description: Informações sobre os inputs do conector assignments: type: array items: type: object allOf: – #/definitions/assignmentRecord description: Atribuidor templates: type: array items: type: object allOf: – #/definitions/conectorTemplateRecord minimum: 1 description: Templates 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações sobre um conector tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Id do conector in: query required: true type: string responses: 200: description: Ok schema: type: object required: – templates properties: categories: type: array items: type: object allOf: – #/definitions/conectorCategoryData description: Lista de categorias do conector conector: type: object allOf: – #/definitions/conectorRecord description: Informações sobre o conector inputs: type: array items: type: object allOf: – #/definitions/conectorInputCompleteData description: Informações sobre os inputs do conector assignments: type: array items: type: object allOf: – #/definitions/assignmentRecord description: Atribuidor templates: type: array items: type: object allOf: – #/definitions/conectorTemplateRecord minimum: 1 description: Templates 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getConectorDefaultInputValue: post: description: Retorna os valores padrões do input de um conector tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: size: type: integer format: int64 description: Quantidade de itens que serão exibidos por página. Padrão 1 default: 1 offset: type: integer format: int64 description: Índice da página a ser retornada. Padrão 0. default: 0 filterType: type: string description: Tipo de filtro para busca filter: type: string description: Filtro para busca responses: 200: description: Ok schema: type: object properties: contents: type: array items: type: object allOf: – #/definitions/defaultInputConectorValueData description: Conteúdo retornado na busca totalElements: type: integer format: int64 description: Quantidade total de elementos encontrados totalPages: type: integer format: int64 description: Quantidade total de páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os valores padrões do input de um conector tags: – Queries x-senior-visibility: PRIVATE parameters: – name: size description: Quantidade de itens que serão exibidos por página. Padrão 1 in: query type: integer format: int64 – name: offset description: Índice da página a ser retornada. Padrão 0. in: query type: integer format: int64 – name: filterType description: Tipo de filtro para busca in: query type: string – name: filter description: Filtro para busca in: query type: string responses: 200: description: Ok schema: type: object properties: contents: type: array items: type: object allOf: – #/definitions/defaultInputConectorValueData description: Conteúdo retornado na busca totalElements: type: integer format: int64 description: Quantidade total de elementos encontrados totalPages: type: integer format: int64 description: Quantidade total de páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/saveConectorDefaultInputValue: post: description: Salva os valores padrões do input de um conector tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: conectorInputId: type: string description: Id do input do conector inputDefaultValue: type: string description: Valor atribuído ao input do conector responses: 200: description: Ok schema: type: object properties: conectorInputId: type: string description: Id do input do conector createdBy: type: string description: Autor da informação do input createdDate: type: string format: date-time description: Data de criação id: type: string description: Id da informação contida no input inputDefaultValue: type: string description: Valor padrão do input lastModifiedBy: type: string description: Autor da última modificação lastModifiedDate: type: string format: date-time description: Data da última modificação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Salva os valores padrões do input de um conector tags: – Queries x-senior-visibility: PRIVATE parameters: – name: conectorInputId description: Id do input do conector in: query type: string – name: inputDefaultValue description: Valor atribuído ao input do conector in: query type: string responses: 200: description: Ok schema: type: object properties: conectorInputId: type: string description: Id do input do conector createdBy: type: string description: Autor da informação do input createdDate: type: string format: date-time description: Data de criação id: type: string description: Id da informação contida no input inputDefaultValue: type: string description: Valor padrão do input lastModifiedBy: type: string description: Autor da última modificação lastModifiedDate: type: string format: date-time description: Data da última modificação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/updateConectorDefaultInputValue: post: description: Salva os valores padrões do input de um conector tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da informação contida no input conectorInputId: type: string description: Id do input do conector inputDefaultValue: type: string description: Valor atribuído ao input do conector responses: 200: description: Ok schema: type: object properties: conectorInputId: type: string description: Id do input do conector createdBy: type: string description: Autor da informação do input createdDate: type: string format: date-time description: Data de criação id: type: string description: Id da informação contida no input inputDefaultValue: type: string description: Valor padrão do input lastModifiedBy: type: string description: Autor da última modificação lastModifiedDate: type: string format: date-time description: Data da última modificação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Salva os valores padrões do input de um conector tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Id da informação contida no input in: query required: true type: string – name: conectorInputId description: Id do input do conector in: query type: string – name: inputDefaultValue description: Valor atribuído ao input do conector in: query type: string responses: 200: description: Ok schema: type: object properties: conectorInputId: type: string description: Id do input do conector createdBy: type: string description: Autor da informação do input createdDate: type: string format: date-time description: Data de criação id: type: string description: Id da informação contida no input inputDefaultValue: type: string description: Valor padrão do input lastModifiedBy: type: string description: Autor da última modificação lastModifiedDate: type: string format: date-time description: Data da última modificação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listEnvelopes: post: description: Lista os envelopes e rascunhos do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Índice da página a ser retornada. Padrão 0. default: 0 limit: type: integer format: int64 description: Quantidade de itens que serão exibidos por página. Padrão 10. default: 10 envelopeName: type: string description: Nome do envelope a ser utilizado no filtro status: type: string allOf: – #/definitions/envelopeDraftStatusType description: Situação do envelope a ser utilizado no filtro createdDate: type: string description: Data de criação do envelope a ser utilizado no filtro orderByField: type: string allOf: – #/definitions/orderByField description: Indica por qual campo os dados serão ordenados order: type: string allOf: – #/definitions/orderType description: Tipo da ordenação responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/envelopeDTO minimum: 1 description: Lista de envelopes encontrados totalElements: type: integer format: int64 description: Total de envelopes encontrados totalPages: type: integer format: int64 description: Total de páginas disponíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os envelopes e rascunhos do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Índice da página a ser retornada. Padrão 0. in: query type: integer format: int64 – name: limit description: Quantidade de itens que serão exibidos por página. Padrão 10. in: query type: integer format: int64 – name: envelopeName description: Nome do envelope a ser utilizado no filtro in: query type: string – name: status description: Situação do envelope a ser utilizado no filtro in: query type: string allOf: – #/definitions/envelopeDraftStatusType – name: createdDate description: Data de criação do envelope a ser utilizado no filtro in: query type: string – name: orderByField description: Indica por qual campo os dados serão ordenados in: query type: string allOf: – #/definitions/orderByField – name: order description: Tipo da ordenação in: query type: string allOf: – #/definitions/orderType responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/envelopeDTO minimum: 1 description: Lista de envelopes encontrados totalElements: type: integer format: int64 description: Total de envelopes encontrados totalPages: type: integer format: int64 description: Total de páginas disponíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getSubjectDocument: post: description: Retorna os assuntos de um documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentVersionId properties: documentVersionId: type: string description: Id da versao do documento responses: 200: description: Ok schema: type: object required: – subjectList properties: subjectList: type: array items: type: string minimum: 1 description: Lista de assuntos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os assuntos de um documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: documentVersionId description: Id da versao do documento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – subjectList properties: subjectList: type: array items: type: string minimum: 1 description: Lista de assuntos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getEnvelopeDocumentLimit: post: description: Retorna o valor da propriedade de limite de documentos em um envelope tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – envelopeDocumentLimit properties: envelopeDocumentLimit: type: integer format: int64 description: Limite de documentos no envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o valor da propriedade de limite de documentos em um envelope tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – envelopeDocumentLimit properties: envelopeDocumentLimit: type: integer format: int64 description: Limite de documentos no envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getDuplicatedNames: post: description: Verifica se já existe um documento com o mesmo título tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentTitleList properties: documentTitleList: type: array items: type: string minimum: 1 description: Lista com títulos dos documentos parentId: type: string description: Identificador da pasta responses: 200: description: Ok schema: type: object required: – hasDuplicated properties: documentNameList: type: array items: type: string description: Lista de títulos duplicados hasDuplicated: type: boolean description: Se o título do documento já existe 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Status do documento não encontrado default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getDocumentsByDocumentVersionFromProcessPdf: post: description: Retorna os documentos com base na lista de ids da versão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – versionIds properties: versionIds: type: array items: type: string minimum: 1 description: Id da versão públicada responses: 200: description: Ok schema: type: object required: – documents properties: documents: type: array items: type: object allOf: – #/definitions/documentFromProcessPdf minimum: 1 description: Documentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getDownloadBulkPresignedUrl: post: description: Obtem Presigned Url para download de arquivos em lote tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: nome do arquivo responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: endereco para download 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtem Presigned Url para download de arquivos em lote tags: – Queries x-senior-visibility: PRIVATE parameters: – name: fileName description: nome do arquivo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: endereco para download 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getDocumentsFieldsByDocumentVersion: post: description: Retorna os campos do formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – versionId properties: versionId: type: string description: Id da versão publicada email: type: string description: email do assinante responses: 200: description: Ok schema: type: object required: – contextId – fields – originalWidth – originalHeight properties: contextId: type: string description: Retorna o id de contexto fields: type: string description: Campos originalWidth: type: number format: double description: Largura original do documento originalHeight: type: number format: double description: Altura original do documento default: description: Error response schema: #/definitions/genericError get: description: Retorna os campos do formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: versionId description: Id da versão publicada in: query required: true type: string – name: email description: email do assinante in: query type: string responses: 200: description: Ok schema: type: object required: – contextId – fields – originalWidth – originalHeight properties: contextId: type: string description: Retorna o id de contexto fields: type: string description: Campos originalWidth: type: number format: double description: Largura original do documento originalHeight: type: number format: double description: Altura original do documento default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getPdfContextFieldsValuesByDocumentVersion: post: description: Retorna os campos preenchidos do formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – versionId properties: id: type: string description: Id do contexto versionId: type: string description: Id da versão públicada do documento fieldsIds: type: array items: type: string description: Id do campo responses: 200: description: Ok schema: type: object required: – contextPdfFieldValue properties: contextPdfFieldValue: type: array items: type: object allOf: – #/definitions/contextPdfFieldValue minimum: 1 description: Valores dos campos resultantes default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getPdfContextFieldsValuesByESignature: post: description: Retorna os valores e campos preenchidos do formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – versionId properties: versionId: type: string description: Id da versão públicada do documento responses: 200: description: Ok schema: type: object required: – documentFromProcessPdf properties: documentFromProcessPdf: type: object allOf: – #/definitions/documentFromProcessPdf description: Valores e campos resultantes default: description: Error response schema: #/definitions/genericError get: description: Retorna os valores e campos preenchidos do formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: versionId description: Id da versão públicada do documento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – documentFromProcessPdf properties: documentFromProcessPdf: type: object allOf: – #/definitions/documentFromProcessPdf description: Valores e campos resultantes default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getEnvelopeAssignments: post: description: Consulta as informações de documentos assinados por processId tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: string description: Id do processo de assinatura statusFilter: type: array items: type: string allOf: – #/definitions/signerStatusFilter description: Filtro por status offset: type: integer format: int64 description: Índice da página a ser retornada. Padrão 0. default: 0 size: type: integer format: int64 description: Quantidade de itens que serão exibidos por página. Padrão 10. default: 10 responses: 200: description: Ok schema: type: object required: – processId – documentTitles – assignments – totalElements – totalPages properties: processId: type: string description: Id do processo de assinatura documentTitles: type: array items: type: string minimum: 1 description: Nome do documento signatureStatus: type: string allOf: – #/definitions/signatureStatus description: Status assinaturas envelopeStatus: type: string description: Status Envelope assignments: type: array items: type: object allOf: – #/definitions/userSignatureDTO minimum: 1 description: Assinaturas totalElements: type: integer format: int64 description: Total de elementos encontrados totalPages: type: integer format: int64 description: Total de páginas disponíveis default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getDocumentAssignments: post: description: Consulta as informações de documentos assinados por document version tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: documentVersion: type: string description: Versão do documento statusFilter: type: array items: type: string allOf: – #/definitions/signerStatusFilter description: Filtro por status responses: 200: description: Ok schema: type: object required: – processId – assignments properties: processId: type: string description: Id do processo de assinatura signatureStatus: type: string allOf: – #/definitions/signatureStatus description: Status assinaturas envelopeStatus: type: string description: Status Envelope assignments: type: array items: type: object allOf: – #/definitions/userSignatureDTO minimum: 1 description: Assinaturas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getEnvelopeTemplateDefault: post: description: Buscar template padrão de envelope tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – envelopeTemplate properties: envelopeTemplate: type: object allOf: – #/definitions/envelopeTemplate description: Template padrão de envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Buscar template padrão de envelope tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – envelopeTemplate properties: envelopeTemplate: type: object allOf: – #/definitions/envelopeTemplate description: Template padrão de envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getMaxIntervaldateReport: post: description: Retorna o valor da propriedade de limite máximo do intervalo de datas para busca dos relatórios na Gestão de assinaturas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – maxIntervaldateReport properties: maxIntervaldateReport: type: integer format: int64 description: Limite máximo do intervalo de datas para busca dos relatórios 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o valor da propriedade de limite máximo do intervalo de datas para busca dos relatórios na Gestão de assinaturas tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – maxIntervaldateReport properties: maxIntervaldateReport: type: integer format: int64 description: Limite máximo do intervalo de datas para busca dos relatórios 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listFavoritesByUser: post: description: Lista os favoritos do usuário logado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Index de início da busca default: 0 size: type: integer format: int64 description: Quantidade de registros por página default: 5 sortField: type: string allOf: – #/definitions/listFavoritesOrderByField description: Campo para ordenação sortOrder: type: string allOf: – #/definitions/orderType description: Sentido da ordenação responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: userFavorites: type: array items: type: object allOf: – #/definitions/userFavorite description: Lista de favoritos do usuário totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os favoritos do usuário logado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Index de início da busca in: query type: integer format: int64 – name: size description: Quantidade de registros por página in: query type: integer format: int64 – name: sortField description: Campo para ordenação in: query type: string allOf: – #/definitions/listFavoritesOrderByField – name: sortOrder description: Sentido da ordenação in: query type: string allOf: – #/definitions/orderType responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: userFavorites: type: array items: type: object allOf: – #/definitions/userFavorite description: Lista de favoritos do usuário totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getFavoritesByFolderIds: post: description: Retorna as pastas favoritadas a partir da lista de ids recebida tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – folderIds properties: folderIds: type: array items: type: string minimum: 1 description: Lista de ids de pastas responses: 200: description: Ok schema: type: object properties: userFavorites: type: array items: type: object allOf: – #/definitions/userFavorite description: Lista dos favoritos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getDocumentTracking: post: description: Buscar visualizações do documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: Identificador do documento responses: 200: description: Ok schema: type: object required: – trackings properties: trackings: type: array items: type: object allOf: – #/definitions/documentTrackingDTO minimum: 1 description: Lista de rastreio do documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Buscar visualizações do documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: documentId description: Identificador do documento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – trackings properties: trackings: type: array items: type: object allOf: – #/definitions/documentTrackingDTO minimum: 1 description: Lista de rastreio do documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getEnvelopeSignerStatus: post: description: Buscar status assinatura de um envelope de um usuário tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – envelopeId – email properties: envelopeId: type: string description: Identificador do envelope email: type: string description: Email do signatário responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/userSignStatus description: Status de assinatura do signatário no envelope default: description: Error response schema: #/definitions/genericError get: description: Buscar status assinatura de um envelope de um usuário tags: – Queries x-senior-visibility: PUBLIC parameters: – name: envelopeId description: Identificador do envelope in: query required: true type: string – name: email description: Email do signatário in: query required: true type: string responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/userSignStatus description: Status de assinatura do signatário no envelope default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listDocumentsRemoved: post: description: Lista os documentos removidos e que serão exibidas na lixeira do GED. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Index de início da busca default: 0 size: type: integer format: int64 description: Tamanho da busca minimum: 1 maximum: 50 default: 20 responses: 200: description: Ok schema: type: object required: – documents – totalDocuments – totalPages properties: documents: type: array items: type: object allOf: – #/definitions/documentTrashItem minimum: 1 description: Lista de documentos removidos totalDocuments: type: integer format: int64 description: Total de documentos encontrados totalPages: type: integer format: int64 description: Total de Páginas disponíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os documentos removidos e que serão exibidas na lixeira do GED. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: page description: Index de início da busca in: query type: integer format: int64 – name: size description: Tamanho da busca in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – documents – totalDocuments – totalPages properties: documents: type: array items: type: object allOf: – #/definitions/documentTrashItem minimum: 1 description: Lista de documentos removidos totalDocuments: type: integer format: int64 description: Total de documentos encontrados totalPages: type: integer format: int64 description: Total de Páginas disponíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listInternalEnvelopes: post: description: Listagem de envelopes para controle interno tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeIds properties: envelopeIds: type: array items: type: string minimum: 1 description: Lista de identificadores de envelopes responses: 200: description: Ok schema: type: object required: – envelopes properties: envelopes: type: array items: type: object allOf: – #/definitions/internalEnvelope minimum: 1 description: Lista de envelopes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listInbox: post: description: Listagem dos envelopes que o usuário logado faz parte tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 default: 0 size: type: integer format: int64 description: Quantidade de registros por página default: 20 filter: type: object allOf: – #/definitions/inboxFilter description: Filtro para a listagem da caixa de entrada responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas disponíveis totalElements: type: integer format: int64 description: Total de documentos encontrados contents: type: array items: type: object allOf: – #/definitions/listInboxDTO minimum: 1 description: Lista de envelopes do usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/countListInbox: post: description: Retorna o número de assinaturas do usuário por status tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: envelopeName: type: string description: Nome do envelope requesterEmail: type: string description: Solicitante – criador do envelope responses: 200: description: Ok schema: type: object required: – pending – signedDeclined – copy – expired properties: pending: type: integer format: int64 description: Quantidade em pendente signedDeclined: type: integer format: int64 description: Quantidade em assinados / recusados copy: type: integer format: int64 description: Quantidade em cópia expired: type: integer format: int64 description: Quantidade em expirados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o número de assinaturas do usuário por status tags: – Queries x-senior-visibility: PRIVATE parameters: – name: envelopeName description: Nome do envelope in: query type: string – name: requesterEmail description: Solicitante – criador do envelope in: query type: string responses: 200: description: Ok schema: type: object required: – pending – signedDeclined – copy – expired properties: pending: type: integer format: int64 description: Quantidade em pendente signedDeclined: type: integer format: int64 description: Quantidade em assinados / recusados copy: type: integer format: int64 description: Quantidade em cópia expired: type: integer format: int64 description: Quantidade em expirados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getDocumentsFromEnvelope: post: description: Busca os documentos de um envelope tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: ID do envelope responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/documentInfoDTO minimum: 1 description: Lista de documentos do envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os documentos de um envelope tags: – Queries x-senior-visibility: PRIVATE parameters: – name: envelopeId description: ID do envelope in: query required: true type: string responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/documentInfoDTO minimum: 1 description: Lista de documentos do envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getEnvelopeSignatureFlow: post: description: Busca o fluxo de assinantes de um envelope tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: ID do envelope page: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 default: 0 size: type: integer format: int64 description: Quantidade de registros por página default: 5 responses: 200: description: Ok schema: type: object required: – signaturesFlow properties: signaturesFlow: type: object allOf: – #/definitions/signatureFlowPageable description: Lista de documentos do envelope default: description: Error response schema: #/definitions/genericError get: description: Busca o fluxo de assinantes de um envelope tags: – Queries x-senior-visibility: PRIVATE parameters: – name: envelopeId description: ID do envelope in: query required: true type: string – name: page description: O número da página retornado. A primeira página corresponde ao índice 0 in: query type: integer format: int64 – name: size description: Quantidade de registros por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – signaturesFlow properties: signaturesFlow: type: object allOf: – #/definitions/signatureFlowPageable description: Lista de documentos do envelope default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/checkSignaturesSignBatch: post: description: Checa quais assinaturas estão aptas para assinar em lote tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeIds – email properties: envelopeIds: type: array items: type: string minimum: 1 description: Lista de identificadores de envelopes email: type: string description: Email do signatário responses: 200: description: Ok schema: type: object required: – hasErrors – countEnvelopeApproved – countNotReadyToSign – countSignatureTypeDigital – countSignatureTypeOptional – countSignatureField properties: hasErrors: type: boolean description: Foi encontrado alguma assinatura não apta para assinar countEnvelopeApproved: type: array items: type: string minimum: 1 description: Totalizador de assinaturas aptas para assinar countNotReadyToSign: type: integer format: int64 description: Totalizador de assinaturas não aptas para assinar devido a Pendente – Aguardando Fluxo countSignatureTypeDigital: type: integer format: int64 description: Totalizador de assinaturas não aptas para assinar por ser tipo digital countSignatureTypeOptional: type: integer format: int64 description: Totalizador de assinaturas não aptas para assinar por ser tipo opcional countSignatureField: type: integer format: int64 description: Totalizador de assinaturas não aptas para assinar por pendência de campos de assinatura OBRIGATÓRIOS 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getDownloadBulkLimit: post: description: Retorna o valor da propriedade de limite de download em lote tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – downloadBulkLimit properties: downloadBulkLimit: type: integer format: int64 description: Limite em GB de download em lote 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o valor da propriedade de limite de download em lote tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – downloadBulkLimit properties: downloadBulkLimit: type: integer format: int64 description: Limite em GB de download em lote 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/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 /ecm_ged/queries/exportSubject: 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 /ecm_ged/queries/exportApplicant: 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 /ecm_ged/queries/exportDocument: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportDocumentVersion: 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 /ecm_ged/queries/exportTimeline: 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 /ecm_ged/queries/exportDraftDocument: 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 /ecm_ged/queries/exportFolder: 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 /ecm_ged/queries/exportDocumentTag: 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 /ecm_ged/queries/exportDocumentMetadata: 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 /ecm_ged/queries/exportPermission: 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 /ecm_ged/queries/exportTracking: 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 /ecm_ged/queries/exportDocumentTicket: 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 /ecm_ged/queries/exportDocumentBatch: 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 /ecm_ged/queries/exportEnvelopeSignature: 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 /ecm_ged/queries/exportDocumentEnvelopeSignature: 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 /ecm_ged/queries/exportUserSignature: 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 /ecm_ged/queries/exportAuthorizationUserSignature: 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 /ecm_ged/queries/exportEnvelopeDraft: 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 /ecm_ged/queries/exportEnvelopeDraftSigners: 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 /ecm_ged/queries/exportEnvelopeExternalSigners: 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 /ecm_ged/queries/exportEnvelopeDraftDocument: 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 /ecm_ged/queries/exportEnvelopeDraftPermission: 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 /ecm_ged/queries/exportConectorEnvelope: 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 /ecm_ged/queries/exportConectorEnvelopeInput: 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 /ecm_ged/queries/exportSignatureGroup: 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 /ecm_ged/queries/exportSignatureGroupUser: 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 /ecm_ged/queries/exportEnvelopeTimeline: 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 /ecm_ged/queries/exportEnvelopeBatchPermission: 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 /ecm_ged/queries/exportEnvelopeBatch: 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 /ecm_ged/queries/exportEnvelopeBatchDocument: 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 /ecm_ged/queries/exportPdfEditorContext: 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 /ecm_ged/queries/exportEnvelopeTemplatePermission: 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 /ecm_ged/queries/exportEnvelopeTemplate: 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 /ecm_ged/queries/exportDeleteQueued: 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 /ecm_ged/queries/exportNotificationTemplate: 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 /ecm_ged/queries/exportNotificationTemplateStep: 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 /ecm_ged/queries/exportFavorite: 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 /ecm_ged/queries/exportDownloadBulk: 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 /ecm_ged/queries/exportDownloadBulkItem: 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 /ecm_ged/queries/exportEnvelopeSignatureBatch: 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 /ecm_ged/queries/exportNotificationLog: 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 /ecm_ged/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 /ecm_ged/actions/regenerateSearchTerms: post: description: Reprocessa os termos de busca de arquivos e/ou pastas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – initialDate – finalDate properties: initialDate: type: string format: date description: Data inicial finalDate: type: string format: date description: Data final processFolders: type: boolean description: Reprocessar termos de pastas default: false processFiles: type: boolean description: Reprocessar termos de arquivos default: false responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/cancelSign: post: description: Cancela um processo de assinatura tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope a ser cancelado reason: type: string description: Motivo do cancelamento responses: 200: description: Ok schema: type: object properties: documentVersionIdList: type: array items: type: string description: Lista com as versões dos documentos que tiveram o processo de assinatura eletrônica cancelada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/resendRequestSignMail: post: description: Reenvia o email de solicitação de assinatura tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope signers: type: array items: type: string description: Lista com os emails dos assinantes, ou vazio para reenviar para todos que ainda não assinaram responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/resendDocumentSign: post: description: Reenvia arquivos que falharam para a assinatura tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/generateUrlToSign: post: description: Gera o link de assinatura de um envelope em processo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope em processo email: type: string description: email do assinante username: type: string description: Nome do usuário no formato nome@dominio_tenant phone: type: string description: Telefone do assinante isShortUrl: type: boolean description: aplica encurtador da url default: true responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL para assinatura do envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/signDocuments: post: description: API DEPRECIADA: Usar signDocuments na versão 2 | DATA: 2022-07-01 | Envia uma lista de documentos para assinatura. Atenção: utilizar no header seniorx.version=2 tags: – Actions deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – documentVersionIds – signers – instructionsToSigner – askGeolocation properties: documentVersionIds: type: array items: type: string minimum: 1 description: Lista com o id dos documentos signers: type: array items: type: object allOf: – #/definitions/signer minimum: 1 description: Lista com os assinantes instructionsToSigner: type: string description: Um texto com instruções para o assinante askGeolocation: type: string allOf: – #/definitions/ask_geolocation description: Solicitar Geolocalização notifySignature: type: boolean description: notificar assinatura default: true callbackSignature: type: string description: url de retorno para envio da lista de links de assinatura eletrônica responses: 200: description: Ok schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope/processo que foi criado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do documento 404: description: Nenhuma instância de entidade foi encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/signDocuments__2: post: description: Assinar uma lista de documentos, apenas cria o registro do processo/envelope e inicia o processo de upload dos documentos. Ao finalizar é disparado o evento envelopeDocumentsLoaded ou failedToLoadEnvelopeDocuments tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – documentVersionIds – signers – instructionsToSigner – askGeolocation properties: documentVersionIds: type: array items: type: string minimum: 1 description: Lista com os Ids das versões dos documentos signers: type: array items: type: object allOf: – #/definitions/signer minimum: 1 description: Lista com os signatários instructionsToSigner: type: string maxLength: 1000 description: Um texto com instruções para o assinante askGeolocation: type: string allOf: – #/definitions/ask_geolocation description: Solicitar Geolocalização notifyUser: type: boolean description: Em caso de sucesso notifica usuário na plataforma que existe assinatura pendente default: false sendEmail: type: boolean description: Envia e-mail com o link de cada signatário para assinar os documentos default: true responses: 200: description: Ok schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope/processo que foi criado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do documento 404: description: Nenhuma instância de entidade foi encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/replicatePermissions: post: description: Primitiva assíncrona, executa o processo de replicação de permissões conforme os parâmetros informados, assinalando os itens que devem herdar as permissões da pasta de referência. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da pasta de referência replicationType: type: array items: type: string allOf: – #/definitions/permissionReplicateOptionType description: Tipo de replicação a ser realizada responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/signatureByCertificate: post: description: Notificar o GED quando um envelope for assinado/recusado com Certificado Digital. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId – email – certificate – signatureType properties: envelopeId: type: string description: Id do envelope email: type: string description: Email do Signatário location: type: object allOf: – #/definitions/location description: Localização geodésica de onde o documento está sendo assinado certificate: type: object allOf: – #/definitions/certificateDTO description: Informações do certificado digital signatureType: type: string allOf: – #/definitions/signatureKind description: Informa se assinatura ou recusa reason: type: string description: Razão da recusa de assinatura platform: type: string description: Sistema operacional do assinante userAgent: type: string description: Navegador do assinante responses: 200: description: Ok schema: type: object required: – statusCode properties: statusCode: type: integer format: int64 description: Status code de retorno default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/approveDocumentVersion: post: description: Aprova ou Reprova uma versão do documento tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – documentVersionId – approve properties: documentVersionId: type: string description: Versão do documento approve: type: boolean description: Aprovação responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: A versão de documento não foi encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/approveDocumentVersionBulk: post: description: API DEPRECIADA: Usar approveDocumentVersionBulk na versão 2 | DATA: 2025-01-13 | Aprova ou Reprova uma lista de documentos tags: – Actions deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – documentIds – approve properties: documentIds: type: array items: type: string minimum: 1 description: Lista de documentos approve: type: boolean description: Aprovação responses: 200: description: Ok schema: type: object required: – errors properties: errors: type: array items: type: object allOf: – #/definitions/errorData minimum: 1 description: Caso ocorra algum erro será exibido o id e a mensagem de erro correspondente 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: A versão de documento não foi encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/approveDocumentVersionBulk__2: post: description: Aprova ou Reprova uma lista de documentos de forma assincrona tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – documentIds – approve properties: documentIds: type: array items: type: string minimum: 1 description: Lista de documentos approve: type: boolean description: Aprovação responses: 200: description: Ok schema: type: object required: – errors properties: errors: type: array items: type: object allOf: – #/definitions/errorData minimum: 1 description: Caso ocorra algum erro será exibido o id e a mensagem de erro correspondente 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: A versão de documento não foi encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/checkOutDocument: post: description: Faz o check-out de um documento\n### Resources:\n- res://senior.com.br/platform/ecm_ged/file\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: Identificador do documento responses: 200: description: Ok schema: type: object required: – lockedBy properties: lockedBy: type: string maxLength: 255 description: Retorna o usuário com documento locado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do documento 404: description: Nenhuma instância de entidade foi encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/checkInDocument: post: description: Faz o check-in de um documento\n### Resources:\n- res://senior.com.br/platform/ecm_ged/file\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: Identificador do documento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do documento 404: description: Nenhuma instância de entidade foi encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/newDocument: post: description: Cria um novo documento\n- Atributo permissions: Quando for do Tipo USER – informar username@dominio.com.br\n### Resources:\n- res://senior.com.br/platform/ecm_ged/file\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/newDocumentDTO responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: Ticket para obter o status do documento 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/newDocumentSync: post: description: Primitiva para persistir um novo documento sincronizado\n- Atributo permissions: Quando for do Tipo USER – informar username@dominio.com.br tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/newDocumentDTO responses: 200: description: Ok schema: type: object required: – ticket – documentId properties: ticket: type: string description: Ticket para obter o status do documento documentId: type: string description: Identificador do documento 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/newDocumentBatch: post: description: Executa a criação de documentos em lote\n- Atributo permissions: Quando for do Tipo USER – informar username@dominio.com.br tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documents properties: documents: type: array items: type: object allOf: – #/definitions/newDocumentDTO minimum: 1 description: Lista de documentos a serem criados domain: type: string description: Domínio do serviço que deverá receber os eventos do processamento da primitiva service: type: string description: Serviço que deverá receber os eventos do processamento da primitiva referenceId: type: string description: Id de referência da origem responses: 200: description: Ok schema: type: object required: – batchId properties: batchId: type: string description: Ticket para obter o status do lote 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/moveDocument: post: description: Move um documento para uma pasta\n### Resources:\n- res://senior.com.br/platform/ecm_ged/file\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – sourceId properties: sourceId: type: string description: Identificador do documento ou pasta origem targetId: type: string description: Identificador da pasta destino. Caso não informado, será considerado a pasta raiz. keepLocalPermission: type: boolean description: Manter permissões locais definidas default: true responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do documento 404: description: Nenhuma instância de entidade foi encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/moveDocumentBatch: post: description: Mover documentos em lote para uma pasta tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – moveDocumentList properties: moveDocumentList: type: array items: type: object allOf: – #/definitions/moveDocumentInputForList minimum: 1 description: Lista de documentos a serem movidos responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do documento 404: description: Nenhuma instância de entidade foi encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/moveDocumentBulk: post: description: Permite mover uma lista de documentos para uma pasta tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – sourceIds properties: sourceIds: type: array items: type: string minimum: 1 description: Lista de identificadores de documentos ou pastas de origem targetId: type: string description: Identificador da pasta destino. Caso não informado, será considerado a pasta raiz. keepLocalPermission: type: boolean description: Manter permissões locais definidas default: true responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do documento default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/takeOverDocument: post: description: Assume Controle do Documento\n### Resources:\n- res://senior.com.br/platform/ecm_ged/file\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: Identificador do documento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do documento 404: description: Documento não encontrado default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/startReview: post: description: Inicia um processo de revisão de documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentVersionId – reviewer properties: documentVersionId: type: string description: Versão do documento reviewer: type: string maxLength: 255 description: Revisor responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Versão do documento não encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/updateDefaultReviewer: post: description: Atualiza o revisor padrão do documento tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: id do documento reviewer: type: string maxLength: 255 description: Novo revisor responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do documento 404: description: Nenhuma instância de entidade foi encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/updateDefaultReviewerBulk: post: description: Atualiza o revisor padrão para uma lista de documentos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentIds properties: documentIds: type: array items: type: string minimum: 1 description: Lista de id de documentos reviewer: type: string maxLength: 255 description: Novo revisor responses: 200: description: Ok schema: type: object required: – errors properties: errors: type: array items: type: object allOf: – #/definitions/errorData minimum: 1 description: Caso ocorra algum erro será exibido o id e a mensagem de erro correspondente 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do documento default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/processFailedDocumentIndexes: post: description: Processa indexação de documentos que tiveram alguma falha na indexação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Mensagem de inicio de indexação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/requestSignatureToken: post: description: Gera o token MFA da assinatura eletronica e envia para o communicationChannel definido no signatário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – signatureToken properties: signatureToken: type: object allOf: – #/definitions/signatureToken description: Dados para geração do token responses: 200: description: Ok schema: type: object required: – statusCode – channel properties: statusCode: type: integer format: int64 description: Status code de retorno channel: type: object allOf: – #/definitions/communicationChannel description: Canal de comunicação em que o token foi enviado para o signatário default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/requestSignature: post: description: Signatário realizando uma solicitação de assinatura no envelope, dependendo do tokenType utilizado, poderá já realizar a assinatura do envelope ou enviar o token MFA gerado para o communicationChannel definido para o signatário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – signature properties: signature: type: object allOf: – #/definitions/signature description: Dados para assinatura de um processo/envelope responses: 200: description: Ok schema: type: object required: – statusCode – channel properties: statusCode: type: integer format: int64 description: Status code de retorno channel: type: object allOf: – #/definitions/communicationChannel description: Canal de comunicação caso token for enviado para o signatário default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/requestSignatureByUserLogged: post: description: Signatário logado na plataforma SeniorX realizando uma solicitação de assinatura no envelope, dependendo do tokenType utilizado, poderá já realizar a assinatura do envelope ou enviar o token MFA gerado para o communicationChannel definido para o signatário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – signature properties: signature: type: object allOf: – #/definitions/signature description: Dados para assinatura de um processo/envelope responses: 200: description: Ok schema: type: object required: – statusCode – channel properties: statusCode: type: integer format: int64 description: Status code de retorno channel: type: object allOf: – #/definitions/communicationChannel description: Canal de comunicação caso o token for enviado para o signatário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/validateSignatureToken: post: description: Valida se o token informado pelo signatário é válido para assinatura de um documento, caso seja válido, já assina o processo/envelope tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – signature properties: signature: type: object allOf: – #/definitions/signature description: Dados para assinatura de um processo/envelope responses: 200: description: Ok schema: type: object required: – statusCode properties: statusCode: type: integer format: int64 description: Status code de retorno default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/declineSignature: post: description: Valida se o token informado pelo signatário é válido para assinatura de um documento, caso seja válido, já assina o processo/envelope tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – decline properties: decline: type: object allOf: – #/definitions/decline description: Dados para recusa de assinatura de um processo/envelope responses: 200: description: Ok schema: type: object required: – statusCode properties: statusCode: type: integer format: int64 description: Status code de retorno default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/markEnvelopeToSignVisited: post: description: Primitiva para marcar o envelope enviado para assinatura como visitado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId – email properties: envelopeId: type: string description: Id do envelope email: type: string description: Email do Signatário responses: 200: description: Ok schema: type: object required: – statusCode properties: statusCode: type: integer format: int64 description: Status code de retorno 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Envelope não encontrado default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/updateFileSecurity: post: description: Atualiza informações de segurança de um arquivo ou pasta tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileKind – fileId properties: fileKind: type: string allOf: – #/definitions/fileKind description: Tipo (arquivo ou pasta) fileId: type: string description: Id do arquivo ou pasta inheritedPermission: type: boolean description: Indica se a permissão da pasta deve ser herdada da pasta pai permissions: type: array items: type: object allOf: – #/definitions/permission description: Lista de permissões da pasta ou arquivo, informar vazio para remover todas as permissões responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, você não possui permissão para executar esta ação 404: description: Diretório ou arquivo não encontrado default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/sendDraftToSign: post: description: Enviar o rascunho de um envelope para assinatura tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeDraftId properties: envelopeDraftId: type: string description: Id do rascunho do envelope notifyUser: type: boolean description: Notificar usuário na plataforma default: false sendEmail: type: boolean description: Envia e-mail com link para assinar documentos default: true responses: 200: description: Ok schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope/processo que foi criado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do rascunho de envelope 404: description: Nenhuma instância de entidade foi encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/saveEnvelope: post: description: API DEPRECIADA: Usar saveEnvelope na versão 2 | DATA: 2024-01-12 | Salvar um rascunho de um envelope tags: – Actions deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name properties: envelopeDraftId: type: string description: Identificador do rascunho de envelope name: type: string maxLength: 255 description: Nome do envelope documentsVersions: type: array items: type: string description: Lista com o id dos documentos signers: type: array items: type: object allOf: – #/definitions/signer description: Lista com os assinantes permissions: type: array items: type: object allOf: – #/definitions/envelopePermission description: Permissões do envelope instructionsToSigner: type: string description: Um texto com instruções para o assinante askGeolocation: type: string allOf: – #/definitions/ask_geolocation description: Solicitar Geolocalização daysToNotify: type: integer format: int64 description: Quantidade de dias para notificar caso a assinatura esteja pendente daysToExpire: type: integer format: int64 description: Prazo para expiração do envelope minimum: 1 maximum: 240 default: 120 conectors: type: array items: type: object allOf: – #/definitions/conector description: Conectores envelopeBatchId: type: string description: Id do envelope em lote mandatoryView: type: boolean description: Visualização obrigatória default: false notificateAuthor: type: boolean description: Notificar autor default: false responses: 200: description: Ok schema: type: object required: – envelopeDraftId properties: envelopeDraftId: type: string description: Id rascunho que foi criado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do rascunho de envelope 404: description: Nenhuma instância de entidade foi encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/saveEnvelope__2: post: description: API DEPRECIADA: Usar saveEnvelope na versão 3 | DATA: 2024-11-05 | Salvar um rascunho de um envelope tags: – Actions deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – envelopeDocuments properties: envelopeDraftId: type: string description: Identificador do rascunho de envelope name: type: string maxLength: 255 description: Nome do envelope envelopeDocuments: type: array items: type: object allOf: – #/definitions/envelopeDocuments minimum: 1 description: Lista de documentos e suas posições signers: type: array items: type: object allOf: – #/definitions/signer description: Lista com os assinantes permissions: type: array items: type: object allOf: – #/definitions/envelopePermission description: Permissões do envelope instructionsToSigner: type: string description: Um texto com instruções para o assinante askGeolocation: type: string allOf: – #/definitions/ask_geolocation description: Solicitar Geolocalização daysToNotify: type: integer format: int64 description: Quantidade de dias para notificar caso a assinatura esteja pendente daysToExpire: type: integer format: int64 description: Prazo para expiração do envelope minimum: 1 maximum: 240 default: 120 conectors: type: array items: type: object allOf: – #/definitions/conector description: Conectores envelopeBatchId: type: string description: Id do envelope em lote mandatoryView: type: boolean description: Visualização obrigatória default: false notificateAuthor: type: boolean description: Notificar autor default: false notificationTemplateId: type: string description: Template de Notificação searchJobPosition: type: boolean description: Buscar cargo/função dos signatários? default: false responses: 200: description: Ok schema: type: object required: – envelopeDraftId properties: envelopeDraftId: type: string description: Id rascunho que foi criado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do rascunho de envelope 404: description: Nenhuma instância de entidade foi encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/saveEnvelope__3: post: description: Salvar um rascunho de um envelope tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – envelopeDocuments properties: envelopeDraftId: type: string description: Identificador do rascunho de envelope name: type: string maxLength: 255 description: Nome do envelope envelopeDocuments: type: array items: type: object allOf: – #/definitions/envelopeDocuments minimum: 1 description: Lista de documentos e suas posições signers: type: array items: type: object allOf: – #/definitions/signer description: Lista com os assinantes permissions: type: array items: type: object allOf: – #/definitions/envelopePermission description: Permissões do envelope instructionsToSigner: type: string description: Um texto com instruções para o assinante askGeolocation: type: string allOf: – #/definitions/ask_geolocation description: Solicitar Geolocalização recurrentNotificationIntervalDays: type: integer format: int64 description: Quantidade de dias para notificar de maneira recorrente caso a assinatura esteja pendente minimum: 0 maximum: 239 default: 0 daysToExpire: type: integer format: int64 description: Prazo para expiração do envelope minimum: 1 maximum: 240 default: 120 conectors: type: array items: type: object allOf: – #/definitions/conector description: Conectores envelopeBatchId: type: string description: Id do envelope em lote mandatoryView: type: boolean description: Visualização obrigatória default: false notificateAuthor: type: boolean description: Notificar autor default: false notificationTemplateId: type: string description: Template de Notificação searchJobPosition: type: boolean description: Buscar cargo/função dos signatários? default: false responses: 200: description: Ok schema: type: object required: – envelopeDraftId properties: envelopeDraftId: type: string description: Id rascunho que foi criado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do rascunho de envelope 404: description: Nenhuma instância de entidade foi encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/saveEnvelopeTimeline: post: description: Salvar uma ação na timeline do envelope tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId – note – kind properties: envelopeId: type: string description: Identificador do rascunho de envelope note: type: string description: Observação do envelope kind: type: string allOf: – #/definitions/envelopTimelineKind description: Tipo da ação do envelope responses: 200: description: Ok schema: type: object required: – timelineId properties: timelineId: type: string description: Id da timeline que foi criada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do rascunho de envelope 404: description: Nenhuma instância de entidade foi encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/addEnvelopeResponsible: post: description: Alterar o responsável de um envelope tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – newUserResponsible properties: envelopeIds: type: array items: type: string description: Lista de identificador do envelope oldUserResponsible: type: string description: Usuário do antigo responsável pelo envelope newUserResponsible: type: string description: Usuário do novo responsável do envelope responses: 200: description: Ok schema: type: object required: – envelopeIds properties: envelopeIds: type: array items: type: string minimum: 1 description: Lista de identificadores dos envelopes que foram adicionados o novo responsável 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/editEnvelope: post: description: Editar um envelope em progresso tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId – signers – documents properties: envelopeId: type: string description: Identificador do o de envelope signers: type: array items: type: object allOf: – #/definitions/signerToEdit minimum: 1 description: Lista com os assinantes documents: type: array items: type: object allOf: – #/definitions/documentToEdit minimum: 1 description: Lista com os documentos permissions: type: array items: type: object allOf: – #/definitions/envelopePermission description: Permissões do envelope searchJobPosition: type: boolean description: Buscar cargo/função dos signatários? default: false daysToExpire: type: integer format: int64 description: Prazo para expiração do envelope minimum: 1 maximum: 240 default: 120 responses: 200: description: Ok schema: type: object required: – statusCode properties: statusCode: type: integer format: int64 description: Status code de retorno errorList: type: array items: type: string description: Lista de erros, se houver 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do rascunho de envelope 404: description: Nenhuma instância de entidade foi encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/editDaysToExpire: post: description: Editar os dias de expiração de um envelope com status Expirado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId – daysToExpire properties: envelopeId: type: array items: type: string minimum: 1 description: Id do envelope que será editado daysToExpire: type: integer format: int64 description: Nova quantidade de dias para expirar minimum: 1 maximum: 240 responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do rascunho de envelope 404: description: Nenhuma instância de entidade foi encontrada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/addDocumentsToEnvelope: post: description: Adicionar documentos a um envelope/rascunho tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeDraftId – documentsVersions properties: envelopeDraftId: type: string description: Identificador do rascunho de envelope documentsVersions: type: array items: type: string minimum: 1 description: Lista com o id dos documentos responses: 200: description: Ok schema: type: object required: – envelopeDraftId – documentsVersions properties: envelopeDraftId: type: string description: Id do rascunho documentsVersions: type: array items: type: string minimum: 1 description: Versões dos documentos no rascunho 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/startReviewBulk: post: description: Permite iniciar o processo de revisão para uma lista de documentos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentIds – reviewer properties: documentIds: type: array items: type: string minimum: 1 description: Lista de documentos reviewer: type: string maxLength: 255 description: Revisor responses: 200: description: Ok schema: type: object required: – errors properties: errors: type: array items: type: object allOf: – #/definitions/errorData minimum: 1 description: Caso ocorra algum erro será exibido o id e a mensagem de erro correspondente 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/deleteDocumentBulk: post: description: Permite deletar uma lista de documentos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentIds properties: documentIds: type: array items: type: string minimum: 1 description: Lista de id de documento ou pasta responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/markEnvelopeBatchDocumentFailed: post: description: Marca o documento do envelope bath como erro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeBatchId – documentId – scheduleConectorId – errorLog properties: envelopeBatchId: type: string description: Id do envelope em lote documentId: type: string description: Id do documento scheduleConectorId: type: string description: Id do agendamento do conector errorLog: type: string description: Mensagem de erro responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/savePdfEditorContext: post: description: Cadastra ou atualiza um contexto do editor de PDF tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – context properties: context: type: object allOf: – #/definitions/pdfEditorContextRecord description: Contexto do editor responses: 200: description: Ok schema: type: object required: – context properties: context: type: object allOf: – #/definitions/pdfEditorContext description: Contexto do editor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/requestDocumentDownloadBulk: post: description: Solicita a geração de um zip para download baseado na versão publicada dos documentos informados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: documentIds: type: array items: type: string description: lista de identificadores dos documentos folderIds: type: array items: type: string description: lista de identificadores de pastas. As subpastas também serão baixadas. responses: 200: description: Ok schema: type: object required: – downloadBulkId properties: downloadBulkId: type: string description: Identificador da requisição de download em massa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/deleteQueuedObjects: post: description: Apaga os objetos na fila tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – priority properties: priority: type: string allOf: – #/definitions/queuedPriority description: Prioridade da execução id: type: string description: Id da execução responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/newFavorite: post: description: Cria um novo favorito tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – folderId properties: folderId: type: string description: Id da pasta a ser favoritada responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Id do favorito criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/removeFavorite: post: description: Remover uma pasta dos favoritos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – folderId properties: folderId: type: string description: Id da pasta a ser removida dos favoritos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/sendInboxEmail: post: description: Envia um e-mail oferecendo a funcionalidade Caixa de Entrada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: hasInterest: type: boolean description: Interesse responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/tourInterest: post: description: Registra o interesse do usuário no Tour GED tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hasInterest properties: hasInterest: type: boolean description: Interesse responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/signEnvelopeTourInterest: post: description: Registra o interesse do usuário no Tour SIGN Gestão de Envelopes tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hasInterest properties: hasInterest: type: boolean description: Interesse responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/createDefaultSignWhatsappTemplates: post: description: Criar os templates padrões do Whatsapp para o Sign tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – conectorId properties: conectorId: type: string description: Id do conector responses: 200: description: Ok schema: type: object required: – templates properties: templates: type: array items: type: object allOf: – #/definitions/whatsappTemplateRecord minimum: 1 description: Templates 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/retryDownloadBulk: post: description: Reprocessa os downloads que falharam por falta de espaço em disco tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – priority properties: priority: type: string allOf: – #/definitions/queuedPriority description: Prioridade da execução id: type: string description: Id da execução responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/newPrintDocumentTracking: post: description: Registrar novo registro na tabela tracking quando usuário imprimi um documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: ID do documento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/editDocumentProperties: post: description: Permite editar as propriedades de um documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentVersionId – title – versionName – author properties: documentVersionId: type: string description: Id da versão do documento type: string description: Título do documento subjectIdsList: type: array items: type: string description: Lista de ids dos assuntos description: type: string maxLength: 1024 description: Descrição do Documento expirationDate: type: string format: date description: Data de expiração deprecationDate: type: string format: date description: Data de depreciação versionName: type: string description: Nome da versão author: type: string description: Autor responses: 200: description: Ok schema: type: object required: – documentVersionProperties properties: documentVersionProperties: type: object allOf: – #/definitions/documentVersionProperties description: Propriedades do documento atualizado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/requestSignatureBatch: post: description: Primitiva para assinar envelopes em lote por um mesmo usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeIds – email properties: envelopeIds: type: array items: type: string minimum: 1 description: Lista de identificadores de envelopes email: type: string description: Email do signatário platform: type: string description: Sistema operacional do assinante userAgent: type: string description: Navegador do assinante ip: type: string description: Endereço de IP de onde o signatário está assinando o documento location: type: object allOf: – #/definitions/location description: Localização geodésica de onde o documento está sendo assinado decline: type: boolean description: Informa se o token será usado para assinar ou recusar default: false reason: type: string description: Motivo da recusa da assinatura responses: 200: description: Ok schema: type: object required: – batchId – countEnvelopesAbleToSign properties: batchId: type: string description: Ticket para obter o status do lote countEnvelopesAbleToSign: type: integer format: int64 description: Totalizador de envelopes que foram enviados para assinatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importSubject: 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 /ecm_ged/actions/importApplicant: 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 /ecm_ged/actions/importDocument: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importDocumentVersion: 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 /ecm_ged/actions/importTimeline: 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 /ecm_ged/actions/importDraftDocument: 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 /ecm_ged/actions/importFolder: 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 /ecm_ged/actions/importDocumentTag: 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 /ecm_ged/actions/importDocumentMetadata: 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 /ecm_ged/actions/importPermission: 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 /ecm_ged/actions/importTracking: 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 /ecm_ged/actions/importDocumentTicket: 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 /ecm_ged/actions/importDocumentBatch: 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 /ecm_ged/actions/importEnvelopeSignature: 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 /ecm_ged/actions/importDocumentEnvelopeSignature: 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 /ecm_ged/actions/importUserSignature: 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 /ecm_ged/actions/importAuthorizationUserSignature: 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 /ecm_ged/actions/importEnvelopeDraft: 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 /ecm_ged/actions/importEnvelopeDraftSigners: 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 /ecm_ged/actions/importEnvelopeExternalSigners: 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 /ecm_ged/actions/importEnvelopeDraftDocument: 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 /ecm_ged/actions/importEnvelopeDraftPermission: 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 /ecm_ged/actions/importConectorEnvelope: 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 /ecm_ged/actions/importConectorEnvelopeInput: 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 /ecm_ged/actions/importSignatureGroup: 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 /ecm_ged/actions/importSignatureGroupUser: 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 /ecm_ged/actions/importEnvelopeTimeline: 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 /ecm_ged/actions/importEnvelopeBatchPermission: 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 /ecm_ged/actions/importEnvelopeBatch: 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 /ecm_ged/actions/importEnvelopeBatchDocument: 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 /ecm_ged/actions/importPdfEditorContext: 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 /ecm_ged/actions/importEnvelopeTemplatePermission: 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 /ecm_ged/actions/importEnvelopeTemplate: 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 /ecm_ged/actions/importDeleteQueued: 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 /ecm_ged/actions/importNotificationTemplate: 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 /ecm_ged/actions/importNotificationTemplateStep: 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 /ecm_ged/actions/importFavorite: 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 /ecm_ged/actions/importDownloadBulk: 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 /ecm_ged/actions/importDownloadBulkItem: 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 /ecm_ged/actions/importEnvelopeSignatureBatch: 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 /ecm_ged/actions/importNotificationLog: 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 /ecm_ged/signals/envelopeSignedCallback: post: description: Notifica o GED quando todos os assinantes assinaram um documento tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do Envelope de assinatura responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ecm_ged/signals/finishEnvelopeCallback: post: description: Finaliza os envelope após a escrita do PDF tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – envelopeId – status properties: envelopeId: type: string description: Id do Envelope de assinatura status: type: string description: Status do envelope recebido da escrita do PDF documents: type: array items: type: object allOf: – #/definitions/documentSigned description: Documentos que foram assinados responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ecm_ged/signals/envelopeDocumentsLoadedCallback: post: description: Notifica o GED quando todos os documentos foram carregados pelo serviço de assinatura, ou quando ocorreu algum erro tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do Envelope de assinatura error: type: object allOf: – #/definitions/envelopeLoadDocumentsError description: Mensagem de erro caso tenha ocorrido algum no processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ecm_ged/signals/notifyExpiredDocument: post: description: Evento para tratamento de documentos expirados. Apenas para uso interno. Ao chamar está primitiva externamente nenhuma ação será executada tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – documentVersionId properties: documentVersionId: type: string description: Id da versao do documento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ecm_ged/signals/notifyDeprecatedDocument: post: description: Evento para tratamento de documentos obsoletos. Apenas para uso interno. Ao chamar está primitiva externamente nenhuma ação será executada tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – documentVersionId properties: documentVersionId: type: string description: Id da versao do documento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ecm_ged/signals/updateExpiredEnvelopeStatus: post: description: Evento que realiza a atualização do status dos envelopes em processo de assinatura que já passaram do prazo para o status EXPIRED. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ecm_ged/signals/notifyPendingSigners: post: description: Evento para notificar os assinantes que possuem envelopes pendentes de assinatura de maneira recorrente. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ecm_ged/signals/loggerEnvelopeStatus: post: description: Evento para logar o status de envelopes. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – status properties: status: type: string description: Status do envelope responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ecm_ged/signals/generatePreview: post: description: Gera preview de um documento e armazena na nuvem tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – documentVersion properties: documentVersion: type: string description: Identificador único da versão do documento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ecm_ged/signals/tryEnvelopeBatchGenerate: post: description: Acionar conector de envelope em lote tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – envelopeBatchId properties: envelopeBatchId: type: string description: Id do envelope em lote responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ecm_ged/signals/tryEnvelopeBatchDocumentGenerate: post: description: Acionar conector de envelope em lote para um documento tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – envelopeBatchDocumentId properties: envelopeBatchDocumentId: type: string description: Id do envelope em lote responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ecm_ged/signals/updatePdfContextValue: post: description: Atualiza os valores de campos de contexto do PDF editor tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id – versionId – fieldId – fieldValue properties: id: type: string description: Id do contexto versionId: type: string description: Id da versão publicada do documento fieldId: type: string description: Id do campo fieldValue: type: string description: Valor do campo signerEmail: type: string description: E-mail do signatário responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ecm_ged/signals/deletePdfContextFieldsValuesByESignature: post: description: Retorna os valores e campos preenchidos do formulário tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – versionId properties: versionId: type: string description: Id da versão públicada do documento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ecm_ged/signals/resendDocumentEnvelopeComplete: post: description: Reenvia documentos para envelopes completos tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – envelopes properties: envelopes: type: array items: type: string minimum: 1 description: Lista com Ids dos envelopes responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ecm_ged/signals/restoreDocumentsRemoved: post: description: Restaurar documentos removidos tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – documents properties: documents: type: array items: type: string minimum: 1 description: Lista com Ids dos documentos folderId: type: string description: Id da pasta onde o documento será restaurado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ecm_ged/events/envelopeSigned: post: description: Evento disparado ao finalizar a assinatura de um documento x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – envelopeId – documentVersionIds properties: envelopeId: type: string description: Id do envelope de assinatura documentVersionIds: type: array items: type: string minimum: 1 description: Lista de ids de versoes de documentos responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ecm_ged/events/documentVersionCreated: post: description: Quando uma novo documento é criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/documentVersionCreatedDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ecm_ged/events/documentBatchFinished: post: description: Quando uma novo lote de documentos é finalizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – finishedStatus – documents properties: batchId: type: string description: Id do lote finishedStatus: type: string allOf: – #/definitions/batchStatus description: Status de finalização de execução do lote documents: type: array items: type: object allOf: – #/definitions/documentVersionCreatedDTO minimum: 1 description: Documentos criados neste lote referenceId: type: string description: Id de referência da origem responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ecm_ged/events/documentRemoved: post: description: Quando documentos são removidos x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – documentIds properties: documentIds: type: array items: type: string minimum: 1 description: Identificador dos documentos responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ecm_ged/events/documentRemovedDetailed: post: description: Quando documentos são removidos x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – documentsRemoved properties: documentsRemoved: type: array items: type: object allOf: – #/definitions/documentRemovedDTO minimum: 1 description: Informações dos documentos removidos responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ecm_ged/events/documentError: post: description: Quando ocorre erro ao criar ou remover um documento x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticket – errorMessage properties: ticket: type: string description: Ticket de Solicitação de criação ou exclusão do documento errorMessage: type: string description: Mensagem de erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ecm_ged/events/envelopeDocumentsLoaded: post: description: Quando os documentos são enviados com sucesso para assinatura x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – envelopeId – signatureLinks properties: envelopeId: type: string description: Identificador do envelope signatureLinks: type: array items: type: object allOf: – #/definitions/signatureLink minimum: 1 description: Links para assinatura dos documentos responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ecm_ged/events/failedToLoadEnvelopeDocuments: post: description: Quando ocorre erro ao carregar os documentos para assinatura x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – envelopeId – errorMessage properties: envelopeId: type: string description: Identificador do envelope errorMessage: type: string description: Mensagem de erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ecm_ged/events/userSignedEnvelope: post: description: Quando um usuário assinar um envelope x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – envelopeId – userSigner properties: envelopeId: type: string description: Identificador do envelope userSigner: type: object allOf: – #/definitions/signer description: Informações do assinante responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ecm_ged/events/expiredEnvelopes: post: description: Quando um envelope tem seu status alterado para Expired x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – envelopeIds properties: envelopeIds: type: array items: type: string minimum: 1 description: Lista de identificadores de envelopes responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ecm_ged/events/downloadZippedFolder: post: description: Evento disparado ao finalizar a compactação da pasta para download. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – downloadUrl – downloadBulkId properties: downloadUrl: type: string description: Url disponível para download downloadBulkId: type: string description: Identificação do download responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ecm_ged/events/importSubjectEvent: 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 /ecm_ged/events/exportSubjectEvent: 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 /ecm_ged/events/importApplicantEvent: 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 /ecm_ged/events/exportApplicantEvent: 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 /ecm_ged/events/importDocumentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ecm_ged/events/exportDocumentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ecm_ged/events/importDocumentVersionEvent: 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 /ecm_ged/events/exportDocumentVersionEvent: 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 /ecm_ged/events/importTimelineEvent: 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 /ecm_ged/events/exportTimelineEvent: 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 /ecm_ged/events/importDraftDocumentEvent: 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 /ecm_ged/events/exportDraftDocumentEvent: 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 /ecm_ged/events/importFolderEvent: 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 /ecm_ged/events/exportFolderEvent: 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 /ecm_ged/events/importDocumentTagEvent: 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 /ecm_ged/events/exportDocumentTagEvent: 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 /ecm_ged/events/importDocumentMetadataEvent: 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 /ecm_ged/events/exportDocumentMetadataEvent: 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 /ecm_ged/events/importPermissionEvent: 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 /ecm_ged/events/exportPermissionEvent: 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 /ecm_ged/events/importTrackingEvent: 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 /ecm_ged/events/exportTrackingEvent: 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 /ecm_ged/events/importDocumentTicketEvent: 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 /ecm_ged/events/exportDocumentTicketEvent: 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 /ecm_ged/events/importDocumentBatchEvent: 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 /ecm_ged/events/exportDocumentBatchEvent: 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 /ecm_ged/events/importEnvelopeSignatureEvent: 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 /ecm_ged/events/exportEnvelopeSignatureEvent: 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 /ecm_ged/events/importDocumentEnvelopeSignatureEvent: 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 /ecm_ged/events/exportDocumentEnvelopeSignatureEvent: 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 /ecm_ged/events/importUserSignatureEvent: 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 /ecm_ged/events/exportUserSignatureEvent: 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 /ecm_ged/events/importAuthorizationUserSignatureEvent: 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 /ecm_ged/events/exportAuthorizationUserSignatureEvent: 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 /ecm_ged/events/importEnvelopeDraftEvent: 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 /ecm_ged/events/exportEnvelopeDraftEvent: 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 /ecm_ged/events/importEnvelopeDraftSignersEvent: 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 /ecm_ged/events/exportEnvelopeDraftSignersEvent: 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 /ecm_ged/events/importEnvelopeExternalSignersEvent: 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 /ecm_ged/events/exportEnvelopeExternalSignersEvent: 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 /ecm_ged/events/importEnvelopeDraftDocumentEvent: 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 /ecm_ged/events/exportEnvelopeDraftDocumentEvent: 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 /ecm_ged/events/importEnvelopeDraftPermissionEvent: 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 /ecm_ged/events/exportEnvelopeDraftPermissionEvent: 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 /ecm_ged/events/importConectorEnvelopeEvent: 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 /ecm_ged/events/exportConectorEnvelopeEvent: 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 /ecm_ged/events/importConectorEnvelopeInputEvent: 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 /ecm_ged/events/exportConectorEnvelopeInputEvent: 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 /ecm_ged/events/importSignatureGroupEvent: 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 /ecm_ged/events/exportSignatureGroupEvent: 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 /ecm_ged/events/importSignatureGroupUserEvent: 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 /ecm_ged/events/exportSignatureGroupUserEvent: 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 /ecm_ged/events/importEnvelopeTimelineEvent: 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 /ecm_ged/events/exportEnvelopeTimelineEvent: 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 /ecm_ged/events/importEnvelopeBatchPermissionEvent: 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 /ecm_ged/events/exportEnvelopeBatchPermissionEvent: 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 /ecm_ged/events/importEnvelopeBatchEvent: 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 /ecm_ged/events/exportEnvelopeBatchEvent: 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 /ecm_ged/events/importEnvelopeBatchDocumentEvent: 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 /ecm_ged/events/exportEnvelopeBatchDocumentEvent: 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 /ecm_ged/events/importPdfEditorContextEvent: 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 /ecm_ged/events/exportPdfEditorContextEvent: 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 /ecm_ged/events/importEnvelopeTemplatePermissionEvent: 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 /ecm_ged/events/exportEnvelopeTemplatePermissionEvent: 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 /ecm_ged/events/importEnvelopeTemplateEvent: 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 /ecm_ged/events/exportEnvelopeTemplateEvent: 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 /ecm_ged/events/importDeleteQueuedEvent: 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 /ecm_ged/events/exportDeleteQueuedEvent: 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 /ecm_ged/events/importNotificationTemplateEvent: 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 /ecm_ged/events/exportNotificationTemplateEvent: 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 /ecm_ged/events/importNotificationTemplateStepEvent: 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 /ecm_ged/events/exportNotificationTemplateStepEvent: 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 /ecm_ged/events/importFavoriteEvent: 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 /ecm_ged/events/exportFavoriteEvent: 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 /ecm_ged/events/importDownloadBulkEvent: 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 /ecm_ged/events/exportDownloadBulkEvent: 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 /ecm_ged/events/importDownloadBulkItemEvent: 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 /ecm_ged/events/exportDownloadBulkItemEvent: 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 /ecm_ged/events/importEnvelopeSignatureBatchEvent: 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 /ecm_ged/events/exportEnvelopeSignatureBatchEvent: 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 /ecm_ged/events/importNotificationLogEvent: 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 /ecm_ged/events/exportNotificationLogEvent: 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 /ecm_ged/entities/subject: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/subject responses: 200: description: The created resource schema: #/definitions/subject 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/subject responses: 200: description: The created resource schema: #/definitions/subject 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/subject 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/subject/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editSubject responses: 200: description: Ok schema: #/definitions/editSubject 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/subject responses: 200: description: Ok schema: #/definitions/subject 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/subject 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/subject/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/subject responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/applicant: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/applicant responses: 200: description: The created resource schema: #/definitions/applicant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/applicant responses: 200: description: The created resource schema: #/definitions/applicant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/applicant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/applicant/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editApplicant responses: 200: description: Ok schema: #/definitions/editApplicant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/applicant responses: 200: description: Ok schema: #/definitions/applicant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/applicant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/subject/{parentId}/applicants: post: 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/applicant responses: 200: description: The created resources schema: type: array items: #/definitions/applicant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/applicant responses: 200: description: The created resources schema: type: array items: #/definitions/applicant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/applicant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/subject/{parentId}/applicants/{id}: put: 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/editApplicant responses: 200: description: Ok schema: #/definitions/editApplicant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/applicant responses: 200: description: Ok schema: #/definitions/applicant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/applicant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ecm_ged/entities/applicant/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/applicant responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/document: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/document responses: 200: description: The created resource schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/document responses: 200: description: The created resource schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/document/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDocument responses: 200: description: Ok schema: #/definitions/editDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/document responses: 200: description: Ok schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/document/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/document responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentVersion: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentVersion responses: 200: description: The created resource schema: #/definitions/documentVersion 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentVersion responses: 200: description: The created resource schema: #/definitions/documentVersion 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/documentVersion 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentVersion/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDocumentVersion responses: 200: description: Ok schema: #/definitions/editDocumentVersion 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentVersion responses: 200: description: Ok schema: #/definitions/documentVersion 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/documentVersion 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/document/{parentId}/versions: post: 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/documentVersion responses: 200: description: The created resources schema: type: array items: #/definitions/documentVersion 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/documentVersion responses: 200: description: The created resources schema: type: array items: #/definitions/documentVersion 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/documentVersion 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/document/{parentId}/versions/{id}: put: 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/editDocumentVersion responses: 200: description: Ok schema: #/definitions/editDocumentVersion 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/documentVersion responses: 200: description: Ok schema: #/definitions/documentVersion 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/documentVersion 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ecm_ged/entities/documentVersion/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentVersion responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/timeline: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/timeline responses: 200: description: The created resource schema: #/definitions/timeline 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/timeline responses: 200: description: The created resource schema: #/definitions/timeline 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/timeline 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/timeline/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editTimeline responses: 200: description: Ok schema: #/definitions/editTimeline 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/timeline responses: 200: description: Ok schema: #/definitions/timeline 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/timeline 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/document/{parentId}/timeline: post: 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/timeline responses: 200: description: The created resources schema: type: array items: #/definitions/timeline 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/timeline responses: 200: description: The created resources schema: type: array items: #/definitions/timeline 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/timeline 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/document/{parentId}/timeline/{id}: put: 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/editTimeline responses: 200: description: Ok schema: #/definitions/editTimeline 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/timeline responses: 200: description: Ok schema: #/definitions/timeline 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/timeline 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ecm_ged/entities/timeline/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/timeline responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/draftDocument: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/draftDocument responses: 200: description: The created resource schema: #/definitions/draftDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/draftDocument responses: 200: description: The created resource schema: #/definitions/draftDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/draftDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/draftDocument/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDraftDocument responses: 200: description: Ok schema: #/definitions/editDraftDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/draftDocument responses: 200: description: Ok schema: #/definitions/draftDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/draftDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/draftDocument/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/draftDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/folder: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/folder responses: 200: description: The created resource schema: #/definitions/folder 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/folder responses: 200: description: The created resource schema: #/definitions/folder 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/folder 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/folder/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editFolder responses: 200: description: Ok schema: #/definitions/editFolder 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/folder responses: 200: description: Ok schema: #/definitions/folder 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/folder 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/folder/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/folder responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentTag: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentTag responses: 200: description: The created resource schema: #/definitions/documentTag 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentTag responses: 200: description: The created resource schema: #/definitions/documentTag 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/documentTag 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentTag/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDocumentTag responses: 200: description: Ok schema: #/definitions/editDocumentTag 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentTag responses: 200: description: Ok schema: #/definitions/documentTag 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/documentTag 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentTag/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentTag responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentMetadata: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentMetadata responses: 200: description: The created resource schema: #/definitions/documentMetadata 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentMetadata responses: 200: description: The created resource schema: #/definitions/documentMetadata 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/documentMetadata 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentMetadata/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDocumentMetadata responses: 200: description: Ok schema: #/definitions/editDocumentMetadata 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentMetadata responses: 200: description: Ok schema: #/definitions/documentMetadata 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/documentMetadata 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentMetadata/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentMetadata responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/permission: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/permission responses: 200: description: The created resource schema: #/definitions/permission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/permission responses: 200: description: The created resource schema: #/definitions/permission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/permission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/permission/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editPermission responses: 200: description: Ok schema: #/definitions/editPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/permission responses: 200: description: Ok schema: #/definitions/permission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/permission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/document/{parentId}/permissions: post: 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/permission responses: 200: description: The created resources schema: type: array items: #/definitions/permission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/permission responses: 200: description: The created resources schema: type: array items: #/definitions/permission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/permission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/folder/{parentId}/permissions: post: 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/permission responses: 200: description: The created resources schema: type: array items: #/definitions/permission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/permission responses: 200: description: The created resources schema: type: array items: #/definitions/permission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/permission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/document/{parentId}/permissions/{id}: put: 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/editPermission responses: 200: description: Ok schema: #/definitions/editPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/permission responses: 200: description: Ok schema: #/definitions/permission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/permission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ecm_ged/entities/folder/{parentId}/permissions/{id}: put: 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/editPermission responses: 200: description: Ok schema: #/definitions/editPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/permission responses: 200: description: Ok schema: #/definitions/permission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/permission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ecm_ged/entities/permission/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/permission responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/tracking: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tracking responses: 200: description: The created resource schema: #/definitions/tracking 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tracking responses: 200: description: The created resource schema: #/definitions/tracking 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/tracking 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/tracking/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editTracking responses: 200: description: Ok schema: #/definitions/editTracking 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tracking responses: 200: description: Ok schema: #/definitions/tracking 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tracking 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/tracking/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tracking responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentTicket: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentTicket responses: 200: description: The created resource schema: #/definitions/documentTicket 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentTicket responses: 200: description: The created resource schema: #/definitions/documentTicket 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/documentTicket 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentTicket/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDocumentTicket responses: 200: description: Ok schema: #/definitions/editDocumentTicket 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentTicket responses: 200: description: Ok schema: #/definitions/documentTicket 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/documentTicket 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentTicket/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentTicket responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentBatch: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentBatch responses: 200: description: The created resource schema: #/definitions/documentBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentBatch responses: 200: description: The created resource schema: #/definitions/documentBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/documentBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentBatch/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDocumentBatch responses: 200: description: Ok schema: #/definitions/editDocumentBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentBatch responses: 200: description: Ok schema: #/definitions/documentBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/documentBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentBatch/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentBatch responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/userSignature: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/userSignature responses: 200: description: The created resource schema: #/definitions/userSignature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/userSignature responses: 200: description: The created resource schema: #/definitions/userSignature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/userSignature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/userSignature/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editUserSignature responses: 200: description: Ok schema: #/definitions/editUserSignature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/userSignature responses: 200: description: Ok schema: #/definitions/userSignature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/userSignature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/userSignature/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/userSignature responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/authorizationUserSignature: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/authorizationUserSignature responses: 200: description: The created resource schema: #/definitions/authorizationUserSignature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/authorizationUserSignature responses: 200: description: The created resource schema: #/definitions/authorizationUserSignature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/authorizationUserSignature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/authorizationUserSignature/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editAuthorizationUserSignature responses: 200: description: Ok schema: #/definitions/editAuthorizationUserSignature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/authorizationUserSignature responses: 200: description: Ok schema: #/definitions/authorizationUserSignature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/authorizationUserSignature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/authorizationUserSignature/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/authorizationUserSignature responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeDraft: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeDraft responses: 200: description: The created resource schema: #/definitions/envelopeDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeDraft responses: 200: description: The created resource schema: #/definitions/envelopeDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeDraft/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeDraft responses: 200: description: Ok schema: #/definitions/editEnvelopeDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeDraft responses: 200: description: Ok schema: #/definitions/envelopeDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeDraft/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeDraft responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeDraftSigners: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeDraftSigners responses: 200: description: The created resource schema: #/definitions/envelopeDraftSigners 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeDraftSigners responses: 200: description: The created resource schema: #/definitions/envelopeDraftSigners 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeDraftSigners 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeDraftSigners/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeDraftSigners responses: 200: description: Ok schema: #/definitions/editEnvelopeDraftSigners 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeDraftSigners responses: 200: description: Ok schema: #/definitions/envelopeDraftSigners 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeDraftSigners 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeDraft/{parentId}/usersDraft: post: 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/envelopeDraftSigners responses: 200: description: The created resources schema: type: array items: #/definitions/envelopeDraftSigners 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/envelopeDraftSigners responses: 200: description: The created resources schema: type: array items: #/definitions/envelopeDraftSigners 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/envelopeDraftSigners 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeDraft/{parentId}/usersDraft/{id}: put: 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/editEnvelopeDraftSigners responses: 200: description: Ok schema: #/definitions/editEnvelopeDraftSigners 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/envelopeDraftSigners responses: 200: description: Ok schema: #/definitions/envelopeDraftSigners 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/envelopeDraftSigners 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ecm_ged/entities/envelopeDraftSigners/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeDraftSigners responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeExternalSigners: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeExternalSigners responses: 200: description: The created resource schema: #/definitions/envelopeExternalSigners 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeExternalSigners responses: 200: description: The created resource schema: #/definitions/envelopeExternalSigners 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeExternalSigners 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeExternalSigners/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeExternalSigners responses: 200: description: Ok schema: #/definitions/editEnvelopeExternalSigners 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeExternalSigners responses: 200: description: Ok schema: #/definitions/envelopeExternalSigners 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeExternalSigners 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeExternalSigners/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeExternalSigners responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeDraftDocument: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeDraftDocument responses: 200: description: The created resource schema: #/definitions/envelopeDraftDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeDraftDocument responses: 200: description: The created resource schema: #/definitions/envelopeDraftDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeDraftDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeDraftDocument/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeDraftDocument responses: 200: description: Ok schema: #/definitions/editEnvelopeDraftDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeDraftDocument responses: 200: description: Ok schema: #/definitions/envelopeDraftDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeDraftDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeDraft/{parentId}/documentsDraft: post: 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/envelopeDraftDocument responses: 200: description: The created resources schema: type: array items: #/definitions/envelopeDraftDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/envelopeDraftDocument responses: 200: description: The created resources schema: type: array items: #/definitions/envelopeDraftDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/envelopeDraftDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeDraft/{parentId}/documentsDraft/{id}: put: 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/editEnvelopeDraftDocument responses: 200: description: Ok schema: #/definitions/editEnvelopeDraftDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/envelopeDraftDocument responses: 200: description: Ok schema: #/definitions/envelopeDraftDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/envelopeDraftDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ecm_ged/entities/envelopeDraftDocument/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeDraftDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeDraftPermission: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeDraftPermission responses: 200: description: The created resource schema: #/definitions/envelopeDraftPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeDraftPermission responses: 200: description: The created resource schema: #/definitions/envelopeDraftPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeDraftPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeDraftPermission/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeDraftPermission responses: 200: description: Ok schema: #/definitions/editEnvelopeDraftPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeDraftPermission responses: 200: description: Ok schema: #/definitions/envelopeDraftPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeDraftPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeDraft/{parentId}/permissions: post: 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/envelopeDraftPermission responses: 200: description: The created resources schema: type: array items: #/definitions/envelopeDraftPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/envelopeDraftPermission responses: 200: description: The created resources schema: type: array items: #/definitions/envelopeDraftPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/envelopeDraftPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeDraft/{parentId}/permissions/{id}: put: 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/editEnvelopeDraftPermission responses: 200: description: Ok schema: #/definitions/editEnvelopeDraftPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/envelopeDraftPermission responses: 200: description: Ok schema: #/definitions/envelopeDraftPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/envelopeDraftPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ecm_ged/entities/envelopeDraftPermission/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeDraftPermission responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/signatureGroup: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/signatureGroup responses: 200: description: The created resource schema: #/definitions/signatureGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/signatureGroup responses: 200: description: The created resource schema: #/definitions/signatureGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/signatureGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/signatureGroup/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editSignatureGroup responses: 200: description: Ok schema: #/definitions/editSignatureGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/signatureGroup responses: 200: description: Ok schema: #/definitions/signatureGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/signatureGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/signatureGroup/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/signatureGroup responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/signatureGroupUser: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/signatureGroupUser responses: 200: description: The created resource schema: #/definitions/signatureGroupUser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/signatureGroupUser responses: 200: description: The created resource schema: #/definitions/signatureGroupUser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/signatureGroupUser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/signatureGroupUser/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editSignatureGroupUser responses: 200: description: Ok schema: #/definitions/editSignatureGroupUser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/signatureGroupUser responses: 200: description: Ok schema: #/definitions/signatureGroupUser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/signatureGroupUser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/signatureGroup/{parentId}/signatureGroupUser: post: 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/signatureGroupUser responses: 200: description: The created resources schema: type: array items: #/definitions/signatureGroupUser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/signatureGroupUser responses: 200: description: The created resources schema: type: array items: #/definitions/signatureGroupUser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/signatureGroupUser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/signatureGroup/{parentId}/signatureGroupUser/{id}: put: 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/editSignatureGroupUser responses: 200: description: Ok schema: #/definitions/editSignatureGroupUser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/signatureGroupUser responses: 200: description: Ok schema: #/definitions/signatureGroupUser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/signatureGroupUser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ecm_ged/entities/signatureGroupUser/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/signatureGroupUser responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeBatchPermission: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeBatchPermission responses: 200: description: The created resource schema: #/definitions/envelopeBatchPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeBatchPermission responses: 200: description: The created resource schema: #/definitions/envelopeBatchPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeBatchPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeBatchPermission/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeBatchPermission responses: 200: description: Ok schema: #/definitions/editEnvelopeBatchPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeBatchPermission responses: 200: description: Ok schema: #/definitions/envelopeBatchPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeBatchPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeBatch/{parentId}/permissions: post: 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/envelopeBatchPermission responses: 200: description: The created resources schema: type: array items: #/definitions/envelopeBatchPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/envelopeBatchPermission responses: 200: description: The created resources schema: type: array items: #/definitions/envelopeBatchPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/envelopeBatchPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeBatch/{parentId}/permissions/{id}: put: 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/editEnvelopeBatchPermission responses: 200: description: Ok schema: #/definitions/editEnvelopeBatchPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/envelopeBatchPermission responses: 200: description: Ok schema: #/definitions/envelopeBatchPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/envelopeBatchPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ecm_ged/entities/envelopeBatchPermission/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeBatchPermission responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeBatch: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeBatch responses: 200: description: The created resource schema: #/definitions/envelopeBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeBatch responses: 200: description: The created resource schema: #/definitions/envelopeBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeBatch/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeBatch responses: 200: description: Ok schema: #/definitions/editEnvelopeBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeBatch responses: 200: description: Ok schema: #/definitions/envelopeBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeBatch/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeBatch responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeBatchDocument: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeBatchDocument responses: 200: description: The created resource schema: #/definitions/envelopeBatchDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeBatchDocument responses: 200: description: The created resource schema: #/definitions/envelopeBatchDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeBatchDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeBatchDocument/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeBatchDocument responses: 200: description: Ok schema: #/definitions/editEnvelopeBatchDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeBatchDocument responses: 200: description: Ok schema: #/definitions/envelopeBatchDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeBatchDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeBatchDocument/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeBatchDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeTemplatePermission: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeTemplatePermission responses: 200: description: The created resource schema: #/definitions/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeTemplatePermission responses: 200: description: The created resource schema: #/definitions/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeTemplatePermission/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeTemplatePermission responses: 200: description: Ok schema: #/definitions/editEnvelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeTemplatePermission responses: 200: description: Ok schema: #/definitions/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeTemplate/{parentId}/permissions: post: 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/envelopeTemplatePermission responses: 200: description: The created resources schema: type: array items: #/definitions/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/envelopeTemplatePermission responses: 200: description: The created resources schema: type: array items: #/definitions/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeTemplate/{parentId}/permissions/{id}: put: 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/editEnvelopeTemplatePermission responses: 200: description: Ok schema: #/definitions/editEnvelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/envelopeTemplatePermission responses: 200: description: Ok schema: #/definitions/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ecm_ged/entities/envelopeTemplatePermission/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeTemplatePermission responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeTemplate: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeTemplate responses: 200: description: The created resource schema: #/definitions/envelopeTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeTemplate responses: 200: description: The created resource schema: #/definitions/envelopeTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeTemplate/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeTemplate responses: 200: description: Ok schema: #/definitions/editEnvelopeTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeTemplate responses: 200: description: Ok schema: #/definitions/envelopeTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeTemplate/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeTemplate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/deleteQueued: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/deleteQueued responses: 200: description: The created resource schema: #/definitions/deleteQueued 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/deleteQueued responses: 200: description: The created resource schema: #/definitions/deleteQueued 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/deleteQueued 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/deleteQueued/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDeleteQueued responses: 200: description: Ok schema: #/definitions/editDeleteQueued 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/deleteQueued responses: 200: description: Ok schema: #/definitions/deleteQueued 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/deleteQueued 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/deleteQueued/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/deleteQueued responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/notificationTemplate: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/notificationTemplate responses: 200: description: The created resource schema: #/definitions/notificationTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/notificationTemplate responses: 200: description: The created resource schema: #/definitions/notificationTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/notificationTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/notificationTemplate/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editNotificationTemplate responses: 200: description: Ok schema: #/definitions/editNotificationTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/notificationTemplate responses: 200: description: Ok schema: #/definitions/notificationTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/notificationTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/notificationTemplate/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/notificationTemplate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/notificationTemplate/{parentId}/notificationTemplateSteps: post: 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/notificationTemplateStep responses: 200: description: The created resources schema: type: array items: #/definitions/notificationTemplateStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/notificationTemplateStep responses: 200: description: The created resources schema: type: array items: #/definitions/notificationTemplateStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/notificationTemplateStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/notificationTemplate/{parentId}/notificationTemplateSteps/{id}: put: 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/editNotificationTemplateStep responses: 200: description: Ok schema: #/definitions/editNotificationTemplateStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/notificationTemplateStep responses: 200: description: Ok schema: #/definitions/notificationTemplateStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/notificationTemplateStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ecm_ged/entities/favorite: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/favorite responses: 200: description: The created resource schema: #/definitions/favorite 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/favorite responses: 200: description: The created resource schema: #/definitions/favorite 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/favorite 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/favorite/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editFavorite responses: 200: description: Ok schema: #/definitions/editFavorite 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/favorite responses: 200: description: Ok schema: #/definitions/favorite 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/favorite 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/favorite/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/favorite responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/downloadBulk: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/downloadBulk responses: 200: description: The created resource schema: #/definitions/downloadBulk 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/downloadBulk responses: 200: description: The created resource schema: #/definitions/downloadBulk 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/downloadBulk 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/downloadBulk/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDownloadBulk responses: 200: description: Ok schema: #/definitions/editDownloadBulk 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/downloadBulk responses: 200: description: Ok schema: #/definitions/downloadBulk 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/downloadBulk 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/downloadBulk/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/downloadBulk responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/downloadBulk/{parentId}/items: post: 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/downloadBulkItem responses: 200: description: The created resources schema: type: array items: #/definitions/downloadBulkItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/downloadBulkItem responses: 200: description: The created resources schema: type: array items: #/definitions/downloadBulkItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/downloadBulkItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/downloadBulk/{parentId}/items/{id}: put: 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/editDownloadBulkItem responses: 200: description: Ok schema: #/definitions/editDownloadBulkItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/downloadBulkItem responses: 200: description: Ok schema: #/definitions/downloadBulkItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/downloadBulkItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /ecm_ged/entities/envelopeSignatureBatch: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeSignatureBatch responses: 200: description: The created resource schema: #/definitions/envelopeSignatureBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeSignatureBatch responses: 200: description: The created resource schema: #/definitions/envelopeSignatureBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeSignatureBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeSignatureBatch/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeSignatureBatch responses: 200: description: Ok schema: #/definitions/editEnvelopeSignatureBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeSignatureBatch responses: 200: description: Ok schema: #/definitions/envelopeSignatureBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeSignatureBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeSignatureBatch/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeSignatureBatch responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: listFavoritesOrderByField: type: string enum: – FOLDER_NAME – CREATED_DATE description: Campos de ordenação da primitiva listFavoriteByUser: * `FOLDER_NAME` – Nome da pasta * `CREATED_DATE` – Data de criação queuedPriority: type: string enum: – low – high description: Prioridade da execução da fila: * `low` – Baixo * `high` – Alto mimetypeFilter: type: string enum: – pdf – excel – word – texto – imagem – video description: Filtro tipos de documentos: * `pdf` – PDF * `excel` – EXCEL * `word` – WORD * `texto` – TEXTO * `imagem` – IMAGEM * `video` – VIDEO templateType: type: string enum: – WHATSAPP_META description: Tipo de template: * `WHATSAPP_META` – Whatsapp Meta templateCategory: type: string enum: – MARKETING – UTILITY – AUTHENTICATION description: Categoria de template: * `MARKETING` – Marketing * `UTILITY` – Utilidade * `AUTHENTICATION` – Autenticação templateStatus: type: string enum: – REGISTERED – REGISTERING – ERROR – UNREGISTERED description: Status de template: * `REGISTERED` – Registrado * `REGISTERING` – Registrando * `ERROR` – Erro * `UNREGISTERED` – Não registrado signerType: type: string enum: – MANDATORY – RECEIVE_COPY – RECEIVE_COPY_BEFORE_SIGN – PIONEER description: Tipo de assinatura requerida para o signatário: * `MANDATORY` – Assinatura obrigatória * `RECEIVE_COPY` – Recebe uma cópia ao final do processo * `RECEIVE_COPY_BEFORE_SIGN` – Receber em cópia – Antes de Assinar * `PIONEER` – Assinatura pioneira signerSubType: type: string enum: – SIGN – SIGN_LEGAL_REPRESENTATIVE – SIGN_ATTESTANT – SIGN_VALIDATOR description: Subtipo de assinatura do signatário: * `SIGN` – Assinar * `SIGN_LEGAL_REPRESENTATIVE` – Assinar como representante legal * `SIGN_ATTESTANT` – Assinar como testemunha * `SIGN_VALIDATOR` – Assinar como validador signatureType: type: string enum: – DIGITAL – ELECTRONIC – OPTIONAL description: Tipos de assinatura do usuário: * `DIGITAL` – Tipo assinatura digital * `ELECTRONIC` – Tipo assinatura eletrônica * `OPTIONAL` – Tipo assinatura opcional productName: type: string enum: – GED – SIGN description: Tipos de produto: * `GED` – GED * `SIGN` – SIGN featureProduct: type: string enum: – INBOX – TOUR_START – TOUR_ENVELOPE_MANAGEMENT description: Tipo do recurso dos produtos: * `INBOX` – SIGN – Caixa de entrada * `TOUR_START` – GED – Tour * `TOUR_ENVELOPE_MANAGEMENT` – SIGN – Tour Gestão Envelope ask_geolocation: type: string enum: – DONT_ASK_LOCATION – ASK_LOCATION – REQUIRED_LOCATION description: Ask Geolocation on document signing: * `DONT_ASK_LOCATION` – Não pedir a localização * `ASK_LOCATION` – Pedir a localização mas não obrigar * `REQUIRED_LOCATION` – Obrigar usuário a informar a localização envelopeBatchStatus: type: string enum: – WAITING_INTEGRATION – FINISH – ERROR description: Status do envelope em lote: * `WAITING_INTEGRATION` – Aguardando integração com o Conector * `FINISH` – Integrado com o Conector * `ERROR` – Erro na integração com o Conector signatureStatus: type: string enum: – PENDING – SIGNED – EMPTY – FAILED_TO_LOAD – EXPIRED – DECLINED – DIGITAL_SIGNATURE – DIGITAL_DECLINE description: Status utilizado na listagem folderList: * `PENDING` – Assinatura pendente * `SIGNED` – Documento assinado * `EMPTY` – Não possui processo de assinatura * `FAILED_TO_LOAD` – Ocorreu erro ao carregar documento para assinatura * `EXPIRED` – Expirou o prazo para assinar o documento * `DECLINED` – Documento com assinatura recusada * `DIGITAL_SIGNATURE` – Documento assinado com certificado digital * `DIGITAL_DECLINE` – Recusa de assinatura com certificado digital signatureErrorType: type: string enum: – BAD_REQUEST – REQUEST_TOKEN – SIGN_DOCUMENT – REQUEST_SIGNATURE – INVALID_ORDER_SIGN – USER_ALREADY_SIGNED – FORM_IS_REQUIRED – USER_CANT_SIGN – DIGITAL_CERTIFICATE_DISABLED description: Códigos de erro durante a assinatura: * `BAD_REQUEST` – Requisição inválida * `REQUEST_TOKEN` – Não foi possível enviar o token * `SIGN_DOCUMENT` – Não foi possível assinar o documento * `REQUEST_SIGNATURE` – Solicitação de assinatura * `INVALID_ORDER_SIGN` – Ordem de assinatura inválida * `USER_ALREADY_SIGNED` – Usuário já efetuou a assinatura * `FORM_IS_REQUIRED` – Formulário requerido * `USER_CANT_SIGN` – Usuário não pode assinar * `DIGITAL_CERTIFICATE_DISABLED` – Certificado Digital Desabilitado signatureKind: type: string enum: – SIGN – DECLINE description: Opções de assinatura para um envelope: * `SIGN` – Assinatura aceita * `DECLINE` – Recusa de assinatura batchStatus: type: string enum: – PENDING – SUCCESS – SUCCESS_PARTIAL – ERROR description: Status de execução de um lote de criação de documentos: * `PENDING` – Pendente * `SUCCESS` – Finalizado com sucesso * `SUCCESS_PARTIAL` – Finalizado parcialmente com sucesso (1 ou mais documentos não foram criados) * `ERROR` – Erro na criação de todos os documentos do lote upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down userSignStatus: type: string enum: – PENDING – SIGNED – EXPIRED – REMOVED – DECLINED – DIGITAL_SIGNATURE – DIGITAL_DECLINE – BATCH_SIGNING description: Status da assinatura por usuário: * `PENDING` – Assinatura pendente * `SIGNED` – Documento assinado * `EXPIRED` – Assinatura expirada * `REMOVED` – Assinatura removida do envelope * `DECLINED` – Recusa de assinatura * `DIGITAL_SIGNATURE` – Documento assinado com certificado digital * `DIGITAL_DECLINE` – Recusa de assinatura com certificado digital * `BATCH_SIGNING` – Em processo de assinatura em lote digitalCertificateOption: type: string enum: – DISABLED – OPTIONAL – MANDATORY description: Opções para Certificado Digital: * `DISABLED` – Desabilitado * `OPTIONAL` – Opcional * `MANDATORY` – Obrigatório signerStatusFilter: type: string enum: – SIGNED – DIGITAL_SIGNATURE – PIONEER_SIGNED – PENDING – PIONEER_PENDING – DECLINED – DIGITAL_DECLINE – RECEIVE_COPY – RECEIVE_COPY_BEFORE_SIGN – EXPIRED – FAILED_TO_LOAD – PIONEER description: Opções de filtro através do status de assinatura: * `SIGNED` – Assinado * `DIGITAL_SIGNATURE` – Assinado com certificado digital * `PIONEER_SIGNED` – Assinatura Pioneira * `PENDING` – Pendente * `PIONEER_PENDING` – Assinatura pioneira pendente * `DECLINED` – Recusado * `DIGITAL_DECLINE` – Recusado com certificado digital * `RECEIVE_COPY` – Recebido em cópia * `RECEIVE_COPY_BEFORE_SIGN` – Recebido em cópia – Antes de Assinar * `EXPIRED` – Expirado * `FAILED_TO_LOAD` – Arquivos com falha * `PIONEER` – Todos os pioneiros fileKind: type: string enum: – FOLDER – DOCUMENT description: Tipo de Arquivo: * `FOLDER` – Pasta * `DOCUMENT` – Documento documentStatus: type: string enum: – PENDING – REVIEW – PUBLISHED – EXPIRED – DEPRECATED description: Tipo de Arquivo: * `PENDING` – Pendente * `REVIEW` – Revisão * `PUBLISHED` – Publicado * `EXPIRED` – Expirado * `DEPRECATED` – Deprecado timelineKind: type: string enum: – REVIEW – NEW_VERSION – CHECK_IN – CHECK_OUT – TAKE_OVER – MOVE – REMOVE – RESTORE description: Tipo da Linha de Tempo do Documento: * `REVIEW` – Comentário Revisão * `NEW_VERSION` – Nova Versão * `CHECK_IN` – Desbloquear Documento * `CHECK_OUT` – Bloquear o Documento * `TAKE_OVER` – Assumir Controle Documento * `MOVE` – Mover Documento * `REMOVE` – Remover Documento * `RESTORE` – Restaurar Pasta ou Documento envelopTimelineKind: type: string enum: – ADD_SIGNER – REMOVE_SIGNER – ADD_DOCUMENT – REMOVE_DOCUMENT – RESEND_DOCUMENT – LINK_SIGN_VISITED – ENVELOPE_CREATED – NOTIFY_EMAIL – NOTIFY_WHATSAPP – NOTIFY_SMS – NOTIFY_CONECTOR – AWAITING_SIGNATURE – SIGNATURE_COMPLETED – ACCEPT_TERMS – SIGNATURE_DECLINE – ENVELOPE_COMPLETED – DOCUMENT_VIEWED – DAYS_TO_EXPIRE – NOTIFY_EMAIL_MANUALLY – NOTIFY_EMAIL_AUTOMATIC – NOTIFY_PLATFORM_AUTOMATIC – NOTIFY_PLATFORM_MANUALLY – NOTIFY_SMS_AUTOMATIC – NOTIFY_SMS_MANUALLY – NOTIFY_WHATSAPP_AUTOMATIC – NOTIFY_WHATSAPP_MANUALLY – NOTIFY_CONECTOR_AUTOMATIC – NOTIFY_CONECTOR_MANUALLY description: Tipo da Linha de Envelope: * `ADD_SIGNER` – Adicionar Signatário * `REMOVE_SIGNER` – Remover Signatário * `ADD_DOCUMENT` – Adicionar Documento * `REMOVE_DOCUMENT` – Remover Documento * `RESEND_DOCUMENT` – Reenviar Documento para Assinatura * `LINK_SIGN_VISITED` – Link de assinatura visualizado * `ENVELOPE_CREATED` – Envelope criado * `NOTIFY_EMAIL` – Notificação por e-mail * `NOTIFY_WHATSAPP` – Notificação por Whatsapp * `NOTIFY_SMS` – Notificação por SMS * `NOTIFY_CONECTOR` – Notificação por Conector * `AWAITING_SIGNATURE` – Aguardando assinatura * `SIGNATURE_COMPLETED` – Assinatura Realizada * `ACCEPT_TERMS` – Aceite dos Termos * `SIGNATURE_DECLINE` – Assinatura Recusadas * `ENVELOPE_COMPLETED` – Envelope Concluído * `DOCUMENT_VIEWED` – Documento Visualizado * `DAYS_TO_EXPIRE` – Prazo de dias para expirar o envelope * `NOTIFY_EMAIL_MANUALLY` – Notificação por e-mail manual * `NOTIFY_EMAIL_AUTOMATIC` – Notificação por e-mail automático * `NOTIFY_PLATFORM_AUTOMATIC` – Notificação pela plataforma automático * `NOTIFY_PLATFORM_MANUALLY` – Notificação pela plataforma manual * `NOTIFY_SMS_AUTOMATIC` – Notificação por SMS automática * `NOTIFY_SMS_MANUALLY` – Notificação por SMS manual * `NOTIFY_WHATSAPP_AUTOMATIC` – Notificação por Whatsapp automática * `NOTIFY_WHATSAPP_MANUALLY` – Notificação por Whatsapp manual * `NOTIFY_CONECTOR_AUTOMATIC` – Notificação por Conector automática * `NOTIFY_CONECTOR_MANUALLY` – Notificação por Conector manual subjectType: type: string enum: – USER – ROLE – GROUP description: Tipos de sujeitos: * `USER` – Usuário * `ROLE` – Papel * `GROUP` – Grupo permissionType: type: string enum: – VIEW – DOWNLOAD – EDIT description: Tipo de permissão de um documento ou pasta: * `VIEW` – Visualizar documento * `DOWNLOAD` – Baixar documento * `EDIT` – Editar documento actionType: type: string enum: – VIEW_DOCUMENT – DOWNLOAD_DOCUMENT – EDIT_DOCUMENT – DELETE_DOCUMENT – RESTORE_DOCUMENT – PUBLISH_DOCUMENT – PRINT_DOCUMENT description: Tipo de permissão de um documento: * `VIEW_DOCUMENT` – Visualização de documento * `DOWNLOAD_DOCUMENT` – Download de documento * `EDIT_DOCUMENT` – Edição de documento * `DELETE_DOCUMENT` – Exclusão de um documento * `RESTORE_DOCUMENT` – Restaurar um documento * `PUBLISH_DOCUMENT` – Publicar documento * `PRINT_DOCUMENT` – Imprimir um documento permissionReplicateOptionType: type: string enum: – NONE – CHILD_FOLDERS – CHILD_FILES – ALL description: Tipo de replicação das permissões: * `NONE` – Não replicar * `CHILD_FOLDERS` – Pastas filhas * `CHILD_FILES` – Arquivos filhos * `ALL` – Todas as pastas e arquivos envelopeDraftStatusType: type: string enum: – DRAFT – FINISHED – EXPIRED – CANCELED – IN_PROGRESS description: Situação do Rascunho de um Envelope: * `DRAFT` – Rascunho – Situação inicial do rascunho de envelope * `FINISHED` – Concluído – Quando todos assinarem o envelope * `EXPIRED` – Expirado – Quando o prazo de assinatura expirou * `CANCELED` – Cancelado – Quando um usuário solicitar o cancelamento da assinatura * `IN_PROGRESS` – Em andamento – Quando o envelope ainda está em processo de assinatura orderType: type: string enum: – ASC – DESC description: Tipo da ordenação: * `ASC` – Crescente * `DESC` – Decrescente orderByField: type: string enum: – name – status – createdDate description: Campo usado na ordenação: * `name` – Nome do envelope * `status` – Situação do envelope * `createdDate` – Data de criação do envelope filterType: type: string enum: – FOLDER – DOCUMENT – ALL description: Tipo de filtro: * `FOLDER` – Pasta * `DOCUMENT` – Documento * `ALL` – Todos folderListPageableOrderByField: type: string enum: – name – author – lastModifiedDate – documentSize – documentStatus description: Campos de ordenação da primitiva folderListPageable: * `name` – Nome do documento/pasta * `author` – Autor do documento/pasta * `lastModifiedDate` – Data da última modificação * `documentSize` – Tamanho do documento * `documentStatus` – Status do documento tokenType: type: string enum: – NOT_USED – LOGGED_USER – MANDATORY description: Tipo de utilização do token pelo signatário: * `NOT_USED` – Não utilizado * `LOGGED_USER` – Utiliza o token do signatário logado na plataforma * `MANDATORY` – Obrigatório informar o token authenticationType: type: string enum: – NOT_USED – LOGGED_USER – MANDATORY – DIGITAL_CERTIFICATE description: Modo de autenticação utilizado pelo signatário: * `NOT_USED` – Não utilizado * `LOGGED_USER` – Usuário logado na plataforma * `MANDATORY` – Token informado pelo signatário * `DIGITAL_CERTIFICATE` – Autenticado com certificado digital communicationChannelType: type: string enum: – EMAIL – PLATFORM – WHATSAPP – SMS description: Canal de comunicação: * `EMAIL` – E-mail * `PLATFORM` – Notificação na plataforma SeniorX * `WHATSAPP` – Whatsapp * `SMS` – SMS listSignaturesOrderByField: type: string enum: – ENVELOPE_NAME – SIGNER_NAME – SIGNER_EMAIL – DOCUMENT_NAME – SIGNATURE_DATE – SEND_TO_SIGN_DATE – SIGNATURE_STATUS – FOLDER_NAME – SIGNER_SUBTYPE – SIGNATURE_TYPE – CREATED_BY – DECLINED_REASON description: Campos de ordenação da primitiva listSignatures: * `ENVELOPE_NAME` – Nome do envelope * `SIGNER_NAME` – Nome do assinante * `SIGNER_EMAIL` – E-mail do assinante * `DOCUMENT_NAME` – Nome do documento * `SIGNATURE_DATE` – Data de assinatura * `SEND_TO_SIGN_DATE` – Data de envio para a assinatura * `SIGNATURE_STATUS` – Status da assinatura * `FOLDER_NAME` – Nome da pasta * `SIGNER_SUBTYPE` – SubTipo de assinatura * `SIGNATURE_TYPE` – Tipo de assinatura * `CREATED_BY` – Criador do envelope * `DECLINED_REASON` – Motivo da recusa documentsCountOrderByField: type: string enum: – REQUESTER – TOTAL_DOCUMENTS – SIGNED_DOCUMENTS – PENDING_DOCUMENTS – DECLINED_DOCUMENTS – EXPIRED_DOCUMENTS description: Campos de ordenação da primitiva getDocumentsCountByRequester: * `REQUESTER` – Solicitante * `TOTAL_DOCUMENTS` – Quantidade total de documentos * `SIGNED_DOCUMENTS` – Quantidade de documentos assinados * `PENDING_DOCUMENTS` – Quantidade de documentos pendentes * `DECLINED_DOCUMENTS` – Quantidade de documentos recusados * `EXPIRED_DOCUMENTS` – Quantidade de documentos expirados envelopesRequesterOrderByField: type: string enum: – CREATED_BY – TOTAL_ENVELOPES – IN_PROCESS – COMPLETED – EXPIRED description: Campos de ordenação da primitiva getReportNumberOfEnvelopesByRequester: * `CREATED_BY` – Nome do solicitante * `TOTAL_ENVELOPES` – Total de envelopes * `IN_PROCESS` – Envelopes em processo * `COMPLETED` – Envelopes concluídos * `EXPIRED` – Envelopes expirados listInboxOrderByField: type: string enum: – ENVELOPE_NAME – REQUESTER_EMAIL – SEND_TO_SIGN_DATE – EXPIRATION_DATE – STATUS – SIGNATURE_DATE – SIGNER_TYPE – STATUS_FLOW – MANDATORY_VIEW – SIGNATURE_TYPE – MODALITY_FIELD description: Campos de ordenação da primitiva listInbox: * `ENVELOPE_NAME` – Nome do Envelope * `REQUESTER_EMAIL` – Email do Requisitante * `SEND_TO_SIGN_DATE` – Data de envio de Assinatura * `EXPIRATION_DATE` – Data de Expiração * `STATUS` – Status do Envelope * `SIGNATURE_DATE` – Data de Assinatura * `SIGNER_TYPE` – Tipo de Assinatura * `STATUS_FLOW` – Status do Flow de Assinatura * `MANDATORY_VIEW` – Visualização obrigatória * `SIGNATURE_TYPE` – Tipo de assinatura * `MODALITY_FIELD` – Modalidade do Campo de Assinatura certificateType: type: string enum: – PHYSICAL_PERSON – LEGAL_PERSON description: Tipo de certificado: * `PHYSICAL_PERSON` – Certificado Pessoa Física * `LEGAL_PERSON` – Certificado Pessoa Jurídica notificationTemplateType: type: string enum: – CANCELED – COMPLETED – SIGNATURE_REQUESTED – SIGNATURE_REQUESTED_IN_COPY – SIGNATURE_PENDING – TOKEN_SIGN – TOKEN_DECLINE description: Etapas da notificação do processo de assinatura: * `CANCELED` – Envelope Cancelado * `COMPLETED` – Processo de assinatura concluída * `SIGNATURE_REQUESTED` – Solicitação de assinatura * `SIGNATURE_REQUESTED_IN_COPY` – Solicitação de assinatura – Em cópia * `SIGNATURE_PENDING` – Assinatura pendente no envelope * `TOKEN_SIGN` – Token para assinatura * `TOKEN_DECLINE` – Token para recusa downloadBulkStatus: type: string enum: – REQUESTED – FAILED – DOWNLOAD_SIZE_LIMIT_EXCEED – SIZE_DISK_EXCEED – MAX_RETRY_ATTEMPTS – ZIP_LOCAL – ZIP_UPLOADED – ZIP_FAILED – PRE_SIGNED_URL description: Situação do Download em Lote: * `REQUESTED` – Solicitação de Download * `FAILED` – Download falhou * `DOWNLOAD_SIZE_LIMIT_EXCEED` – Tamanho do download maior que o permitido * `SIZE_DISK_EXCEED` – Sem espaço em disco * `MAX_RETRY_ATTEMPTS` – Máximo de tentativas alcançado * `ZIP_LOCAL` – Arquivo ZIP gerado em disco * `ZIP_UPLOADED` – Arquivo ZIP enviado para nuvem * `ZIP_FAILED` – Erro ao gerar o arquivo .zip * `PRE_SIGNED_URL` – URL de download gerada com sucesso modalityField: type: string enum: – REQUIRED – OPTIONAL – READING – NO_FIELD description: Modalidade de Campo de Leitura: * `REQUIRED` – Obrigatório * `OPTIONAL` – Opcional * `READING` – Leitura * `NO_FIELD` – Sem campo envelopeCompetence: type: string enum: – BRASIL – COLOMBIA description: Indica a jurisdição que o envelope pertence: * `BRASIL` – Brasil * `COLOMBIA` – Colômbia 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 listInboxDTO: description: Record para a caixa de entrada type: object required: – envelopeId – envelopeName – requesterEmail – signerEmail – signerType – userSignStatus – sendToSignDate – expirationDate – readyToSign – modalityField – authenticationType – mandatoryView – signatureType properties: envelopeId: type: string description: Id do envelope envelopeName: type: string description: Nome do envelope requesterEmail: type: string description: Solicitante – criador do envelope signerEmail: type: string description: E-mail do signatário signerType: type: string allOf: – #/definitions/signerType description: Tipo de assinatura requerida para o signatário userSignStatus: type: string allOf: – #/definitions/userSignStatus description: Status da assinatura sendToSignDate: type: string format: date-time description: Data de envio para assinatura expirationDate: type: string format: date-time description: Prazo do envelope readyToSign: type: boolean description: Apto para assinar dependendo do fluxo de assinatura signatureDate: type: string format: date-time description: Data da assinatura do envelope modalityField: type: string allOf: – #/definitions/modalityField description: Modalidade do Campo de Assinatura authenticationType: type: string allOf: – #/definitions/authenticationType description: Modo utilizado pelo signatário para autenticar a assinatura mandatoryView: type: boolean description: Visualização obrigatória askGeolocation: type: string allOf: – #/definitions/ask_geolocation description: Solicitar Geolocalização signatureType: type: string allOf: – #/definitions/signatureType description: Tipo de assinatura inboxFilter: description: Record para o filtro da caixa de entrada type: object properties: envelopeName: type: string description: Nome do envelope requesterEmail: type: string description: Email do solicitante userSignStatus: type: array items: type: string allOf: – #/definitions/userSignStatus description: Filtro pelo status da assinatura do signatário signerType: type: array items: type: string allOf: – #/definitions/signerType description: Filtro para tipo de assinatura readyToSign: type: boolean description: Filtro para o status do flow de assinatura do envelope orderByField: type: string allOf: – #/definitions/listInboxOrderByField description: Indica por qual campo os dados serão ordenados order: type: string allOf: – #/definitions/orderType description: Tipo da ordenação documentInfoDTO: description: Record para informações básicas do documento type: object required: – title – documentVersionId properties: type: string description: Nome do documento documentVersionId: type: string description: Versão do documento reportDocumentCountByRequester: description: Record do relatório quantidade de documentos por solicitante type: object required: – requester – totalDocumentsCount – pendingDocumentsCount – signedDocumentsCount – deniedDocumentsCount – expiredDocumentsCount properties: requester: type: string description: Solicitante totalDocumentsCount: type: integer format: int64 description: Quantidade de documentos enviados para a assinatura pendingDocumentsCount: type: integer format: int64 description: Quantidade de documentos com assinatura pendente signedDocumentsCount: type: integer format: int64 description: Quantidade de documentos assinados deniedDocumentsCount: type: integer format: int64 description: Quantidade de documentos recusados expiredDocumentsCount: type: integer format: int64 description: Quantidade de documentos com assinatura expirada whatsappTemplateRecord: description: Record do template do whatsapp type: object required: – name – status properties: name: type: string description: Nome do template status: type: string description: Status do template internalEnvelope: description: Record do envelope interno type: object required: – envelopeId – envelopeStatus properties: envelopeId: type: string description: Identificador do envelope envelopeStatus: type: string description: Status Envelope signers: type: array items: type: object allOf: – #/definitions/internalSigner description: Informações do signatário internalSigner: description: Record do signatário interno type: object required: – name – email – phone – status properties: name: type: string description: Nome do signatário email: type: string description: Email do signatário phone: type: string description: Telefone do signatário token: type: string description: Token de assinatura status: type: string allOf: – #/definitions/userSignStatus description: Status da assinatura documentTrackingDTO: description: Record do rastreio do documento type: object required: – id – type – documentVersion – user – trackingDate – reviewer – versionName properties: id: type: string description: Identificador type: type: string allOf: – #/definitions/actionType description: Tipo da ação documentVersion: type: string description: Versão do documento user: type: string description: Usuário que executou a ação trackingDate: type: string format: date-time description: Data do monitoramento reviewer: type: string description: Revisor versionName: type: string description: Nome da versão documentChanges: type: string description: Log das alterações no documento userSignatureDTO: description: Record dos dados do usuário assinante type: object required: – name properties: name: type: string description: Nome do assinante email: type: string description: e-mail do assinante phone: type: string description: Telefone do assinante ip: type: string description: ip do assinante signatureDate: type: string format: date-time description: Data da assinatura status: type: string allOf: – #/definitions/userSignStatus description: Status da assinatura signerType: type: string allOf: – #/definitions/signerType description: Tipo de assinatura requerida para o signatário signerSubType: type: string allOf: – #/definitions/signerSubType description: Subtipo do signatário reason: type: string description: Motivo da recusa da assinatura firstSignatureNotification: type: boolean description: Notificação da primeira assinatura enviada por email contextPdfFieldValue: description: Valor do contextPfdField type: object required: – fieldId – fieldValue properties: fieldId: type: string description: Id do campo fieldValue: type: string description: Valor do campo documentFromProcessPdf: description: DTO do documentFromProcessPdf type: object required: – versionId – title – originalWidth – originalHeight – fields properties: versionId: type: string description: Versão Id type: string description: Nome do documento originalWidth: type: number format: double description: Largura original do documento originalHeight: type: number format: double description: Altura original do documento fields: type: string description: campos do editor de pdf documentVersionCreatedDTO: description: Versão do documento criada type: object required: – documentId – documentVersion – status properties: documentId: type: string description: Identificador do documento documentVersion: type: string description: Identificador da versão do documento status: type: string allOf: – #/definitions/documentStatus description: Status da versão do documento ticket: type: string description: Ticket de Solicitação de criação do documento type: string description: Nome do documento folderPath: type: string description: Caminho da pasta do documento fullPath: type: string description: Caminho completo do documento size: type: string description: Tamanho do documento em bytes newDocumentDTO: description: Novo documento type: object required: – fileUrl – title properties: fileName: type: string maxLength: 255 description: Nome original do Arquivo. Se a url de upload foi solicitada para o GED, não é necessário informar novamente. fileUrl: type: string maxLength: 2048 description: URL do documento type: string maxLength: 255 description: Título do documento description: type: string maxLength: 1024 description: Descrição do documento folderPath: type: string description: Caminho da pasta (caso não exista, um novo path será criado) createNewPathWithNoParentPermissions: type: boolean description: Indicativo se o novo path a ser criado deve copiar as permissões da pasta superior, caso seja informado\ntrue a pasta será criada somente com as permissões informadas na lista permissions (ou assinalada que\nherda as permissões). Caso seja false a pasta será criada contendo as permissões informadas em\npermissions juntamente com as permissões de sua pasta superior (pai). Caso não informado, será considerado\no padrão false. default: false documentId: type: string description: Identificador do documento subject: type: string maxLength: 100 description: Assunto relacionado ao documento autor: type: string maxLength: 255 description: Usuário autor do documento versionName: type: string maxLength: 50 description: Nome da versão do documento documentMetadados: type: string description: Metadados para o documento no formato. Ex: area=rh, empresa=1 tags: type: string maxLength: 512 description: Nome das tags relacionadas. Ex: bpm, diretoria, urgente approved: type: boolean description: Indica se o documento requer aprovação default: false inheritedPermission: type: boolean description: Indica se a permissão é herdada da pasta pai default: false permissions: type: array items: type: object allOf: – #/definitions/documentPermissionKind description: Lista contendo as permissões que serão definidas para o documento ou path sendo criado signer: description: Assinante de um documento discriminator: _discriminator type: object required: – name – _discriminator properties: name: type: string maxLength: 255 description: Nome email: type: string maxLength: 255 description: Email phoneNumber: type: string maxLength: 255 description: Número do telefone, apenas os números sem pontuações username: type: string maxLength: 255 description: Caso seja usuário da plataforma para poder assinar sem token. Ex: username@domain askGeolocation: type: string allOf: – #/definitions/ask_geolocation description: Solicitar Geolocalização signerStatus: type: string description: Status da assinatura desse usuário tokenType: type: string allOf: – #/definitions/tokenType description: Tipo de utilização do token pelo signatário communicationChannel: type: object allOf: – #/definitions/communicationChannel description: Canal que será utilizado para comunicação com o signatário signerType: type: string allOf: – #/definitions/signerType description: Tipo de assinatura requerida para o signatário signerSubType: type: string allOf: – #/definitions/signerSubType description: Subtipo de assinatura orderSign: type: integer format: int64 description: Ordem do assinante no fluxo de assinaturas minimum: 1 default: 1 digitalCertificate: type: string allOf: – #/definitions/digitalCertificateOption description: Certificado Digital jobPosition: type: string description: Cargo/Função do signatário mandatoryEmail: type: boolean description: Email obrigatório para assinatura default: true _discriminator: type: string description: conector: description: Conector model type: object required: – id – inputs properties: id: type: string description: ID inputs: type: array items: type: object allOf: – #/definitions/conectorInput minimum: 1 description: Parâmetros de entrada conectorName: type: string description: Nome do conector conectorTitle: type: string description: Título do conector conectorDescription: type: string description: Descrição do conector conectorInput: description: Parâmetros de entrada do conector type: object required: – id – inputParameter – inputValue properties: id: type: string description: ID inputParameter: type: string description: Parâmetro de entrada inputValue: type: string description: Valor configurado conectorInputCompleteData: description: Parâmetros de entrada do conector type: object properties: id: type: string description: Id do input inputName: type: string description: Nome do input inputParameter: type: string description: Parâmetro de entrada inputType: type: string description: Tipo de input required: type: boolean description: Se é obrigatório default: false defaultInputConectorValueData: description: Informações salvas em um input de um conector type: object properties: conectorInputId: type: string description: Id do input do conector createdBy: type: string description: Autor da informação do input createdDate: type: string format: date-time description: Data de criação id: type: string description: Id da informação contida no input inputDefaultValue: type: string description: Valor padrão do input lastModifiedBy: type: string description: Autor da última modificação lastModifiedDate: type: string format: date-time description: Data da última modificação signerToEdit: description: Edição de Assinante de um envelope type: object required: – signer properties: signer: type: object allOf: – #/definitions/signer description: Signatário markToRemove: type: boolean description: Remover ou não o signatário default: false documentToEdit: description: Edição de documento de um envelope type: object required: – documentVersion properties: documentVersion: type: string description: Versão do Documento markToRemove: type: boolean description: Remover ou não o documento default: false envelopePosition: type: integer format: int64 description: Posição no envelope signatureFlowPageable: description: Record dos dados do fluxo dos usuários assinantes type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de registros contents: type: array items: type: object allOf: – #/definitions/signatureFlow minimum: 1 description: Dados das assinaturas conectorRecord: description: Conector record type: object required: – name – title – description – categories – createdDate – lastModifiedDate properties: id: type: string description: Identificador name: type: string description: nome type: string description: titulo description: type: string description: descrição asynchronous: type: boolean description: Assincrono default: false dynamic: type: boolean description: Dinamico default: false categories: type: array items: type: object allOf: – #/definitions/conectorCategoryType minimum: 1 description: Categorias createdDate: type: string format: date-time description: Data de criação lastModifiedDate: type: string format: date-time description: Data de atualização deprecated: type: boolean description: Descontinuado default: false template: type: boolean description: Template default: false assignmentRecord: description: Atribuidor record type: object required: – id – name – title – description – inputsData properties: id: type: string description: Identificador name: type: string description: nome type: string description: titulo description: type: string description: descrição inputsData: type: array items: type: object allOf: – #/definitions/assignmentInputData minimum: 1 description: Parâmetros de entrada conectorTemplateRecord: description: Template do conector type: object required: – templateType – templateName – templateCategory – templateStatus properties: id: type: string description: Identificador conectorId: type: string description: Identificador do conector templateType: type: string allOf: – #/definitions/templateType description: Tipo de template templateName: type: string description: Nome do template templateCategory: type: string allOf: – #/definitions/templateCategory description: Categoria do template templateStatus: type: string allOf: – #/definitions/templateStatus description: Status do template templateHeader: type: string description: Template header templateBody: type: string description: Template body templateFooter: type: string description: Template footer templateError: type: string description: Erro ao registrar o template assignmentInputData: description: Parâmetros de entrada da atribuição type: object required: – assignment – inputParameter properties: id: type: string description: Identificador assignment: type: object allOf: – #/definitions/assignment description: Atribuição inputParameter: type: string description: Parâmetro esperado pela Lambda inputName: type: string description: Descrição do input inputType: type: string description: Tipo do parâmetro esperado pela Lambda default: string required: type: boolean description: Se o parâmetro será obrigatório default: false assignment: description: Atruibuição do agendamento de conector type: object required: – name – title – description properties: id: type: string description: Identificador name: type: string description: nome type: string description: titulo description: type: string description: descrição conectorCategoryType: description: Tipo de categoria de conectores type: object required: – name properties: id: type: string description: Identificador name: type: string description: Nome da categoria conectorCategoryData: description: Dados completos sobre categorias de conectores type: object properties: id: type: string description: Identificador name: type: string description: Nome da categoria createdBy: type: string description: Autor da categoria createdDate: type: string format: date-time description: Data de criação da categoria lastModifiedBy: type: string description: Quem modificou por último lastModifiedDate: type: string format: date-time description: Data da última modificação moveDocumentInputForList: description: Entrada para mover documentos para uma pasta type: object required: – sourceId properties: sourceId: type: string description: Identificador do documento ou pasta origem targetId: type: string description: Identificador da pasta destino. Caso não informado, será considerado a pasta raiz. keepLocalPermission: type: boolean description: Manter permissões locais definidas default: true envelopePermission: description: Permissão de um envelope type: object required: – subject – type properties: subject: type: string description: Sujeito type: type: string allOf: – #/definitions/subjectType description: Tipo do sujeito signerStatus: description: Status de um assinante de um documento allOf: – #/definitions/signer – type: object required: – status properties: signatureDate: type: string format: date description: Data de assinatura, apenas para documento já assinado status: type: string allOf: – #/definitions/signatureStatus description: Status da assinatura desse usuário envelopeDTO: description: Dados de um envelope type: object required: – id – name – createdDate – createdBy properties: id: type: string description: Identificação askGeolocation: type: string allOf: – #/definitions/ask_geolocation description: Solicitar Geolocalização name: type: string description: Nome do rascunho instructionsToSigner: type: string maxLength: 1000 description: Um texto com instruções para o assinante envelope: type: object allOf: – #/definitions/envelopeSignature description: Envelope de assinatura usersDraft: type: array items: type: object allOf: – #/definitions/signer description: Assinantes do envelope documentsDraft: type: array items: type: object allOf: – #/definitions/documentVersionInfo description: Documentos do rascunho de envelope permissions: type: array items: type: object allOf: – #/definitions/envelopePermission description: Permissões do rascunho de envelope status: type: string allOf: – #/definitions/envelopeDraftStatusType description: Status do rascunho createdDate: type: string format: date-time description: Data de criação createdBy: type: string description: Autor do envelope daysToNotify: type: integer format: int64 description: Quantidade de dias para notificar caso a assinatura esteja pendente recurrentNotificationIntervalDays: type: integer format: int64 description: Quantidade de dias para notificar de maneira recorrente caso a assinatura esteja pendente daysToExpire: type: integer format: int64 description: Prazo para expiração do envelope expirationDate: type: string format: date-time description: Data de expiração do envelope mandatoryView: type: boolean description: Visualização obrigatória default: false notificateAuthor: type: boolean description: Notificar autor default: false lastSignDate: type: string format: date-time description: Data da última assinatura envelopeSignatureDTO: description: Dados de um envelope enviado para assinatura type: object required: – envelope properties: envelope: type: object allOf: – #/definitions/envelopeSignature description: Envelope users: type: array items: type: object allOf: – #/definitions/signer description: Assinantes do envelope documents: type: array items: type: object allOf: – #/definitions/documentVersionInfo description: Documentos do envelope permissions: type: array items: type: object allOf: – #/definitions/envelopePermission description: Permissões do envelope envelopeDocumentItem: description: Item de assinatura de documento type: object required: – versionId – title – url – envelopePosition properties: versionId: type: string description: Id da versão do documento type: string description: Título do documento url: type: string description: Url do Documento (válida por 1 minuto) envelopePosition: type: integer format: int64 description: Posição no envelope checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck errorData: description: Objeto para armazenar erros de primitivas bulk type: object required: – id – errorMessage properties: id: type: string description: Id do objeto fileKind: type: string allOf: – #/definitions/fileKind description: Tipo de arquivo errorMessage: type: string description: Mensagem de erro errorList: description: Lista de erros de primitivas bulk type: object required: – errors properties: errors: type: array items: type: object allOf: – #/definitions/errorData minimum: 1 description: Lista de erros optionDisplay: description: Opção de display para editor type: object required: – displayValue properties: displayValue: type: string description: valor mostrado na tela positionAttributes: description: Posição do campo no pdf type: object required: – x – y properties: x: type: number format: double description: Posição horizontal do campo no pdf y: type: number format: double description: Posição vertical do campo no pdf pdfEditorContextRecord: description: Relação do campo com o documento type: object required: – originalWidth – originalHeight properties: id: type: string description: Identificação documentVersionId: type: string description: Identificador da versão do documento originalWidth: type: number format: double description: Largura original do documento originalHeight: type: number format: double description: Altura original do documento jsonContext: type: string description: Json de contexto do editor jsonContextValues: type: string description: Valores preenchidos no json de contexto do editor folderPosition: description: Representa o caminho na árvore type: object required: – id – name – level properties: id: type: string description: ID da pasta name: type: string maxLength: 255 description: Nome level: type: integer format: int64 description: Nível na árvore parent: type: string description: Pasta superior inheritedPermission: type: boolean description: Indicador se a permissão de acesso foi herdada localPermissionLevel: type: integer format: int64 description: Nível de permissão de acesso definido localmente (caso não for herdada) inheritedPermissionLevel: type: integer format: int64 description: Nível de permissão de acesso que foi herdado inheritedPermissionFrom: type: string description: Indicador de qual pasta em que a permissão foi herdada isDeleting: type: boolean description: Indicador se a pasta está na fila de exclusão file: description: Representa arquivo ou pasta na árvore de navegação type: object required: – id – title – kind – children – publishedVersion – createdBy – lastModifiedDate – isExpired – isDeprecated properties: id: type: string description: Id do documento ou pasta type: string maxLength: 255 description: Nome author: type: string maxLength: 255 description: Autor da nova versão do documento kind: type: string allOf: – #/definitions/fileKind description: Indica se é um docuemnto ou pasta children: type: array items: type: string minimum: 1 description: Lista de IDs documentos e pastas filhas status: type: string allOf: – #/definitions/documentStatus description: Status Documento publishedVersion: type: string description: Versão publicada do documento mimetype: type: string description: Mimetype do arquivo, null caso seja uma pasta createdBy: type: string description: Quem criou o documento ou pasta lastModifiedDate: type: string format: date-time description: Data da última modificação lockedBy: type: string maxLength: 255 description: Documento travado para um usuário canEdit: type: boolean description: Verifica se o usuário tem permissão de editar canDownload: type: boolean description: Verifica se o usuário tem permissão de realizar download canChangeReview: type: boolean description: Verifica se o usuário tem permissão de editar a revisão removed: type: boolean description: Indicador para exclusão lógica do documento default: false signatureStatus: type: string allOf: – #/definitions/signatureStatus description: Status de assinatura de um documento inheritedPermission: type: boolean description: Indica se a permissão da pasta é herdada da pasta pai isExpired: type: boolean description: Indica se o documento está expirado isDeprecated: type: boolean description: Indica se o documento está obsoleto isDeleting: type: boolean description: Indica se a pasta esta na fila de deleção size: type: integer format: int64 description: Tamanho do documento documentInfo: description: Representação do documento em uma determinada versão type: object required: – id – title – version properties: id: type: string description: Identificador do documento type: string maxLength: 255 description: Nome lockedBy: type: string maxLength: 255 description: Documento travado para um usuário pending: type: boolean description: Status Pendente default: true type: object allOf: – #/definitions/documentVersionInfo description: Versão do documento documentVersionInfo: description: Representação de uma determinada versão de um documento type: object required: – id – title – signatureStatus – createdBy – reviewer – createdDate – lastModifiedDate properties: id: type: string description: Id da versão do documento type: string maxLength: 255 description: Nome status: type: string allOf: – #/definitions/documentStatus description: Status Documento signatureStatus: type: string allOf: – #/definitions/signatureStatus description: Status da assinatura desse usuário mimetype: type: string description: Mimetype do arquivo, null caso seja uma pasta versionName: type: string maxLength: 50 description: Nome da Versão do Usuário path: type: array items: type: object allOf: – #/definitions/folderPosition description: Caminho para o documento createdBy: type: string description: Publicador reviewer: type: string description: Revisor createdDate: type: string format: date-time description: Data de criação da versão lastModifiedDate: type: string format: date-time description: Data da última modificação envelopePosition: type: integer format: int64 description: Posição no envelope envelopeDocuments: description: Documentos do envelope type: object required: – documentVersion – envelopePosition properties: documentVersion: type: string description: Versão do Documento envelopePosition: type: integer format: int64 description: Posição no envelope minimum: 1 user: description: Informações referente a um usuário type: object required: – id – username – fullName – email – tenantDomain – tenantName – tenantLocale properties: id: type: string description: Identificador do usuário username: type: string description: Nome do usuário fullName: type: string description: Nome completo do usuário description: type: string description: Descrição do usuário email: type: string description: Endereço de e-mail do usuário locale: type: string description: localidade do usuário tenantDomain: type: string description: Domínio do tenant no login do usuário tenantName: type: string description: Nome do tenant do usuario tenantLocale: type: string description: Localidade do tenant do usuario photo: type: string description: Foto do usuário em Base64. Retornado em apenas algumas primitivas por questão de performance phoneNumber: type: string description: Número de telefone blocked: type: boolean description: Se o usuário está bloqueado na plataforma authType: type: string description: Tipo de autenticação do usuário integrationCode: type: string description: Código do tipo de integração do usuário integrationName: type: string description: Nome do tipo de integração do usuário group: description: Informações referente a um grupos type: object required: – id – name properties: id: type: string description: Identificador do Grupo name: type: string description: Nome do Grupo description: type: string description: Descrição do Grupo email: type: string description: Email do grupo role: description: Um papel de usuário type: object required: – name – description properties: name: type: string description: Nome único do papel description: type: string description: Descrição do papel verifiedPermission: description: Permissão verificada type: object required: – type – hasPermission properties: type: type: string allOf: – #/definitions/permissionType description: Tipo da permissão hasPermission: type: boolean description: Se possui permissão documentPermissionKind: description: Permissão para o novo documento type: object required: – subjectType – subjectName – permissionType properties: subjectType: type: string allOf: – #/definitions/subjectType description: Indica o sujeito (papel, grupo ou usuário) subjectName: type: string description: Identicador do sujeito (Tipo USER – informar username@dominio.com.br) permissionType: type: string allOf: – #/definitions/permissionType description: Tipo da permissão envelopeSignatureStatus: description: Status de assinatura de um envelope type: object required: – signers – isFinished – documentVersionIds – envelopeId properties: signers: type: array items: type: object allOf: – #/definitions/signerStatus minimum: 1 description: Lista com os assinantes isFinished: type: boolean description: Se o processo de assinatura já foi finalizado documentVersionIds: type: array items: type: string minimum: 1 description: Id das versões dos documentos envelopeId: type: string description: Id do envelope status: type: string description: Status do envelope. Equivale ao status mantido no serviço de assinatura eletrônica na AWS. errorMessage: type: string description: Mensagem de erro que ocorreu no envelope caso o status seja de falha envelopeCompletedUrl: type: array items: type: object allOf: – #/definitions/signerEnvelopeCompletedUrl description: URL para visualização do envelope concluído documentBasicInfoToView: description: Informações básicas do documento para visualização type: object required: – title – url properties: type: string description: Título do documento url: type: string description: Url do Documento (válida por 1 minuto) validDocumentToSign: description: Informações do documento válido para assinar type: object required: – id – title – publishedVersion – lastModifiedDate properties: id: type: string description: id type: string description: Nome do documento publishedVersion: type: string description: Versão publicada do documento lastModifiedDate: type: string format: date-time description: Data da última modificação userFavorite: description: Pastas favoritas de um usuário type: object required: – id – folderId – name – createdDate properties: id: type: string description: Id do favorito folderId: type: string description: Id da pasta favoritada name: type: string description: Nome createdDate: type: string format: date-time description: Data criação favorito communicationChannel: description: Canais de comunicação utilizados com o signatário type: object properties: email: type: boolean description: E-mail default: false platform: type: boolean description: Notificação na plataforma SeniorX default: false whatsapp: type: boolean description: Whatsapp default: false sms: type: boolean description: SMS default: false documentRemovedDTO: description: Documento removido type: object required: – documentId – deleteBy – deletedDate properties: documentId: type: string description: Identificador do documento type: string description: Nome do documento fullPath: type: string description: Caminho completo do documento signatureStatus: type: string allOf: – #/definitions/signatureStatus description: Status de assinatura de um documento deleteBy: type: string description: usuário que deletou o arquivo deletedDate: type: string format: date-time description: data que o documento foi deletado documentTrashItem: description: Itens da lixeira type: object required: – id – kind – createdBy – deleteBy – lastModifiedDate properties: id: type: string description: Identificador do documento type: string description: Título do documento parentFolder: type: string description: Pasta pai do documento kind: type: string allOf: – #/definitions/fileKind description: Tipo de resultado documento ou pasta createdBy: type: string description: Usuário que criou o documento deleteBy: type: string description: Usuário que deletou o arquivo lastModifiedDate: type: string format: date-time description: data que o documento foi deletado signatureStatus: type: string allOf: – #/definitions/signatureStatus description: Status de assinatura de um documento mimetype: type: string description: Mimetype do arquivo, null caso seja uma pasta documentStatus: type: string allOf: – #/definitions/documentStatus description: Status Documento path: type: array items: type: object allOf: – #/definitions/folderPosition description: Caminho onde esta a pasta ou documento searchResult: description: retorno da pesquisa de documentos/pastas no ged type: object required: – id – title – kind – createdBy – author – lastModifiedDate properties: id: type: string description: Identificador documento/pasta type: string description: Título documento/pasta kind: type: string allOf: – #/definitions/fileKind description: Tipo de resultado documento ou pasta createdBy: type: string description: Nome do Publicador/Criador documento/pasta author: type: string description: Nome do Autor do documento lastModifiedDate: type: string format: date-time description: Data de criação documento/pasta canEdit: type: boolean description: Verifica se o usuário tem permissão de editar canDownload: type: boolean description: Verifica se o usuário tem permissão de realizar download signatureStatus: type: string allOf: – #/definitions/signatureStatus description: Status de assinatura de um documento mimetype: type: string description: Mimetype do arquivo, null caso seja uma pasta documentStatus: type: string allOf: – #/definitions/documentStatus description: Status Documento path: type: array items: type: object allOf: – #/definitions/folderPosition description: Caminho onde esta a pasta ou documento inheritedPermission: type: boolean description: Indicador se o documento/pasta possui as permissões herdadas signatureLink: description: Lista contendo os e-mails, telefones e links para assinatura eletrônica type: object required: – signer – link properties: signer: type: string description: Email que receberá o link phone: type: string description: Telefone de quem receberá o link link: type: string description: link da assinatura signature: description: Payload utilizado quando um signatário solicitar a assinatura eletrônica no envelope/processo discriminator: _discriminator type: object required: – processId – email – _discriminator properties: processId: type: string description: Identificador do processo/envelope de assinatura token: type: string description: Token MFA informado pelo signatário email: type: string description: Email do signatário location: type: object allOf: – #/definitions/location description: Localização geodésica de onde o documento está sendo assinado phone: type: string description: Telefone do signatário name: type: string description: Nome do signatário ip: type: string description: Endereço de IP de onde o signatário está assinando o documento incrementSignature: type: boolean description: Determina se o signatário irá incrementar ou não o contador de assinaturas do documento default: true decline: type: boolean description: Informa se o token será usado para assinar ou recusar default: false platform: type: string description: Sistema operacional do assinante userAgent: type: string description: Navegador do assinante _discriminator: type: string description: decline: description: Payload utilizado quando um signatário recusar a assinatura do envelope allOf: – #/definitions/signature – type: object required: – reason properties: reason: type: string description: Motivo da recusa da assinatura location: description: Contém a localização para assinar um processo/envelope type: object required: – latitude – longitude properties: latitude: type: number format: double description: Latitude longitude: type: number format: double description: Longitude signatureToken: description: Usado para buscar o token da assinatura type: object required: – processId – email properties: processId: type: string description: Identificador do processo/envelope de assinatura email: type: string description: E=mail do signatário decline: type: boolean description: Informa se o token será usado para assinar ou recusar default: false envelopeLoadDocumentsError: description: Usado para recuperar informações sobre erro que ocorreu no processo de assinatura type: object required: – type – message properties: type: type: string description: Tipo do erro message: type: string description: Mensagem de erro processId: type: string description: Identificador do processo/envelope de assinatura documentId: type: string description: Identificador do documento signatureManagementFilterDTO: description: Filtro da gestão de assinaturas discriminator: _discriminator type: object required: – _discriminator properties: documentName: type: string description: Nome do documento signerName: type: string description: Nome do assinante signerStatus: type: string description: Status da assinatura signerStatusList: type: array items: type: string allOf: – #/definitions/signerStatusFilter description: Lista com status da assinatura signerTypeList: type: array items: type: string allOf: – #/definitions/signerStatusFilter description: Lista com os tipos de assinante initialDate: type: string format: date description: Data inicial finalDate: type: string format: date description: Data final envelopeName: type: string description: Nome do envelope folderName: type: string description: Nome da pasta folderId: type: string description: Id da pasta envelopeId: type: string description: ID do envelope createdBy: type: string description: Email do solicitante includeSubfolders: type: boolean description: Incluir subPasta default: false orderByField: type: string allOf: – #/definitions/listSignaturesOrderByField description: Indica por qual campo os dados serão ordenados order: type: string allOf: – #/definitions/orderType description: Tipo da ordenação signerSubType: type: array items: type: string allOf: – #/definitions/signerSubType description: Subtipo da assinatura signatureType: type: array items: type: string allOf: – #/definitions/signatureType description: Tipo de assinatura authenticationType: type: array items: type: string allOf: – #/definitions/authenticationType description: Modo utilizado pelo signatário para autenticar a assinatura _discriminator: type: string description: listSignaturesFilter: description: Filtro da gestão de assinaturas – primitiva listSignaturesV2 allOf: – #/definitions/filterReportByRequester – type: object properties: documentName: type: string description: Nome do documento signerName: type: string description: Nome do assinante signerStatus: type: string description: Status da assinatura signerStatusList: type: array items: type: string allOf: – #/definitions/signerStatusFilter description: Lista com status da assinatura signerTypeList: type: array items: type: string allOf: – #/definitions/signerStatusFilter description: Lista com os tipos de assinante envelopeName: type: string description: Nome do envelope envelopeId: type: string description: ID do envelope signerSubType: type: array items: type: string allOf: – #/definitions/signerSubType description: Subtipo da assinatura signatureType: type: array items: type: string allOf: – #/definitions/signatureType description: Tipo de assinatura authenticationType: type: array items: type: string allOf: – #/definitions/authenticationType description: Modo utilizado pelo signatário para autenticar a assinatura listSignaturesDocumentsFilter: description: Filtro da gestão de assinaturas – primitiva listSignaturesDocumentsV2 allOf: – #/definitions/filterReportByRequester – type: object properties: documentName: type: string description: Nome do documento envelopeName: type: string description: Nome do envelope envelopeId: type: string description: ID do envelope getNumberOfEnvelopesByStatusFilter: description: Filtro da gestão de assinaturas – primitiva getNumberOfEnvelopesByStatusV2 allOf: – #/definitions/filterReportByRequester – type: object properties: documentName: type: string description: Nome do documento envelopeName: type: string description: Nome do envelope getNumberOfSignaturesByStatusFilter: description: Filtro da gestão de assinaturas – primitiva getNumberOfSignaturesByStatusV2 allOf: – #/definitions/filterReportByRequester – type: object properties: documentName: type: string description: Nome do documento envelopeName: type: string description: Nome do envelope filterReportByRequester: description: Filtro do relatório quantitativo de documentos e envelopes discriminator: _discriminator type: object required: – initialDate – finalDate – _discriminator properties: initialDate: type: string format: date description: Data inicial obrigatória finalDate: type: string format: date description: Data final obrigatória createdBy: type: string description: E-mail do solicitante folderId: type: string description: Identificador da pasta includeSubfolders: type: boolean description: Incluir sub-pastas default: false _discriminator: type: string description: signatureManagementFilterPaginationDTO: description: Filtro da gestão de assinaturas com paginação allOf: – #/definitions/signatureManagementFilterDTO – type: object required: – page – size properties: page: type: integer format: int64 description: Página size: type: integer format: int64 description: Tamanho signatureDTO: description: Dados da assinatura type: object required: – envelopeId – signerId – documentVersionId – name – email – status – documentName – date – envelopeName – createdBy properties: envelopeId: type: string description: Identificador do envelope signerId: type: string description: Identificador do assinante documentVersionId: type: string description: Identificador do documento name: type: string description: Nome do assinante email: type: string description: Email do assinante status: type: string description: Status documentName: type: string description: Nome do documento date: type: string format: date-time description: Data da criação da assinatura envelopeName: type: string description: Nome do envelope signatureDate: type: string format: date-time description: Data da Assinatura folderName: type: string description: Nome da pasta onde está o documento documentStatus: type: string description: Status do documento createdBy: type: string description: Email do solicitante signerSubType: type: string description: Sub tipo da assinatura do usuário authenticationType: type: string description: Tipo da assinatura signerType: type: string description: Tipo do assinante readyToSign: type: boolean description: Apto para assinar dependendo do fluxo de assinatura declinedReason: type: string description: Motivo de recusa signaturePageableDTO: description: Dados da página de gestão de assinaturas type: object required: – totalPages – totalElements – signatureList properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de registros signatureList: type: array items: type: object allOf: – #/definitions/signatureDTO minimum: 1 description: Dados das assinaturas signaturePageable: description: Dados da página de gestão de assinaturas V2 type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de registros contents: type: array items: type: object allOf: – #/definitions/signatureDTO minimum: 1 description: Dados das assinaturas numberOfEnvelopesByStatusDTO: description: Dados para gráfico de envelopes por status type: object required: – completed – pending – expired – error properties: completed: type: integer format: int64 description: Envelopes concluídos pending: type: integer format: int64 description: Envelopes pendentes expired: type: integer format: int64 description: Envelopes expirados error: type: integer format: int64 description: Envelopes com erro numberOfSignaturesByStatusDTO: description: Dados para gráfico de assinatura por status type: object required: – signed – pending – receiveCopy – receiveCopyBeforeSign – declined properties: signed: type: integer format: int64 description: Assinados pending: type: integer format: int64 description: Pendentes receiveCopy: type: integer format: int64 description: Recebidos em cópia receiveCopyBeforeSign: type: integer format: int64 description: Recebidos em cópia – Antes de assinar declined: type: integer format: int64 description: Recusados digitalSignature: type: integer format: int64 description: Assinados Digitalmente digitalDeclined: type: integer format: int64 description: Recusados Digitalmente pendencies: description: Documento com status Pendente type: object required: – id – title – createdBy – lastModifiedDate – status – mimetype – path properties: id: type: string description: Id do Documento type: string description: Nome do Documento createdBy: type: string description: Autor do Documento lastModifiedDate: type: string format: date-time description: Ultima modificacao status: type: string allOf: – #/definitions/documentStatus description: Status Documento mimetype: type: string description: Mimetype do arquivo, null caso seja uma pasta path: type: array items: type: object allOf: – #/definitions/folderPosition minimum: 1 description: Local do Arquivo signerHistory: description: Dados sobre o histórico de um signatário type: object required: – email – name – signerType – signerSubType – signatureStatus properties: email: type: string description: E-mail do signatário name: type: string description: Nome do signatário signerType: type: string allOf: – #/definitions/signerType description: Tipo de signatário signerSubType: type: string allOf: – #/definitions/signerSubType description: Subtipo do signatário signatureStatus: type: string allOf: – #/definitions/userSignStatus description: Status da assinatura orderSign: type: integer format: int64 description: Ordem de assinatura tokenType: type: string allOf: – #/definitions/tokenType description: Tipo de utilização do token pelo signatário acceptTerms: type: boolean description: Aceite dos termos de serviço signatureDate: type: string format: date-time description: Data da assinatura linkSignVisitedDate: type: array items: type: string format: date-time description: Lista de datas que o link de assinatura foi visualizado phone: type: string description: Número de telefone username: type: string description: Nome de usuário envelopeTimelineRecord: description: Dados da timeline do envelope type: object required: – envelopeId – kind – note – createdBy – createdDate – lastModifiedBy – lastModifiedDate properties: envelopeId: type: string description: Id do Envelope kind: type: string description: Tipo da timeline note: type: string description: Observação createdBy: type: string description: Criador do evento createdDate: type: string format: date-time description: Date e hora da criação do evento lastModifiedBy: type: string description: Responsável pela ultima modificação lastModifiedDate: type: string format: date-time description: Data da ultima modificação certificateDTO: description: Dados do Certificado Digital type: object required: – certificate properties: certificateType: type: string allOf: – #/definitions/certificateType description: Tipo de certificado certificate: type: string format: byte description: Arquivo do Certificado password: type: string description: Password certificado signerEnvelopeCompletedUrl: description: Url para visualizar envelope assinado de acordo com o e-mail type: object properties: email: type: string description: e-mail do assinante url: type: string description: URL do envelope concluído para visualização documentSigned: description: Documentos que foram assinados type: object required: – documentVersionId – documentSignedUrl properties: documentVersionId: type: string description: Id da versão do documento documentSignedUrl: type: string description: Link para o documento assinado signatureFlow: description: Record dos dados do fluxo de usuários assinantes type: object required: – name – orderSign properties: 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/userSignStatus description: Status da assinatura signerType: type: string allOf: – #/definitions/signerType description: Tipo de assinatura requerida para o signatário signerSubType: type: string allOf: – #/definitions/signerSubType description: Subtipo do signatário orderSign: type: integer format: int64 description: Ordem da assinatura readyToSign: type: boolean description: Apto para assinar dependendo do fluxo de assinatura default: false reportNumberOfEnvelopesByRequester: description: Dados para o relatório de quantidade de envelopes por solicitante type: object required: – createdBy – created – inProcess – finished – expired properties: createdBy: type: string description: Solicitante e-mail created: type: integer format: int64 description: Envelopes criados inProcess: type: integer format: int64 description: Envelopes em processo finished: type: integer format: int64 description: Envelopes finalizados expired: type: integer format: int64 description: Envelopes expirados documentVersionProperties: description: Propriedades da versão do documento type: object required: – title – mimeType – author – createdBy – size – description – createdDate – lastModifiedDate – expirationDate – deprecatedDate properties: type: string description: Título do documento mimeType: type: string description: Formato do documento author: type: string description: Autor do documento versionName: type: string description: Nome da versão do documento majorVersion: type: integer format: int64 description: Versão major do documento default: 0 minorVersion: type: integer format: int64 description: Versão minor do documento default: 0 patchVersion: type: integer format: int64 description: Versão patch do documento default: 0 createdBy: type: string description: Publicador size: type: integer format: int64 description: Tamanho do documento description: type: string description: Descrição do documento subject: type: array items: type: string description: Assuntos do documento createdDate: type: string format: date-time description: Data de criação lastModifiedDate: type: string format: date-time description: Data da última modificação expirationDate: type: string format: date description: Data de expiração deprecatedDate: type: string format: date description: Data de obsolescência subject: description: Assunto type: object required: – name properties: id: type: string format: uuid description: Identificação name: type: string maxLength: 100 description: Nome do Assunto applicants: type: array items: type: object allOf: – #/definitions/applicant description: Interessados no assunto editSubject: type: object required: – id allOf: – #/definitions/subject applicant: description: Interessados type: object properties: id: type: string format: uuid description: Identificação userName: type: string description: Nome do interessado type: type: string allOf: – #/definitions/subjectType description: Tipo do sujeito subject: type: object allOf: – #/definitions/subject description: Assunto groupId: type: string description: Identificação de um grupo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editApplicant: type: object required: – id allOf: – #/definitions/applicant document: description: Documento type: object properties: id: type: string format: uuid description: Identificação type: string maxLength: 255 description: Nome do Documento dueDate: type: string format: date-time description: Vencimento do Documento parent: type: string format: uuid description: ID do folder pai lockedBy: type: string maxLength: 255 description: Documento travado para um usuário versions: type: array items: type: object allOf: – #/definitions/documentVersion description: Versões do Documento currentVersion: type: object allOf: – #/definitions/documentVersion description: Versão Atual publishedVersion: type: object allOf: – #/definitions/documentVersion description: Versão Publicada pending: type: boolean description: Status Pendente default: true permissions: type: array items: type: object allOf: – #/definitions/permission description: Lista de permissões timeline: type: array items: type: object allOf: – #/definitions/timeline description: Timeline do documento removed: type: boolean description: Indicador para exclusão lógica do documento default: false defaultReviewer: type: string maxLength: 255 description: Revisor para proxima versao do documento inheritedPermission: type: boolean description: Indica se a permissão do documento é herdada da pasta pai default: false isDeleting: type: boolean description: Indica se a pasta esta na fila de deleção default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDocument: type: object required: – id allOf: – #/definitions/document documentVersion: description: Versão de um Documento type: object properties: id: type: string format: uuid description: ID document: type: object allOf: – #/definitions/document description: Documento Associado readOnly: true changeVersion: type: boolean description: Indicador Versão Atualizada default: false changeFile: type: boolean description: Indicador Arquivo Atualizado default: false versionName: type: string maxLength: 50 description: Nome da Versão do Usuário majorVersion: type: integer format: int64 description: Versão Maior – usuário trocou versão default: 0 minorVersion: type: integer format: int64 description: Versão Menor – upload novo arquivo default: 0 patchVersion: type: integer format: int64 description: Versão Mudança nas Propriedades do Documento default: 0 uploadId: type: string description: Identificador do upload originalUploadId: type: string description: Identificador do upload Original, caso a versão assinada tenha sido originalFilename: type: string maxLength: 255 description: Nome Original do Arquivo size: type: integer format: int64 description: Tamanho do arquivo type: string maxLength: 255 description: Titulo da Versão do Documento description: type: string maxLength: 1024 description: Descrição do Documento mimetype: type: string maxLength: 255 description: Tipo do Arquivo status: type: string allOf: – #/definitions/documentStatus description: Status Documento meta: type: array items: type: object allOf: – #/definitions/documentMetadata description: Metadados do Documento tags: type: string maxLength: 512 description: Tags subjects: type: array items: type: object allOf: – #/definitions/subject description: Assunto author: type: string maxLength: 255 description: Autor do Documento reviewer: type: string maxLength: 255 description: Revisor expirationDate: type: string format: date description: Date de expiração deprecationDate: type: string format: date description: Date de depreciação previewId: type: string description: Identificador do upload de Preview previewFilename: type: string description: Nome Original do Arquivo de Preview signatureStatus: type: string allOf: – #/definitions/signatureStatus description: Status de assinatura de um documento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDocumentVersion: type: object required: – id allOf: – #/definitions/documentVersion timeline: description: Timeline do documento type: object required: – kind properties: id: type: string format: uuid description: ID kind: type: string allOf: – #/definitions/timelineKind description: Tipo da timeline note: type: string description: Anotação sobre o documento document: type: object allOf: – #/definitions/document description: Documento Associado folder: type: object allOf: – #/definitions/folder description: Folder Associado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editTimeline: type: object required: – id allOf: – #/definitions/timeline draftDocument: description: Documento em rascunho type: object required: – filename properties: id: type: string format: uuid description: ID filename: type: string maxLength: 255 description: Nome do Arquivo uploadId: type: string maxLength: 255 description: Identificador do upload uploadVersion: type: string maxLength: 255 description: Versão do upload no serviço de armazenamento uploadURI: type: string maxLength: 2048 description: URI para upload do documento mimetype: type: string maxLength: 255 description: Tipo do Arquivo size: type: integer format: int64 description: Tamanho do Arquivo em bytes owner: type: string maxLength: 255 description: Proprietário do Arquivo trashed: type: boolean description: Indica se o foi marcado para remoção upload: type: boolean description: Indica se foi feito upload arquivo uploadDate: type: string format: date-time description: Data do Upload do arquivo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDraftDocument: type: object required: – id allOf: – #/definitions/draftDocument folder: description: Pasta type: object required: – name properties: id: type: string format: uuid description: Identificação name: type: string maxLength: 255 description: Nome do Arquivo description: type: string maxLength: 1024 description: Descrição parent: type: string format: uuid description: ID da pasta pai defaultMetadata: type: array items: type: object allOf: – #/definitions/documentMetadata description: Metadados Padrões para Documentos da Pasta permissions: type: array items: type: object allOf: – #/definitions/permission description: Lista de permissões removed: type: boolean description: Indicador para exclusão lógica da pasta default: false inheritedPermission: type: boolean description: Indica se a permissão da pasta é herdada da pasta pai isDeleting: type: boolean description: Indica se a pasta esta na fila de deleção default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editFolder: type: object required: – id allOf: – #/definitions/folder documentTag: description: Tag de documento type: object required: – name properties: id: type: string format: uuid description: Identificação documents: type: array items: type: object allOf: – #/definitions/documentVersion description: Documentos Relacionado name: type: string maxLength: 100 description: Nome da tag editDocumentTag: type: object required: – id allOf: – #/definitions/documentTag documentMetadata: description: Metadados do documento type: object required: – key properties: id: type: string format: uuid description: Identificação key: type: string maxLength: 50 description: Chave do Metadado value: type: string maxLength: 255 description: Valor da Chave editDocumentMetadata: type: object required: – id allOf: – #/definitions/documentMetadata permission: description: Permissão por subject type: object required: – subject – type – permissionLevel – active properties: id: type: string format: uuid description: Identificação folder: type: object allOf: – #/definitions/folder description: Folder document: type: object allOf: – #/definitions/document description: File subject: type: string description: Sujeito (Tipo USER – informar username@dominio.com.br) type: type: string allOf: – #/definitions/subjectType description: Tipo do sujeito permissionLevel: type: integer format: int64 description: Nível de permissão, 0 para sem permissão, 1 para permissão de visualização e 2 para permissão de edição active: type: boolean description: Indica se a permissão está ativa ou desabilitada createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editPermission: type: object required: – id allOf: – #/definitions/permission tracking: description: Rastreamento de ações type: object required: – id – type – node properties: id: type: string format: uuid description: Identificador type: type: string allOf: – #/definitions/actionType description: Tipo da ação que está sendo registrada node: type: string format: uuid description: Identificador do objeto onde a ação foi executada type: string format: uuid description: Versão do objeto onde a ação foi executada description: type: string description: Descrição adicional documentChanges: type: string description: Log das alterações no documento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editTracking: type: object required: – id allOf: – #/definitions/tracking documentTicket: description: Armazena status de criação de documentos via integração type: object required: – finished properties: id: type: string format: uuid description: Identificação do Ticket finished: type: boolean description: Indica se o processo de criação foi finalizado documentId: type: string maxLength: 255 description: Identificador do Documento Criado batchId: type: string description: Id do lote de criação de documentos message: type: string maxLength: 1000 description: Mensagem da finalização do ticket createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDocumentTicket: type: object required: – id allOf: – #/definitions/documentTicket documentBatch: description: Documento type: object required: – finishedStatus properties: id: type: string format: uuid description: Identificação do batch finishedStatus: type: string allOf: – #/definitions/batchStatus description: Indica estado de finalização de execução do lote createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDocumentBatch: type: object required: – id allOf: – #/definitions/documentBatch envelopeSignature: description: Envelopes de assinatura de documento type: object required: – id – askGeolocation properties: id: type: string description: Id do Envelope de assinatura askGeolocation: type: string allOf: – #/definitions/ask_geolocation description: Solicitar Geolocalização instructionsToSigner: type: string description: Um texto com instruções para o assinante isFinished: type: boolean description: Se o processo foi finalizado default: false isNotifyUser: type: boolean description: Notificar usuário na plataforma default: false isSendEmail: type: boolean description: Enviar e-mail para usuário com link para assinar documentos default: true status: type: string description: Status do envelope. Equivale ao status mantido no serviço de assinatura eletrônica na AWS. name: type: string description: Nome do envelope daysToNotify: type: integer format: int64 description: Quantidade de dias para notificar caso a assinatura esteja pendente recurrentNotificationIntervalDays: type: integer format: int64 description: Quantidade de dias para notificar de maneira recorrente caso a assinatura esteja pendente minimum: 0 maximum: 239 default: 0 daysToExpire: type: integer format: int64 description: Prazo para expiração do envelope expirationDate: type: string format: date-time description: Data de expiração do envelope envelopeBatchId: type: string format: uuid description: Id do envelope em lote mandatoryView: type: boolean description: Visualização obrigatória default: false notificateAuthor: type: boolean description: Notificar autor default: false notificationTemplate: type: object allOf: – #/definitions/notificationTemplate description: Template de Notificação newSign: type: boolean description: Novo serviço de assinatura default: false currentOrder: type: integer format: int64 description: Ordem atual de assinatura default: 0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: documentEnvelopeSignature: description: Entidade de relacionamento documento x processo de assinatura type: object required: – documentVersionId – envelope properties: id: type: string format: uuid description: Identificador documentVersionId: type: string description: Id da versão do documento envelope: type: string description: Envelope de assinatura envelopePosition: type: integer format: int64 description: Posição no envelope minimum: 1 default: 1 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: userSignature: description: Entidade para controle das assinaturas eletrônicas type: object required: – envelopId – email – status properties: id: type: string format: uuid description: Identificação envelopId: type: string format: uuid description: identificador da assinatura name: type: string description: Nome do assinante email: type: string description: Email phone: type: string description: Telefone status: type: string allOf: – #/definitions/userSignStatus description: Status da assinatura signatureDate: type: string format: date-time description: Data da assinatura ip: type: string description: Ip do assinante location: type: string description: Geolocalização do assinante tokenType: type: string allOf: – #/definitions/tokenType description: Tipo de utilização do token pelo signatário communicationChannel: type: string description: Canal que será utilizado para comunicação com o signatário signerType: type: string allOf: – #/definitions/signerType description: Tipo de assinatura requerida para o signatário signerSubType: type: string allOf: – #/definitions/signerSubType description: Subtipo de assinatura orderSign: type: integer format: int64 description: Ordem do assinante no fluxo de assinaturas minimum: 1 default: 1 digitalCertificate: type: string allOf: – #/definitions/digitalCertificateOption description: Certificado Digital requerido reason: type: string description: Motivo da recusa da assinatura jobPosition: type: string description: Cargo/Função do signatário firstNotifiedSignature: type: boolean description: Notificação da primeira assinatura enviada por email signatureType: type: string allOf: – #/definitions/signatureType description: Tipo da assinatura do signatário platform: type: string description: Sistema operacional do assinante userAgent: type: string description: Navegador do assinante authenticationType: type: string allOf: – #/definitions/authenticationType description: Modo utilizado pelo signatário para autenticar a assinatura mandatoryEmail: type: boolean description: Email obrigatório para assinatura default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editUserSignature: type: object required: – id allOf: – #/definitions/userSignature authorizationUserSignature: description: Entidade para controle das assinaturas eletrônicas com usuários internos type: object required: – envelopId – email properties: id: type: string format: uuid description: Identificação envelopId: type: string format: uuid description: identificador da assinatura username: type: string description: nome de usuário interno 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: editAuthorizationUserSignature: type: object required: – id allOf: – #/definitions/authorizationUserSignature envelopeDraft: description: Entidade para manter os rascunhos de envelope type: object required: – name properties: id: type: string format: uuid description: Identificação askGeolocation: type: string allOf: – #/definitions/ask_geolocation description: Solicitar Geolocalização name: type: string description: Nome do rascunho instructionsToSigner: type: string maxLength: 1000 description: Um texto com instruções para o assinante envelope: type: object allOf: – #/definitions/envelopeSignature description: Envelope de assinatura usersDraft: type: array items: type: object allOf: – #/definitions/envelopeDraftSigners description: Usuários do rascunho de envelope documentsDraft: type: array items: type: object allOf: – #/definitions/envelopeDraftDocument description: Documentos do rascunho de envelope permissions: type: array items: type: object allOf: – #/definitions/envelopeDraftPermission description: Permissões do rascunho de envelope status: type: string allOf: – #/definitions/envelopeDraftStatusType description: Status do rascunho daysToNotify: type: integer format: int64 description: Quantidade de dias para notificar caso a assinatura esteja pendente recurrentNotificationIntervalDays: type: integer format: int64 description: Quantidade de dias para notificar de maneira recorrente caso a assinatura esteja pendente minimum: 0 maximum: 239 default: 0 daysToExpire: type: integer format: int64 description: Prazo para expiração do envelope expirationDate: type: string format: date-time description: Data de expiração do envelope envelopeBatchId: type: string format: uuid description: Id do envelope em lote mandatoryView: type: boolean description: Visualização obrigatória default: false notificateAuthor: type: boolean description: Notificar autor default: false notificationTemplate: type: object allOf: – #/definitions/notificationTemplate description: Template de Notificação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeDraft: type: object required: – id allOf: – #/definitions/envelopeDraft envelopeDraftSigners: description: Entidade para manter os usuários do rascunho de envelope type: object properties: id: type: string format: uuid description: Identificação envelopeDraft: type: object allOf: – #/definitions/envelopeDraft description: identificador do rascunho askGeolocation: type: string allOf: – #/definitions/ask_geolocation description: Solicitar Geolocalização name: type: string description: Nome email: type: string description: Email phone: type: string description: Telefone username: type: string description: Caso seja usuário da plataforma para poder assinar sem token tokenType: type: string allOf: – #/definitions/tokenType description: Tipo de utilização do token pelo signatário communicationChannel: type: string description: Canal que será utilizado para a comunicação com o signatário signerType: type: string allOf: – #/definitions/signerType description: Tipo de assinatura requerida para o signatário orderSign: type: integer format: int64 description: Ordem do assinante no fluxo de assinaturas minimum: 1 default: 1 digitalCertificate: type: string allOf: – #/definitions/digitalCertificateOption description: Certificado Digital requerido jobPosition: type: string description: Cargo/Função do signatário signatureType: type: string allOf: – #/definitions/signatureType description: Tipo da assinatura do signatário signerSubType: type: string allOf: – #/definitions/signerSubType description: Subtipo de assinatura mandatoryEmail: type: boolean description: Email obrigatório para assinatura default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeDraftSigners: type: object required: – id allOf: – #/definitions/envelopeDraftSigners envelopeExternalSigners: description: Entidade para manter os usuários externos do rascunho do envelope type: object required: – name – email properties: id: type: string format: uuid description: Identificação name: type: string description: Nome email: type: string description: Email phone: type: string description: Telefone createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeExternalSigners: type: object required: – id allOf: – #/definitions/envelopeExternalSigners envelopeDraftDocument: description: Entidade para manter os documentos do rascunho de envelope type: object properties: id: type: string format: uuid description: Identificação envelopeDraft: type: object allOf: – #/definitions/envelopeDraft description: identificador do rascunho documentVersion: type: object allOf: – #/definitions/documentVersion description: Id da versão do documento envelopePosition: type: integer format: int64 description: Posição no envelope createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeDraftDocument: type: object required: – id allOf: – #/definitions/envelopeDraftDocument envelopeDraftPermission: description: Entidade para manter as permissões dos envelopes type: object properties: id: type: string format: uuid description: Identificação envelopeDraft: type: object allOf: – #/definitions/envelopeDraft description: identificador do rascunho do envelope subject: type: string description: Sujeito type: type: string allOf: – #/definitions/subjectType description: Tipo do sujeito createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeDraftPermission: type: object required: – id allOf: – #/definitions/envelopeDraftPermission conectorEnvelope: description: Conector model type: object required: – conectorId – envelopeId properties: id: type: string format: uuid description: ID conectorId: type: string format: uuid description: Conector id envelopeId: type: string format: uuid description: Envelope draft Id envelopeSignatureId: type: string description: Envelope Signature Id createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: conectorEnvelopeInput: description: Parâmetros de entrada do conector type: object required: – conectorEnvelopeId – conectorInputParameter – conectorInputValue properties: id: type: string format: uuid description: ID conectorEnvelopeId: type: string format: uuid description: ID do conector conectorInputParameter: type: string description: Parâmetro de entrada conectorInputValue: type: string maxLength: 1000 description: Valor configurado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: signatureGroup: description: Entidade para grupo de assinatura type: object required: – name – signatureGroupUser properties: id: type: string format: uuid description: Identificação name: type: string maxLength: 255 description: Nome do grupo signatureGroupUser: type: array items: type: object allOf: – #/definitions/signatureGroupUser minimum: 1 description: Usuários do grupo de assinatura createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editSignatureGroup: type: object required: – id allOf: – #/definitions/signatureGroup signatureGroupUser: description: Entidade para usuários do grupo de assinatura type: object required: – name – email properties: id: type: string format: uuid description: Identificação signatureGroup: type: object allOf: – #/definitions/signatureGroup description: Grupo de assinatura name: type: string maxLength: 255 description: Nome de usuário phone: type: string maxLength: 255 description: Telefone email: type: string maxLength: 255 description: Email username: type: string maxLength: 255 description: Caso seja usuário da plataforma para poder assinar sem token createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editSignatureGroupUser: type: object required: – id allOf: – #/definitions/signatureGroupUser envelopeTimeline: description: Timeline do envelope type: object required: – envelopeId – kind properties: id: type: string format: uuid description: ID envelopeId: type: string format: uuid description: Identificador do envelope kind: type: string allOf: – #/definitions/envelopTimelineKind description: Tipo da timeline note: type: string description: Anotação sobre o envelope ip: type: string description: IP do usuário createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: envelopeBatchPermission: description: Entidade para manter as permissões dos envelopes em lote type: object properties: id: type: string format: uuid description: Identificação envelopeBatch: type: object allOf: – #/definitions/envelopeBatch description: identificador do rascunho do envelope subject: type: string description: Sujeito type: type: string allOf: – #/definitions/subjectType description: Tipo do sujeito createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeBatchPermission: type: object required: – id allOf: – #/definitions/envelopeBatchPermission envelopeBatch: description: Envelope em lote type: object required: – envelopeBatchName – prefixEnvelopeName – conectorId – assignmentId – conectorInputs properties: id: type: string format: uuid description: Identificação envelopeBatchName: type: string description: Nome do envelope em lote prefixEnvelopeName: type: string description: Prefixo do nome do envelope conectorId: type: string format: uuid description: Conector assignmentId: type: string format: uuid description: Atribuidor do conector askGeolocation: type: string allOf: – #/definitions/ask_geolocation description: Solicitar Geolocalização instructionsToSigner: type: string maxLength: 1000 description: Um texto com instruções para o assinante permissions: type: array items: type: object allOf: – #/definitions/envelopeBatchPermission description: Permissões do rascunho de envelope daysToNotify: type: integer format: int64 description: Quantidade de dias para notificar caso a assinatura esteja pendente recurrentNotificationIntervalDays: type: integer format: int64 description: Quantidade de dias para notificar de maneira recorrente caso a assinatura esteja pendente minimum: 0 maximum: 239 default: 0 daysToExpire: type: integer format: int64 description: Prazo para expiração do envelope minimum: 1 maximum: 240 default: 120 documentQuantity: type: integer format: int64 description: Quantidade de arquivos no envelope em lote default: 0 conectorInputs: type: string description: inputs do plugin envelopeBatchStatus: type: string allOf: – #/definitions/envelopeBatchStatus description: Status createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeBatch: type: object required: – id allOf: – #/definitions/envelopeBatch envelopeBatchDocument: description: Entidade para manter os arquivos processados em lote type: object properties: id: type: string format: uuid description: Identificação envelopeBatchId: type: string format: uuid description: identificador do rascunho do envelope documentId: type: string format: uuid description: Identificador do documento documentTitle: type: string description: Titulo do documento documentVersionId: type: string format: uuid description: Versão do documento documentVersionName: type: string description: Versão do documento errorLog: type: string description: Erro na criação do envelope conectorScheduleId: type: string format: uuid description: Id do agendamento do conector createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeBatchDocument: type: object required: – id allOf: – #/definitions/envelopeBatchDocument pdfEditorContext: description: Entidade para manter os dados do JKPDF type: object required: – originalWidth – originalHeight – jsonContext properties: id: type: string format: uuid description: Identificação documentVersionId: type: string format: uuid description: Identificador da versão do documento originalWidth: type: number format: double description: Largura original do documento originalHeight: type: number format: double description: Altura original do documento jsonContext: type: string description: Json de contexto do editor jsonContextValues: type: string description: Valores preenchidos no json de contexto do editor createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: envelopeTemplatePermission: description: Entidade para manter as permissões do template de envelope type: object properties: id: type: string format: uuid description: Identificação envelopeTemplate: type: object allOf: – #/definitions/envelopeTemplate description: Identificador do template que foi adicionado as permissões. subject: type: string description: Sujeito que possui as permissões type: type: string allOf: – #/definitions/subjectType description: Tipo de permisão do sujeito createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeTemplatePermission: type: object required: – id allOf: – #/definitions/envelopeTemplatePermission envelopeTemplate: description: Entidade para salvar os templates de envelopes type: object required: – templateName – name properties: id: type: string format: uuid description: Identificação templateName: type: string maxLength: 255 description: Nome do template defaultTemplate: type: boolean description: Define o template como padrão a ser utilizado default: false name: type: string maxLength: 255 description: Nome do envelope instructionsToSigner: type: string maxLength: 1000 description: Um texto com instruções para o assinante askGeolocation: type: string allOf: – #/definitions/ask_geolocation description: Solicitar Geolocalização permissions: type: array items: type: object allOf: – #/definitions/envelopeTemplatePermission description: Permissões do rascunho de envelope daysToNotify: type: integer format: int64 description: Quantidade de dias para notificar caso a assinatura esteja pendente minimum: 0 default: 0 recurrentNotificationIntervalDays: type: integer format: int64 description: Quantidade de dias para notificar de maneira recorrente caso a assinatura esteja pendente minimum: 0 maximum: 239 default: 0 daysToExpire: type: integer format: int64 description: Prazo para expiração do envelope minimum: 1 maximum: 240 default: 120 mandatoryView: type: boolean description: Visualização obrigatória default: false notificateAuthor: type: boolean description: Notificar autor default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeTemplate: type: object required: – id allOf: – #/definitions/envelopeTemplate deleteQueued: description: Entidade que contém a fila de deleção type: object required: – objectId – tenantName – queuingDate – queueType properties: id: type: string format: uuid description: Identificação objectId: type: string format: uuid description: Identificação do objeto a ser deletado tenantName: type: string description: Tenant a ser deletado queuingDate: type: string format: date-time description: data de criação do item na fila queueType: type: string allOf: – #/definitions/filterType description: Tipo de deleção createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDeleteQueued: type: object required: – id allOf: – #/definitions/deleteQueued notificationTemplate: description: Guarda os templates de notificações type: object required: – name properties: id: type: string format: uuid description: Identificador name: type: string description: Descrição do template defaultTemplate: type: boolean description: Define o template como padrão a ser utilizado default: false notificationTemplateSteps: type: array items: type: object allOf: – #/definitions/notificationTemplateStep description: Lista de etapas do template removed: type: boolean description: Indicador para exclusão lógica do template default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editNotificationTemplate: type: object required: – id allOf: – #/definitions/notificationTemplate notificationTemplateStep: description: Guarda o conteúdo de cada etapa do template de notificações type: object required: – content – stepType – channelType properties: id: type: string format: uuid description: Identificador notificationTemplate: type: object allOf: – #/definitions/notificationTemplate description: Template a qual o conteúdo da etapa pertence content: type: string format: byte description: Conteúdo do template subject: type: string maxLength: 1000 description: Assunto do template stepType: type: string allOf: – #/definitions/notificationTemplateType description: Etapa que o template se refere channelType: type: string allOf: – #/definitions/communicationChannelType description: Tipo da notificação do template createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editNotificationTemplateStep: type: object required: – id allOf: – #/definitions/notificationTemplateStep favorite: description: Favoritar folder type: object properties: id: type: string format: uuid description: Identificação folder: type: object allOf: – #/definitions/folder description: Folder username: type: string description: Nome de usuário createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editFavorite: type: object required: – id allOf: – #/definitions/favorite downloadBulk: description: Solicitação de Download em Lote type: object required: – tenant – size – status properties: id: type: string format: uuid description: Identificação tenant: type: string description: Nome do tenant size: type: number format: double description: Tamanho total do download times: type: integer format: int64 description: Quantidade de vezes executado default: 0 status: type: string allOf: – #/definitions/downloadBulkStatus description: Situação do Download items: type: array items: type: object allOf: – #/definitions/downloadBulkItem description: Lista de documentos/pastas selecionadas para download createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDownloadBulk: type: object required: – id allOf: – #/definitions/downloadBulk downloadBulkItem: description: Item de Download em Lote type: object required: – kind – bulkItem properties: id: type: string format: uuid description: Identificação downloadBulk: type: object allOf: – #/definitions/downloadBulk description: Identificador do download kind: type: string allOf: – #/definitions/fileKind description: Tipo do item bulkItem: type: string description: Documento/Folder createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDownloadBulkItem: type: object required: – id allOf: – #/definitions/downloadBulkItem envelopeSignatureBatch: description: Log do Evento de Assinatura em lote de envelopes type: object required: – status – envelopeIds properties: id: type: string format: uuid description: Identificação do batch status: type: string allOf: – #/definitions/batchStatus description: Indica estado de finalização de execução do lote envelopeIds: type: string description: IDs dos Envelopes enviados para processar em lote, separados por virgula createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeSignatureBatch: type: object required: – id allOf: – #/definitions/envelopeSignatureBatch notificationLog: description: Entidade para manter os logs das notificações type: object required: – id – communicationChannel – signerName – notificationInfo properties: id: type: string format: uuid description: Identificação envelopeId: type: string description: Id do envelope communicationChannel: type: string allOf: – #/definitions/communicationChannelType description: tipo do canal de comunicação signerName: type: string description: Nome do signatário notificationInfo: type: string description: Atributo para onde é enviada a notificação notificationAction: type: string description: Momento em que ocorreu o envio da notificação notificationId: type: string description: Id retornado ao enviar a notificação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string 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