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


---

# DocumentVersionService - com escopo, global

# DocumentVersionService - 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 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.

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

Antes de criar uma versão do documento, você deve definir e adicionar um registro do documento.

* [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.
{#DocumentVersionServiceBothAPI__ul_qyt_tpr_wpb}

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

Instancia um objeto DocumentVersionService.
{#DocVersSvc-DocumentVersionService__table_zw5_mcg_tpb__entry__3}

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

{#DocVersSvc-DocumentVersionService__table_zw5_mcg_tpb}  
O exemplo a seguir mostra como instanciar um objeto DocumentVersionService.

    var versionSvc = new sn_doc_services.DocumentVersionService();

## DocumentVersionService - createDocumentVersion(SystemDocumentVersion docVersion) {#ariaid-title3}

Cria um registro de versão do documento na tabela Versões \[ds_document_version\].
{#DocVersSvc-createDocumentVersion_O__table_w4z_2cg_tpb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| docVersion | [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].") | Uma ou mais propriedades que representam campos de uma versão do documento. |
[Tabela 2. Parâmetros]

{#DocVersSvc-createDocumentVersion_O__table_w4z_2cg_tpb} {#DocVersSvc-createDocumentVersion_O__table_tj4_p5j_34b__entry__2}{#DocVersSvc-createDocumentVersion_O__row_pdfgen_ret_msgCnv}

| Tipo | Descrição |
|-|-|
| Objeto | Sys_id do novo registro na tabela Versões \[ds_document_version\] 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. Se for bem-sucedido, inclui o sys_id do registro do documento e o sys_id da nova versão do documento. Tipo de dados: cadeia de caracteres |
| \<Object\>.request_id | Sys_id do novo registro na tabela Versões \[ds_document_version\]. 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. {#DocVersSvc-createDocumentVersion_O__ul_rlv_5cv_j4b} Tipo de dados: cadeia de caracteres |
[Tabela 3. Retorna]

{#DocVersSvc-createDocumentVersion_O__table_tj4_p5j_34b}  
O exemplo a seguir mostra como preencher as propriedades do objeto SystemDocumentVersion e criar uma nova versão do documento. Consulte também [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].").

    var versionDefinition = new sn_doc_services.SystemDocumentVersion('491efbee24187410f877a6fed1c2b0a9');

    versionDefinition.type('url');
    versionDefinition.url('http://one/1.0');

    var versionSvc = new sn_doc_services.DocumentVersionService();
    gs.info(JSON.stringify(versionSvc.createDocumentVersion(versionDefinition), null, 2));

Saída:

    {
      "message": "Adding an entry to DocumentVersion for the given docId : 491efbee24187410f877a6fed1c2b0a9, sysId : d5a340d9242cf810f877a6fed1c2b069 is successful.",
      "request_id": "d5a340d9242cf810f877a6fed1c2b069",
      "status": "success"
    }

## DocumentVersionService -- deleteDocumentVersion(String docVersionSysId) {#ariaid-title4}

Exclui uma versão do documento.
{#DocVersSvc-deleteDocumentVersion_S__table_w4z_2cg_tpb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| docVersionSysId | Cadeia de caracteres | Sys_id de uma versão de documento na tabela Versões \[ds_document_version\]. |
[Tabela 4. Parâmetros]

{#DocVersSvc-deleteDocumentVersion_S__table_w4z_2cg_tpb} {#DocVersSvc-deleteDocumentVersion_S__table_x4z_2cg_tpb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Mensagem de sucesso. Caso contrário, mensagem de erro. { "message": "String", "status": "String" } {#DocVersSvc-deleteDocumentVersion_S__api_docserv_codeblock_dets} |
| \<Object\>.mensagem | Mensagem confirmando sucesso ou erro. Se for bem-sucedido, inclui o sys_id da versão do documento excluído. 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. {#DocVersSvc-deleteDocumentVersion_S__ul_rlv_5cv_j4b} Tipo de dados: cadeia de caracteres |
[Tabela 5. Retorna]

{#DocVersSvc-deleteDocumentVersion_S__table_x4z_2cg_tpb}  
O exemplo a seguir mostra como excluir uma versão de documento existente.

    var vId = "<versionSysId>";
    var versionSvc = new sn_doc_services.DocumentVersionService();

    gs.info(JSON.stringify(versionSvc.deleteDocumentVersion(vId), null, 2));

Saída:

    {
      "message": "Deleting an entry to DocumentVersion for the given documentVersionSysId : , sysId : <versionSysId> is successful.",
      "status": "success"
    }