フォルダを照会します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| PageNumber |
integer |
任意 |
ページ番号。ページは 1 から始まります。デフォルト値：1。 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりの件数。デフォルト値：10。最大値：100。 |
10 |
| ProjectId |
integer |
必須 |
ワークスペースの ID。 |
10001 |
| TenantId |
integer |
任意 |
テナント ID。テナント ID を取得するには、以下の手順を実行します： DataWorks コンソール にログインします。ご利用のワークスペースを特定し、DataStudio ページに移動します。表示されたページの右上隅にあるログインユーザー名をクリックし、メニューから [ユーザー情報] を選択します。 |
10002 |
| GroupId |
string |
任意 |
フォルダが属するビジネスプロセスの ID。 |
ds_123abc |
| FolderNameKeyword |
string |
任意 |
フォルダ名に含まれるキーワード。このキーワードを含むフォルダ名を検索するために使用されます。 |
文件夹名称关键词 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID。 |
0000-ABCD-EF**** |
| FolderPagingResult |
object |
フォルダのページング結果。 |
|
| PageNumber |
integer |
ページ番号。このパラメーターの値は、リクエスト内の PageNumber パラメーターの値と同じです。 |
1 |
| PageSize |
integer |
1 ページあたりの件数。デフォルト値：10。最大値：100。 |
10 |
| TotalCount |
integer |
返された合計件数。 |
100 |
| Folders |
array<object> |
フォルダ。 |
|
|
object |
|||
| ParentId |
integer |
親フォルダの ID。ビジネスプロセスにおけるルートフォルダの ID は 0 であり、ユーザーがビジネスプロセス内で作成したフォルダの ID は 0 より大きくなります。 |
0 |
| ModifiedTime |
string |
フォルダが最後に変更された時刻。 |
2020-09-24T18:37:51+0800 |
| GroupId |
string |
フォルダが属するビジネスプロセスの ID。 |
ds_1234 |
| FolderId |
integer |
フォルダ ID。 |
11 |
| FolderName |
string |
フォルダ名。 |
test1 |
| ProjectId |
integer |
ワークスペース ID。 |
10001 |
| CreatedTime |
string |
フォルダが作成された時刻。 |
2020-09-24T18:37:51+0800 |
| TenantId |
integer |
テナント ID。 |
10002 |
例
成功レスポンス
JSONJSON
{
"RequestId": "0000-ABCD-EF****",
"FolderPagingResult": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"Folders": [
{
"ParentId": 0,
"ModifiedTime": "2020-09-24T18:37:51+0800",
"GroupId": "ds_1234",
"FolderId": 11,
"FolderName": "test1",
"ProjectId": 10001,
"CreatedTime": "2020-09-24T18:37:51+0800",
"TenantId": 10002
}
]
}
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。