DocumentReferenceService - com escopo, global

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.

As seguintes APIs permitem definir e gerenciar documentos:

• SystemDocument — Defina um objeto de documento.
• DocumentService : adicione, atualize ou exclua um documento.

DocumentReferenceService - DocumentReferenceService()

Instancia um objeto DocumentReferenceService.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
Nenhum(a)

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)

Adiciona uma referência de documento a um registro de tabela de destino.

Tabela 2. Parâmetros

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 3. Retornos

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" }
<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. Tipo de dados: cadeia de caracteres

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)

Remove uma referência de documento da tabela Referências de documento [ds_document_reference].

Tabela 4. Parâmetros

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 5. Retornos

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

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