---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# SystemDocumentList - com escopo, global

# SystemDocumentList - com escopo, global {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 min. de leitura

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](https://www.servicenow.com/docs/access?context=document-services-landing-page&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US).

Para criar ou gerenciar uma lista de documentos, use a [API DocumentListService](https://servicenow-prod.fluidtopics.net/bBzofnAy2Cw~CzBp2hqCkQ#DocumentListServiceBothAPI "A API DocumentListService fornece métodos para criar, excluir e atualizar uma lista de documentos.").

## SystemDocumentList --- SystemDocumentList(cadeia de caracteres docListName) {#ariaid-title2}

Instancia um objeto SystemDocumentList.
{#SysDocList-SystemDocumentList_S__table_o12_jrk_spb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| DocListName | Cadeia de caracteres | Nome da lista de documentos. |
[Tabela 1. Parâmetros]

{#SysDocList-SystemDocumentList_S__table_o12_jrk_spb} {#SysDocList-SystemDocumentList_S__table_p12_jrk_spb__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 2. Retorna]

{#SysDocList-SystemDocumentList_S__table_p12_jrk_spb}  
O exemplo a seguir mostra como instanciar um objeto SystemDocumentList.

    var docList = new sn_doc_services.SystemDocumentList();

## SystemDocumentList - description(cadeia de caracteres descrição) {#ariaid-title3}

Define o campo Descrição de um novo registro de lista de documentos.
{#SysDocList-description_S__table_o12_jrk_spb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| descrição | Cadeia de caracteres | Descrição da lista de documentos. |
[Tabela 3. Parâmetros]

{#SysDocList-description_S__table_o12_jrk_spb} {#SysDocList-description_S__table_p12_jrk_spb__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 4. Retorna]

{#SysDocList-description_S__table_p12_jrk_spb}  
O exemplo a seguir mostra como adicionar uma descrição à lista de documentos. Consulte também [API DocumentListService](https://servicenow-prod.fluidtopics.net/bBzofnAy2Cw~CzBp2hqCkQ#DocumentListServiceBothAPI "A API DocumentListService fornece métodos para criar, excluir e atualizar uma lista de documentos.").

    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) {#ariaid-title4}

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().
{#SysDocList-name_S__table_o12_jrk_spb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| DocListName | Cadeia de caracteres | Nome da lista de documentos. |
[Tabela 5. Parâmetros]

{#SysDocList-name_S__table_o12_jrk_spb} {#SysDocList-name_S__table_p12_jrk_spb__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 6. Retorna]

{#SysDocList-name_S__table_p12_jrk_spb}  
O exemplo a seguir mostra como renomear uma lista de documentos existente. Consulte também [DocumentListService](https://servicenow-prod.fluidtopics.net/bBzofnAy2Cw~CzBp2hqCkQ#DocumentListServiceBothAPI "A API DocumentListService fornece métodos para criar, excluir e atualizar uma lista de documentos.").

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