フォルダ

次のエンドポイントを使用して、ワークスペース内のフォルダとプロジェクト（最上位フォルダ）を管理します:

エンドポイントアクセス

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

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

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

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

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

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

プロジェクトを選択し、プロジェクトアセット > プロジェクトとフォルダに移動します。

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

プロジェクトとフォルダ
- このロールのすべてのエンドポイントを有効化するには、このオプションを選択します。
プロジェクトをリスト GET /api/projects
フォルダをリスト GET /api/folders
プロジェクトまたはフォルダを作成 POST /api/folders
フォルダを削除 DELETE /api/folders/:id
フォルダを更新 PUT /api/folders/:id
プロジェクトを削除 DELETE /api/projects/:id
プロジェクトを更新 PUT /api/projects/:id

有効化するエンドポイントを選択

レート制限

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

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

クイックリファレンス

タイプ	リソース	説明
GET	/api/folders	フォルダをリストします。
GET	/api/projects	プロジェクトをリストします。
POST	/api/folders	プロジェクトまたはフォルダを作成します。
PUT	/api/folders/:folder_id	フォルダを更新します。
PUT	/api/projects/:project_id	プロジェクトを更新します。
DELETE	/api/folders/:folder_id	フォルダを削除します。
DELETE	/api/projects/:project_id	プロジェクトを削除します。

フォルダをリスト

すべてのフォルダをリストします。

shell

GET /api/folders

クエリパラメーター

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

サンプルリクエスト

shell

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

レスポンス

json

[
    {
        "id": 7498,
        "name": "Netsuite production",
        "parent_id": 3319,
        "is_project": false,
        "project_id": 4567,
        "created_at": "2020-07-31T03:08:29.486-07:00",
        "updated_at": "2020-07-31T03:08:29.493-07:00"
    },
    {
        "id": 7302,
        "name": "Automation HR",
        "parent_id": 3319,
        "is_project": true,
        "project_id": null,
        "created_at": "2020-07-09T14:37:47.789-07:00",
        "updated_at": "2020-07-09T14:37:47.802-07:00"
    }
]

プロジェクトをリスト

すべてのプロジェクトをリストします。プロジェクトは、通常1つのユースケースを包含する最上位フォルダです。

shell

GET /api/projects

クエリパラメータ

名前	タイプ	説明
page	integer	ページ番号。デフォルトは1です。
per_page	integer	ページサイズ。デフォルトは100（最大は100）です。
updated_after	string 任意	指定した日時より後に更新されたプロジェクトのみを含むように、プロジェクトのリストをフィルタします。日時は、次のパターンに従ってISO 8601形式で指定する必要があります: `YYYY-MM-DDTHH:MM:SSZ`。

サンプルリクエスト

shell

curl  -X GET 'https://www.workato.com/api/projects' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \

レスポンス

json

[
    {
        "id": 649122,
        "description": "Coupa to Netsuite automations",
        "folder_id": 1563029,
        "name": "Procure to Pay"
    },
    {
        "id": 604202,
        "description": "Salesforce to Netsuite automations",
        "folder_id": 1486330,
        "name": "Order to Cash"
    },
]

プロジェクトまたはフォルダを作成

指定した親フォルダ内に新しいフォルダを作成します。親フォルダIDを指定しない場合、システムはホームフォルダ内の最上位フォルダとしてフォルダを作成します。

shell

POST /api/folders

ペイロード

名前	タイプ	説明
name	string 必須	フォルダの名前。
parent_id	string	親フォルダID。デフォルトはホームフォルダです。

サンプルリクエスト

shell

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

レスポンス

json

{
  "id": 3498583,
}

フォルダを更新

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

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

shell

PUT /api/folders/:folder_id

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

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

URLパラメーター

名前	タイプ	説明
folder_id	string 必須	更新するフォルダのID。フォルダをリストエンドポイントを呼び出すことで、フォルダIDのリストを取得できます。

ペイロード

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

フォルダ名

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

サンプルリクエスト

shell

curl  -X PUT https://www.workato.com/api/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"
}

プロジェクトを更新

ワークスペース内のプロジェクトを更新します。プロジェクトは、通常1つのユースケースを包含する最上位フォルダです。このエンドポイントを使用して、プロジェクトの名前と説明を変更します。

shell

PUT /api/projects/:project_id

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

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

URLパラメータ

名前	タイプ	説明
project_id	string 必須	更新するプロジェクトのID。これはプロジェクトの`folder_id`とは異なります。プロジェクトをリストエンドポイントを呼び出して、ワークスペース内のプロジェクトのリストを取得します。

ペイロード

名前	タイプ	説明
name	string 必須	プロジェクトの新しい名前。
説明	string 任意	プロジェクトの新しい説明。

プロジェクト名

プロジェクト名には/または\文字を含めることはできません。

サンプルリクエスト

shell

curl  -X PUT https://www.workato.com/api/projects/54321 \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "My updated project name",
            "description": "My updated project description"
          }'

レスポンス

成功レスポンス

json

{
    "id": 54321,
    "description": "My updated project description",
    "folder_id": 09876,
    "name": "My updated project name"
}

失敗レスポンス

プロジェクト名を更新して/または\文字を含めようとすると、次のエラーが返されます:

json

{
    "message": "Name is invalid"
}

フォルダを削除

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

WARNING

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

このエンドポイントを使用するには、APIクライアントロールに次の権限が必要です:

フォルダを削除 DELETE /api/folders/:id

shell

DELETE /api/folders/:folder_id

URLパラメータ

名前	タイプ	説明
folder_id	string 必須	削除するフォルダのID。フォルダをリストエンドポイントを呼び出すことで、フォルダIDのリストを取得できます。

クエリパラメータ

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

サンプルリクエスト

shell

curl  -X DELETE 'https://www.workato.com/api/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"
}

プロジェクトを削除する

ワークスペース内のプロジェクトを削除します。プロジェクトは、通常1つのユースケースを包含する最上位フォルダです。

WARNING

このアクションは、プロジェクトとそのすべてのコンテンツを削除します。これには、プロジェクト内のすべての子フォルダ、レシピ、コネクション、およびWorkflow appsアセット（該当する場合）が含まれます。

このエンドポイントを使用するには、APIクライアントロールに次の権限が必要です:

プロジェクトを削除 DELETE /api/projects/:id

shell

DELETE /api/projects/:project_id

URLパラメータ

名前	タイプ	説明
project_id	string 必須	削除するプロジェクトのID。プロジェクトをリストエンドポイントを呼び出して、ワークスペース内のすべてのプロジェクトのリストを取得します。

サンプルリクエスト

shell

curl  -X DELETE 'https://www.workato.com/api/projects/54321' \
      -H 'Authorization: Bearer <api_token>'

レスポンス

成功レスポンス

json

{
    "success": "true"
}

失敗レスポンス

プロジェクトを削除しようとして適切な権限がない場合、Workatoは次のレスポンスを返します。

json

{
    "message": "Cannot destroy folder"
}

Last updated:

フォルダ ​

レート制限 ​

クイックリファレンス ​

フォルダをリスト ​

クエリパラメーター ​

サンプルリクエスト ​

レスポンス ​

プロジェクトをリスト ​

クエリパラメータ ​

サンプルリクエスト ​

レスポンス ​

プロジェクトまたはフォルダを作成 ​

ペイロード ​

サンプルリクエスト ​

レスポンス ​

フォルダを更新 ​

URLパラメーター ​

ペイロード ​

サンプルリクエスト ​

レスポンス ​

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

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

プロジェクトを更新 ​

URLパラメータ ​

ペイロード ​

サンプルリクエスト ​

レスポンス ​

フォルダを削除 ​

URLパラメータ ​

クエリパラメータ ​

サンプルリクエスト ​

レスポンス ​

プロジェクトを削除する ​

URLパラメータ ​

サンプルリクエスト ​

レスポンス ​

フォルダ

レート制限

クイックリファレンス

フォルダをリスト

クエリパラメーター

サンプルリクエスト

レスポンス

プロジェクトをリスト

クエリパラメータ

サンプルリクエスト

レスポンス

プロジェクトまたはフォルダを作成

ペイロード

サンプルリクエスト

レスポンス

フォルダを更新

URLパラメーター

ペイロード

サンプルリクエスト

レスポンス

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

フォルダ名の無効な文字

プロジェクトを更新

URLパラメータ

ペイロード

サンプルリクエスト

レスポンス

フォルダを削除

URLパラメータ

クエリパラメータ

サンプルリクエスト

レスポンス

プロジェクトを削除する

URLパラメータ

サンプルリクエスト

レスポンス