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


---

# DocumentService - com escopo, global

# DocumentService - 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) 4 min. de leitura

A API DocumentService fornece métodos para criar, excluir e atualizar um documento.

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

Um documento é uma coleção de informações sobre um registro de documento. Os métodos usados para criar ou atualizar um registro modificam os campos usando o objeto [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].").  
O conteúdo do documento é gerenciado usando versões. As seguintes APIs permitem que você defina e gerencie versões de documentos:

* [SystemDocumentVersion](https://servicenow-prod.fluidtopics.net/XK5gw9kwCb36ZoO0vu1ZSw#SystemDocumentVersionBothAPI "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].") -- defina uma versão do documento como a origem do conteúdo do documento. Cada versão é um elemento que contém o conteúdo do documento e é fornecida usando um único URL ou anexo. Um anexo só pode ser adicionado na IU da tabela Versões do documento \[ds_document_version\] e não com a API.
* [DocumentVersionService](https://servicenow-prod.fluidtopics.net/7ajJEEjvQvmpUsRdQd5uxg#DocumentVersionServiceBothAPI "A API DocumentVersionService fornece um serviço para criar e excluir versões de documentos. Cada versão é um elemento que contém o conteúdo do documento e é fornecida usando um único URL ou anexo. Um anexo só pode ser adicionado na IU da tabela Versões do documento [ds_document_version] e não com a API.") -- o conteúdo do documento é gerenciado usando versões.
{#DocumentServiceBothAPI__ul_krc_vmf_vpb}

Use a API [DocumentReferenceService](https://servicenow-prod.fluidtopics.net/Ts_YRcLv97_5Kz~VgmsMlg#DocumentReferenceServiceBothAPI "A API DocumentReferenceService fornece métodos para gerenciar referências de documentos em uma tabela de destino, como a tabela Incidentes [incident] ou Knowledge [kb_knowledge]. Você pode usar referências de documento para associar informações a um registro.") para gerenciar documentos referenciados em uma tabela de destino, como a tabela Incidentes \[incident\] ou Knowledge \[kb_knowledge\].  
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.

* [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].") --- Defina uma lista de modelos de documento.
* [DocumentListService](https://servicenow-prod.fluidtopics.net/bBzofnAy2Cw~CzBp2hqCkQ#DocumentListServiceBothAPI "A API DocumentListService fornece métodos para criar, excluir e atualizar uma lista de documentos.") -- adicione ou remova uma lista de 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.
{#DocumentServiceBothAPI__ul_asn_gjg_vpb}

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

Instancia um objeto DocumentService.
{#DocumentService-DocumentService__table_zw5_mcg_tpb__entry__3}

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

{#DocumentService-DocumentService__table_zw5_mcg_tpb}  
O exemplo a seguir mostra como instanciar um objeto DocumentService.

    var s = new sn_doc_services.DocumentService();

## DocumentService - createDocument(SystemDocument doc) {#ariaid-title3}

Cria um registro de documento na tabela Documentos \[ds_document\].
{#DocumentService-createDocument_O__table_w4z_2cg_tpb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| 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 campos de um novo registro. A propriedade name é necessária e pode ser definida usando o construtor SystemDocument ou o método name(). |
[Tabela 2. Parâmetros]

{#DocumentService-createDocument_O__table_w4z_2cg_tpb} {#DocumentService-createDocument_O__table_tj4_p5j_34b__entry__2}{#DocumentService-createDocument_O__row_pdfgen_ret_msgCnv}

| Tipo | Descrição |
|-|-|
| Objeto | Sys_id do novo registro na tabela Documentos \[ds_document\] 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. Valores possíveis: * Criar sysId do documento :\<sys_id\> foi bem-sucedido. * O nome do documento é obrigatório e deve ser válido. * O nome do documento é obrigatório e não deve ser nulo ou vazio. * \< propriedade[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].") que requer entrada sys_id\> com SysId: "\<sys_id\> " não existe {#DocumentService-createDocument_O__ul_hwn_lbh_tpb} Tipo de dados: cadeia de caracteres |
| \<Object\>.request_id | Sys_id do registro na tabela Documentos \[ds_document\]. 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. {#DocumentService-createDocument_O__ul_rlv_5cv_j4b} Tipo de dados: cadeia de caracteres |
[Tabela 3. Retorna]

{#DocumentService-createDocument_O__table_tj4_p5j_34b}  
O exemplo a seguir mostra como preencher as propriedades do objeto SystemDocument e criar um novo registro de documento.

    var d = new sn_doc_services.SystemDocument('My document');

    // Define the document fields
    var reviewers = '62826bf03710200044e0bfc8bcbe5df1,a8f98bb0eb32010045e1a5115206fe3a';
    d.description('description');
    d.classification('restricted');
    d.state('review');
    d.department('93b25282c0a8000b0b55c8ab34e2f1e6');
    d.template(false);
    d.type('policy');
    d.reviewers(reviewers);
    d.audience('external');

    var s = new sn_doc_services.DocumentService();
    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Saída:

    {
      "message": "Create document sysId : 1040420224503410f877a6fed1c2b031 is successful.",
      "request_id": "1040420224503410f877a6fed1c2b031",
      "status": "success"
    }

## DocumentService -- deleteDocument(String docSysId) {#ariaid-title4}

Remove um registro de documento da tabela Documentos \[ds_document\].
{#DocumentService-deleteDocument_S__table_w4z_2cg_tpb__entry__3}{#DocumentService-deleteDocument_S__ph_docserv_parm_docID}

| Nome | Tipo | Descrição |
|-|-|-|
| docSysId | Cadeia de caracteres | Sys_id de um registro de documento na tabela Documentos \[ds_document\]. |
[Tabela 4. Parâmetros]

{#DocumentService-deleteDocument_S__table_w4z_2cg_tpb} {#DocumentService-deleteDocument_S__table_x4z_2cg_tpb__entry__2}{#DocumentService-deleteDocument_S__ph-docserv-ret-obj-basic}

| Tipo | Descrição |
|-|-|
| Objeto | Mensagem de sucesso ou erro { "message": "String", "request_id": "String", "status": "String" } {#DocumentService-deleteDocument_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 Documentos \[ds_document\]. 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. {#DocumentService-deleteDocument_S__ul_rlv_5cv_j4b} Tipo de dados: cadeia de caracteres |
[Tabela 5. Retorna]

{#DocumentService-deleteDocument_S__table_x4z_2cg_tpb}  
O exemplo a seguir mostra como excluir um registro de documento existente.

    var docid = "<sys_id>";
    var svc = new sn_doc_services.DocumentService();
    gs.info(JSON.stringify(svc.deleteDocument(docid), null, 2));

Saída:

    {
      "message": "Delete document sysId : <sys_id> is successful.",
      "request_id": "<sys_id>",
      "status": "success"
    }

## DocumentService - updateDocument(String docSysId, SystemDocument doc) {#ariaid-title5}

Atualiza os valores de campo de um registro de documento existente.
{#DocumentService-updateDocument_S_O__table_w4z_2cg_tpb__entry__3}{#DocumentService-updateDocument_S_O__ph_docserv_parm_docID}

| Nome | Tipo | Descrição |
|-|-|-|
| docSysId | Cadeia de caracteres | Sys_id de um registro de documento na tabela Documentos \[ds_document\]. |
| 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 do documento a serem atualizados. |
[Tabela 6. Parâmetros]

{#DocumentService-updateDocument_S_O__table_w4z_2cg_tpb} {#DocumentService-updateDocument_S_O__table_x4z_2cg_tpb__entry__2}{#DocumentService-updateDocument_S_O__ph-docserv-ret-obj-basic}

| Tipo | Descrição |
|-|-|
| Objeto | Mensagem de sucesso ou erro { "message": "String", "request_id": "String", "status": "String" } {#DocumentService-updateDocument_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 Documentos \[ds_document\]. 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. {#DocumentService-updateDocument_S_O__ul_rlv_5cv_j4b} Tipo de dados: cadeia de caracteres |
[Tabela 7. Retorna]

{#DocumentService-updateDocument_S_O__table_x4z_2cg_tpb}  
O exemplo a seguir mostra como alterar o nome de um documento. Consulte também [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].").

    var dId = "19aab54e24103410f877a6fed1c2b03d";
    var d = new sn_doc_services.SystemDocument();
    d.name("c22.txt");

    var s = new sn_doc_services.DocumentService();
    gs.info(JSON.stringify(s.updateDocument(dId, d), null, 2));

Saída:

    {
      "message": "Update document sysId : 19aab54e24103410f877a6fed1c2b03d is successful.",
      "request_id": "19aab54e24103410f877a6fed1c2b03d",
      "status": "success"
    }