Unterstützte API-Aufrufe

In diesem Abschnitt werden Connect API-Aufrufe beschrieben.
    Hinweis:
  • Verwenden Sie die Proxys loginConnect und logoutConnect für alle Connect API-Aufrufe.
  • Einige Job.get-Aufrufe geben zu jedem Job einen Eintrag zurück. Wenn eine große Menge von Daten zurückgegeben werden muss, kann dies den Ausfall eines großen Systems verursachen. Um die unnötige Rückgabe umfangreicher Ergebnisse zu vermeiden, verwenden Sie Auswahlkriterien, um nur die benötigten Jobs und deren erforderliche Attribute zu extrahieren. Eine solche Filterung ist effizienter, da sie auf dem Server ausgeführt wird.

In this section:

  1. Job.create(string workflow {srcfile : spoolfile, ...})
    Dieser Aufruf erstellt einen neuen Job und gibt die zugehörige Job-ID zurück. Zusätzlich kopiert dieser Aufruf die Quelldateien in das Spoolverzeichnis und vergibt für diese Spooldateinamen. Verwenden Sie diesen Aufruf zusammen mit dem Aufruf Job.changeFirstState (jobID, None, “Creating”, string workflow), um einen neuen Job zu erstellen und diesen den richtigen Workflow durchlaufen zu lassen.
  2. Job.changeFirstState (jobID, None, “Creating”, string workflow)
    Dieser Aufruf startet den Job zum festgelegten Workflow. Zusätzlich kopiert dieser Aufruf die Quelldateien in das Spoolverzeichnis und vergibt für diese Spooldateinamen. Er unterstützt einen Job, der mit dem Aufruf Job.create(string workflow {srcfile : spoolfile, ...}) erstellt wurde, den richtigen Workflow zu durchlaufen.
  3. Job.get(string jobID)
    Verwenden Sie diesen Aufruf zum Anzeigen aller Jobattribute des angegebenen Jobs.
  4. Job.get([jobAttr,...], string selectionCriteria)
    Verwenden Sie diesen Aufruf, um die angegebenen Attribute für die Jobs anzuzeigen, die den Auswahlkriterien entsprechen.
  5. Job.getMessages(string jobId, "Job")
    Verwenden Sie diesen Aufruf zum Anzeigen aller mit dem angegebenen Job verbundenen Nachrichten.
  6. Document.get(string docID)
    Verwenden Sie diesen Aufruf zum Anzeigen aller Dokumentattribute des angegebenen Dokuments.
  7. Document.get([], string selectionCriteria, int skip, int maxCount)
    Verwenden Sie diesen Aufruf, um die zentralen Attribute der Dokumente anzuzeigen, die den Auswahlkriterien entsprechen.
  8. Document.get(None, string selectionCriteria, int skip, int maxCount)
    Mit diesem Aufruf können Sie alle Attribute der Dokumente sehen, die den Auswahlkriterien entsprechen. ;
  9. Document.getCurrentJob([ ], string docID)
    Verwenden Sie diesen Aufruf, um die Attribute des angegebenen Dokuments und die Jobattribute des Jobs anzuzeigen, mit dem das Dokument verbunden ist.
  10. Document.getDocumentCount(string selectionCriteria)
    Verwenden Sie diesen Aufruf, um die Anzahl der Dokumente anzuzeigen, die den Auswahlkriterien entsprechen.

Related information:

Fernzugriff – Grundlagen
Übergeordnetes Thema: Verwendung von API-Aufrufen per Fernzugriff