SystemDocumentList - com escopo, global

A API SystemDocumentList fornece métodos para definir os campos de registro na tabela Listas de documentos [ds_document_lists].

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 ou gerenciar uma lista de documentos, use a API DocumentListService.

SystemDocumentList — SystemDocumentList(cadeia de caracteres docListName)

Instancia um objeto SystemDocumentList.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
DocListName	Cadeia de caracteres	Nome da lista de documentos.

Tabela 2. Retorna

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como instanciar um objeto SystemDocumentList.

var docList = new sn_doc_services.SystemDocumentList();

SystemDocumentList - description(cadeia de caracteres descrição)

Define o campo Descrição de um novo registro de lista de documentos.

Tabela 3. Parâmetros

Nome	Tipo	Descrição
descrição	Cadeia de caracteres	Descrição da lista de documentos.

Tabela 4. Retorna

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como adicionar uma descrição à lista de documentos. Consulte também API DocumentListService.

var dL = new sn_doc_services.SystemDocumentList('My document list');

// Define the document list field
dL.description('description');

var docList = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docList.createDocumentList(dL), null, 2));

Saída:

{
  "message": "Create List for the given name : My document list, List sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}

SystemDocumentList - name(cadeia de caracteres docListName)

Define o campo Nome de um registro de lista de documentos.

Nota:

Você também pode definir o nome como um parâmetro no construtor SystemDocumentList().

Tabela 5. Parâmetros

Nome	Tipo	Descrição
DocListName	Cadeia de caracteres	Nome da lista de documentos.

Tabela 6. Retorna

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como renomear uma lista de documentos existente. Consulte também DocumentListService.

var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';
var docListUpdate = new sn_doc_services.SystemDocumentList();

docListUpdate.name('name change');

var docListSvc = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docListSvc.updateDocumentList(docListID , docListUpdate), null, 2));

Saída:

{
  "message": "Update List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}