Download OpenAPI specification:Download
Eine API, die Kernfunktionen des Blue Prism Produkts verfügbar macht
Blue Prism agreements: https://portal.blueprism.com/agreements
workQueueIds required | Array of strings <uuid> Array von Arbeitswarteschlangen-IDs, für die Daten abgerufen werden sollen. |
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "completed": 0,
- "pending": 0,
- "deferred": 0,
- "locked": 0,
- "exceptioned": 0
}
]
startDate required | string <date-time> Das Startdatum |
resourceIds | Array of strings <uuid> Array von Ressourcen-IDs zum Filtern. |
pageNumber | integer Seitennummer-Parameter für Datenauslagerung der Auslastungskarte. |
pageSize | integer Seitengrößen-Parameter für Datenauslagerung der Auslastungskarte. |
[- {
- "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
- "digitalWorkerName": "string",
- "utilizationDate": "2020-10-02T12:34:56+02:00",
- "usages": [
- 0
]
}
]
startDate required | string <date-time> Das Startdatum |
endDate required | string <date-time> Das Enddatum |
resourceIds | Array of strings <uuid> Ressourcen-IDs zum Filtern. |
[- {
- "dates": "2020-10-02T12:34:56+02:00",
- "usage": 0
}
]
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
Ein Filter zur Suche nach dem Namen der Ressource. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
Ein Filter zur Suche nach dem Gruppennamen der Ressource. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
Ein Filter zur Suche nach dem Poolnamen der Ressource. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Zahl aktiver Sitzungen der Ressource. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Anzahl ausstehender Sitzungen der Ressource. | |
displayStatus | Array of strings Items Enum: "Working" "Idle" "Warning" "Offline" "Missing" "LoggedOut" "Private" Ein Filter zur Suche nach dem aktuellen Status der Ressource. |
sortBy | string Enum: "NameAsc" "NameDesc" "PoolAsc" "PoolDesc" "GroupAsc" "GroupDesc" "PendingAsc" "PendingDesc" "ActiveAsc" "ActiveDesc" "DisplayStatusAsc" "DisplayStatusDesc" Das Feld, nach dem die Ergebnisse sortiert werden sollen, und die Sortierreihenfolge. |
itemsPerPage | integer >= 1 Die maximale Anzahl der Elemente, die auf dieser Seite abgerufen werden sollen. |
pagingToken | string Das Token, das auf das letzte zuvor zurückgegebene Element verweist. |
{- "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"
}
]
}
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
Ein Filter zur Suche nach dem Namen des Zeitplans. | |
retirementStatus | Array of strings Items Enum: "Active" "Retired" Ein Filter zur Suche nach dem Zurückziehungsstatus des Zeitplans. Standardmäßig wird nach allen Status gesucht. |
itemsPerPage | integer >= 1 Die maximale Anzahl der abzurufenden Elemente |
pagingToken | string Das Token, das auf das letzte zuvor zurückgegebene Element verweist |
{- "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
- "items": [
- {
- "id": 123,
- "name": "Example schedule",
- "description": "Ein Zeitplan für API-Beispielzwecke",
- "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"
}
]
}
scheduleId required | integer Die ID des zu aktualisierenden Zeitplans |
isRetired | boolean Ein neuer Wert für den Zurückziehungsstatus des Zeitplans |
{- "isRetired": true
}
{- "invalidField": "string",
- "message": "string"
}
itemsPerPage | integer Die Anzahl der Elemente, die pro Seite angezeigt werden sollen |
scheduleLogStatus | Array of strings Items Enum: "Pending" "Running" "Terminated" "Completed" "PartExceptioned" Ein Filter zur Suche nach dem aktuellen Status des Logs. |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Startzeit des Logs. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Endzeit des Logs. | |
pagingToken | string Das Token, das auf das letzte zuvor zurückgegebene Element verweist |
{- "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"
}
]
}
scheduleId required | integer Die ID des Zeitplans, für den Daten abgerufen werden sollen |
itemsPerPage | integer Die Anzahl der Elemente, die pro Seite angezeigt werden sollen |
scheduleLogStatus | Array of strings Items Enum: "Pending" "Running" "Terminated" "Completed" "PartExceptioned" Ein Filter zur Suche nach dem aktuellen Status des Logs. |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Startzeit des Logs. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Endzeit des Logs. | |
pagingToken | string Das Token, das auf das letzte zuvor zurückgegebene Element verweist |
{- "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"
}
]
}
scheduleId required | string <uuid> Die ID des zu startenden Zeitplans |
startTime | string <date-time> Datum und Uhrzeit, an dem der Zeitplan ausgeführt werden soll |
{- "startTime": "2020-10-02T12:34:56+02:00"
}
{- "scheduledTime": "2020-10-02T12:34:56+02:00"
}
scheduleId required | integer Die ID des Zeitplans, für den Aufgaben abgerufen werden sollen |
[- {
- "id": 0,
- "name": "string",
- "description": "string",
- "failFastOnError": true,
- "delayAfterEnd": 0,
- "onSuccessTaskId": 0,
- "onSuccessTaskName": "string",
- "onFailureTaskId": 0,
- "onFailureTaskName": "string"
}
]
sortBy | string Enum: "SessionNumberAsc" "SessionNumberDesc" "ProcessNameAsc" "ProcessNameDesc" "ResourceNameAsc" "ResourceNameDesc" "UserNameAsc" "UserNameDesc" "StatusAsc" "StatusDesc" "ExceptionTypeAsc" "ExceptionTypeDesc" "StartTimeAsc" "StartTimeDesc" "EndTimeAsc" "EndTimeDesc" "LatestStageAsc" "LatestStageDesc" "StageStartedAsc" "StageStartedDesc" Das Feld, nach dem die Ergebnisse sortiert werden sollen, und die Sortierreihenfolge. |
itemsPerPage | integer >= 1 Die maximale Anzahl der abzurufenden Elemente. |
pagingToken | string Das Token, das auf das letzte zuvor zurückgegebene Element verweist. |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
Ein Filter zur Suche nach dem Namen des Prozesses, der von der Sitzung ausgeführt wird. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
Ein Filter zur Suche nach der Sitzungsnummer. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
Ein Filter zur Suche nach dem Namen der Ressource, auf der die Sitzung ausgeführt wird/wurde. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
Ein Filter zur Suche nach dem Namen des Benutzers, der die Sitzung ausgelöst hat. | |
status | Array of strings Items Enum: "Pending" "Running" "Terminated" "Stopped" "Completed" "Stopping" "Warning" Der Status der Sitzungen, nach denen gesucht werden soll. |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Zeit, zu der die Sitzung gestartet wurde. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Zeit, zu der die Sitzung beendet wurde. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
Ein Filter zur Suche nach dem Namen der letzten Phase. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Zeit, zu der die letzte Phase begonnen hat |
{- "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"
}
]
}
sessionId required | string <uuid> Die ID der Sitzung, für die Daten abgerufen werden sollen |
{- "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"
}
sessionId required | string <uuid> Die ID der Sitzung, für die Daten abgerufen werden sollen |
itemsPerPage | integer >= 1 Die maximale Anzahl der abzurufenden Elemente |
pagingToken | string Das Token, das auf das letzte zuvor zurückgegebene Element verweist |
{- "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
- "items": [
- {
- "logId": 123,
- "stageName": "Example stage",
- "stageType": "Calculation",
- "result": "Some result",
- "resourceStartTime": "2020-10-02T12:34:56+01:00",
- "hasParameters": true
}
]
}
sessionId required | string <uuid> Die ID der Sitzung, für die Daten abgerufen werden sollen |
logId required | integer >= 1 Die ID des Logs, das für die Sitzung abgerufen werden soll |
{- "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"
}
]
}
}
}
}
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" Das Feld, nach dem die Ergebnisse sortiert werden sollen, und die Sortierreihenfolge. |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
Ein Filter zur Suche nach dem Namen der Arbeitswarteschlange. | |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
Ein Filter zur Suche nach Schlüsselfeld der Arbeitswarteschlange. | |
status.eq | string (QueueStatus) Enum: "Running" "Paused" Ein Filter zur Suche nach dem aktuellen Status der Arbeitswarteschlange. |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach den konfigurierten maximalen Versuchen der Arbeitswarteschlange. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Anzahl ausstehender Elemente der Arbeitswarteschlange. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Anzahl gesperrter Elemente der Arbeitswarteschlange. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Anzahl abgeschlossener Elemente der Arbeitswarteschlange. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Anzahl von Elementen mit Ausnahmen der Arbeitswarteschlange. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Gesamtzahl der Elemente der Arbeitswarteschlange. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der durchschnittlichen Arbeitszeit der Arbeitswarteschlange. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Gesamtfalldauer der Arbeitswarteschlange. | |
itemsPerPage | integer >= 1 Die maximale Anzahl der Elemente, die auf der aktuellen Seite zurückgegeben werden sollen. |
pagingToken | string Das Token, das auf das letzte zuvor zurückgegebene Element verweist |
{- "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"
}
]
}
Details der zu erstellenden Warteschlange
name | string [ 1 .. 255 ] characters Der Name der Warteschlange, die erstellt werden soll |
keyField | string [ 0 .. 255 ] characters Der Name der Spalte, die als Schlüssel der Warteschlange verwendet werden soll |
maxAttempts | integer [ 1 .. 999999 ] Die maximale Anzahl der Wiederholungsversuche für Elemente in der Warteschlange |
status | string (QueueStatus) Enum: "Running" "Paused" Der aktuelle Status der Warteschlange. |
encryptionKeyId | integer Die ID des Verschlüsselungsschlüssels, der für die Warteschlange verwendet werden soll. Wenn keine Verschlüsselung erforderlich ist, sollte dieses Feld 0 sein |
{- "name": "Example queue",
- "keyField": "Example field",
- "maxAttempts": 3,
- "status": "Running",
- "encryptionKeyId": 0
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
workQueueId required | string <uuid> Die ID der Warteschlange, für die Details abgerufen werden sollen |
{- "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"
}
workQueueId required | string <uuid> Die ID der zu ändernden Warteschlange |
op required | string Enum: "add" "remove" "replace" "move" "copy" "test" Der auszuführende Vorgang |
path required | string Ein JSON-Pointer |
value | object Der Wert, der innerhalb der Vorgänge verwendet werden soll. |
from | string Eine Zeichenfolge, die einen JSON-Pointer-Wert enthält. |
[- {
- "op": "add",
- "path": "/someArrayProperty",
- "value": [
- "item1",
- "item2"
]
}
]
{- "invalidField": "string",
- "message": "string"
}
workQueueId required | string <uuid> Die ID der Warteschlange, aus der ein Element abgerufen werden soll |
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" Das Feld, nach dem die Ergebnisse sortiert werden sollen, und die Sortierreihenfolge. |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
Ein Filter zur Suche nach dem Wert des Schlüsselfelds des Arbeitswarteschlangenelements. | |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
Ein Filter zur Suche nach dem Status des Arbeitswarteschlangenelements. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Gesamtarbeitszeit des Arbeitswarteschlangenelements. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Zeit, zu der das Arbeitswarteschlangenelement in die Warteschlange geladen wurde. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Zeit, bis zu der das Arbeitswarteschlangenelement verschoben ist. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Zeit, zu der das Arbeitswarteschlangenelement gesperrt wurde. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Zeit, zu der das Arbeitswarteschlangenelement abgeschlossen wurde. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Zeit, zu der das Arbeitswarteschlangenelement eine Ausnahme auslöste. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Zeit, zu der das Arbeitswarteschlangenelement zuletzt aktualisiert wurde. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der aktuellen Versuchsnummer des Arbeitswarteschlangenelements. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
Ein Filter zur Suche nach der Priorität des Arbeitswarteschlangenelements. | |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
Ein Filter zur Suche nach dem Grund, warum das Arbeitswarteschlangenelement eine Ausnahme auslöste. | |
itemsPerPage | integer Die maximale Anzahl der abzurufenden Elemente |
pagingToken | string Das Token, das auf das letzte zuvor zurückgegebene Element verweist |
{- "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"
}
]
}
workQueueId required | string <uuid> Die ID der Warteschlange, in die eingefügt werden soll |
Details der zu erstellenden Warteschlangenelementen
object (DataCollection) Stellt eine Blue Prism Sammlung dar. | |
deferredDate | string <date-time> Die früheste Uhrzeit und das früheste Datum, bis zu dem das Element verschoben wird |
priority | integer <integer> Der dem Element zugewiesene Prioritätswert |
tags | Array of strings Eine Sammlung von Tags, die dem Element zugewiesen sind |
status | string Der vom Benutzer bereitgestellte Statuswert |
[- {
- "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"
]
}
workQueueItemId required | string <uuid> Die ID des abzurufenden Elements |
{- "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"
}
]
}
}