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


---

# SystemDocument - com escopo, global

# SystemDocument - 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) 6 min. de leitura

A API SystemDocument fornece métodos para definir campos de um registro na tabela Documentos \[ds_document\].

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 um documento, use a [API DocumentService](https://servicenow-prod.fluidtopics.net/RQl3CMjmO43RtsVfo11mWQ#DocumentServiceBothAPI "A API DocumentService fornece métodos para criar, excluir e atualizar um documento.").

## SystemDocument - SystemDocument(cadeia de caracteres docName) {#ariaid-title2}

Instancia um objeto SystemDocument.
{#SystemDoc-SystemDocument_S__table_o12_jrk_spb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| docName | Cadeia de caracteres | Nome do Documento. |
[Tabela 1. Parâmetros]

{#SystemDoc-SystemDocument_S__table_o12_jrk_spb} {#SystemDoc-SystemDocument_S__table_p12_jrk_spb__entry__2}

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

{#SystemDoc-SystemDocument_S__table_p12_jrk_spb}  
O exemplo a seguir mostra como instanciar um objeto SystemDocument e definir vários campos para um registro de documento. Consulte também [a API DocumentService](https://servicenow-prod.fluidtopics.net/RQl3CMjmO43RtsVfo11mWQ#DocumentServiceBothAPI "A API DocumentService fornece métodos para criar, excluir e atualizar um 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"
    }

## SystemDocument - público(cadeia de caracteres público) {#ariaid-title3}

Define o campo Público de um registro de documento para especificar a disponibilidade externa ou interna. Representa o campo Público em um formulário Gestão de documentos.
{#SystemDoc-audience_S__table_o12_jrk_spb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| público(a) | Cadeia de caracteres | Cadeia de caracteres que representa o público-alvo do documento. Valores possíveis: * externo * interno(a) {#SystemDoc-audience_S__ul_occ_ydl_spb}Padrão: interno |
[Tabela 3. Parâmetros]

{#SystemDoc-audience_S__table_o12_jrk_spb} {#SystemDoc-audience_S__table_p12_jrk_spb__entry__2}

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

{#SystemDoc-audience_S__table_p12_jrk_spb}  
O exemplo a seguir mostra como definir o campo Público em um novo registro de documento. Consulte também [DocumentService - com escopo, global](https://servicenow-prod.fluidtopics.net/RQl3CMjmO43RtsVfo11mWQ#DocumentServiceBothAPI "A API DocumentService fornece métodos para criar, excluir e atualizar um documento.").

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

    d.audience('external');

    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Saída:

    {
      "message": "Create document sysId : 1193fd4624103410f877a6fed1c2b016 is successful.",
      "request_id": "1193fd4624103410f877a6fed1c2b016",
      "status": "success"
    }

## SystemDocument - classificação (classificação de cadeia de caracteres) {#ariaid-title4}

Define o campo Classificação de um registro de documento para identificar o nível de confidencialidade das informações. Representa o campo Classificação em um formulário Gestão de documentos.
{#SystemDoc-classification_S__table_o12_jrk_spb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| classificação | Cadeia de caracteres | Classificação do documento. Valores possíveis: * confidencial * público * restrito {#SystemDoc-classification_S__ul_nk4_zfl_spb}Padrão: público |
[Tabela 5. Parâmetros]

{#SystemDoc-classification_S__table_o12_jrk_spb} {#SystemDoc-classification_S__table_p12_jrk_spb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | O valor da propriedade de classificação de um objeto SystemDocument. |
[Tabela 6. Retorna]

{#SystemDoc-classification_S__table_p12_jrk_spb}  
O exemplo a seguir mostra como definir o campo de classificação em um novo registro de documento. Consulte também [a API DocumentService](https://servicenow-prod.fluidtopics.net/RQl3CMjmO43RtsVfo11mWQ#DocumentServiceBothAPI "A API DocumentService fornece métodos para criar, excluir e atualizar um documento.").

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

    d.classification('restricted');

    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Saída:

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

## SystemDocument - createdFromTemplate(String docTemplate) {#ariaid-title5}

Define o modelo a partir do qual um documento será gerado. Quando o documento é gerado, o modelo especificado é listado no campo Criado a partir do modelo na tabela Documentos \[ds_document_list\].
{#SystemDoc-createdFromTemplate_S__table_o12_jrk_spb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| docTemplate | Cadeia de caracteres | Sys_id de um documento listado na tabela Documentos \[ds_document_list\]. O documento deve ter a caixa de seleção Modelo marcada (verdadeira). Consulte também [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."). |
[Tabela 7. Parâmetros]

{#SystemDoc-createdFromTemplate_S__table_o12_jrk_spb} {#SystemDoc-createdFromTemplate_S__table_p12_jrk_spb__entry__2}

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

{#SystemDoc-createdFromTemplate_S__table_p12_jrk_spb}  
O exemplo a seguir mostra como criar um novo registro de documento a partir de um modelo existente. Consulte também [a API DocumentService](https://servicenow-prod.fluidtopics.net/RQl3CMjmO43RtsVfo11mWQ#DocumentServiceBothAPI "A API DocumentService fornece métodos para criar, excluir e atualizar um documento.").

    var d = new sn_doc_services.SystemDocument('New doc from template');
    var s = new sn_doc_services.DocumentService();

    d.createdFromTemplate('<doc_template_sys_id>');

    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Saída:

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

## SystemDocument - departamento(cadeia de caracteres docDept) {#ariaid-title6}

Define o campo Departamento de um registro de documento.
{#SystemDoc-department_S__table_o12_jrk_spb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Dept.Doc. | Cadeia de caracteres | Sys_id de um departamento listado na tabela Departamentos \[cmn_department\]. |
[Tabela 9. Parâmetros]

{#SystemDoc-department_S__table_o12_jrk_spb} {#SystemDoc-department_S__table_p12_jrk_spb__entry__2}

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

{#SystemDoc-department_S__table_p12_jrk_spb}  
O exemplo a seguir mostra como definir o campo de departamento em um novo registro de documento. Consulte também [a API DocumentService](https://servicenow-prod.fluidtopics.net/RQl3CMjmO43RtsVfo11mWQ#DocumentServiceBothAPI "A API DocumentService fornece métodos para criar, excluir e atualizar um documento.").

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

    // Assign the doc to the human resources department
    d.department('<dept_sys_id>');

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

Saída:

    {
      "message": "Create document sysId : 491efbee24187410f877a6fed1c2b0a9 is successful.",
      "request_id": "491efbee24187410f877a6fed1c2b0a9",
      "status": "success"
    }

## SystemDocument - descrição (descrição da cadeia de caracteres) {#ariaid-title7}

Define o campo Descrição de um registro de documento.
{#SystemDoc-description_S__table_o12_jrk_spb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| descrição | Cadeia de caracteres | Descrição do documento. |
[Tabela 11. Parâmetros]

{#SystemDoc-description_S__table_o12_jrk_spb} {#SystemDoc-description_S__table_p12_jrk_spb__entry__2}

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

{#SystemDoc-description_S__table_p12_jrk_spb}  
O exemplo a seguir mostra como definir o campo de descrição em um registro de documento. Consulte também: [API DocumentService](https://servicenow-prod.fluidtopics.net/RQl3CMjmO43RtsVfo11mWQ#DocumentServiceBothAPI "A API DocumentService fornece métodos para criar, excluir e atualizar um documento.").

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

    d.description('Information describing the doc.');

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

Saída:

    {
      "message": "Create document sysId : 9acd7fea24587410f877a6fed1c2b060 is successful.",
      "request_id": "9acd7fea24587410f877a6fed1c2b060",
      "status": "success"
    }

## SystemDocument - name(cadeia de caracteres docName) {#ariaid-title8}

Define o campo Nome de um registro de documento.
Nota:  
Você também pode definir o nome como um parâmetro no construtor SystemDocument().
{#SystemDoc-name_S__table_o12_jrk_spb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| docName | Cadeia de caracteres | Nome do Documento. |
[Tabela 13. Parâmetros]

{#SystemDoc-name_S__table_o12_jrk_spb} {#SystemDoc-name_S__table_p12_jrk_spb__entry__2}

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

{#SystemDoc-name_S__table_p12_jrk_spb}  
O exemplo a seguir mostra como definir o campo Nome em um novo registro de documento. Consulte também [a API DocumentService](https://servicenow-prod.fluidtopics.net/RQl3CMjmO43RtsVfo11mWQ#DocumentServiceBothAPI "A API DocumentService fornece métodos para criar, excluir e atualizar um documento.").

    var d = new sn_doc_services.SystemDocument();

    d.name('Document named using method instead of constructor');

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

Saída:

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

## SystemDocument - proprietário(cadeia de caracteres responsável) {#ariaid-title9}

Define o campo Proprietário de um registro de documento.
{#SystemDoc-owner_S__table_o12_jrk_spb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| responsável | Cadeia de caracteres | Sys_id de um usuário listado na tabela Usuários \[sys_user\]. Função necessária: administrador Padrão: usuário atual |
[Tabela 15. Parâmetros]

{#SystemDoc-owner_S__table_o12_jrk_spb} {#SystemDoc-owner_S__table_p12_jrk_spb__entry__2}

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

{#SystemDoc-owner_S__table_p12_jrk_spb}  
O exemplo a seguir mostra como definir o campo do proprietário em um novo registro de documento. Consulte também [a API DocumentService](https://servicenow-prod.fluidtopics.net/RQl3CMjmO43RtsVfo11mWQ#DocumentServiceBothAPI "A API DocumentService fornece métodos para criar, excluir e atualizar um documento.").

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

    d.owner('aa826bf03710200044e0bfc8bcbe5dd6');

    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Saída:

    {
      "message": "Create document sysId : 4235318a24103410f877a6fed1c2b0ff is successful.",
      "request_id": "4235318a24103410f877a6fed1c2b0ff",
      "status": "success"
    }

## SystemDocument - revisores(cadeia de caracteres revisores) {#ariaid-title10}

Define o campo Revisores de um registro de documento.
{#SystemDoc-reviewers_S__table_o12_jrk_spb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| revisores | Cadeia de caracteres | Lista de um ou mais revisores de documentos por sys_id. O revisor deve ser um usuário listado na tabela Usuários \[sys_user\]. |
[Tabela 17. Parâmetros]

{#SystemDoc-reviewers_S__table_o12_jrk_spb} {#SystemDoc-reviewers_S__table_p12_jrk_spb__entry__2}

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

{#SystemDoc-reviewers_S__table_p12_jrk_spb}  
O exemplo a seguir mostra como definir o campo de revisores em um novo registro de documento. Consulte também [a API DocumentService](https://servicenow-prod.fluidtopics.net/RQl3CMjmO43RtsVfo11mWQ#DocumentServiceBothAPI "A API DocumentService fornece métodos para criar, excluir e atualizar um documento.").

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

    var reviewers = '62826bf03710200044e0bfc8bcbe5df1,a8f98bb0eb32010045e1a5115206fe3a';
    d.reviewers(reviewers);

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

Saída:

    {
      "message": "Create document sysId : 8d19f9ca24103410f877a6fed1c2b0aa is successful.",
      "request_id": "8d19f9ca24103410f877a6fed1c2b0aa",
      "status": "success"
    }

## SystemDocument - estado (estado da cadeia de caracteres) {#ariaid-title11}

Define o campo Estado de um registro de documento.
{#SystemDoc-state_S__table_o12_jrk_spb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Estado | Cadeia de caracteres | Estado do documento que representa onde o documento está no fluxo de trabalho. Valores válidos: * rascunho * enviar * revisão * concluída {#SystemDoc-state_S__ul_o3h_zbm_spb}Padrão: rascunho |
[Tabela 19. Parâmetros]

{#SystemDoc-state_S__table_o12_jrk_spb} {#SystemDoc-state_S__table_thg_lcm_spb__entry__2}

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

{#SystemDoc-state_S__table_thg_lcm_spb}  
O exemplo a seguir mostra como definir o campo de estado em um novo registro de documento. Consulte também [a API DocumentService](https://servicenow-prod.fluidtopics.net/RQl3CMjmO43RtsVfo11mWQ#DocumentServiceBothAPI "A API DocumentService fornece métodos para criar, excluir e atualizar um documento.").

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

    d.state('submit');

    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Saída:

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

## SystemDocument - template (modelo booliano) {#ariaid-title12}

Especifica se um registro de documento é um modelo.
{#SystemDoc-template_S__table_o12_jrk_spb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| modelo | Booliano | Sinalizador que especifica se um registro de documento é um modelo. Valores válidos: * verdadeiro: a versão padrão deste documento é um modelo. * falso: este documento não é um modelo. {#SystemDoc-template_S__ul_pyf_cgm_spb} Padrão: falso |
[Tabela 21. Parâmetros]

{#SystemDoc-template_S__table_o12_jrk_spb} {#SystemDoc-template_S__table_p12_jrk_spb__entry__2}

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

{#SystemDoc-template_S__table_p12_jrk_spb}  
O exemplo a seguir mostra como indicar que um registro de documento é um modelo. Consulte também [a API DocumentService](https://servicenow-prod.fluidtopics.net/RQl3CMjmO43RtsVfo11mWQ#DocumentServiceBothAPI "A API DocumentService fornece métodos para criar, excluir e atualizar um documento.").

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

    d.template(true);

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

Saída:

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

## SystemDocument - type(cadeia de caracteres docType) {#ariaid-title13}

Define o campo Tipo de um registro de documento.
{#SystemDoc-type_S__table_o12_jrk_spb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| docType | Cadeia de caracteres | Tipo de documento. Valores válidos: * contrato * diretriz * política * procedimento {#SystemDoc-type_S__ul_xzq_qsl_spb}Padrão: nenhum |
[Tabela 23. Parâmetros]

{#SystemDoc-type_S__table_o12_jrk_spb} {#SystemDoc-type_S__table_p12_jrk_spb__entry__2}

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

{#SystemDoc-type_S__table_p12_jrk_spb}  
O exemplo a seguir mostra como definir o campo de tipo em um novo registro de documento. Consulte também [a API DocumentService](https://servicenow-prod.fluidtopics.net/RQl3CMjmO43RtsVfo11mWQ#DocumentServiceBothAPI "A API DocumentService fornece métodos para criar, excluir e atualizar um documento.").

    var d = new sn_doc_services.SystemDocument('How to use the document mgmt API');
    var s = new sn_doc_services.DocumentService();

    d.type('guideline');

    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Saída:

    {
      "message": "Create document sysId : 8adfb10224503410f877a6fed1c2b0e4 is successful.",
      "request_id": "8adfb10224503410f877a6fed1c2b0e4",
      "status": "success"
    }