SystemDocumentVersion - com escopo, global

A API SystemDocumentVersion fornece métodos para definir os valores da versão de origem de um documento na tabela Versões [ds_document_version].

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.

Para criar uma versão do documento, use a API DocumentVersionService.

SystemDocumentVersion - SystemDocumentVersion(cadeia de caracteres docSysId)

Instancia um objeto SystemDocumentVersion.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
docSysId	Cadeia de caracteres	Sys_id de um registro de documento na tabela Documentos [ds_document].

Tabela 2. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como instanciar um objeto SystemDocumentVersion e criar uma versão do documento. Consulte também DocumentVersionService.

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"
}

SystemDocumentVersion - document(cadeia de caracteres docSysId)

Especifica o registro do documento para esta versão.

Nota:

Como alternativa, você pode definir o nome como um parâmetro no construtor SystemDocumentVersion().

Tabela 3. Parâmetros

Nome	Tipo	Descrição
docSysId	Cadeia de caracteres	Sys_id de um registro de documento na tabela Documentos [ds_document].

Tabela 4. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir o campo de nome de uma versão do documento. Consulte também DocumentVersionService – createDocumentVersion().

var versionDefinition = new sn_doc_services.SystemDocumentVersion();

versionDefinition.document('491efbee24187410f877a6fed1c2b0a9');

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 : 1c504c91242cf810f877a6fed1c2b08b is successful.",
  "request_id": "1c504c91242cf810f877a6fed1c2b08b",
  "status": "success"
}

SystemDocumentVersion - type(cadeia de caracteres docType)

Define o campo Tipo de uma versão do documento.

Tabela 5. Parâmetros

Nome	Tipo	Descrição
docType	Cadeia de caracteres	Tipo de origem do documento. Valores válidos: URL anexo Padrão: anexo Nota: No momento, um anexo só pode ser adicionado na IU da tabela Versões do documento [ds_document_version] e não com a API.

Tabela 6. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir o campo de tipo e criar uma versão do documento. Consulte também DocumentVersionService.

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));

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

SystemDocumentVersion - url (cadeia de caracteres URL)

Define o URL de uma versão do documento.

Tabela 7. Parâmetros

Nome	Tipo	Descrição
URL	Cadeia de caracteres	URL do documento de origem para esta versão.

Tabela 8. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir o campo URL como a origem de uma versão do documento. Consulte também DocumentVersionService.

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));

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

SystemDocumentVersion - versionNumber(Number versionNumber)

Define o número de uma versão do documento.

Tabela 9. Parâmetros

Nome	Tipo	Descrição
versionNumber	Número	Número da versão deste documento.

Tabela 10. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir o número da versão e criar uma versão do documento. Consulte também DocumentVersionService.

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

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

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 : ff47449d242cf810f877a6fed1c2b06c is successful.",
  "request_id": "ff47449d242cf810f877a6fed1c2b06c",
  "status": "success"
}