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


---

# DocumentListService - com escopo, global

# DocumentListService - 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) 5 min. de leitura

A API DocumentListService fornece métodos para criar, excluir e atualizar uma lista de documentos.

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).  
O plug-in Gestão de documentos também oferece suporte à criação de listas de modelos de documento para associar ao seu documento. Por exemplo, uma candidatura de trabalho que exige vários documentos, como um diploma, ID ou passaporte. Depois de adicionar sua lista de documentos, você pode adicionar modelos de documento:

* [SystemDocumentListEntry](https://servicenow-prod.fluidtopics.net/FlaIl3JyWpUrgSGQoK3Bww#SystemDocumentListEntryBothAPI "A API SystemDocumentListEntry fornece métodos para definir os campos de registro na tabela Entradas da lista de documentos [ds_document_list_entry].") --- Defina uma entrada de lista de modelos de documento.
* [DocumentListEntryService](https://servicenow-prod.fluidtopics.net/4UqhkDift1QTd4B3v63Wjg#DocumentListEntryServiceBothAPI "A API DocumentListEntryService fornece métodos para manter modelos de documento em uma lista de documentos.") -- adicione ou remova uma entrada de lista de modelo de documento.
{#DocumentListServiceBothAPI__ul_asn_gjg_vpb}  
Para definir um documento como modelo:

* Defina o objeto de documento definindo o método [SystemDocument -- template()](https://servicenow-prod.fluidtopics.net/f~~djlIZ0oB2DBCzulQgrg#SystemDoc-template_S "Especifica se um registro de documento é um modelo.") como verdadeiro. Crie ou atualize o registro do documento com os métodos na API [DocumentService](https://servicenow-prod.fluidtopics.net/RQl3CMjmO43RtsVfo11mWQ#DocumentServiceBothAPI "A API DocumentService fornece métodos para criar, excluir e atualizar um documento.").
* Marque a caixa de seleção Modelo de um documento na tabela Documentos \[ds_document\].
{#DocumentListServiceBothAPI__ul_b12_5zv_wpb}  
As seguintes APIs permitem definir e gerenciar documentos:

* [SystemDocument](https://servicenow-prod.fluidtopics.net/f~~djlIZ0oB2DBCzulQgrg#SystemDocumentBothAPI "A API SystemDocument fornece métodos para definir campos de um registro na tabela Documentos [ds_document].") --- Defina um objeto de documento.
* [DocumentService](https://servicenow-prod.fluidtopics.net/RQl3CMjmO43RtsVfo11mWQ#DocumentServiceBothAPI "A API DocumentService fornece métodos para criar, excluir e atualizar um documento.") : adicione, atualize ou exclua um documento.
{#DocumentListServiceBothAPI__ul_krc_vmf_vpb}  
Para definir um documento como modelo:

* Defina o objeto de documento definindo o método [SystemDocument -- template()](https://servicenow-prod.fluidtopics.net/f~~djlIZ0oB2DBCzulQgrg#SystemDoc-template_S "Especifica se um registro de documento é um modelo.") como verdadeiro. Crie ou atualize o registro do documento com os métodos na API [DocumentService](https://servicenow-prod.fluidtopics.net/RQl3CMjmO43RtsVfo11mWQ#DocumentServiceBothAPI "A API DocumentService fornece métodos para criar, excluir e atualizar um documento.").
* Marque a caixa de seleção Modelo de um documento na tabela Documentos \[ds_document\].
{#DocumentListServiceBothAPI__d3455e144}

Consulte também [SystemDocumentList](https://servicenow-prod.fluidtopics.net/Q02k42sP5z8J5FYYlYRQdA#SystemDocumentListBothAPI "A API SystemDocumentList fornece métodos para definir os campos de registro na tabela Listas de documentos [ds_document_lists].").

## DocumentListService - DocumentListService() {#ariaid-title2}

Instancia um objeto DocumentListService.
{#DLS-DocumentListService__table_zw5_mcg_tpb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum(a) |   |   |
[Tabela 1. Parâmetros]

{#DLS-DocumentListService__table_zw5_mcg_tpb}  
O exemplo a seguir mostra como instanciar um objeto DocumentListService. Consulte também [SystemDocumentList](https://servicenow-prod.fluidtopics.net/Q02k42sP5z8J5FYYlYRQdA#SystemDocumentListBothAPI "A API SystemDocumentList fornece métodos para definir os campos de registro na tabela Listas de documentos [ds_document_lists].").

    var s = new sn_doc_services.DocumentListService();

## DocumentListService - createDocumentList(SystemDocumentList doc) {#ariaid-title3}

Cria uma lista de documentos na tabela Listas de documentos \[ds_document_lists\].
O plug-in Gestão de documentos também oferece suporte à criação de listas de modelos de documento para associar ao seu documento. Por exemplo, uma candidatura de trabalho que exige vários documentos, como um diploma, ID ou passaporte. Depois de adicionar sua lista de documentos, você pode adicionar modelos de documento:

* [SystemDocumentListEntry](https://servicenow-prod.fluidtopics.net/FlaIl3JyWpUrgSGQoK3Bww#SystemDocumentListEntryBothAPI "A API SystemDocumentListEntry fornece métodos para definir os campos de registro na tabela Entradas da lista de documentos [ds_document_list_entry].") --- Defina uma entrada de lista de modelos de documento.
* [DocumentListEntryService](https://servicenow-prod.fluidtopics.net/4UqhkDift1QTd4B3v63Wjg#DocumentListEntryServiceBothAPI "A API DocumentListEntryService fornece métodos para manter modelos de documento em uma lista de documentos.") -- adicione ou remova uma entrada de lista de modelo de documento.
{#DLS-createDocumentList_O__ul_asn_gjg_vpb}

Use o método [createDocumentsFromList()](https://servicenow-prod.fluidtopics.net/bBzofnAy2Cw~CzBp2hqCkQ#DLS-createDocumentsFromList_S_S_S "Cria documentos a partir de uma lista de modelos de documento.") para criar documentos a partir da lista de modelos de documento.
{#DLS-createDocumentList_O__table_w4z_2cg_tpb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| documento | [ListaDocumentosdoSistema](https://servicenow-prod.fluidtopics.net/Q02k42sP5z8J5FYYlYRQdA#SystemDocumentListBothAPI "A API SystemDocumentList fornece métodos para definir os campos de registro na tabela Listas de documentos [ds_document_lists].") | Uma ou mais propriedades que representam campos de um novo registro. A propriedade name é necessária e pode ser definida usando o construtor SystemDocumentList ou o método name(). |
[Tabela 2. Parâmetros]

{#DLS-createDocumentList_O__table_w4z_2cg_tpb} {#DLS-createDocumentList_O__table_tj4_p5j_34b__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Sys_id do novo registro na tabela Listas de documentos \[ds_document_lists\] com uma mensagem de sucesso. Caso contrário, mensagem de erro. { "message": "String", "request_id": "String", "status": "String" } |
| \<Object\>.mensagem | Mensagem confirmando sucesso ou erro. Tipo de dados: cadeia de caracteres |
| \<Object\>.request_id | Sys_id do registro na tabela Listas de documentos \[ds_document_lists\]. 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. O message fornece detalhes. {#DLS-createDocumentList_O__ul_rlv_5cv_j4b} Tipo de dados: cadeia de caracteres |
[Tabela 3. Retorna]

{#DLS-createDocumentList_O__table_tj4_p5j_34b}  
O exemplo a seguir mostra como criar uma lista de documentos. Consulte também [SystemDocumentList](https://servicenow-prod.fluidtopics.net/Q02k42sP5z8J5FYYlYRQdA#SystemDocumentListBothAPI "A API SystemDocumentList fornece métodos para definir os campos de registro na tabela Listas de documentos [ds_document_lists].").

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

## DocumentListService - createDocumentsFromList(cadeia de caracteres listSysId, cadeia de caracteres tableName, cadeia de caracteres tableSysId) {#ariaid-title4}

Cria documentos a partir de uma lista de modelos de documento.
Nota:  
Antes de usar este método, crie uma lista de modelos de documento usando o método [createDocumentList()](https://servicenow-prod.fluidtopics.net/bBzofnAy2Cw~CzBp2hqCkQ#DLS-createDocumentList_O "Cria uma lista de documentos na tabela Listas de documentos [ds_document_lists].").
{#DLS-createDocumentsFromList_S_S_S__table_w4z_2cg_tpb__entry__3}

| 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\]. |
| tableName | Cadeia de caracteres | Nome da tabela que contém o registro ao qual adicionar uma lista de referências de modelo de documento. |
| tableSysId | Cadeia de caracteres | Sys_id do registro que contém o conteúdo do qual uma lista de referências de modelo de documento será adicionada. |
[Tabela 4. Parâmetros]

{#DLS-createDocumentsFromList_S_S_S__table_w4z_2cg_tpb} {#DLS-createDocumentsFromList_S_S_S__table_tj4_p5j_34b__entry__2}{#DLS-createDocumentsFromList_S_S_S__ph-docserv-ret-obj-basic}{#DLS-createDocumentsFromList_S_S_S__row_pdfgen_ret_msgCnv}

| Tipo | Descrição |
|-|-|
| Objeto | Mensagem de sucesso ou erro { "message": "String", "request_id": "String", "status": "String" } {#DLS-createDocumentsFromList_S_S_S__api_docserv_codeblock_dets} |
| \<Object\>.mensagem | Mensagem que contém o número de modelos de documento na lista de documentos. Tipo de dados: cadeia de caracteres |
| \<Object\>.request_id | Sys_id do registro na tabela Listas de documentos \[ds_document_lists\]. 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. O message fornece detalhes. {#DLS-createDocumentsFromList_S_S_S__ul_rlv_5cv_j4b} Tipo de dados: cadeia de caracteres |
[Tabela 5. Retorna]

{#DLS-createDocumentsFromList_S_S_S__table_tj4_p5j_34b}  
O exemplo a seguir mostra como adicionar uma lista de referências de modelo de documento a um registro. A documentação é adicionada a um registro na tabela Incidentes \[incidente\].

    var result = new sn_doc_services.DocumentListService().createDocumentsFromList('21afddea2460fc10f877a6fed1c2b0dd', 'incident', 'd7158da0c0a8016700eef46c8d1f3661');
    gs.info(JSON.stringify(result, null, 2));

Saída:

    {
      "message": "Created 1 document references for the given table name: incident, table sysId : d7158da0c0a8016700eef46c8d1f3661 with list SysId 21afddea2460fc10f877a6fed1c2b0dd",
      "request_id": "21afddea2460fc10f877a6fed1c2b0dd",
      "status": "success"
    }

## DocumentListService -- deleteDocumentList(String listSysId) {#ariaid-title5}

Remove um registro de documento da tabela Listas de documentos \[ds_document_lists\].
{#DLS-deleteDocumentList_S__table_w4z_2cg_tpb__entry__3}

| 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 6. Parâmetros]

{#DLS-deleteDocumentList_S__table_w4z_2cg_tpb} {#DLS-deleteDocumentList_S__table_x4z_2cg_tpb__entry__2}{#DLS-deleteDocumentList_S__ph-docserv-ret-obj-basic}

| Tipo | Descrição |
|-|-|
| Objeto | Mensagem de sucesso ou erro { "message": "String", "request_id": "String", "status": "String" } {#DLS-deleteDocumentList_S__api_docserv_codeblock_dets} |
| \<Object\>.mensagem | Mensagem confirmando sucesso ou erro. Tipo de dados: cadeia de caracteres |
| \<Object\>.request_id | Sys_id do registro na tabela Listas de documentos \[ds_document_lists\]. 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. O message fornece detalhes. {#DLS-deleteDocumentList_S__ul_rlv_5cv_j4b} Tipo de dados: cadeia de caracteres |
[Tabela 7. Retorna]

{#DLS-deleteDocumentList_S__table_x4z_2cg_tpb}  
O exemplo a seguir mostra como excluir um registro de lista de documentos. Consulte também [SystemDocumentList](https://servicenow-prod.fluidtopics.net/Q02k42sP5z8J5FYYlYRQdA#SystemDocumentListBothAPI "A API SystemDocumentList fornece métodos para definir os campos de registro na tabela Listas de documentos [ds_document_lists].").

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

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

Saída:

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

## DocumentListService - updateDocumentList(cadeia de caracteres docSysId, SystemDocumentList doc) {#ariaid-title6}

Atualiza os valores de campo de uma lista de documentos existente.
{#DLS-updateDocumentList_S_O__table_w4z_2cg_tpb__entry__3}

| 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\]. |
| documento | [DocumentoDoSistema](https://servicenow-prod.fluidtopics.net/f~~djlIZ0oB2DBCzulQgrg#SystemDocumentBothAPI "A API SystemDocument fornece métodos para definir campos de um registro na tabela Documentos [ds_document].") | Uma ou mais propriedades que representam os campos da lista de documentos a serem atualizados. |
[Tabela 8. Parâmetros]

{#DLS-updateDocumentList_S_O__table_w4z_2cg_tpb} {#DLS-updateDocumentList_S_O__table_x4z_2cg_tpb__entry__2}{#DLS-updateDocumentList_S_O__ph-docserv-ret-obj-basic}

| Tipo | Descrição |
|-|-|
| Objeto | Mensagem de sucesso ou erro { "message": "String", "request_id": "String", "status": "String" } {#DLS-updateDocumentList_S_O__api_docserv_codeblock_dets} |
| \<Object\>.mensagem | Mensagem confirmando sucesso ou erro. Tipo de dados: cadeia de caracteres |
| \<Object\>.request_id | Sys_id do registro na tabela Listas de documentos \[ds_document_lists\]. 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. O message fornece detalhes. {#DLS-updateDocumentList_S_O__ul_rlv_5cv_j4b} Tipo de dados: cadeia de caracteres |
[Tabela 9. Retorna]

{#DLS-updateDocumentList_S_O__table_x4z_2cg_tpb}  
O exemplo a seguir mostra como atualizar o nome e a descrição de uma lista de documentos. Consulte também [SystemDocumentList](https://servicenow-prod.fluidtopics.net/Q02k42sP5z8J5FYYlYRQdA#SystemDocumentListBothAPI "A API SystemDocumentList fornece métodos para definir os campos de registro na tabela Listas de documentos [ds_document_lists].").

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

    var docListUpdate = new sn_doc_services.SystemDocumentList();
    docListUpdate.name('name change');
    docListUpdate.description('description update');

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