サポートされるAPI呼び出し

このセクションでは、Connect API呼び出しについて説明します。
    注意:
  • すべてのConnect API呼び出しで、loginConnectおよびlogoutConnectプロキシを使用します。
  • 一部のJob.get呼び出しは、各ジョブのエントリーを返します。大量のデータを返す呼び出しを実行すると、大規模なシステムで失敗することがあります。不必要に大量の結果を返さないようにするために、選択条件を使用して、必要なジョブおよびそれらに必要な属性のみを抽出するようにしてください。このフィルター処理はサーバーで実行されるため効果的です。

In this section:

  1. Job.create(string workflow {srcfile : spoolfile, ...})
    この呼び出しは、新しいジョブを作成し、作成したジョブのジョブ ID を返します。また、この呼び出しは、ソースファイルをスプールディレクトリーにコピーし、それにスプールファイル名を付けます。この呼び出しは、Job.changeFirstState (jobID, None, “Creating”, string workflow) 呼び出しと組み合わせて、新しいジョブを作成し、正しいワークフロー内で動かすのに使用されます。
  2. Job.changeFirstState (jobID, None, “Creating”, string workflow)
    この呼び出しは、指定したワークフローのジョブを開始させます。また、この呼び出しは、ソースファイルをスプールディレクトリーにコピーし、それにスプールファイル名を付けます。正しいワークフロー内で Job.create(string workflow {srcfile : spoolfile, ...}) 呼び出しを使用して作成されたジョブを移動するときに使用できます。
  3. Job.get(string jobID)
    この呼び出しを使用して、指定されたジョブのすべてのジョブ属性を確認できます。
  4. Job.get([jobAttr,...], string selectionCriteria)
    この呼び出しを使用して、選択条件と一致するジョブの指定された属性を確認できます。
  5. Job.getMessages(string jobId, “Job”)
    この呼び出しを使用して、特性のジョブに関連付けられているすべてのメッセージを確認できます。
  6. Document.get(string docID)
    この呼び出しを使用して、指定した文書のすべての文書属性を確認できます。
  7. Document.get([], string selectionCriteria, int skip, int maxCount)
    この呼び出しを使用して、選択条件と一致する文書のコア属性を確認できます。
  8. Document.get(None, string selectionCriteria, int skip, int maxCount)
    この呼び出しを使用して、選択条件と一致する文書のすべての属性を確認できます。
  9. Document.getCurrentJob([ ], string docID)
    この呼び出しを使用して、指定した文書の属性と、その文書が関連付けられているジョブのジョブ属性を確認できます。
  10. Document.getDocumentCount(string selectionCriteria)
    この呼び出しを使用して、選択条件と一致する文書の数を確認できます。

Related information:

リモートアクセスの基本
上位層のトピック： リモートアクセス経由で API 呼び出しを使用する