Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
Embedded API
リソース

フォルダ ​

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

次のエンドポイントを使用して、顧客ワークスペース内のフォルダとプロジェクト（トップレベルフォルダ）を管理します。

エンドポイントアクセス

これらのエンドポイントにアクセスするには、APIクライアントに適切な権限が必要です。 これは、APIクライアントに割り当てられたロールによって決まります。

エンドポイントアクセスを有効にするには:

既存のAPIクライアントロールを編集するか、新しいAPIクライアントロールを作成して、これらのエンドポイントへのアクセスを有効化できます:

1

ワークスペース管理者 > APIクライアント > クライアントロールに移動します。

編集するロールを選択します。

または、+ クライアントロールを追加をクリックして新しいAPIクライアントロールを作成します。

2

顧客ワークスペース > プロジェクト > プロジェクトアセット > プロジェクトとフォルダに移動します。

3

このロールで有効化するエンドポイントの横にあるチェックボックスを選択します。 次のオプションを使用できます。

  • プロジェクトとフォルダ
    • このロールのすべてのエンドポイントを有効化するには、このオプションを選択します。
  • フォルダの一覧表示 GET /api/managed_users/:managed_user_id/folders
  • プロジェクトの一覧表示 GET /api/managed_users/:managed_user_id/projects
  • フォルダの作成 POST /api/managed_users/:managed_user_id/folders
  • フォルダの削除 DELETE /api/managed_users/:managed_user_id/folders
    /:folder_id
  • フォルダの更新 PUT /api/managed_users/:managed_user_id/folders
    /:folder_id
  • プロジェクトの削除 DELETE /api/managed_users/:managed_user_id/projects
    /:project_id
  • プロジェクトの更新 PUT /api/managed_users/:managed_user_id/projects
    /:project_id

有効にする予定のエンドポイントを選択有効にする予定のエンドポイントを選択

レート制限 ​

フォルダリソースには、次のレート制限があります:

タイプリソース制限
すべてすべてのフォルダエンドポイント1分あたり60リクエスト

クイックリファレンス ​

タイプリソース説明
GET/api/managed_users/:managed_user_id/folders顧客ワークスペース内のフォルダを一覧表示します。
POST/api/managed_users/:managed_user_id/folders顧客ワークスペース内にフォルダを作成します。
PUT/api/managed_users/:managed_user_id/folders/:folder_id顧客ワークスペース内のフォルダを更新します。
DELETE/api/managed_users/:managed_user_id/folders/:folder_id顧客ワークスペース内のフォルダを削除します。

フォルダをリスト ​

顧客ワークスペース内のすべてのフォルダを一覧表示します。

shell
GET /api/managed_users/:managed_user_id/folders

URLパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客ID/外部ID。
外部IDにはEのプレフィックスを付ける必要があり（例: EA2300）、結果のIDはURLエンコードする必要があります。

クエリパラメーター ​

名前タイプ説明
parent_idstring
任意		親フォルダID。 デフォルトはホームフォルダです。
pageinteger
optional		ページ番号。 デフォルトは1です。
per_pageinteger
optional		ページサイズ。 デフォルトは100です。 最大値は100です。
with_nested_foldersboolean
optional		falseの場合、ルート配下のすべての直下の子フォルダを返し、ルートは除外します。 デフォルトはfalseです。
updated_afterstring
任意		指定した日時より後に更新されたフォルダのみを含むように、フォルダのリストをフィルタします。 日時は、次のパターンに従ってISO 8601形式で指定する必要があります: YYYY-MM-DDTHH:MM:SSZ。

サンプルリクエスト ​

shell
curl  -X GET 'https://www.workato.com/api/managed_users/1199/folders?parent_id=12323' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \

レスポンス ​

json
{
    "result": [
        {
            "id": 1789,
            "name": "Netsuite production",
            "parent_id": 12323,
            "created_at": "2020-07-16T10:49:53.337-07:00",
            "updated_at": "2020-07-16T10:49:53.347-07:00"
        }
    ],
    "count": 1,
    "page": 1,
    "per_page": 100
}

フォルダの作成 ​

指定した親フォルダ内に新しいフォルダを作成します。 親フォルダIDを指定しない場合、システムはそのフォルダをホームフォルダ内のトップレベルフォルダとして作成します。

shell
POST /api/managed_users/:managed_user_id/folders

URLパラメータ ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客ID/外部ID。
外部IDにはEのプレフィックスを付ける必要があり（例: EA2300）、結果のIDはURLエンコードする必要があります。

ペイロード ​

名前タイプ説明
namestring
必須		フォルダの名前。
parent_idstring
任意		親フォルダID。 デフォルトはホームフォルダです。

サンプルリクエスト ​

shell
curl  -X POST https://www.workato.com/api/managed_users/1892/folders \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
            "name": "Salesforce folder"
           }'

レスポンス ​

json
{
  "id": 3498583,
}

フォルダの更新 ​

このエンドポイントを使用して、顧客ワークスペース内のフォルダ名を更新するか、別のフォルダに移動します。 フォルダがプロジェクトでない場合は、フォルダの名前を変更し、そのparent_idを更新できます。 フォルダがプロジェクトの場合、このエンドポイントを使用して変更できるのはプロジェクト名のみです。

プロジェクトのリクエストペイロードにおける追加オプションについては、プロジェクトの更新エンドポイントのドキュメントを参照してください。

shell
PUT /api/managed_users/:managed_user_id/folders/:folder_id

フォルダとプロジェクトの変換

このエンドポイントを使用して、フォルダをプロジェクトに変換したり、プロジェクトをフォルダに変換したりすることはできません。

URLパラメータ ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客ID/外部ID。
External IDはURLエンコードし、Eをプレフィックスとして付ける必要があります（例: EA2300）。
folder_idstring
必須		更新するフォルダのID。 フォルダをリストエンドポイントを呼び出すことで、フォルダIDのリストを取得できます。

ペイロード ​

名前タイプ説明
namestring
任意		フォルダの新しい名前。
parent_idstring
任意		フォルダの移動先となる親フォルダのID。

フォルダ名

フォルダ名には/または\文字を含めることはできません。

サンプルリクエスト ​

shell
curl  -X PUT https://www.workato.com/api/managed_users/19029/folders/12345 \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "My updated folder name",
            "parent_id": 67890
          }'

レスポンス ​

成功レスポンス
json
{
    "id": 12345,
    "name": "My updated folder name",
    "parent_id": 67890,
    "created_at": "2024-08-02T13:35:11.691-07:00",
    "updated_at": "2024-08-02T14:26:30.365-07:00"
}
失敗レスポンス

プロジェクトの親フォルダを変更 ​

プロジェクトは最上位フォルダです。 プロジェクトの親フォルダを変更しようとすると、次のエラーが返されます:

json
{
    "message": "Parent can't be changed for project folder"
}

リクエストペイロードで利用可能なオプションについては、プロジェクトの更新エンドポイントのドキュメントを参照してください。

フォルダ名の無効な文字 ​

フォルダ名を更新して/または\文字を含めようとすると、次のエラーが返されます:

json
{
    "message": "Folder name can't contain the folder path"
}

フォルダの削除 ​

顧客ワークスペース内のフォルダを削除します。

フォルダの削除にはレシピとコネクションが含まれます

このアクションは、フォルダとそのすべてのコンテンツ（レシピとコネクション）を削除します。

このエンドポイントを使用するには、APIクライアントロールにフォルダの削除権限が必要です。

shell
DELETE /api/managed_users/:managed_user_id/folders/:folder_id

URLパラメータ ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客ID/外部ID。
External IDはURLエンコードし、Eをプレフィックスとして付ける必要があります（例: EA2300）。
folder_idstring
必須		削除するフォルダのID。 フォルダの一覧表示エンドポイントを呼び出すことで、フォルダIDの一覧を取得できます。

クエリパラメータ ​

名前タイプ説明
forceboolean
optional		空でないフォルダを削除するには、このパラメータをtrueに設定します。 trueの場合、folder_idパラメータを使用して指定したフォルダと、フォルダ内のそのコンテンツ（すべてのレシピとコネクション）が削除されます。 falseに設定した場合、このアクションで削除できるのは空のフォルダのみです。

サンプルリクエスト ​

shell
curl  -X DELETE 'https://www.workato.com/api/managed_users/:managed_user_id/folders/12345?force=true' \
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

成功レスポンス
json
{
    "success": "true"
}
失敗レスポンス

空でないフォルダを削除しようとして、forceパラメータをtrueに設定していない場合、Workatoは指定したフォルダを削除できません。

フォルダにコネクションが含まれている場合、Workatoは次のレスポンスを返します:

json
{
    "message": "can't remove a folder with connections"
}

フォルダにレシピが含まれている場合、Workatoは次のレスポンスを返します:

json
{
    "message": "can't remove a folder with recipe"
}

Last updated: