Skip to main content

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

ワークフローのエンドポイントとパラメーター

オブジェクト関係に関する詳細とAPIでの使用方法については、 オブジェクト関係 のセクションを参照してください。

ワークフローの詳細については、「 ワークフロー 」に関するヘルプページを参照してください。

新しいワークフローをアップロードする

新しいワークフローをアップロードするには、 POST {baseURL}/v3/workflows エンドポイントを使用します。

パラメーター

  • 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」を選択します。詳細については、「 Admin (管理者)のワークフローオプション 」ページを参照してください。

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

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

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

既存ワークフローに新しいバージョンをアップロードする

既存のワークフローに新しいバージョンをアップロードするには、 POST {baseURL}/v3/workflows/{workflowId}/versions エンドポイントを使用します。

パラメーター

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

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

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

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

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

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

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

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

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

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

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

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

すべてのワークフローを取得する

すべてのワークフローレコードに関する情報を取得するには、 GET {baseURL}/v3/workflows/ エンドポイントを使用します。

パラメーター

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

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

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

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

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

リクエストの例: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'

特定のワークフローレコードを取得する

特定のワークフローに関する情報を取得するには、 GET {baseURL}/v3/workflows/{workflowId} エンドポイントを使用します。

パラメーター

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

リクエストの例: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

既存のワークフローを更新する

既存のワークフローに関する情報を変更するには、  PUT {baseURL}/v3/workflows/{workflowId} endpointを使用します。

注記

ownerIdを変更するには、新しい所有者が現在の所有者と同じサブスクリプションにある必要があります。

パラメーター

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

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

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

  • versionId (文字列): 必須です。バージョンIDを入力します。

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

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

  • workerTag (文字列): 必須です。workerTagがない場合、代わりに""を使用します。

  • districtTags (文字列): 必須です。ディストリクトタグを入力します。ディストリクトを使用すると、共有されたパブリックワークフローをタグでグループ化し、ユーザーが簡単に見つけられるようにすることができます。詳細については、「 ディストリクト 」ヘルプページを参照してください。

  • comments (文字列): 必須です。コメントを入力します。

  • isPublic (ブール型): オプションです。指定しない場合、それまでと同じ値が使用されます。

  • isReadyForMigration (ブール型): オプションです。指定しない場合、それまでと同じ値が使用されます。

  • othersMayDownload (ブール型): オプションです。指定しない場合、それまでと同じ値が使用されます。パブリックワークフローに「false」を設定すると、ワークフローは使用できなくなります。

  • othersCanExecute (ブール型): オプションです。指定しない場合、それまでと同じ値が使用されます。パブリックワークフローに「false」を設定すると、ワークフローは使用できなくなります。

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

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

ワークフローパッケージをダウンロードする

ワークフローパッケージをダウンロードするには、 GET {baseURL}/v3/workflows/{workflowId}/package エンドポイントを使用します。

パラメーター

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

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

    注記

    versionIDが2桁の場合、サイズ制限に達し、「414 - URI Too Long」というエラーが表示される可能性があります。この場合、JSONのversionID文字列を解析して、最新バージョンのみにトリミングしてください。これにより、フィールドの長さが制御されます。

リクエストの例: cURL

curl -X GET --header 'Accept: application/octet-stream' --header 'Authorization: Bearer BearerTokenGoesHere' 'http://localhost/webapi/v3/workflows/635a4be7dc6e24bb8ff0/package'

ワークフローの質問情報を取得する

ワークフローの質問情報を取得するには、  GET {baseURL}/v3/workflows/{workflowId}/questions エンドポイントを使用します。

パラメーター

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

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

リクエストの例: cURL

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer BearerTokenGoesHere' 'http://localhost/webapi/v3/workflows/635a4bc6e24b78d0b8ff0/questions'

特定のワークフローのジョブに関する情報を取得する

特定のワークフローのジョブに関する情報を取得するには、  GET {baseURL}/v3/workflows/{workflowId}/jobs  エンドポイントを使用します。

パラメーター

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

  • sortField (文字列): オプションです。

  • direction (文字列): オプションです。

  • offset (文字列): オプションです。

  • limit (文字列): オプションです。

リクエストの例: cURL

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer BearerTokenGoesHere' 'http://localhost/webapi/v3/workflows/635a4be6e24b78d0b8ff0/jobs'

ワークフローを削除する

特定のワークフローを削除するには、 DELETE {baseURL}/v3/workflows/{workflowId} エンドポイントを使用します。

パラメーター

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

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

リクエストの例: cURL

curl -X DELETE --header 'Accept: application/json' --header 'Authorization: Bearer BearerTokenGoesHere' 'http://localhost/webapi/v3/workflows/635a752fdc6e278d0ba40b'

新しいジョブを作成する

新しいジョブを作成してキューに追加するには、 POST/v3/workflows/{workflowId}/jobs エンドポイントを使用します。

パラメーター

  • workflowId (文字列): 必須です。スケジュールするワークフローIDを入力します。

  • contract (本文): 新しいジョブを作成するには、次のパラメーターを指定します。

    • workerTag (文字列): オプションです。割り当てられたワーカーを指定します。指定しない場合、値は「none」になります。

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

    • questions (文字列): オプションです。分析アプリの場合は、質問と回答を指定してワークフローを実行します。

    • priority (文字列): オプションです。実行するスケジュールの優先度を指定します。「Low」(低)、「Medium」(中)、「High」(高)、「Critical」(重大)のいずれかのオプションを選択します。指定しない場合、既定値は「Low」になります。

リクエストの例: cURL

ジョブを作成するリクエストの例:

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: Bearer BearerTokenGoesHere' -d '{ \ "workerTag": "", \ "credentialId": "", \ "questions": [], \ "priority": "Low" \ }' 'http://localhost/webapi/v3/workflows/651faa8bde3e5381fd0dac29/jobs'{ "workerTag": "tag1",  "credentialId": "652e6f90ea174cd34f6779d2", "questions": [  {   "name": "Drop_Down",   "value": "true"  } ], "priority": "Low"}

Transfer Workflows and Schedules to a Specified Owner

To transfer a specific workflow to a specific owner, together with schedules if desired, use the PUT {baseURL}/v3/workflows/{workflowId}/transfer endpoint.

注記

  • Only Curators can use this API endpoint.

  • If any of the workflows require DCM connections, Server connections, or specific run as credentials to run, these items need to be updated before the workflow can run.

  • If users are not in the same studio and when a workflow is transferred to the new studio, all other users in the new owner's studio will also receive access to the workflow, and all users from the old studio will lose access.

  • Workflows can only be transferred to a user with the Artisan or Curator role.

  • If transferring schedules, the new owner must have access to the scheduled workflow, otherwise you won’t be able to transfer that workflow to the new owner.

  • If transferring schedules, the new owner must have permission to schedule workflows.

  • If the user is deleted, it returns a list of schedule Ids that will be broken or disabled after transfer.

Parameters

  • workflowId (string): Required. Specify the Id of the workflow to transfer.

  • contract (body): Required. Specify the following information:

    • ownerId (string): Specify the Id of the new owner.

    • transferSchedules (Boolean): Specify whether the schedules should be transferred to a new owner together with the workflow. Only the schedules owned by the current workflow owner will be transferred to the new owner.

Request Example: cURL

curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ "ownerId": "63d17f6cb049da66d0afd4e2", \ "transferSchedules": true \ }' 'http://localhost/webapi/v3/workflows/7917969784f84bd09442f66996ecb8f3/transfer'

オブジェクト関係

ワークフローをアップロードする場合、作成したオブジェクトを次のように使用することができます。

作成されたオブジェクト: " workflowId " (例えば、"id": "7917969784f84bd09442f66996ecb8f3")

次のように使用できます。

Postmanリクエストの例

GET /v3/workflows/{workflowId}

Use GET /v3/workflows/{workflowId} endpoint.

Postmanリクエストの詳細については、「 Postmanの使用方法 」ヘルプページを参照してください。

このセクションの内容: