Appels d'API pris en charge

Cette section décrit les appels de l'API Connect.
    Remarque:
  • Utilisez les proxy loginConnect et logoutConnect pour tous les appels de l'API Connect.
  • Certains appels Job.get renvoient une entrée pour chaque travail. La nécessité de renvoyer une grande quantité de données peut provoquer des défaillances pour les grands systèmes. Pour éviter de renvoyer des résultats inutilement volumineux, utilisez les critères de sélection afin de n'extraire que les travaux nécessaires et leurs attributs associés. Ce filtrage est plus efficace parce qu'il est effectué sur le serveur.

In this section:

  1. Job.create(string workflow {srcfile : spoolfile, ...})
    Cet appel crée un nouveau travail et renvoie son ID. En outre, cet appel copie les fichiers source dans le répertoire de spool et leur attribue les noms de répertoire spool. Utilisez cet appel en combinaison avec l'appel Job.changeFirstState (jobID, None, “Creating”, string workflow) pour créer un nouveau travail et le déplacer dans un flot de travaux correct.
  2. Job.changeFirstState (jobID, None, “Creating”, string workflow)
    Cet appel lance le travail sur le flot de travaux spécifié. En outre, cet appel copie les fichiers source dans le répertoire de spool et leur attribue les noms de répertoire spool. Sa fonction est d'aider à déplacer un travail créé avec l'appel Job.create(string workflow {srcfile : spoolfile, ...}) en utilisant le bon flot de travaux.
  3. Job.get(string jobID)
    Utilisez cet appel pour voir tous les attributs du travail spécifié.
  4. Job.get([jobAttr,...], string selectionCriteria)
    Utilisez cet appel pour voir les attributs spécifiés pour les travaux correspondant aux critères de sélection.
  5. Job.getMessages(string jobId, “Job”)
    Utilisez cet appel pour voir tous les messages associés au travail spécifié.
  6. Document.get(string docID)
    Utilisez cet appel pour voir tous les attributs du document spécifié.
  7. Document.get([], string selectionCriteria, int skip, int maxCount)
    Utilisez cet appel pour voir les principaux attributs des documents correspondant aux critères de sélection.
  8. Document.get(None, string selectionCriteria, int skip, int maxCount)
    Utilisez cet appel pour voir tous les attributs des documents correspondant aux critères de sélection.
  9. Document.getCurrentJob([ ], string docID)
    Utilisez cet appel pour voir les attributs du document spécifié et les attributs du travail auquel est associé le document.
  10. Document.getDocumentCount(string selectionCriteria)
    Utilisez cet appel pour voir le nombre de documents correspondant aux critères de sélection.

Related information:

Informations de base sur l'accès à distance
Rubrique parente : Utilisation des appels d'API via l'accès à distance