Chamadas da API suportadas

Esta seção descreve as chamadas da API Connect.
    Obs.:
  • Use os proxies loginConnect e logoutConnect com todas as chamadas da API Connect.
  • Algumas chamadas Job.get retornam uma entrada para cada tarefa. O fato de ter de retornar uma grande quantidade de dados pode causar falha em um sistema grande. Para evitar retornar resultados desnecessariamente grandes, use os critérios de seleção para extrair somente as tarefas necessárias e os respectivos atributos necessários. Essa filtragem é mais eficiente porque é feita no servidor.

In this section:

  1. Job.create(string workflow {srcfile : spoolfile, ...})
    Esta chamada cria uma nova tarefa e retorna o ID da tarefa. Além disso, esta chamada copia os arquivos de origem para o diretório de spool e lhes dá nomes de arquivos de spool. Use esta chamada em conjunto com a chamada Job.changeFirstState (jobID, None, “Creating”, string workflow) para criar uma nova tarefa e movê-la pelo fluxo de trabalho correto.
  2. Job.changeFirstState (jobID, None, “Criando”, string workflow)
    Esta chamada inicia o trabalho no fluxo de trabalho especificado. Além disso, esta chamada copia os arquivos de origem para o diretório de spool e lhes dá nomes de arquivos de spool. Ela ajuda a mover uma tarefa criada com a chamada Job.create(string workflow {srcfile : spoolfile, ...}) através do fluxo de trabalho correto.
  3. Job.get(string jobID)
    Use esta chamada para ver todos os atributos da tarefa especificada.
  4. Job.get([jobAttr,...], string selectionCriteria)
    Use esta chamada para ver os atributos especificados das tarefas que correspondem aos critérios de seleção.
  5. Job.getMessages(string jobId, “Tarefa”)
    Use esta chamada para ver todas as mensagens associadas à tarefa especificada.
  6. Document.get(string docID)
    Use esta chamada para ver todos os atributos do documento especificado.
  7. Document.get([], string selectionCriteria, int skip, int maxCount)
    Use esta chamada para ver os principais atributos dos documentos que correspondem aos critérios de seleção.
  8. Document.get(None, string selectionCriteria, int skip, int maxCount)
    Use esta chamada para ver todos os atributos dos documentos que correspondem aos critérios de seleção.
  9. Document.getCurrentJob([ ], string docID)
    Use esta chamada para ver os atributos do documento especificado e os atributos da tarefa à qual o documento está associado.
  10. Document.getDocumentCount(string selectionCriteria)
    Use esta chamada para ver o número de documentos que correspondem aos critérios de seleção.

Related information:

Noções básicas de acesso remoto
Tópico principal: Como usar chamadas de API por acesso remoto