この操作では、ワークフローディレクトリを照会します。
デバッグ
リクエストパラメーター
パラメーター | データ型 | 必須/任意 | 例 | 説明 |
---|---|---|---|---|
Action | String | 必須 | ListFlowCategory |
実行する操作。 値を ListFlowCategory に設定します。 |
ProjectId | String | 必須 | FP-6E8E198E6C79**** |
プロジェクトの ID。 |
RegionId | String | 必須 | cn-hangzhou |
リージョンの ID。 |
PageNumber | Integer | 任意 | 1 |
返されるページ数。 |
PageSize | Integer | 任意 | 10 |
返される各ページのエントリ数。 |
ParentId | String | 任意 | FC-6E8E198E6C79179C |
親ディレクトリの ID。 |
Root | Boolean | 任意 | false |
ルートディレクトリの使用有無を指定します。 |
レスポンスパラメーター
パラメーター | データ型 | 例 | 説明 |
---|---|---|---|
Categories |
ディレクトリの一覧。 |
||
CategoryType | String | FILE |
ディレクトリのノードタイプ。 次のいずれかの値を設定可能です。
|
GmtCreate | Long | 1563848015000 |
ディレクトリの作成時刻。 |
GmtModified | Long | 1563848015000 |
ディレクトリが変更された時刻。 |
Id | String | FC-DF781BBF3F2E8317 |
ディレクトリの ID。 |
Name | String | Test |
ディレクトリの名前。 |
ObjectId | String | F-0B30759C146EA1E7 |
関連するエンティティの ID (ジョブやワークフローなど)。 |
ObjectType | String | FLOW |
関連するエンティティのタイプ。 次のいずれかの値を設定可能です。
|
ParentId | String | FC-DF781BBF3F2E8318 |
親ディレクトリの ID。 |
ProjectId | String | FP-179332E88F52**** |
プロジェクトの ID。 |
Type | String | FLOW |
ディレクトリのタイプ。 次のいずれかの値を設定可能です。
|
PageNumber | Integer | 1 |
返されたページ数。 |
PageSize | Integer | 10 |
返された各ページのエントリ数。 |
RequestId | String | 5ECD6EA1-838E-4BDF-96C8-AEAA40F04F48 |
リクエストの ID。 |
Total | Integer | 100 |
ディレクトリの総数。 |
例
リクエスト例
http(s)://[Endpoint]/? Action=ListFlowCategory
&ProjectId=FP-6E8E198E6C79****
&RegionId=cn-hangzhou
&<Common request parameters>
通常のレスポンス例
XML
形式
<ListFlowCategoryResponse>
<PageSize>10</PageSize>
<RequestId>BCF52B64-007F-4883-BAEA-0499106D07C2</RequestId>
<PageNumber>1</PageNumber>
<Total>1</Total>
<Categories>
<categoryType>FOLDER</categoryType>
<gmtModified>1563848002000</gmtModified>
<name>FLOW</name>
<id>FC-D566F13A20A00D18</id>
<gmtCreate>1563848002000</gmtCreate>
<type>FLOW</type>
<projectId>FP-179332E88F52****</projectId>
<parentId>root_parent</parentId>
</Categories>
</ListFlowCategoryResponse>
JSON
形式
{
"PageNumber":1,
"PageSize":10,
"RequestId":"BCF52B64-007F-4883-BAEA-0499106D07C2",
"Categories":[
{
"id":"FC-D566F13A20A00D18",
"gmtModified":1563848002000,
"parentId":"root_parent",
"gmtCreate":1563848002000,
"name":"FLOW",
"categoryType":"FOLDER",
"projectId":"FP-179332E88F52****",
"type":"FLOW"
}
],
"Total":1
}
エラーコード
エラーコードの詳細については、「API エラーセンター」をご参照ください。