ワークフローエンドポイント

file (ファイル): 必須です。システムにアップロードする実際のファイルを選択します。メディアタイプはYXZPファイルである必要があります。

name (文字列): 必須です。ワークフロー名を入力します。Server UIに表示するワークフローの名前です。

ownerId (文字列): 必須です。所有者の名前を入力します。

workerTag (文字列): オプションです。ワーカーで定義されたワーカータグを指定して、特定のワーカーノードにジョブを割り当てる際に役立てることができます。詳細については、ワーカーのヘルプページを参照してください。

districtTags (文字列): オプションです。JSON形式の配列(例: ["id1", "id2"])で送信します。ディストリクトを使用すると、共有されたパブリックワークフローをタグでグループ化し、ユーザーが簡単に見つけられるようにすることができます。詳細については、「ディストリクト」ヘルプページを参照してください。

comments (文字列): オプションです。コメントを入力します。

isPublic (ブール型): 必須です。ワークフローを公開する場合は、「true」を選択します。ワークフローを非公開にして利用できないようにする場合は、「false」を選択します。

isReadyForMigration (ブール型): 必須です。このワークフローを移行対象にするか否かを選択します。あるServer環境から別のServer環境への移行の詳細については、「ワークフローを移行できるようにする」ヘルプページを参照してください。

sourceAppId (文字列): オプションです。ワークフローのソースアプリケーション ID を設定します。POST admin/v1/workflowsエンドポイントの「sourceId」リファレンスとして使用できます。既存のsourceAppIdを指定すると、リクエストが無効になります。

othersMayDownload (ブール型): 必須です。他のユーザーによるこのワークフローのダウンロードを可能にするか否かを指定します。

othersCanExecute (ブール型): 必須です。他のユーザーによるこのワークフローの実行を可能にするか否かを指定します。

executionMode (文字列): 必須です。使用可能な値は「Safe」、「SemiSafe」、「Standard」です。実行モードの詳細については、「セーフモードおよび準セーフ実行モード: ブロックされるツール、イベント、データコネクタ」ヘルプページを参照してください。

hasPrivateDataExemption (ブール型): オプションです。プライベートデータを含むワークフローを実行できるように、適用除外を設定します。適用除外を許可する場合は「true」、適用除外を許可しない場合は「false」を選択します。詳細については、管理者のワークフローオプションページを参照してください。

workflowCredentialType (文字列): 必須です。使用できる値は、「Default」(既定)、「Required」(必須)、「Specific」(指定)です。

credentialId (文字列): オプションです。このワークフローのcredentialIdを指定します。

collectionIds (文字列): オプションです。このワークフローを追加するcollectionIdを入力します。JSON形式の配列(例: ["id1", "id2"])で送信します。

workflowId (文字列): 必須です。新しいバージョンをアップロードするワークフローIDを入力します。

file (ファイル): 必須です。新しいバージョンとしてシステムにアップロードする実際のファイルを選択します。メディアタイプはYXZPファイルである必要があります。

name (文字列): 必須です。ワークフロー名を入力します。Server UIに表示するワークフローの名前です。

ownerId (文字列): 必須です。所有者の名前を入力します。

othersMayDownload (ブール型): 必須です。既定は「true」に設定されています。

othersCanExecute (ブール型): 必須です。既定は「true」に設定されています。

executionMode (文字列): 必須です。使用可能な値は「Safe」、「SemiSafe」、「Standard」です。実行モードの詳細については、「セーフモードおよび準セーフ実行モード: ブロックされるツール、イベント、データコネクタ」ヘルプページを参照してください。

hasPrivateDataExemption (ブール型): オプションです。プライベートデータを含むワークフローを実行できるように、適用除外を設定します。適用除外を許可する場合は「true」、適用除外を許可しない場合は「false」を選択します。詳細については、管理者のワークフローオプションページを参照してください。

comments (文字列): オプションです。コメントを入力します。

makePublished (ブール型): 必須です。既定は「true」に設定されています。makePublishedパラメーターは、Serverにプッシュするワークフローの新しいバージョンを公開バージョンとするか否かを制御するためのものです。ワークフローをServerにプッシュする際に値を「false」に設定することで、自分だけが実行することができるようになります。

workflowCredentialType (文字列): 必須です。このワークフローに使用する資格情報タイプを入力します。使用できる値は、「Default」(既定)、「Required」(必須)、「Specific」(指定)です。

credentialId (文字列): オプションです。このワークフローのcredentialIdを指定します。資格情報エンドポイントの詳細については、資格情報エンドポイントを参照してください。

view (文字列): オプションです。ワークフロー情報の表示方法を選択します。値を指定しないこともできます。値は「Default」(既定)と「Full」(完全)から選択できます。このパラメーターを「Default」(既定)に設定すると、縮小表示オブジェクトが返されます。指定しない場合は、「Default」(既定)の値が使用されます。

name (文字列): オプションです。ワークフローを名前でフィルタリングする場合に備えて、ワークフローの名前を入力します。Server UIに表示するワークフローの名前です。

ownerId (文字列): オプションです。ワークフローを所有者でフィルタリングする場合に備えて、所有者のIDを入力します。

createdAfter (文字列): オプションです。ワークフローが作成された後の日付と時刻を入力します。日付と時刻を ISO8601形式 で入力します。

createdBefore (文字列): オプションです。ワークフローが作成される前の日付と時刻を入力します。日付と時刻を ISO8601形式 で入力します。

workflowId (文字列): 必須です。このワークフローに関する情報を取得するには、ワークフローIDを入力します。

workflowId (文字列): 必須です。更新するワークフローのIDを入力します。

updateWorkflowContract (本文): 必須です。更新するワークフロー情報を入力します。

updateWorkflowContractの値の例:

{
  "name": "string",
  "versionId": "string",
  "makePublished": true,
  "ownerId": "string",
  "workerTag": "string",
  "districtTags": [
    "string"
  ],
  "comments": "string",
  "isPublic": true,
  "isReadyForMigration": true,
  "othersMayDownload": true,
  "othersCanExecute": true,
  "executionMode": "Safe",
  "hasPrivateDataExemption": true,
  "workflowCredentialType": "Default",
  "credentialId": "string"
}

workflowId (文字列): 必須です。パッケージをダウンロードするワークフローIDを入力します。

versionId (文字列): オプションです。ワークフローの特定のバージョンIDを入力します。バージョンを指定しない場合は、公開されたバージョンがダウンロードされます。

workflowId (文字列): 必須です。情報を取得するワークフローIDを入力します。

versionId (文字列): オプションです。ワークフローの特定のバージョンIDを入力します。バージョンを指定しない場合は、公開されたバージョンが使用されます。

workflowId (文字列): 必須です。情報を取得するワークフローIDを入力します。

sortField (文字列): オプションです。結果を並べ替えるためのフィールド名を入力します。

direction (文字列): オプションです。ここで並べ替え順を指定します。使用可能な値は「asc」(昇順)と「desc」(降順)です。並べ替えを指定しない場合、既定で昇順になります。

offset (文字列): オプションです。結果に表示する最初のレコードを指します。

limit (文字列): オプションです。結果に表示する最後のレコードを指します。

status (文字列): オプションです。ジョブの実行の全体的なステータスです。完了したジョブでも、失敗している可能性があります。使用可能な値は、「Complete」(完了)、「Error」(エラー）、「Running」(実行中)、「Queued」(順番待ち)です。

resultCode (文字列): オプションです。ワークフローの実行の結果コードです。これは、ワークフローは失敗したものの、ジョブは成功したことを示します。指定できる値は、「Success」(成功)、「Warning」(警告)、「Error」(エラー)です。

workflowId (文字列): 必須です。削除するワークフローIDを入力します。

force (ブール型): オプションです。選択しない場合は、既定値が「false」になります。ワークフローがスケジュールされている場合、パラメーターを「true」に設定すると、ワークフローを削除する前にすべてのスケジュールが削除されます。