SystemDocumentListEntry - com escopo, global

A API SystemDocumentListEntry fornece métodos para definir os campos de registro na tabela Entradas da lista de documentos [ds_document_list_entry].

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 usar os métodos nesta API, você deve adicionar um documento com suas versões e criar uma lista de documentos.

• SystemDocument — Defina um objeto de documento.
• DocumentService : adicione, atualize ou exclua um documento.
• SystemDocumentVersion – define uma versão do documento.
• DocumentVersionService – adicione, atualize ou exclua uma versão de um documento.
• SystemDocumentList — Defina uma lista de documentos.
• DocumentListService – adicione, atualize ou exclua uma lista de documentos.

SystemDocumentListEntry - SystemDocumentListEntry (cadeia de caracteres listID)

Instancia um objeto SystemDocumentListEntry.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
listaSysId	Cadeia de caracteres	Sys_id de um registro de lista de documentos na tabela Listas de documentos [ds_document_lists].

Tabela 2. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como instanciar um objeto SystemDocumentListEntry.

var docList = new sn_doc_services.SystemDocumentListEntry("<docListSysId>");

SystemDocumentListEntry - descrição (descrição da cadeia de caracteres)

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

Tabela 3. Parâmetros

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

Tabela 4. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como adicionar uma descrição à entrada da lista de documentos fornecida usando o construtor. Consulte também API DocumentListEntryService.

var docListEntry = new sn_doc_services.SystemDocumentListEntry('21afddea2460fc10f877a6fed1c2b0dd');

docListEntry.description('birth');

var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
gs.info(JSON.stringify(dlEntrySvc.createDocumentListEntry(docListEntry), null, 2));

Saída:

{
  "message": "Create List Entry , List Entry sysId : d3f0b13624e8fc10f877a6fed1c2b0d9is successful.",
  "request_id": "d3f0b13624e8fc10f877a6fed1c2b0d9",
  "status": "success"
}

SystemDocumentListEntry - document(cadeia de caracteres docSysId)

Especifica o modelo de documento a ser adicionado a uma lista de documentos.

Para definir um documento como modelo:

• Defina o objeto de documento definindo o método SystemDocument – template() como verdadeiro. Crie ou atualize o registro do documento com os métodos na API DocumentService.
• Marque a caixa de seleção Modelo de um documento na tabela Documentos [ds_document].

O registro do documento especificado deve ter uma versão. Use as seguintes APIs para definir e adicionar uma versão de documento:

• SystemDocumentVersion – define uma versão do documento.
• DocumentVersionService – adicione, atualize ou exclua uma versão de um documento.

Tabela 5. Parâmetros

Nome	Tipo	Descrição
docSysId	Cadeia de caracteres	Sys_id de um registro de documento na tabela Documentos [ds_document]. O documento especificado deve ser um modelo e ter uma versão.

Tabela 6. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como adicionar um modelo de documento como uma entrada de lista de documentos. Consulte também API DocumentListEntryService.

var docListEntry = new sn_doc_services.SystemDocumentListEntry('21afddea2460fc10f877a6fed1c2b0dd');
docListEntry.document("9acd7fea24587410f877a6fed1c2b060");
docListEntry.description('birth certificate');

var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
gs.info(JSON.stringify(dlEntrySvc.createDocumentListEntry(docListEntry), null, 2));

Saída:

{
  "message": "Create List Entry , List Entry sysId : d3f0b13624e8fc10f877a6fed1c2b0d9is successful.",
  "request_id": "d3f0b13624e8fc10f877a6fed1c2b0d9",
  "status": "success"
}

SystemDocumentListEntry - documentList(cadeia de caracteres listSysId)

Especifica a lista de documentos na qual um documento será adicionado.

Nota:

Como alternativa, você pode definir a lista de documentos como um parâmetro no construtor SystemDocumentListEntry().

Use as seguintes APIs para definir e criar uma lista de documentos:

• SystemDocumentList — Defina uma lista de documentos.
• DocumentListService – adicione, atualize ou exclua uma lista de documentos.

Tabela 7. Parâmetros

Nome	Tipo	Descrição
listaSysId	Cadeia de caracteres	Sys_id de um registro de lista de documentos na tabela Listas de documentos [ds_document_lists].

Tabela 8. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir a lista de documentos na qual adicionar um documento. Consulte também API DocumentListEntryService.

var docListEntry = new sn_doc_services.SystemDocumentListEntry();

docListEntry.documentList('21afddea2460fc10f877a6fed1c2b0dd');
docListEntry.document('deaef1ce24103410f877a6fed1c2b085');
docListEntry.description('passport');

var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
gs.info(JSON.stringify(dlEntrySvc.createDocumentListEntry(docListEntry), null, 2));

Saída:

{
  "message": "Create List Entry , List Entry sysId : c4ccaa8b24283050f877a6fed1c2b003is successful.",
  "request_id": "c4ccaa8b24283050f877a6fed1c2b003",
  "status": "success"
}