DocumentVersionService - escopo, global

. DocumentVersionService A API 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 Gestão de documentos plug-in (com.snc.platform_document_management) e é fornecido em sn_doc_services namespace. Para obter informações, consulte Serviços de documentos .

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

• SystemDocument - Defina um objeto de documento.
• DocumentService - Adicionar, atualizar ou excluir um documento.

DocumentVersionService - DocumentVersionService()

Instancia um DocumentVersionService objeto.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como instanciar um DocumentVersionService objeto.

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. Retornos

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>.message	Mensagem confirmando sucesso ou erro. Se 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. . messagefornece detalhes. Tipo de dados: Cadeia de caracteres

O exemplo a seguir mostra como preencher SystemDocumentVersion propriedades do objeto 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(cadeia de caracteres 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 do documento na tabela Versões [ds_document_version].

Tabela 5. Retornos

Tipo	Descrição
Objeto	Mensagem de sucesso. Caso contrário, mensagem de erro. { "message": "String", "status": "String" }
<Object>.message	Mensagem confirmando sucesso ou erro. Se 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. . messagefornece 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"
}