Download OpenAPI specification:Download
Blue Prism製品のコア機能を明らかにするAPI
Blue Prism agreements: https://portal.blueprism.com/agreements
workQueueIds required | Array of strings <uuid> データを取得するワークキューIDの配列。 |
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "completed": 0,
- "pending": 0,
- "deferred": 0,
- "locked": 0,
- "exceptioned": 0
}
]
startDate required | string <date-time> 開始日 |
resourceIds | Array of strings <uuid> フィルターを適用するリソースIDの配列。 |
pageNumber | integer 使用状況ヒートマップのデータページングに使用するページ番号パラメーター。 |
pageSize | integer 使用状況ヒートマップのデータページングに使用するページサイズのパラメーター。 |
[- {
- "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
- "digitalWorkerName": "string",
- "utilizationDate": "2020-10-02T12:34:56+02:00",
- "usages": [
- 0
]
}
]
Permissions required
At least one of:
リソースを表示
|リソーススクリーンキャプチャを表示
|リソースを構成
|リソースをコントロール
|リソースアクセス権を管理
|リソースの詳細を表示
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
リソースの名前を検索するフィルター。 | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
リソースのグループ名を検索するフィルター。 | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
リソースのプール名を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
リソースのアクティブなセッション数を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
リソースの保留中のセッション数を検索するフィルター。 | |
displayStatus | Array of strings Items Enum: "Working" "Idle" "Warning" "Offline" "Missing" "LoggedOut" "Private" リソースの現在のステータスを検索するフィルター。 |
sortBy | string Enum: "NameAsc" "NameDesc" "PoolAsc" "PoolDesc" "GroupAsc" "GroupDesc" "PendingAsc" "PendingDesc" "ActiveAsc" "ActiveDesc" "DisplayStatusAsc" "DisplayStatusDesc" 結果を並べ替えるフィールドと、並べ替える方向。 |
itemsPerPage | integer >= 1 このページで取得するアイテムの最大数。 |
pagingToken | string 以前に返された最後のアイテムを指定するトークン。 |
{- "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
- "items": [
- {
- "id": "01234567-89ab-cdef-0123-456789abcdef",
- "name": "Example",
- "poolId": "99e23d41-e8ec-4ffe-89c9-93814d70d551",
- "poolName": "Pool name",
- "groupId": "fedcba98-7654-3210-fedc-ba9876543210",
- "groupName": "Example group",
- "attributes": [
- "None"
], - "activeSessionCount": 5,
- "warningSessionCount": 1,
- "pendingSessionCount": 2,
- "databaseStatus": "Ready",
- "displayStatus": "Working"
}
]
}
Permissions required:
リソースをコントロール
resourceId required | string <uuid> リソースまたはプールのID |
attributes | Array of strings (ResourceAttribute) Items Enum: "None" "Retired" "Local" "LoginAgent" "Private" "DefaultInstance" リソースに指定する属性 |
{- "attributes": [
- "Retired",
- "None"
]
}
{- "invalidField": "string",
- "message": "string"
}
Permissions required
At least one of:
スケジュールを表示
|スケジュールを編集
|スケジュールを削除
|スケジュールを作成
|スケジュールを廃止
|システム - スケジューラー
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
スケジュールの名前を検索するフィルター。 | |
retirementStatus | Array of strings Items Enum: "Active" "Retired" スケジュールの廃止ステータスを検索するフィルター。デフォルトの動作では、すべてのステータスを検索します。 |
itemsPerPage | integer >= 1 取得するアイテムの最大数 |
pagingToken | string 以前に返された最後のアイテムを指定するトークン |
{- "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
- "items": [
- {
- "id": 123,
- "name": "Example schedule",
- "description": "APIの例のためのスケジュール",
- "isRetired": false,
- "tasksCount": 3,
- "intervalType": "Hour",
- "timePeriod": 2,
- "startPoint": "0001-01-01T09:00:00+01:00",
- "endPoint": "0001-01-01T17:30:00+01:00",
- "dayOfWeek": "Tuesday",
- "dayOfMonth": "First",
- "startDate": "2020-10-02T00:00:00Z",
- "endDate": "2020-10-03T02:20:00Z",
- "calendarId": 1,
- "calendarName": "Example calendar name"
}
]
}
Permissions required
For retiring all of the following:
スケジュールを編集
|スケジュールを廃止
For unretiring all of the following:スケジュールを編集
|スケジュールを廃止
|スケジュールを作成
scheduleId required | integer 更新するスケジュールのID |
isRetired | boolean スケジュールの廃止ステータスの新しい値 |
{- "isRetired": true
}
{- "invalidField": "string",
- "message": "string"
}
Permissions required
At least one of:
スケジュールを表示
|スケジュールを編集
|スケジュールを削除
|スケジュールを作成
|スケジュールを廃止
|システム - スケジューラー
itemsPerPage | integer 1ページあたりの表示アイテム数 |
scheduleLogStatus | Array of strings Items Enum: "Pending" "Running" "Terminated" "Completed" "PartExceptioned" ログのステータスを検索するフィルター。 |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ログの開始時刻を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ログの終了時刻を検索するフィルター。 | |
pagingToken | string 以前に返された最後のアイテムを指定するトークン |
{- "pagingToken": "string",
- "items": [
- {
- "scheduleLogId": 0,
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "status": "pending",
- "serverName": "string",
- "scheduleId": 0,
- "scheduleName": "string"
}
]
}
Permissions required
At least one of:
スケジュールを表示
|スケジュールを編集
|スケジュールを削除
|スケジュールを作成
|スケジュールを廃止
|システム - スケジューラー
scheduleId required | integer データを取得するスケジュールのID |
itemsPerPage | integer 1ページあたりの表示アイテム数 |
scheduleLogStatus | Array of strings Items Enum: "Pending" "Running" "Terminated" "Completed" "PartExceptioned" ログのステータスを検索するフィルター。 |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ログの開始時刻を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ログの終了時刻を検索するフィルター。 | |
pagingToken | string 以前に返された最後のアイテムを指定するトークン |
{- "pagingToken": "string",
- "items": [
- {
- "scheduleLogId": 0,
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "status": "pending",
- "serverName": "string",
- "scheduleId": 0,
- "scheduleName": "string"
}
]
}
Permissions required:
スケジュールを編集
scheduleId required | string <uuid> 開始するスケジュールのID |
startTime | string <date-time> スケジュールを実行する日時 |
{- "startTime": "2020-10-02T12:34:56+02:00"
}
{- "scheduledTime": "2020-10-02T12:34:56+02:00"
}
Permissions required
At least one of:
スケジュールを表示
|スケジュールを編集
|スケジュールを削除
|スケジュールを作成
|スケジュールを廃止
|システム - スケジューラー
scheduleId required | integer タスクを取得するスケジュールのID |
[- {
- "id": 0,
- "name": "string",
- "description": "string",
- "failFastOnError": true,
- "delayAfterEnd": 0,
- "onSuccessTaskId": 0,
- "onSuccessTaskName": "string",
- "onFailureTaskId": 0,
- "onFailureTaskName": "string"
}
]
Permissions required
At least one of:
スケジュールを表示
|スケジュールを編集
|スケジュールを削除
|スケジュールを作成
|スケジュールを廃止
|システム - スケジューラー
taskId required | integer >= 1 データを取得するタスクのID |
[- {
- "processName": "string",
- "resourceName": "string"
}
]
Permissions required
At least one of:
プロセスを作成
|プロセスを削除
|プロセスを編集
|プロセスグループを編集
|エクスポートプロセス
|プロセスを実行
|Webサービスとしてプロセスを実行
|プロセス定義を表示
|プロセスアクセス権を管理
And at least one of:リソースを表示
|リソーススクリーンキャプチャを表示
|リソースを構成
|リソースをコントロール
|リソースアクセス権を管理
sortBy | string Enum: "SessionNumberAsc" "SessionNumberDesc" "ProcessNameAsc" "ProcessNameDesc" "ResourceNameAsc" "ResourceNameDesc" "UserNameAsc" "UserNameDesc" "StatusAsc" "StatusDesc" "ExceptionTypeAsc" "ExceptionTypeDesc" "StartTimeAsc" "StartTimeDesc" "EndTimeAsc" "EndTimeDesc" "LatestStageAsc" "LatestStageDesc" "StageStartedAsc" "StageStartedDesc" 結果を並べ替えるフィールドと、並べ替える方向。 |
itemsPerPage | integer >= 1 取得するアイテムの最大数。 |
pagingToken | string 以前に返された最後のアイテムを指定するトークン。 |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
セッションによって実行されるプロセスの名前を検索するフィルター。 | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
セッション番号を検索するフィルター。 | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
セッションが実行している、または実行したリソースの名前を検索するためのフィルター。 | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
セッションをトリガーしたユーザーの名前を検索するフィルター。 | |
status | Array of strings Items Enum: "Pending" "Running" "Terminated" "Stopped" "Completed" "Stopping" "Warning" 検索するセッションのステータス。 |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
セッションが開始した時刻を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
セッションが終了した時刻を検索するフィルター。 | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
最新のステージの名前を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
最新のステージが開始された時刻を検索するフィルター |
{- "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
- "items": [
- {
- "sessionId": "01234567-89ab-cdef-0123-456789abcdef",
- "sessionNumber": 123,
- "processId": "01234567-89ab-cdef-0123-456789abcdef",
- "processName": "Example process",
- "resourceId": "01234567-89ab-cdef-0123-456789abcdef",
- "resourceName": "Example resource",
- "username": "Example user",
- "status": "Running",
- "startTime": "2020-10-02T12:34:56+02:00",
- "endTime": "2020-10-03T13:36:21+02:00",
- "latestStage": "Example stage",
- "stageStarted": "2020-10-02T12:35:30+02:00",
- "exceptionMessage": "Exception message",
- "terminationReason": "InternalError",
- "exceptionType": "Exception type"
}
]
}
Permissions required
At least one of:
プロセスを作成
|プロセスを削除
|プロセスを編集
|プロセスグループを編集
|エクスポートプロセス
|プロセスを実行
|Webサービスとしてプロセスを実行
|プロセス定義を表示
|プロセスアクセス権を管理
And at least one of:リソースを表示
|リソーススクリーンキャプチャを表示
|リソースを構成
|リソースをコントロール
|リソースアクセス権を管理
sessionId required | string <uuid> データを取得するセッションのID |
{- "sessionId": "01234567-89ab-cdef-0123-456789abcdef",
- "sessionNumber": 123,
- "processId": "01234567-89ab-cdef-0123-456789abcdef",
- "processName": "Example process",
- "resourceId": "01234567-89ab-cdef-0123-456789abcdef",
- "resourceName": "Example resource",
- "username": "Example user",
- "status": "Running",
- "startTime": "2020-10-02T12:34:56+02:00",
- "endTime": "2020-10-03T13:36:21+02:00",
- "latestStage": "Example stage",
- "stageStarted": "2020-10-02T12:35:30+02:00",
- "exceptionMessage": "Exception message",
- "terminationReason": "InternalError",
- "exceptionType": "Exception type"
}
Permissions required
At least one of:
プロセスを作成
|プロセスを削除
|プロセスを編集
|プロセスグループを編集
|エクスポートプロセス
|プロセスを実行
|Webサービスとしてプロセスを実行
|プロセス定義を表示
|プロセスアクセス権を管理
And at least one of:リソースを表示
|リソーススクリーンキャプチャを表示
|リソースを構成
|リソースをコントロール
|リソースアクセス権を管理
から監査 - プロセスログ
sessionId required | string <uuid> データを取得するセッションのID |
itemsPerPage | integer >= 1 取得するアイテムの最大数 |
pagingToken | string 以前に返された最後のアイテムを指定するトークン |
{- "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
- "items": [
- {
- "logId": 123,
- "stageName": "Example stage",
- "stageType": "Calculation",
- "result": "Some result",
- "resourceStartTime": "2020-10-02T12:34:56+01:00",
- "hasParameters": true
}
]
}
Permissions required
At least one of:
プロセスを作成
|プロセスを削除
|プロセスを編集
|プロセスグループを編集
|エクスポートプロセス
|プロセスを実行
|Webサービスとしてプロセスを実行
|プロセス定義を表示
|プロセスアクセス権を管理
And at least one of:リソースを表示
|リソーススクリーンキャプチャを表示
|リソースを構成
|リソースをコントロール
|リソースアクセス権を管理
から監査 - プロセスログ
sessionId required | string <uuid> データを取得するセッションのID |
logId required | integer >= 1 セッションで取得するログのID |
{- "inputs": {
- "parameter1": {
- "valueType": "Text",
- "value": "Example value"
}, - "parameter2": {
- "valueType": "Number",
- "value": 123
}
}, - "outputs": {
- "parameter1": {
- "valueType": "Collection",
- "value": {
- "rows": [
- {
- "valueType": "Number",
- "value": 321
}, - {
- "valueType": "Date",
- "value": "2020-10-02T12:34:56+01:00"
}
]
}
}
}
}
Permissions required
At least one of:
キュー管理への読み取りアクセス
|キュー管理へのフルアクセス
sortBy | string Enum: "NameAsc" "NameDesc" "StatusAsc" "StatusDesc" "KeyFieldAsc" "KeyFieldDesc" "MaxAttemptsAsc" "MaxAttemptsDesc" "IsEncryptedAsc" "IsEncryptedDesc" "TotalItemCountAsc" "TotalItemCountDesc" "CompletedItemCountAsc" "CompletedItemCountDesc" "PendingItemCountAsc" "PendingItemCountDesc" "LockedItemCountAsc" "LockedItemCountDesc" "ExceptionedItemCountAsc" "ExceptionedItemCountDesc" "TotalCaseDurationAsc" "TotalCaseDurationDesc" "AverageWorkTimeAsc" "AverageWorkTimeDesc" 結果を並べ替えるフィールドと、並べ替える方向。 |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
ワークキューの名前を検索するフィルター。 | |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
ワークキューのキーフィールドの名前を検索するフィルター。 | |
status.eq | string (QueueStatus) Enum: "Running" "Paused" ワークキューの現在のステータスを検索するフィルター。 |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ワークキューの構成済みの最大試行回数を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ワークキューの保留中のアイテム数を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ワークキューのロックされているアイテム数を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ワークキューの完了したアイテム数を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ワークキューの例外アイテム数を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ワークキューの合計アイテム数を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ワークキューの平均作業時間を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ワークキューの合計処理時間を検索するフィルター。 | |
itemsPerPage | integer >= 1 現在のページで返すアイテムの最大数。 |
pagingToken | string 以前に返された最後のアイテムを指定するトークン |
{- "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
- "items": [
- {
- "id": "01234567-89ab-cdef-0123-456789abcdef",
- "name": "Example work queue",
- "keyField": "Example field",
- "status": "Running",
- "isEncrypted": false,
- "maxAttempts": 5,
- "pendingItemCount": 10,
- "completedItemCount": 75,
- "lockedItemCount": 1,
- "exceptionedItemCount": 3,
- "totalItemCount": 14,
- "averageWorkTime": "00:01:23",
- "totalCaseDuration": "06:12:53",
- "groupName": "Example group",
- "groupId": "fedcba98-7654-3210-fedc-ba9876543210"
}
]
}
Permissions required:
ワークフロー - ワークキューの構成
作成するキューの詳細
name | string [ 1 .. 255 ] characters 作成するキューの名前 |
keyField | string [ 0 .. 255 ] characters キューのキーとして使用される列の名前 |
maxAttempts | integer [ 1 .. 999999 ] キュー内のアイテムの最大再試行回数 |
status | string (QueueStatus) Enum: "Running" "Paused" キューの現在のステータス。 |
encryptionKeyId | integer キューに使用する暗号化キーのID。暗号化が不要な場合、このフィールドは0にしてください |
{- "name": "Example queue",
- "keyField": "Example field",
- "maxAttempts": 3,
- "status": "Running",
- "encryptionKeyId": 0
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Permissions required
At least one of:
キュー管理への読み取りアクセス
|キュー管理へのフルアクセス
workQueueId required | string <uuid> 詳細を取得するキューのID |
{- "id": "01234567-89ab-cdef-0123-456789abcdef",
- "name": "Example work queue",
- "keyField": "Example field",
- "status": "Running",
- "isEncrypted": false,
- "maxAttempts": 5,
- "pendingItemCount": 10,
- "completedItemCount": 75,
- "lockedItemCount": 1,
- "exceptionedItemCount": 3,
- "totalItemCount": 14,
- "averageWorkTime": "00:01:23",
- "totalCaseDuration": "06:12:53",
- "groupName": "Example group",
- "groupId": "fedcba98-7654-3210-fedc-ba9876543210"
}
Permissions required
At least one of:
キュー管理への読み取りアクセス
|キュー管理へのフルアクセス
からワークフロー - ワークキューの構成
workQueueId required | string <uuid> 変更するキューのID |
op required | string Enum: "add" "remove" "replace" "move" "copy" "test" 実行する操作 |
path required | string JSON Pointer |
value | object 操作で使用される値。 |
from | string JSON Pointer値を含む文字列。 |
[- {
- "op": "add",
- "path": "/someArrayProperty",
- "value": [
- "item1",
- "item2"
]
}
]
{- "invalidField": "string",
- "message": "string"
}
Permissions required
At least one of:
キュー管理への読み取りアクセス
|キュー管理へのフルアクセス
workQueueId required | string <uuid> アイテムを取得するキューのID |
sortBy | string Enum: "AttemptAsc" "AttemptDesc" "AttemptWorkTimeAsc" "AttemptWorkTimeDesc" "CompletedAsc" "CompletedDesc" "DeferredAsc" "DeferredDesc" "ExceptionAsc" "ExceptionDesc" "ExceptionReasonAsc" "ExceptionReasonDesc" "KeyValueAsc" "KeyValueDesc" "LastUpdatedAsc" "LastUpdatedDesc" "LoadedAsc" "LoadedDesc" "LockedAsc" "LockedDesc" "PriorityAsc" "PriorityDesc" "StatusAsc" "StatusDesc" "WorkTimeAsc" "WorkTimeDesc" 結果を並べ替えるフィールドと、並べ替える方向。 |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
ワークキュー項目のキーフィールドの値を検索するフィルター。 | |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
ワークキュー項目のステータスを検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ワークキュー項目の合計作業時間を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ワークキュー項目がキューに読み込まれた時刻を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ワークキュー項目が延期された時刻を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ワークキュー項目がロックされた時刻を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ワークキュー項目が完了した時刻を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ワークキュー項目が例外となった時刻を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ワークキュー項目が最後に更新された時刻を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ワークキュー項目の現在の試行回数を検索するフィルター。 | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
ワークキュー項目の優先度を検索するフィルター。 | |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
ワークキュー項目が例外となった理由を検索するフィルター。 | |
itemsPerPage | integer 取得するアイテムの最大数 |
pagingToken | string 以前に返された最後のアイテムを指定するトークン |
{- "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
- "items": [
- {
- "id": "01234567-89ab-cdef-0123-456789abcdef",
- "priority": 3,
- "ident": 5112,
- "state": "Pending",
- "keyValue": "Example value",
- "status": "Example status",
- "tags": [
- "Example tag 1",
- "Example tag 2"
], - "attemptNumber": 1,
- "loadedDate": "2020-10-02T12:34:56+01:00",
- "deferredDate": "2020-10-02T12:34:56+01:00",
- "lockedDate": "0001-01-01T00:00:00Z",
- "completedDate": "0001-01-01T00:00:00Z",
- "exceptionedDate": "0001-01-01T00:00:00Z",
- "exceptionReason": "Example reason",
- "lastUpdated": "2020-10-02T12:34:56+01:00",
- "workTimeInSeconds": 123,
- "attemptWorkTimeInSeconds": 56,
- "resource": "Example resource"
}
]
}
Permissions required:
キュー管理へのフルアクセス
workQueueId required | string <uuid> 挿入先のキューのID |
作成するキュー項目の詳細
object (DataCollection) Blue Prismコレクションを表します。 | |
deferredDate | string <date-time> このアイテムが次の日付まで延期される最も早い日時 |
priority | integer <integer> アイテムに指定されている優先度値 |
tags | Array of strings アイテムに指定されているタグのコレクション |
status | string ユーザー提供のステータス値 |
[- {
- "data": {
- "rows": [
- {
- "valueType": "Number",
- "value": 321
}, - {
- "valueType": "Date",
- "value": "2020-10-02T12:34:56+01:00"
}
]
}, - "deferredDate": "2020-10-02T12:34:56+01:00",
- "priority": 3,
- "tags": [
- "Example tag 1",
- "Example tag 2"
], - "status": "Example status"
}
]
{- "ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Permissions required
At least one of:
キュー管理への読み取りアクセス
|キュー管理へのフルアクセス
workQueueItemId required | string <uuid> 取得するアイテムのID |
{- "id": "01234567-89ab-cdef-0123-456789abcdef",
- "priority": 3,
- "ident": 123,
- "state": "Completed",
- "keyValue": "Example value",
- "status": "Example status",
- "tags": [
- "Example tag 1",
- "Example tag 2"
], - "attemptNumber": 1,
- "loadedDate": "2020-10-02T12:34:56+01:00",
- "deferredDate": "2020-10-02T12:34:56+01:00",
- "lockedDate": "0001-01-01T00:00:00Z",
- "completedDate": "2020-10-02T13:00:00+01:00",
- "exceptionedDate": "0001-01-01T00:00:00Z",
- "exceptionReason": "Example reason",
- "lastUpdated": "2020-10-02T13:00:00+01:00",
- "workTimeInSeconds": 123,
- "attemptWorkTimeInSeconds": 123,
- "resource": "Example resource",
- "data": {
- "rows": [
- {
- "valueType": "Number",
- "value": 321
}, - {
- "valueType": "Date",
- "value": "2020-10-02T12:34:56+01:00"
}
]
}
}