Documentation Powered by ReDoc

Blue Prism API (7.0.1)

Download OpenAPI specification:Download

Eine API, die Kernfunktionen des Blue Prism Produkts verfügbar macht

Blue Prism agreements: https://portal.blueprism.com/agreements

Authentication

Bearer

JWT-Token ausgestellt von Authentication Server

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

OAuth2

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: https://auth-server/connect/token
Scopes:
  • bp-api -

    API scope

  • bpserver -

    Blue Prism Application scope

Dashboards

Gibt aggregierte Arbeitswarteschlangendaten für jede der angeforderten Warteschlangen zurück.

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
query Parameters
workQueueIds
required
Array of strings <uuid>

Array von Arbeitswarteschlangen-IDs, für die Daten abgerufen werden sollen.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Laufzeitressourcennutzung zurückgeben

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
query Parameters
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Zusammenfassung der Laufzeitressourcennutzung nach Datumsbereich zurückgeben

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
query Parameters
startDate
required
string <date-time>

Das Startdatum

endDate
required
string <date-time>

Das Enddatum

resourceIds
Array of strings <uuid>

Ressourcen-IDs zum Filtern.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Verschlüsselungsschemata

Rückgabe einer Liste der Verschlüsselungsschemata in der Umgebung

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Ressourcen

Rückgabe einer Liste der Ressourcen in der Umgebung

Permissions required

At least one of: Ressource anzeigen | Ressourcen-Bildschirmaufnahmen anzeigen | Ressource konfigurieren | Ressource steuern | Ressourcen-Zugriffsrechte verwalten | Ressourcendetails anzeigen

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
query Parameters
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter)
Examples:
  • name[eq]=Example - Suche nach einem Wert gleich „Example“.
  • name[strtw]=Exa - Suche nach einem Wert, der mit „Exa“ beginnt.
  • name[gte]=Ex&name[lte]=F - Alphanumerische Suche nach einem Wert zwischen „Ex“ und „F“.
  • name[gte]=Example - Alphanumerische Suche nach einem Wert nach oder gleich „Beispiel“.

Ein Filter zur Suche nach dem Namen der Ressource.

(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter)
Examples:
  • groupName[eq]=Example - Suche nach einem Wert gleich „Example“.
  • groupName[strtw]=Exa - Suche nach einem Wert, der mit „Exa“ beginnt.
  • groupName[gte]=Ex&groupName[lte]=F - Alphanumerische Suche nach einem Wert zwischen „Ex“ und „F“.
  • groupName[gte]=Example - Alphanumerische Suche nach einem Wert nach oder gleich „Beispiel“.

Ein Filter zur Suche nach dem Gruppennamen der Ressource.

(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter)
Examples:
  • poolName[eq]=Example - Suche nach einem Wert gleich „Example“.
  • poolName[strtw]=Exa - Suche nach einem Wert, der mit „Exa“ beginnt.
  • poolName[gte]=Ex&poolName[lte]=F - Alphanumerische Suche nach einem Wert zwischen „Ex“ und „F“.
  • poolName[gte]=Example - Alphanumerische Suche nach einem Wert nach oder gleich „Beispiel“.

Ein Filter zur Suche nach dem Poolnamen der Ressource.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • activeSessionCount[eq]=123 - Suche nach einem Wert gleich 123.
  • activeSessionCount[gte]=123&activeSessionCount[lte]=321 - Suche nach einem Wert zwischen 123 und 321, inklusive.
  • activeSessionCount[lte]=123 - Suche nach einem Wert kleiner oder gleich 123.

Ein Filter zur Suche nach der Zahl aktiver Sitzungen der Ressource.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • pendingSessionCount[eq]=123 - Suche nach einem Wert gleich 123.
  • pendingSessionCount[gte]=123&pendingSessionCount[lte]=321 - Suche nach einem Wert zwischen 123 und 321, inklusive.
  • pendingSessionCount[lte]=123 - Suche nach einem Wert kleiner oder gleich 123.

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.

Responses

Response samples

Content type
application/json
{
  • "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
  • "items": [
    ]
}

Zieht Ressourcen mit der angegebenen ID zurück bzw. hebt deren Rückziehung auf

Permissions required: Ressource steuern

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
resourceId
required
string <uuid>

Die ID der Ressource oder des Pools

Request Body schema: application/json
attributes
Array of strings (ResourceAttribute)
Items Enum: "None" "Retired" "Local" "LoginAgent" "Private" "DefaultInstance"

Die Attribute, die der Ressource zugewiesen werden sollen

Responses

Request samples

Content type
application/json
{
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "invalidField": "string",
  • "message": "string"
}

Zeitpläne

Rückgabe einer Liste der Zeitpläne in der Umgebung

Permissions required

At least one of: Zeitplan anzeigen | Zeitplan bearbeiten | Zeitplan löschen | Zeitplan erstellen | Zeitplan zurückziehen | System – Zeitplaner

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
query Parameters
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter)
Examples:
  • name[eq]=Example - Suche nach einem Wert gleich „Example“.
  • name[strtw]=Exa - Suche nach einem Wert, der mit „Exa“ beginnt.
  • name[gte]=Ex&name[lte]=F - Alphanumerische Suche nach einem Wert zwischen „Ex“ und „F“.
  • name[gte]=Example - Alphanumerische Suche nach einem Wert nach oder gleich „Beispiel“.

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

Responses

Response samples

Content type
application/json
{
  • "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
  • "items": [
    ]
}

Einen angegebenen Zeitplan aktualisieren

Permissions required

For retiring all of the following: Zeitplan bearbeiten | Zeitplan zurückziehen
For unretiring all of the following: Zeitplan bearbeiten | Zeitplan zurückziehen | Zeitplan erstellen

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
scheduleId
required
integer

Die ID des zu aktualisierenden Zeitplans

Request Body schema: application/json
isRetired
boolean

Ein neuer Wert für den Zurückziehungsstatus des Zeitplans

Responses

Request samples

Content type
application/json
{
  • "isRetired": true
}

Response samples

Content type
application/json
{
  • "invalidField": "string",
  • "message": "string"
}

Rückgabe aller Zeitplanlogs

Permissions required

At least one of: Zeitplan anzeigen | Zeitplan bearbeiten | Zeitplan löschen | Zeitplan erstellen | Zeitplan zurückziehen | System – Zeitplaner

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
query Parameters
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:
  • startTime[eq]=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht.
  • startTime[gte]=2020-10-02T12:34:56+01:00&startTime[lte]=2020-11-02T12:34:56+01:00 - Suche nach einem Wert zwischen 2020-10-02 um 12:34:56 (GMT+1) und 2020-11-02 um 12:34:56 (GMT+1) (inklusive).
  • startTime[gte]=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht oder danach liegt.

Ein Filter zur Suche nach der Startzeit des Logs.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • endTime[eq]=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht.
  • endTime[gte]=2020-10-02T12:34:56+01:00&endTime[lte]=2020-11-02T12:34:56+01:00 - Suche nach einem Wert zwischen 2020-10-02 um 12:34:56 (GMT+1) und 2020-11-02 um 12:34:56 (GMT+1) (inklusive).
  • endTime[gte]=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht oder danach liegt.

Ein Filter zur Suche nach der Endzeit des Logs.

pagingToken
string

Das Token, das auf das letzte zuvor zurückgegebene Element verweist

Responses

Response samples

Content type
application/json
{
  • "pagingToken": "string",
  • "items": [
    ]
}

Rückgabe aller Logs für einen angegebenen Zeitplan

Permissions required

At least one of: Zeitplan anzeigen | Zeitplan bearbeiten | Zeitplan löschen | Zeitplan erstellen | Zeitplan zurückziehen | System – Zeitplaner

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
scheduleId
required
integer

Die ID des Zeitplans, für den Daten abgerufen werden sollen

query Parameters
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:
  • startTime[eq]=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht.
  • startTime[gte]=2020-10-02T12:34:56+01:00&startTime[lte]=2020-11-02T12:34:56+01:00 - Suche nach einem Wert zwischen 2020-10-02 um 12:34:56 (GMT+1) und 2020-11-02 um 12:34:56 (GMT+1) (inklusive).
  • startTime[gte]=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht oder danach liegt.

Ein Filter zur Suche nach der Startzeit des Logs.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • endTime[eq]=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht.
  • endTime[gte]=2020-10-02T12:34:56+01:00&endTime[lte]=2020-11-02T12:34:56+01:00 - Suche nach einem Wert zwischen 2020-10-02 um 12:34:56 (GMT+1) und 2020-11-02 um 12:34:56 (GMT+1) (inklusive).
  • endTime[gte]=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht oder danach liegt.

Ein Filter zur Suche nach der Endzeit des Logs.

pagingToken
string

Das Token, das auf das letzte zuvor zurückgegebene Element verweist

Responses

Response samples

Content type
application/json
{
  • "pagingToken": "string",
  • "items": [
    ]
}

Festlegen eines Zeitplans für die Ausführung zu einem bestimmten Datum und einer bestimmten Uhrzeit

Permissions required: Zeitplan bearbeiten

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
scheduleId
required
string <uuid>

Die ID des zu startenden Zeitplans

Request Body schema: application/json
startTime
string <date-time>

Datum und Uhrzeit, an dem der Zeitplan ausgeführt werden soll

Responses

Request samples

Content type
application/json
{
  • "startTime": "2020-10-02T12:34:56+02:00"
}

Response samples

Content type
application/json
{
  • "scheduledTime": "2020-10-02T12:34:56+02:00"
}

Abrufen einer Liste von Aufgaben in einem Zeitplan

Permissions required

At least one of: Zeitplan anzeigen | Zeitplan bearbeiten | Zeitplan löschen | Zeitplan erstellen | Zeitplan zurückziehen | System – Zeitplaner

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
scheduleId
required
integer

Die ID des Zeitplans, für den Aufgaben abgerufen werden sollen

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Rückgabe einer Liste der geplanten Sitzungen für eine bestimmte Aufgabe

Permissions required

At least one of: Zeitplan anzeigen | Zeitplan bearbeiten | Zeitplan löschen | Zeitplan erstellen | Zeitplan zurückziehen | System – Zeitplaner

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
taskId
required
integer >= 1

Die ID der Aufgabe, für die Daten abgerufen werden sollen

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sitzungen

Rückgabe einer Liste der Sitzungen in der Umgebung

Permissions required

At least one of: Prozess erstellen | Prozess löschen | Prozess bearbeiten | Prozessgruppen bearbeiten | Prozess exportieren | Prozess ausführen | Prozess als Webdienst ausführen | Prozessdefinition anzeigen | Prozess-Zugriffsrechte verwalten

And at least one of: Ressource anzeigen | Ressourcen-Bildschirmaufnahmen anzeigen | Ressource konfigurieren | Ressource steuern | Ressourcen-Zugriffsrechte verwalten

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
query Parameters
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:
  • processName[eq]=Example - Suche nach einem Wert gleich „Example“.
  • processName[strtw]=Exa - Suche nach einem Wert, der mit „Exa“ beginnt.
  • processName[gte]=Ex&processName[lte]=F - Alphanumerische Suche nach einem Wert zwischen „Ex“ und „F“.
  • processName[gte]=Example - Alphanumerische Suche nach einem Wert nach oder gleich „Beispiel“.

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:
  • sessionNumber[eq]=Example - Suche nach einem Wert gleich „Example“.
  • sessionNumber[strtw]=Exa - Suche nach einem Wert, der mit „Exa“ beginnt.
  • sessionNumber[gte]=Ex&sessionNumber[lte]=F - Alphanumerische Suche nach einem Wert zwischen „Ex“ und „F“.
  • sessionNumber[gte]=Example - Alphanumerische Suche nach einem Wert nach oder gleich „Beispiel“.

Ein Filter zur Suche nach der Sitzungsnummer.

(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter)
Examples:
  • resourceName[eq]=Example - Suche nach einem Wert gleich „Example“.
  • resourceName[strtw]=Exa - Suche nach einem Wert, der mit „Exa“ beginnt.
  • resourceName[gte]=Ex&resourceName[lte]=F - Alphanumerische Suche nach einem Wert zwischen „Ex“ und „F“.
  • resourceName[gte]=Example - Alphanumerische Suche nach einem Wert nach oder gleich „Beispiel“.

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:
  • userName[eq]=Example - Suche nach einem Wert gleich „Example“.
  • userName[strtw]=Exa - Suche nach einem Wert, der mit „Exa“ beginnt.
  • userName[gte]=Ex&userName[lte]=F - Alphanumerische Suche nach einem Wert zwischen „Ex“ und „F“.
  • userName[gte]=Example - Alphanumerische Suche nach einem Wert nach oder gleich „Beispiel“.

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:
  • startTime[eq]=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht.
  • startTime[gte]=2020-10-02T12:34:56+01:00&startTime[lte]=2020-11-02T12:34:56+01:00 - Suche nach einem Wert zwischen 2020-10-02 um 12:34:56 (GMT+1) und 2020-11-02 um 12:34:56 (GMT+1) (inklusive).
  • startTime[gte]=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht oder danach liegt.

Ein Filter zur Suche nach der Zeit, zu der die Sitzung gestartet wurde.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • endTime[eq]=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht.
  • endTime[gte]=2020-10-02T12:34:56+01:00&endTime[lte]=2020-11-02T12:34:56+01:00 - Suche nach einem Wert zwischen 2020-10-02 um 12:34:56 (GMT+1) und 2020-11-02 um 12:34:56 (GMT+1) (inklusive).
  • endTime[gte]=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht oder danach liegt.

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:
  • latestStage[eq]=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht.
  • latestStage[gte]=2020-10-02T12:34:56+01:00&latestStage[lte]=2020-11-02T12:34:56+01:00 - Suche nach einem Wert zwischen 2020-10-02 um 12:34:56 (GMT+1) und 2020-11-02 um 12:34:56 (GMT+1) (inklusive).
  • latestStage[gte]=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht oder danach liegt.

Ein Filter zur Suche nach dem Namen der letzten Phase.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • stageStarted[eq]=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht.
  • stageStarted[gte]=2020-10-02T12:34:56+01:00&stageStarted[lte]=2020-11-02T12:34:56+01:00 - Suche nach einem Wert zwischen 2020-10-02 um 12:34:56 (GMT+1) und 2020-11-02 um 12:34:56 (GMT+1) (inklusive).
  • stageStarted[gte]=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht oder danach liegt.

Ein Filter zur Suche nach der Zeit, zu der die letzte Phase begonnen hat

Responses

Response samples

Content type
application/json
{
  • "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
  • "items": [
    ]
}

Details einer bestimmten Sitzung abrufen

Permissions required

At least one of: Prozess erstellen | Prozess löschen | Prozess bearbeiten | Prozessgruppen bearbeiten | Prozess exportieren | Prozess ausführen | Prozess als Webdienst ausführen | Prozessdefinition anzeigen | Prozess-Zugriffsrechte verwalten

And at least one of: Ressource anzeigen | Ressourcen-Bildschirmaufnahmen anzeigen | Ressource konfigurieren | Ressource steuern | Ressourcen-Zugriffsrechte verwalten

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
sessionId
required
string <uuid>

Die ID der Sitzung, für die Daten abgerufen werden sollen

Responses

Response samples

Content type
application/json
{
  • "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"
}

Rückgabe aller Logs für eine angegebene Sitzung

Permissions required

At least one of: Prozess erstellen | Prozess löschen | Prozess bearbeiten | Prozessgruppen bearbeiten | Prozess exportieren | Prozess ausführen | Prozess als Webdienst ausführen | Prozessdefinition anzeigen | Prozess-Zugriffsrechte verwalten

And at least one of: Ressource anzeigen | Ressourcen-Bildschirmaufnahmen anzeigen | Ressource konfigurieren | Ressource steuern | Ressourcen-Zugriffsrechte verwalten

und Audit – Prozess-Logs

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
sessionId
required
string <uuid>

Die ID der Sitzung, für die Daten abgerufen werden sollen

query Parameters
itemsPerPage
integer >= 1

Die maximale Anzahl der abzurufenden Elemente

pagingToken
string

Das Token, das auf das letzte zuvor zurückgegebene Element verweist

Responses

Response samples

Content type
application/json
{
  • "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
  • "items": [
    ]
}

Rückgabe aller Parameter für das angegebene Sitzungslog

Permissions required

At least one of: Prozess erstellen | Prozess löschen | Prozess bearbeiten | Prozessgruppen bearbeiten | Prozess exportieren | Prozess ausführen | Prozess als Webdienst ausführen | Prozessdefinition anzeigen | Prozess-Zugriffsrechte verwalten

And at least one of: Ressource anzeigen | Ressourcen-Bildschirmaufnahmen anzeigen | Ressource konfigurieren | Ressource steuern | Ressourcen-Zugriffsrechte verwalten

und Audit – Prozess-Logs

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
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

Responses

Response samples

Content type
application/json
{
  • "inputs": {
    },
  • "outputs": {
    }
}

Arbeitswarteschlangen

Rückgabe einer Liste der Arbeitswarteschlangen in der Umgebung

Permissions required

At least one of: Lesezugriff auf Warteschlangenmanagement | Vollständiger Zugriff auf Warteschlangenmanagement

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
query Parameters
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:
  • name[eq]=Example - Suche nach einem Wert gleich „Example“.
  • name[strtw]=Exa - Suche nach einem Wert, der mit „Exa“ beginnt.
  • name[ctn]=amp - Suche nach einem Wert, der „amp“ enthält
  • name[gte]=Ex&name[lte]=F - Alphanumerische Suche nach einem Wert zwischen „Ex“ und „F“.
  • name[gte]=Example - Alphanumerische Suche nach einem Wert nach oder gleich „Beispiel“.

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:
  • keyField[eq]=Example - Suche nach einem Wert gleich „Example“.
  • keyField[strtw]=Exa - Suche nach einem Wert, der mit „Exa“ beginnt.
  • keyField[ctn]=amp - Suche nach einem Wert, der „amp“ enthält
  • keyField[gte]=Ex&keyField[lte]=F - Alphanumerische Suche nach einem Wert zwischen „Ex“ und „F“.
  • keyField[gte]=Example - Alphanumerische Suche nach einem Wert nach oder gleich „Beispiel“.

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:
  • eq=123 - Suche nach einem Wert gleich 123.
  • gte=123&lte=321 - Suche nach einem Wert zwischen 123 und 321, inklusive.
  • lte=123 - Suche nach einem Wert kleiner oder gleich 123.

Ein Filter zur Suche nach den konfigurierten maximalen Versuchen der Arbeitswarteschlange.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Suche nach einem Wert gleich 123.
  • gte=123&lte=321 - Suche nach einem Wert zwischen 123 und 321, inklusive.
  • lte=123 - Suche nach einem Wert kleiner oder gleich 123.

Ein Filter zur Suche nach der Anzahl ausstehender Elemente der Arbeitswarteschlange.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Suche nach einem Wert gleich 123.
  • gte=123&lte=321 - Suche nach einem Wert zwischen 123 und 321, inklusive.
  • lte=123 - Suche nach einem Wert kleiner oder gleich 123.

Ein Filter zur Suche nach der Anzahl gesperrter Elemente der Arbeitswarteschlange.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Suche nach einem Wert gleich 123.
  • gte=123&lte=321 - Suche nach einem Wert zwischen 123 und 321, inklusive.
  • lte=123 - Suche nach einem Wert kleiner oder gleich 123.

Ein Filter zur Suche nach der Anzahl abgeschlossener Elemente der Arbeitswarteschlange.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Suche nach einem Wert gleich 123.
  • gte=123&lte=321 - Suche nach einem Wert zwischen 123 und 321, inklusive.
  • lte=123 - Suche nach einem Wert kleiner oder gleich 123.

Ein Filter zur Suche nach der Anzahl von Elementen mit Ausnahmen der Arbeitswarteschlange.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Suche nach einem Wert gleich 123.
  • gte=123&lte=321 - Suche nach einem Wert zwischen 123 und 321, inklusive.
  • lte=123 - Suche nach einem Wert kleiner oder gleich 123.

Ein Filter zur Suche nach der Gesamtzahl der Elemente der Arbeitswarteschlange.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=12:34:56 - Suche nach einem Wert gleich 12:34:56.
  • gte=01:23:45&lte=12:34:56 - Suche nach einem Wert zwischen 01:23:45 und 12:34:56 (inklusive)
  • lte=12:34:56 - Suche nach einem Wert kleiner oder gleich 12:34:56

Ein Filter zur Suche nach der durchschnittlichen Arbeitszeit der Arbeitswarteschlange.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=12:34:56 - Suche nach einem Wert gleich 12:34:56.
  • gte=01:23:45&lte=12:34:56 - Suche nach einem Wert zwischen 01:23:45 und 12:34:56 (inklusive)
  • lte=12:34:56 - Suche nach einem Wert kleiner oder gleich 12:34:56

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

Responses

Response samples

Content type
application/json
{
  • "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
  • "items": [
    ]
}

Erstellen einer neuen Arbeitswarteschlange

Permissions required: Workflow – Arbeitswarteschlangenkonfiguration

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "name": "Example queue",
  • "keyField": "Example field",
  • "maxAttempts": 3,
  • "status": "Running",
  • "encryptionKeyId": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Rückgabe von Details einer Arbeitswarteschlange

Permissions required

At least one of: Lesezugriff auf Warteschlangenmanagement | Vollständiger Zugriff auf Warteschlangenmanagement

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
workQueueId
required
string <uuid>

Die ID der Warteschlange, für die Details abgerufen werden sollen

Responses

Response samples

Content type
application/json
{
  • "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"
}

Ändern der angegebenen Arbeitswarteschlange wie im Patch-Dokument beschrieben

Permissions required

At least one of: Lesezugriff auf Warteschlangenmanagement | Vollständiger Zugriff auf Warteschlangenmanagement
und Workflow – Arbeitswarteschlangenkonfiguration

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
workQueueId
required
string <uuid>

Die ID der zu ändernden Warteschlange

Request Body schema: application/json
Array
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.

Responses

Request samples

Content type
application/json
Example
Einer Sammlung Werte hinzufügen.
Einer Sammlung Werte hinzufügen.
Einem Objekt neue Eigenschaftswerte hinzufügen.
Einen Wert von einer Eigenschaft zu einer anderen kopieren.
Einen Wert von einer Eigenschaft zu einer anderen verschieben.
Einen Eigenschaftswert entfernen.
Den Wert in einer Eigenschaft ersetzen.
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "invalidField": "string",
  • "message": "string"
}

Löscht eine angegebene Arbeitswarteschlange

Permissions required: Workflow – Arbeitswarteschlangenkonfiguration

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
workQueueId
required
string <uuid>

Die ID der zu löschenden Warteschlange

Responses

Response samples

Content type
application/json
{
  • "invalidField": "string",
  • "message": "string"
}

Rückgabe von Elementen in der angegebenen Arbeitswarteschlange

Permissions required

At least one of: Lesezugriff auf Warteschlangenmanagement | Vollständiger Zugriff auf Warteschlangenmanagement

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
workQueueId
required
string <uuid>

Die ID der Warteschlange, aus der ein Element abgerufen werden soll

query Parameters
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:
  • eq=Example - Suche nach einem Wert gleich „Example“.
  • strtw=Exa - Suche nach einem Wert, der mit „Exa“ beginnt.
  • ctn=amp - Suche nach einem Wert, der „amp“ enthält
  • gte=Ex&lte=F - Alphanumerische Suche nach einem Wert zwischen „Ex“ und „F“.
  • gte=Example - Alphanumerische Suche nach einem Wert nach oder gleich „Beispiel“.

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:
  • eq=Example - Suche nach einem Wert gleich „Example“.
  • strtw=Exa - Suche nach einem Wert, der mit „Exa“ beginnt.
  • ctn=amp - Suche nach einem Wert, der „amp“ enthält
  • gte=Ex&lte=F - Alphanumerische Suche nach einem Wert zwischen „Ex“ und „F“.
  • gte=Example - Alphanumerische Suche nach einem Wert nach oder gleich „Beispiel“.

Ein Filter zur Suche nach dem Status des Arbeitswarteschlangenelements.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=12:34:56 - Suche nach einem Wert gleich 12:34:56.
  • gte=01:23:45&lte=12:34:56 - Suche nach einem Wert zwischen 01:23:45 und 12:34:56 (inklusive)
  • lte=12:34:56 - Suche nach einem Wert kleiner oder gleich 12:34:56

Ein Filter zur Suche nach der Gesamtarbeitszeit des Arbeitswarteschlangenelements.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht.
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - Suche nach einem Wert zwischen 2020-10-02 um 12:34:56 (GMT+1) und 2020-11-02 um 12:34:56 (GMT+1) (inklusive).
  • gte=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht oder danach liegt.

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:
  • eq=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht.
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - Suche nach einem Wert zwischen 2020-10-02 um 12:34:56 (GMT+1) und 2020-11-02 um 12:34:56 (GMT+1) (inklusive).
  • gte=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht oder danach liegt.

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:
  • eq=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht.
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - Suche nach einem Wert zwischen 2020-10-02 um 12:34:56 (GMT+1) und 2020-11-02 um 12:34:56 (GMT+1) (inklusive).
  • gte=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht oder danach liegt.

Ein Filter zur Suche nach der Zeit, zu der das Arbeitswarteschlangenelement gesperrt wurde.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht.
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - Suche nach einem Wert zwischen 2020-10-02 um 12:34:56 (GMT+1) und 2020-11-02 um 12:34:56 (GMT+1) (inklusive).
  • gte=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht oder danach liegt.

Ein Filter zur Suche nach der Zeit, zu der das Arbeitswarteschlangenelement abgeschlossen wurde.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht.
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - Suche nach einem Wert zwischen 2020-10-02 um 12:34:56 (GMT+1) und 2020-11-02 um 12:34:56 (GMT+1) (inklusive).
  • gte=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht oder danach liegt.

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:
  • eq=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht.
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - Suche nach einem Wert zwischen 2020-10-02 um 12:34:56 (GMT+1) und 2020-11-02 um 12:34:56 (GMT+1) (inklusive).
  • gte=2020-10-02T12:34:56+01:00 - Suche nach einem Wert, der 2020-10-02 um 12:34:56 (GMT+1) entspricht oder danach liegt.

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:
  • eq=123 - Suche nach einem Wert gleich 123.
  • gte=123&lte=321 - Suche nach einem Wert zwischen 123 und 321, inklusive.
  • lte=123 - Suche nach einem Wert kleiner oder gleich 123.

Ein Filter zur Suche nach der aktuellen Versuchsnummer des Arbeitswarteschlangenelements.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Suche nach einem Wert gleich 123.
  • gte=123&lte=321 - Suche nach einem Wert zwischen 123 und 321, inklusive.
  • lte=123 - Suche nach einem Wert kleiner oder gleich 123.

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:
  • eq=Example - Suche nach einem Wert gleich „Example“.
  • ctn=amp - Suche nach einem Wert, der „amp“ enthält
  • strtw=Exa - Suche nach einem Wert, der mit „Exa“ beginnt.
  • gte=Ex&lte=F - Alphanumerische Suche nach einem Wert zwischen „Ex“ und „F“.
  • gte=Example - Alphanumerische Suche nach einem Wert nach oder gleich „Beispiel“.

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

Responses

Response samples

Content type
application/json
{
  • "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
  • "items": [
    ]
}

Elemente zu einer Warteschlange hinzufügen

Permissions required: Vollständiger Zugriff auf Warteschlangenmanagement

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
workQueueId
required
string <uuid>

Die ID der Warteschlange, in die eingefügt werden soll

Request Body schema: application/json

Details der zu erstellenden Warteschlangenelementen

Array
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

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": [
    ]
}

Gibt Details zu einem angegebenen Element in einer Arbeitswarteschlange zurück

Permissions required

At least one of: Lesezugriff auf Warteschlangenmanagement | Vollständiger Zugriff auf Warteschlangenmanagement

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
workQueueItemId
required
string <uuid>

Die ID des abzurufenden Elements

Responses

Response samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "priority": 3,
  • "ident": 123,
  • "state": "Completed",
  • "keyValue": "Example value",
  • "status": "Example status",
  • "tags": [
    ],
  • "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": {
    }
}