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

Gestão de Documentos (ecm_ged)

352 views 0 23/09/2019 Atualizado em 19/05/2022 integrador

2.0info: 2.4.6 Gestão de Documentos description: Gestão 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: – documents properties: documents: type: array items: type: object allOf: – #/definitions/documentBasicInfoToView minimum: 1 description: 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: – documents properties: documents: type: array items: type: object allOf: – #/definitions/documentBasicInfoToView minimum: 1 description: 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 responses: 200: description: Ok schema: type: object required: – documents – askGeolocation – instructionsToSigner – createdBy – createdDate 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 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 responses: 200: description: Ok schema: type: object required: – documents – askGeolocation – instructionsToSigner – createdBy – createdDate 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 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/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: 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: responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: 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: in: query type: string responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listPendencies: 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: responses: 200: description: Ok schema: type: object properties: pendencies: type: array items: type: object allOf: – #/definitions/document description: 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: in: query type: string responses: 200: description: Ok schema: type: object properties: pendencies: type: array items: type: object allOf: – #/definitions/document description: 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. 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: 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: 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/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 responses: 200: description: Ok schema: type: object properties: 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 responses: 200: description: Ok schema: type: object properties: 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/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: 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: 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: 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: 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/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/listSignatures: post: description: Lista as assinaturas de acordo com filtro tags: – Queries 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 get: description: Lista as assinaturas de acordo com filtro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: documentName description: Nome do documento in: query type: string – name: signerName description: Nome do assinante in: query type: string – name: signerStatus description: Status da assinatura in: query type: string – name: initialDate description: Data inicial in: query type: string format: date – name: finalDate description: Data final in: query type: string format: date – name: page description: Página in: query required: true type: integer format: int64 – name: size description: Tamanho in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object allOf: – #/definitions/signaturePageableDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getNumberOfEnvelopesByStatus: post: description: Retorna o número de envelopes por status tags: – Queries 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 get: description: Retorna o número de envelopes por status tags: – Queries x-senior-visibility: PRIVATE parameters: – name: documentName description: Nome do documento in: query type: string – name: signerName description: Nome do assinante in: query type: string – name: signerStatus description: Status da assinatura in: query type: string – name: initialDate description: Data inicial in: query type: string format: date – name: finalDate description: Data final in: query type: string format: date 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: Retorna o número de assinaturas por status tags: – Queries 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 get: description: Retorna o número de assinaturas por status tags: – Queries x-senior-visibility: PRIVATE parameters: – name: documentName description: Nome do documento in: query type: string – name: signerName description: Nome do assinante in: query type: string – name: signerStatus description: Status da assinatura in: query type: string – name: initialDate description: Data inicial in: query type: string format: date – name: finalDate description: Data final in: query type: string format: date responses: 200: description: Ok schema: type: object allOf: – #/definitions/numberOfSignaturesByStatusDTO 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: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportDocument: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportDraftDocument: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportFolder: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportDocumentTag: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportDocumentMetadata: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportTracking: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportDocumentTicket: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportDocumentBatch: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportEnvelopeSignature: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportDocumentEnvelopeSignature: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportUserSignature: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportAuthorizationUserSignature: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 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: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 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: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials 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/signDocuments: post: description: Assinar uma lista de documentos 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 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: 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 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 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 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: 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,\n 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/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/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 ### 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/newDocumentBatch: post: description: Executa a criação de documentos em lote 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 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/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: 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: – documentId properties: documentId: type: string description: Versão 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/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: 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: responses: 200: description: Ok schema: type: object required: – statusCode properties: statusCode: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/requestSignature: post: description: 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: responses: 200: description: Ok schema: type: object required: – statusCode properties: statusCode: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/requestSignatureByUserLogged: post: description: 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: responses: 200: description: Ok schema: type: object required: – statusCode properties: statusCode: type: integer format: int64 description: 401: description: Invalid Credentials 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/importSubject: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importDocument: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importDraftDocument: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importFolder: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importDocumentTag: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importDocumentMetadata: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importTracking: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importDocumentTicket: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importDocumentBatch: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importEnvelopeSignature: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importDocumentEnvelopeSignature: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importUserSignature: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importAuthorizationUserSignature: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 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/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/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/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 responses: 200: description: Ok schema: 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/subject responses: 200: description: Ok schema: #/definitions/subject 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 responses: 200: description: Ok schema: 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/applicant responses: 200: description: Ok schema: #/definitions/applicant 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 responses: 200: description: Ok schema: 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/applicant responses: 200: description: Ok schema: #/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: 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 responses: 200: description: Ok schema: 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/document responses: 200: description: Ok schema: #/definitions/document 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 responses: 200: description: Ok schema: 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/documentVersion responses: 200: description: Ok schema: #/definitions/documentVersion 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 responses: 200: description: Ok schema: 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/documentVersion responses: 200: description: Ok schema: #/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: 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 responses: 200: description: Ok schema: 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/timeline responses: 200: description: Ok schema: #/definitions/timeline 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 responses: 200: description: Ok schema: 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/timeline responses: 200: description: Ok schema: #/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: 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 responses: 200: description: Ok schema: 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/draftDocument responses: 200: description: Ok schema: #/definitions/draftDocument 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 responses: 200: description: Ok schema: 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/folder responses: 200: description: Ok schema: #/definitions/folder 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 responses: 200: description: Ok schema: 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/documentTag responses: 200: description: Ok schema: #/definitions/documentTag 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 responses: 200: description: Ok schema: 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/documentMetadata responses: 200: description: Ok schema: #/definitions/documentMetadata 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 responses: 200: description: Ok schema: 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/permission responses: 200: description: Ok schema: #/definitions/permission 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 responses: 200: description: Ok schema: 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 responses: 200: description: Ok schema: 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/permission responses: 200: description: Ok schema: #/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: 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/permission responses: 200: description: Ok schema: #/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: 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 responses: 200: description: Ok schema: 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/tracking responses: 200: description: Ok schema: #/definitions/tracking 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 responses: 200: description: Ok schema: 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/documentTicket responses: 200: description: Ok schema: #/definitions/documentTicket 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 responses: 200: description: Ok schema: 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/documentBatch responses: 200: description: Ok schema: #/definitions/documentBatch 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/envelopeSignature: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeSignature responses: 200: description: The created resource schema: #/definitions/envelopeSignature 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/envelopeSignature responses: 200: description: The created resource schema: #/definitions/envelopeSignature 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 responses: 200: description: Ok schema: type: array items: #/definitions/envelopeSignature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/envelopeSignature/{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/envelopeSignature responses: 200: description: Ok schema: #/definitions/envelopeSignature 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/envelopeSignature responses: 200: description: Ok schema: #/definitions/envelopeSignature 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/envelopeSignature 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/envelopeSignature/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeSignature responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentEnvelopeSignature: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentEnvelopeSignature responses: 200: description: The created resource schema: #/definitions/documentEnvelopeSignature 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/documentEnvelopeSignature responses: 200: description: The created resource schema: #/definitions/documentEnvelopeSignature 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 responses: 200: description: Ok schema: type: array items: #/definitions/documentEnvelopeSignature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentEnvelopeSignature/{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/documentEnvelopeSignature responses: 200: description: Ok schema: #/definitions/documentEnvelopeSignature 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/documentEnvelopeSignature responses: 200: description: Ok schema: #/definitions/documentEnvelopeSignature 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/documentEnvelopeSignature 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/documentEnvelopeSignature/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentEnvelopeSignature 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 responses: 200: description: Ok schema: 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/userSignature responses: 200: description: Ok schema: #/definitions/userSignature 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 responses: 200: description: Ok schema: 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/authorizationUserSignature responses: 200: description: Ok schema: #/definitions/authorizationUserSignature 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 definitions: ask_geolocation: description: Ask Geolocation on document signing type: string enum: – DONT_ASK_LOCATION – ASK_LOCATION – REQUIRED_LOCATION signatureStatus: description: Status utilizado na listagem folderList type: string enum: – PENDING – SIGNED – EMPTY – FAILED_TO_LOAD batchStatus: description: Status de execução de um lote de criação de documentos type: string enum: – PENDING – SUCCESS – SUCCESS_PARTIAL – ERROR upDown: description: Up or down type: string enum: – UP – DOWN userSignStatus: description: Status da assinatura por usuário type: string enum: – PENDING – SIGNED fileKind: description: Tipo de Arquivo type: string enum: – FOLDER – DOCUMENT documentStatus: description: Tipo de Arquivo type: string enum: – PENDING – REVIEW – PUBLISHED – EXPIRED – DEPRECATED timelineKind: description: Tipo da Linha de Tempo do Documento type: string enum: – REVIEW – NEW_VERSION – CHECK_IN – CHECK_OUT – TAKE_OVER – MOVE – REMOVE subjectType: description: Tipos de sujeitos type: string enum: – USER – ROLE – GROUP permissionType: description: Tipo de permissão de um documento ou pasta type: string enum: – VIEW – DOWNLOAD – EDIT actionType: description: Tipo de permissão de um documento type: string enum: – VIEW_DOCUMENT – DOWNLOAD_DOCUMENT – EDIT_DOCUMENT – DELETE_DOCUMENT permissionReplicateOptionType: description: type: string enum: – NONE – CHILD_FOLDERS – CHILD_FILES – ALL userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR documentVersionCreatedDTO: description: 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: type: object required: – fileUrl – title properties: fileName: type: string description: Nome original do Arquivo. Se a url de upload foi solicitada para o GED, não é necessário informar novamente. fileUrl: type: string description: URL do documento type: string description: Título do documento description: type: string description: Descrição do documento folderPath: type: string description: Caminho da pasta documentId: type: string description: Identificador do documento para criar uma nova versão documento subject: type: string description: Assunto Relacionado ao documento autor: type: string description: Usuário autor do documento versionName: type: string description: Nome da Versão Documento definida pelo Usuário documentMetadados: type: string description: metadados para o documento no formato. Ex: area=rh, empresa=1 tags: type: string 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: Permissão para Visualização do Documento signer: description: Assinante de um documento discriminator: _discriminator type: object required: – name – email – phoneNumber – _discriminator properties: name: type: string description: Nome email: type: string description: Email phoneNumber: type: string description: Número do telefone, apenas os números sem pontuações username: type: string description: Caso seja usuário da plataforma para poder assinar sem token _discriminator: type: string description: 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 envelopeDocumentItem: description: Item de assinatura de documento type: object required: – versionId – title – url 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) 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 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 file: description: Representa arquivo ou pasta na árvore de navegação type: object required: – id – title – kind – children – publishedVersion – createdBy – lastModifiedDate properties: id: type: string description: Id do documento ou pasta type: string maxLength: 255 description: Nome 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: Autor 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 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 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 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 permissionType: type: string allOf: – #/definitions/permissionType description: Tipo da permissão envelopeSignatureStatus: description: 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 errorMessage: type: string description: Mensagem de erro que ocorreu no envelope caso o status seja de falha documentBasicInfoToView: description: 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) documentRemovedDTO: description: 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 searchResult: description: retorno da pesquisa de documentos/pastas no ged type: object required: – id – title – kind – createdBy – 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 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: Contém os dados para assinar o documento quando o usuário esta logado na plataforma type: object required: – processId – token – email properties: processId: type: string description: token: type: string description: email: type: string description: location: type: object allOf: – #/definitions/location description: phone: type: string description: name: type: string description: ip: type: string description: location: description: Contém a localização para assinar o documento quando o usuário esta logado na plataforma type: object required: – latitude – longitude properties: latitude: type: number format: double description: longitude: type: number format: double description: signatureToken: description: Usado para buscar o token da assinatura caso o usuário esteja logado type: object required: – processId – email properties: processId: type: string description: email: type: string description: 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: message: type: string description: processId: type: string description: documentId: type: string description: 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 initialDate: type: string format: date description: Data inicial finalDate: type: string format: date description: Data final _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 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 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 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 properties: signed: type: integer format: int64 description: Assinados pending: type: integer format: int64 description: Pendentes 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 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: 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 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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 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: 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: 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: 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 default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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 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 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 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: 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 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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 description: Identificador do Documento Criado batchId: type: string description: Id do lote de criação de documentos message: type: string 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: documentBatch: description: 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: 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 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 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 assinte 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 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Sim  Não
Leave A Comment Cancelar resposta

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

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