DocumentListEntryService - com escopo, global

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 3 min. de leitura

    • A API DocumentListEntryService fornece métodos para manter modelos de documento em 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.

    Antes de usar os métodos nesta API, adicione um modelo de documento com sua versão e crie uma lista de documentos. Use a API SystemDocumentListEntry para adicionar ou remover documentos de uma lista de documentos.

    Antes de usar os métodos nesta API, você deve adicionar um documento com sua versão padrão e criar uma lista de 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].

    DocumentListEntryService — DocumentListEntryService()

    Instancia um objeto DocumentListEntryService.

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

    O exemplo a seguir mostra como instanciar um objeto DocumentListEntryService.

    var s = new sn_doc_services.DocumentListEntryService();

    DocumentListEntryService - createDocumentListEntry (entrada SystemDocumentListEntry)

    Adiciona uma entrada de modelo de documento a uma lista de documentos.

    Tabela 2. Parâmetros
    Nome Tipo Descrição
    entrada SystemDocumentListEntry Uma ou mais propriedades que representam campos de um objeto de entrada de lista de documentos.
    Tabela 3. Retornos
    Tipo Descrição
    Objeto Sys_id do novo registro na tabela Entradas da lista de documentos [ds_document_list_entry] 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.

    Tipo de dados: cadeia de caracteres
    <Object>.request_id Sys_id do registro na tabela Entradas da lista de documentos [ds_document_list_entry].

    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 definir uma entrada de documento e adicioná-la a uma lista de documentos. Consulte também SystemDocumentListEntry.

    var docListEntry = new sn_doc_services.SystemDocumentListEntry('21afddea2460fc10f877a6fed1c2b0dd');
docListEntry.document("9acd7fea24587410f877a6fed1c2b060");
docListEntry.description('birth certificate');

var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
gs.info(JSON.stringify(dlEntrySvc.createDocumentListEntry(docListEntry), null, 2));
    Saída:
    {
  "message": "Create List Entry , List Entry sysId : d3f0b13624e8fc10f877a6fed1c2b0d9is successful.",
  "request_id": "d3f0b13624e8fc10f877a6fed1c2b0d9",
  "status": "success"
}

    DocumentListEntryService – deleteDocumentListEntry(cadeia de caracteres listEntryId)

    Remove uma entrada de lista de documentos da tabela Entradas de lista de documentos [ds_document_list_entry].

    Tabela 4. Parâmetros
    Nome Tipo Descrição
    IdEntradaEntrada Cadeia de caracteres Sys_id de um registro de lista de documentos na tabela Entradas de lista de documentos [ds_document_list_entry].
    Tabela 5. Retornos
    Tipo Descrição
    Objeto Mensagem de sucesso ou erro 
    {
  "message": "String",
  "status": "String"
}
    <Object>.mensagem Mensagem confirmando sucesso ou erro.

    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 listEntryId = 'd3f0b13624e8fc10f877a6fed1c2b0d9';

var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
gs.info(JSON.stringify(dlEntrySvc.deleteDocumentListEntry(listEntryId), null, 2));
    Saída:
    {
  "message": "Deleting an entry for the given documentListEntrySysId : d3f0b13624e8fc10f877a6fed1c2b0d9 is successful.",
  "status": "success"
}

    DocumentListEntryService - updateDocumentListEntry(cadeia de caracteres listEntryId, entrada SystemDocumentListEntry)

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

    Tabela 6. Parâmetros
    Nome Tipo Descrição
    IdEntradaEntrada Cadeia de caracteres Sys_id de um registro de lista de documentos na tabela Entradas de lista de documentos [ds_document_list_entry].
    entrada SystemDocumentListEntry Uma ou mais propriedades que representam campos de um objeto de entrada de lista de documentos.
    Tabela 7. Retornos
    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 Entradas da lista de documentos [ds_document_list_entry].

    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 uma descrição de entrada da lista de documentos. Consulte também SystemDocumentListEntry.

    var listEntryId = 'd3f0b13624e8fc10f877a6fed1c2b0d9';

var entry = new sn_doc_services.SystemDocumentListEntry();
entry.description('description update');

var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
gs.info(JSON.stringify(dlEntrySvc.updateDocumentListEntry(listEntryId, entry), null, 2));
    Saída:
    {
  "message": "Updating an entry for the given documentListEntrySysId : d3f0b13624e8fc10f877a6fed1c2b0d9 is successful.",
  "request_id": "d3f0b13624e8fc10f877a6fed1c2b0d9",
  "status": "success"
}