DocumentListService - escopo, global

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 5 min. de leitura

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

    Esta API requer Gestão de documentos plug-in (com.snc.platform_document_management) e é fornecido em sn_doc_services namespace. Para obter informações, consulte Serviços de documentos .

    . Gestão de documentos o plug-in também oferece suporte à criação de listas de modelos de documento para associar ao seu documento. Por exemplo, uma candidatura de trabalho que requer vários documentos, como diploma, documento de identidade 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 que define SystemDocument – template() método como verdadeiro. Crie ou atualize o registro do documento com os métodos em DocumentService API.
    • 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 que define SystemDocument – template() método como verdadeiro. Crie ou atualize o registro do documento com os métodos em DocumentService API.
    • Marque a caixa de seleção Modelo de um documento na tabela Documentos [ds_document].

    Consulte também SystemDocumentList .

    DocumentListService - DocumentListService()

    Instancia um DocumentListService objeto.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum(a)

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

    var s = new sn_doc_services.DocumentListService();

    DocumentListService - createDocumentList (documento SystemDocumentList)

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

    . Gestão de documentos o plug-in também oferece suporte à criação de listas de modelos de documento para associar ao seu documento. Por exemplo, uma candidatura de trabalho que requer vários documentos, como diploma, documento de identidade ou passaporte. Depois de adicionar sua lista de documentos, você pode adicionar modelos de documento:

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

    Tabela 2. Parâmetros
    Nome Tipo Descrição
    documento SystemDocumentList Uma ou mais propriedades que representam campos de um novo registro. A propriedade do nome é necessária e pode ser definida usando SystemDocumentList construtor ou nome() método.
    Tabela 3. Retornos
    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. . messagefornece 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 - createDocumentDocumentsFromList(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 CreateDocumentList() método.
    Tabela 4. Parâmetros
    Nome Tipo Descrição
    ListSySID 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 no qual adiciona 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 adicionar uma lista de referências de modelo de documento.
    Tabela 5. Retornos
    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. . messagefornece 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 6. Parâmetros
    Nome Tipo Descrição
    ListSySID Cadeia de caracteres Sys_id de um registro de lista de documentos na tabela Listas de documentos [ds_document_lists].
    Tabela 7. Retornos
    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. . messagefornece 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 - updateDocumentList(cadeia de caracteres docSysId, documento SystemDocumentList)

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

    Tabela 8. Parâmetros
    Nome Tipo Descrição
    ListSySID 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. Retornos
    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. . messagefornece 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"
}