# フォルダー

フォルダーを管理するには、以下のエンドポイントを使用します。

# クイックリファレンス

タイプ リソース 説明
GET /api/folders フォルダーを列挙します。
GET /api/projects プロジェクトを列挙します。
POST /api/folders フォルダーを作成します。

# フォルダーの列挙

すべてのフォルダーを列挙します。

GET /api/folders

# URL パラメータ

名前 説明
parent_id string 親フォルダー ID。デフォルトでホームフォルダーに設定されます。
page integer ページ番号。デフォルトで1に設定されます。
per_page integer ページサイズ。デフォルトで100に設定されます (最大値は100)。

# サンプルリクエスト

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

# レスポンス

[
    {
        "id": 7498,
        "name": "Netsuite production",
        "parent_id": 3319,
        "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,
        "created_at": "2020-07-09T14:37:47.789-07:00",
        "updated_at": "2020-07-09T14:37:47.802-07:00"
    }
]

# プロジェクトの列挙

すべてのプロジェクトを列挙します。プロジェクトとは、通常は1つのユースケースをまとめるトップレベルのフォルダーを指します。

GET /api/projects

# URL パラメータ

名前 説明
page integer ページ番号。デフォルトで1に設定されます。
per_page integer ページサイズ。デフォルトで100に設定されます (最大値は100)。

# サンプルリクエスト

curl  -X GET 'https://www.workato.com/api/projects' \
      -H 'Authorization: Bearer <api_token>'
      -H 'Content-Type: application/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 が指定されなかった場合は、作成されるフォルダーはトップレベルのフォルダー (ホームフォルダー内の) になります。

POST /api/folders

# ペイロード

名前 説明
name string
必須
フォルダーの名前。
parent_id string 親フォルダー ID。デフォルトでホームフォルダーに設定されます。

# サンプルリクエスト

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

# レスポンス

{
  "id": 3498583,
}


Last updated: 2023/8/31 1:07:14