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


---

# DocumentReferenceService - com escopo, global

# DocumentReferenceService - 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) 2 min. de leitura

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.

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).  
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.
{#DocumentReferenceServiceBothAPI__ul_krc_vmf_vpb}

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

Instancia um objeto DocumentReferenceService.
{#DRS-DocumentReferenceService__table_zw5_mcg_tpb__entry__3}

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

{#DRS-DocumentReferenceService__table_zw5_mcg_tpb}  
O exemplo a seguir mostra como instanciar um objeto DocumentReferenceService.

    var result = new sn_doc_services.DocumentReferenceService();

## DocumentReferenceService -- addDocumentReference(cadeia de caracteres docSysId, cadeia de caracteres targetTable, cadeia de caracteres tableSysId) {#ariaid-title3}

Adiciona uma referência de documento a um registro de tabela de destino.
{#DRS-addDocumentReference_S_S_S__table_w4z_2cg_tpb__entry__3}{#DRS-addDocumentReference_S_S_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\]. |
| targetTable | Cadeia de caracteres | Nome da tabela de destino na qual uma referência de documento será fornecida. |
| tableSysId | Cadeia de caracteres | Sys_id do registro da tabela de destino ao qual a referência do documento será adicionada. |
[Tabela 2. Parâmetros]

{#DRS-addDocumentReference_S_S_S__table_w4z_2cg_tpb} {#DRS-addDocumentReference_S_S_S__table_x4z_2cg_tpb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Sys_id do novo registro na tabela Referências de documento \[ds_document_reference\] com uma mensagem de sucesso. Caso contrário, mensagem de erro. { "message": "String", "status": "String" } {#DRS-addDocumentReference_S_S_S__api_docserv_codeblock_dets} |
| \<Object\>.mensagem | Mensagem confirmando sucesso ou erro. Se bem-sucedido, inclui o sys_id do registro ao qual a referência do documento foi adicionada. 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. {#DRS-addDocumentReference_S_S_S__ul_rlv_5cv_j4b} Tipo de dados: cadeia de caracteres |
[Tabela 3. Retorna]

{#DRS-addDocumentReference_S_S_S__table_x4z_2cg_tpb}  
O exemplo a seguir mostra como adicionar uma referência de documento a um registro na tabela Incidentes \[incidente\].

    var docReference = new sn_doc_services.DocumentReferenceService();

    var result = docReference.addDocumentReference("<docSysId>", "incident", "<tableSysId>");

    gs.info(JSON.stringify(result, null, 2));

Saída:

    {
      "message": "Adding an entry to DocumentReference for the given docId to target table : incident, sysId : <tableSysId> is successful.",
      "status": "success"
    }

## DocumentReferenceService - removeDocumentReference(cadeia de caracteres docSysId, cadeia de caracteres targetTable, cadeia de caracteres tableSysId) {#ariaid-title4}

Remove uma referência de documento da tabela Referências de documento \[ds_document_reference\].
{#DRS-removeDocumentReference_S_S_S__table_w4z_2cg_tpb__entry__3}{#DRS-removeDocumentReference_S_S_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\]. |
| targetTable | Cadeia de caracteres | Nome da tabela que contém a referência do documento. Essas informações são listadas com o documento na tabela Referências de documento \[ds_document_reference\]. |
| tableSysId | Cadeia de caracteres | Sys_id do registro a partir do qual o documento é referenciado. Você pode encontrar informações relacionadas listadas com o documento na tabela Referências de documento \[ds_document_reference\]. |
[Tabela 4. Parâmetros]

{#DRS-removeDocumentReference_S_S_S__table_w4z_2cg_tpb} {#DRS-removeDocumentReference_S_S_S__table_x4z_2cg_tpb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Mensagem de sucesso. Caso contrário, mensagem de erro. { "message": "String", "status": "String" } {#DRS-removeDocumentReference_S_S_S__api_docserv_codeblock_dets} |
| \<Object\>.mensagem | Mensagem confirmando sucesso ou erro. Se for bem-sucedido, inclui o sys_id do registro do qual a referência do documento foi removida. 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. {#DRS-removeDocumentReference_S_S_S__ul_rlv_5cv_j4b} Tipo de dados: cadeia de caracteres |
[Tabela 5. Retorna]

{#DRS-removeDocumentReference_S_S_S__table_x4z_2cg_tpb}  
O exemplo a seguir mostra como remover uma referência de documento de um registro na tabela Incidentes \[incidente\].

    var docReference = new sn_doc_services.DocumentReferenceService();

    var result = docReference.removeDocumentReference("<docSysId>", "incident", "<tableSysId>");

    gs.info(JSON.stringify(result, null, 2));

Saída:

    {
      "message": "Deleting an entry to DocumentReference for the given docId to target table : incident, sysId : <tableSysId> is successful.",
      "status": "success"
    }