DocumentService - com escopo, global

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.

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.

O conteúdo do documento é gerenciado usando versões. As seguintes APIs permitem que você defina e gerencie versões de documentos:

• SystemDocumentVersion – 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 – o conteúdo do documento é gerenciado usando versões.

Use a API DocumentReferenceService 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 — Defina uma lista de modelos de documento.
• DocumentListService – adicione ou remova uma lista de modelos de documento.
• SystemDocumentListEntry — Defina uma entrada de lista de modelos de documento.
• DocumentListEntryService – adicione ou remova uma entrada de lista de modelo de documento.

DocumentService - DocumentService()

Instancia um objeto DocumentService.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como instanciar um objeto DocumentService.

var s = new sn_doc_services.DocumentService();

DocumentService - createDocument(SystemDocument doc)

Cria um registro de documento na tabela Documentos [ds_document].

Tabela 2. Parâmetros

Nome	Tipo	Descrição
documento	DocumentoDoSistema	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 3. Retorna

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. < propriedadeSystemDocument que requer entrada sys_id> com SysId: "<sys_id> " não existe 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. Tipo de dados: cadeia de caracteres

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)

Remove um registro de documento da tabela Documentos [ds_document].

Tabela 4. Parâmetros

Nome	Tipo	Descrição
docSysId	Cadeia de caracteres	Sys_id de um registro de documento na tabela Documentos [ds_document].

Tabela 5. Retorna

Tipo	Descrição
Objeto	Mensagem de sucesso ou erro { "message": "String", "request_id": "String", "status": "String" }
<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. Tipo de dados: cadeia de caracteres

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)

Atualiza os valores de campo de um registro de documento existente.

Tabela 6. Parâmetros

Nome	Tipo	Descrição
docSysId	Cadeia de caracteres	Sys_id de um registro de documento na tabela Documentos [ds_document].
documento	DocumentoDoSistema	Uma ou mais propriedades que representam os campos do documento a serem atualizados.

Tabela 7. Retorna

Tipo	Descrição
Objeto	Mensagem de sucesso ou erro { "message": "String", "request_id": "String", "status": "String" }
<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. Tipo de dados: cadeia de caracteres

O exemplo a seguir mostra como alterar o nome de um documento. Consulte também SystemDocument.

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