ビジネスプロセスを照会します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| PageNumber |
integer |
任意 |
ページ番号。ページは 1 から始まります。デフォルト値：1。 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりのエントリ数。有効値：1～100。デフォルト値：10。 |
10 |
| ProjectId |
integer |
必須 |
ワークスペース ID。 |
10000 |
| TenantId |
integer |
任意 |
テナント ID。このパラメーターは非推奨です。 |
10001 |
| GroupNameKeyword |
string |
任意 |
ビジネスプロセス名のキーワード。このキーワードを含むビジネスプロセスを検索するために使用されます。 |
测试业务流程 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID。 |
0000-ABCD-EF**** |
| GroupPagingResult |
object |
ビジネスプロセスのページング結果。 |
|
| PageNumber |
integer |
ページ番号。このパラメーターの値は、リクエストの PageNumber パラメーターの値と同じです。 |
1 |
| PageSize |
integer |
1 ページあたりのエントリ数。有効値：1～100。デフォルト値：10。 |
10 |
| TotalCount |
integer |
返されるエントリの合計数。 |
100 |
| Groups |
array<object> |
ビジネスプロセス。 |
|
|
object |
|||
| ModifiedTime |
string |
ビジネスプロセスが変更された時間。 |
2020-09-24T18:37:51+0800 |
| Description |
string |
ビジネスプロセスの説明。 |
业务流程描述 |
| GroupName |
string |
ビジネスプロセスの名前。 |
业务流程名称 |
| GroupId |
string |
ビジネスプロセス ID。 |
ds_123abc |
| ProjectId |
integer |
ワークスペース ID。 |
10002 |
| ApiGatewayGroupId |
string |
ワークフローがバインドされている API Gateway グループの ID。 |
100abc |
| CreatorId |
string |
ビジネスプロセスの作成者のユーザー識別子 (UID)。既存の一部のビジネスプロセスの作成者については、このパラメーターの値が空の場合があります。 |
10001 |
| CreatedTime |
string |
ビジネスプロセスが作成された時間。 |
2020-09-24T18:37:51+0800 |
| TenantId |
integer |
テナント ID。 |
10003 |
例
成功レスポンス
JSONJSON
{
"RequestId": "0000-ABCD-EF****",
"GroupPagingResult": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"Groups": [
{
"ModifiedTime": "2020-09-24T18:37:51+0800",
"Description": "业务流程描述",
"GroupName": "业务流程名称",
"GroupId": "ds_123abc",
"ProjectId": 10002,
"ApiGatewayGroupId": "100abc",
"CreatorId": "10001",
"CreatedTime": "2020-09-24T18:37:51+0800",
"TenantId": 10003
}
]
}
}エラーコード
|
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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。