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


---

# SystemDocumentVersion - com escopo, global

# SystemDocumentVersion - 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 SystemDocumentVersion fornece métodos para definir os valores da versão de origem de um documento na tabela Versões \[ds_document_version\].

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 uma versão do documento, use 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.").

## SystemDocumentVersion - SystemDocumentVersion(cadeia de caracteres docSysId) {#ariaid-title2}

Instancia um objeto SystemDocumentVersion.
{#SysDocVer-SystemDocumentVersion_S__table_o12_jrk_spb__entry__3}{#SysDocVer-SystemDocumentVersion_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 1. Parâmetros]

{#SysDocVer-SystemDocumentVersion_S__table_o12_jrk_spb} {#SysDocVer-SystemDocumentVersion_S__table_p12_jrk_spb__entry__2}

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

{#SysDocVer-SystemDocumentVersion_S__table_p12_jrk_spb}  
O exemplo a seguir mostra como instanciar um objeto SystemDocumentVersion e criar uma versão do documento. Consulte também [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.").

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

## SystemDocumentVersion - document(cadeia de caracteres docSysId) {#ariaid-title3}

Especifica o registro do documento para esta versão.
Nota:  
Como alternativa, você pode definir o nome como um parâmetro no construtor SystemDocumentVersion().
{#SysDocVer-document_S__table_o12_jrk_spb__entry__3}{#SysDocVer-document_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 3. Parâmetros]

{#SysDocVer-document_S__table_o12_jrk_spb} {#SysDocVer-document_S__table_p12_jrk_spb__entry__2}

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

{#SysDocVer-document_S__table_p12_jrk_spb}  
O exemplo a seguir mostra como definir o campo de nome de uma versão do documento. Consulte também DocumentVersionService -- [createDocumentVersion()](https://servicenow-prod.fluidtopics.net/7ajJEEjvQvmpUsRdQd5uxg#DocVersSvc-createDocumentVersion_O "Cria um registro de versão do documento na tabela Versões [ds_document_version].").

    var versionDefinition = new sn_doc_services.SystemDocumentVersion();

    versionDefinition.document('491efbee24187410f877a6fed1c2b0a9');

    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 : 1c504c91242cf810f877a6fed1c2b08b is successful.",
      "request_id": "1c504c91242cf810f877a6fed1c2b08b",
      "status": "success"
    }

## SystemDocumentVersion - type(cadeia de caracteres docType) {#ariaid-title4}

Define o campo Tipo de uma versão do documento.
{#SysDocVer-type_S__table_o12_jrk_spb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| docType | Cadeia de caracteres | Tipo de origem do documento. Valores válidos: * URL * anexo {#SysDocVer-type_S__ul_xzq_qsl_spb}Padrão: anexo Nota: No momento, um anexo só pode ser adicionado na IU da tabela Versões do documento \[ds_document_version\] e não com a API. |
[Tabela 5. Parâmetros]

{#SysDocVer-type_S__table_o12_jrk_spb} {#SysDocVer-type_S__table_p12_jrk_spb__entry__2}

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

{#SysDocVer-type_S__table_p12_jrk_spb}  
O exemplo a seguir mostra como definir o campo de tipo e criar uma versão do documento. Consulte também [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.").

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

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

## SystemDocumentVersion - url (cadeia de caracteres URL) {#ariaid-title5}

Define o URL de uma versão do documento.
{#SysDocVer-url_S__table_o12_jrk_spb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| URL | Cadeia de caracteres | URL do documento de origem para esta versão. |
[Tabela 7. Parâmetros]

{#SysDocVer-url_S__table_o12_jrk_spb} {#SysDocVer-url_S__table_p12_jrk_spb__entry__2}

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

{#SysDocVer-url_S__table_p12_jrk_spb}  
O exemplo a seguir mostra como definir o campo URL como a origem de uma versão do documento. Consulte também [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.").

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

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

## SystemDocumentVersion - versionNumber(Number versionNumber) {#ariaid-title6}

Define o número de uma versão do documento.
{#SysDocVer-versionNumber_N__table_o12_jrk_spb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| versionNumber | Número | Número da versão deste documento. |
[Tabela 9. Parâmetros]

{#SysDocVer-versionNumber_N__table_o12_jrk_spb} {#SysDocVer-versionNumber_N__table_p12_jrk_spb__entry__2}

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

{#SysDocVer-versionNumber_N__table_p12_jrk_spb}  
O exemplo a seguir mostra como definir o número da versão e criar uma versão do documento. Consulte também [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.").

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

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

    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 : ff47449d242cf810f877a6fed1c2b06c is successful.",
      "request_id": "ff47449d242cf810f877a6fed1c2b06c",
      "status": "success"
    }