DocumentListService - com escopo, global

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 5 min. de leitura

    • A API DocumentListService fornece métodos para criar, excluir e atualizar uma lista de documentos.

    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.

    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 aplicação de trabalho que requer vários documentos, como um diploma, ID ou passaporte. Depois de adicionar sua lista de documentos, você pode adicionar modelos de documento:
    Para definir um documento como modelo:
    • Defina o objeto de documento definindo o método SystemDocument – template() como verdadeiro. Crie ou atualize o registro do documento com os métodos na API DocumentService.
    • Marque a caixa de seleção Modelo de um documento na tabela Documentos [ds_document].
    As seguintes APIs permitem definir e gerenciar documentos:
    Para definir um documento como modelo:
    • Defina o objeto de documento definindo o método SystemDocument – template() como verdadeiro. Crie ou atualize o registro do documento com os métodos na API DocumentService.
    • Marque a caixa de seleção Modelo de um documento na tabela Documentos [ds_document].

    Consulte também SystemDocumentList.

    DocumentListService - createDocumentList(SystemDocumentList doc)

    Cria uma lista de documentos na tabela Listas de documentos [ds_document_lists].

    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 aplicação de trabalho que requer vários documentos, como um diploma, ID ou passaporte. Depois de adicionar sua lista de documentos, você pode adicionar modelos de documento:

    Use o método createDocumentsFromList() para criar documentos a partir da lista de modelos de documento.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    documento SystemDocumentList Uma ou mais propriedades que representam campos de um novo registro. A propriedade name é obrigatória e pode ser definida usando o construtor SystemDocumentList ou o método name().
    Tabela 2. Retorna
    Tipo Descrição
    Objeto Sys_id do novo registro na tabela Listas de documentos [ds_document_lists] com uma mensagem de sucesso. Caso contrário, mensagem de erro.
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message Mensagem confirmando sucesso ou erro.

    Tipo de dados: cadeia de caracteres
    <Object>.request_id Sys_id do registro na tabela Listas de documentos [ds_document_lists].

    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 criar uma lista de documentos. Consulte também SystemDocumentList.

    var dL = new sn_doc_services.SystemDocumentList('My document list');

// Define the document list field
dL.description('description');

var docList = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docList.createDocumentList(dL), null, 2));
    Saída:
    {
  "message": "Create List for the given name : My document list, List sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}

    DocumentListService - createDocumentsFromList(cadeia de caracteres listSysId, cadeia de caracteres tableName, cadeia de caracteres tableSysId)

    Cria documentos a partir de uma lista de modelos de documento.

    Nota:
    Antes de usar este método, crie uma lista de modelos de documento usando o método createDocumentList().
    Tabela 3. Parâmetros
    Nome Tipo Descrição
    listaSysId Cadeia de caracteres Sys_id de um registro de lista de documentos na tabela Listas de documentos [ds_document_lists].
    tableName Cadeia de caracteres Nome da tabela que contém o registro ao qual adicionar uma lista de referências de modelo de documento.
    tableSysId Cadeia de caracteres Sys_id do registro que contém o conteúdo do qual uma lista de referências de modelo de documento será adicionada.
    Tabela 4. Retorna
    Tipo Descrição
    Objeto Mensagem de sucesso ou erro 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message

    Mensagem que contém o número de modelos de documento na lista de documentos.

    Tipo de dados: cadeia de caracteres
    <Object>.request_id Sys_id do registro na tabela Listas de documentos [ds_document_lists].

    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 lista de referências de modelo de documento a um registro. A documentação é adicionada a um registro na tabela Incidentes [incidente].

    var result = new sn_doc_services.DocumentListService().createDocumentsFromList('21afddea2460fc10f877a6fed1c2b0dd', 'incident', 'd7158da0c0a8016700eef46c8d1f3661');
gs.info(JSON.stringify(result, null, 2));
    Saída:
    {
  "message": "Created 1 document references for the given table name: incident, table sysId : d7158da0c0a8016700eef46c8d1f3661 with list SysId 21afddea2460fc10f877a6fed1c2b0dd",
  "request_id": "21afddea2460fc10f877a6fed1c2b0dd",
  "status": "success"
}

    DocumentListService - deleteDocumentList(cadeia de caracteres listSysId)

    Remove um registro de documento da tabela Listas de documentos [ds_document_lists].

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    listaSysId Cadeia de caracteres Sys_id de um registro de lista de documentos na tabela Listas de documentos [ds_document_lists].
    Tabela 6. Retorna
    Tipo Descrição
    Objeto Mensagem de sucesso ou erro 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message Mensagem confirmando sucesso ou erro.

    Tipo de dados: cadeia de caracteres
    <Object>.request_id Sys_id do registro na tabela Listas de documentos [ds_document_lists].

    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 lista de documentos. Consulte também SystemDocumentList.

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

var docListSvc = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docListSvc.deleteDocumentList(docListID), null, 2));
    Saída:
    {
  "message": "Delete List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}

    DocumentListService - DocumentListService()

    Instancia um objeto DocumentListService.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como instanciar um objeto DocumentListService. Consulte também SystemDocumentList.

    var s = new sn_doc_services.DocumentListService();

    DocumentListService - updateDocumentList(cadeia de caracteres docSysId, SystemDocumentList doc)

    Atualiza os valores de campo de uma lista de documentos existente.

    Tabela 8. Parâmetros
    Nome Tipo Descrição
    listaSysId Cadeia de caracteres Sys_id de um registro de lista de documentos na tabela Listas de documentos [ds_document_lists].
    documento SystemDocument Uma ou mais propriedades que representam os campos da lista de documentos a serem atualizados.
    Tabela 9. Retorna
    Tipo Descrição
    Objeto Mensagem de sucesso ou erro 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message Mensagem confirmando sucesso ou erro.

    Tipo de dados: cadeia de caracteres
    <Object>.request_id Sys_id do registro na tabela Listas de documentos [ds_document_lists].

    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 atualizar o nome e a descrição de uma lista de documentos. Consulte também SystemDocumentList.

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

var docListUpdate = new sn_doc_services.SystemDocumentList();
docListUpdate.name('name change');
docListUpdate.description('description update');

var docListSvc = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docListSvc.updateDocumentList(docListID , docListUpdate), null, 2));
    Saída:
    {
  "message": "Update List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}