DocumentVersionService - com escopo, global

A API DocumentVersionService fornece um serviço para criar e excluir versões de documentos. Cada versão é um elemento que contém o conteúdo do documento e é fornecida usando um único URL ou anexo. Um anexo só pode ser adicionado na IU da tabela Versões do documento [ds_document_version] e não com a API.

Esta API requer o plug-in Gestão de documentos (com.snc.platform_document_management) e é fornecida no namespace sn_doc_services. Para obter informações, consulte Serviços de documentos.

Antes de criar uma versão do documento, você deve definir e adicionar um registro do documento.

• SystemDocument — Defina um objeto de documento.
• DocumentService : adicione, atualize ou exclua um documento.

DocumentVersionService - DocumentVersionService()

Instancia um objeto DocumentVersionService.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como instanciar um objeto DocumentVersionService.

var versionSvc = new sn_doc_services.DocumentVersionService();

DocumentVersionService - createDocumentVersion(SystemDocumentVersion docVersion)

Cria um registro de versão do documento na tabela Versões [ds_document_version].

Tabela 2. Parâmetros

Nome	Tipo	Descrição
docVersion	SystemDocumentVersion	Uma ou mais propriedades que representam campos de uma versão do documento.

Tabela 3. Retorna

Tipo	Descrição
Objeto	Sys_id do novo registro na tabela Versões [ds_document_version] com uma mensagem de sucesso. Caso contrário, mensagem de erro. { "message": "String", "request_id": "String", "status": "String" }
<Object>.mensagem	Mensagem confirmando sucesso ou erro. Se for bem-sucedido, inclui o sys_id do registro do documento e o sys_id da nova versão do documento. Tipo de dados: cadeia de caracteres
<Object>.request_id	Sys_id do novo registro na tabela Versões [ds_document_version]. Tipo de dados: cadeia de caracteres
<Object>.status	Status que indica se a operação foi bem-sucedida. Valores possíveis: sucesso — A operação foi bem-sucedida. falha – A operação não foi bem-sucedida. O message fornece detalhes. Tipo de dados: cadeia de caracteres

O exemplo a seguir mostra como preencher as propriedades do objeto SystemDocumentVersion e criar uma nova versão do documento. Consulte também SystemDocumentVersion.

var versionDefinition = new sn_doc_services.SystemDocumentVersion('491efbee24187410f877a6fed1c2b0a9');

versionDefinition.type('url');
versionDefinition.url('http://one/1.0');

var versionSvc = new sn_doc_services.DocumentVersionService();
gs.info(JSON.stringify(versionSvc.createDocumentVersion(versionDefinition), null, 2));

Saída:

{
  "message": "Adding an entry to DocumentVersion for the given docId : 491efbee24187410f877a6fed1c2b0a9, sysId : d5a340d9242cf810f877a6fed1c2b069 is successful.",
  "request_id": "d5a340d9242cf810f877a6fed1c2b069",
  "status": "success"
}

DocumentVersionService – deleteDocumentVersion(String docVersionSysId)

Exclui uma versão do documento.

Tabela 4. Parâmetros

Nome	Tipo	Descrição
docVersionSysId	Cadeia de caracteres	Sys_id de uma versão de documento na tabela Versões [ds_document_version].

Tabela 5. Retorna

Tipo	Descrição
Objeto	Mensagem de sucesso. Caso contrário, mensagem de erro. { "message": "String", "status": "String" }
<Object>.mensagem	Mensagem confirmando sucesso ou erro. Se for bem-sucedido, inclui o sys_id da versão do documento excluído. Tipo de dados: cadeia de caracteres
<Object>.status	Status que indica se a operação foi bem-sucedida. Valores possíveis: sucesso — A operação foi bem-sucedida. falha – A operação não foi bem-sucedida. O message fornece detalhes. Tipo de dados: cadeia de caracteres

O exemplo a seguir mostra como excluir uma versão de documento existente.

var vId = "<versionSysId>";
var versionSvc = new sn_doc_services.DocumentVersionService();

gs.info(JSON.stringify(versionSvc.deleteDocumentVersion(vId), null, 2));

Saída:

{
  "message": "Deleting an entry to DocumentVersion for the given documentVersionSysId : , sysId : <versionSysId> is successful.",
  "status": "success"
}