Documentation Powered by ReDoc

API Blue Prism (7.0.0)

Download OpenAPI specification:Download

API pour afficher les fonctionnalités principales du produit Blue Prism

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

Authentication

Bearer

Jeton JWT émis à partir d'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

Tableaux de bord

Renvoyer les données de file d'attente de travaux agrégées pour chacune des files d'attente demandées

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

Ensemble des ID de file d'attente de travaux pour lesquels récupérer les données.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Renvoyer l'utilisation des ressources d'exécution

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

Date de début

resourceIds
Array of strings <uuid>

Ensemble des ID de ressource à filtrer.

pageNumber
integer

Paramètre de numéro de page utilisé pour la pagination des données de la carte thermique d'utilisation.

pageSize
integer

Paramètre de taille de page utilisé pour la pagination des données de la carte thermique d'utilisation.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Renvoyer le résumé de l'utilisation des ressources d'exécution par plage de dates

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

Date de début

endDate
required
string <date-time>

Date de fin

resourceIds
Array of strings <uuid>

ID de ressource à filtrer.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Schémas de cryptage

Renvoyer la liste des schémas de cryptage dans l'environnement

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Ressources

Renvoyer la liste des ressources dans l'environnement

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 - Rechercher une valeur égale à « Example ».
  • name[strtw]=Exa - Rechercher une valeur commençant par « Exa ».
  • name[gte]=Ex&name[lte]=F - Rechercher une valeur alphanumérique entre « Ex » et « F ».
  • name[gte]=Example - Rechercher une valeur alphanumérique après ou égale à « Example ».

Filtre pour rechercher le nom de la ressource.

(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter)
Examples:
  • groupName[eq]=Example - Rechercher une valeur égale à « Example ».
  • groupName[strtw]=Exa - Rechercher une valeur commençant par « Exa ».
  • groupName[gte]=Ex&groupName[lte]=F - Rechercher une valeur alphanumérique entre « Ex » et « F ».
  • groupName[gte]=Example - Rechercher une valeur alphanumérique après ou égale à « Example ».

Filtre pour rechercher le nom du groupe de la ressource.

(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter)
Examples:
  • poolName[eq]=Example - Rechercher une valeur égale à « Example ».
  • poolName[strtw]=Exa - Rechercher une valeur commençant par « Exa ».
  • poolName[gte]=Ex&poolName[lte]=F - Rechercher une valeur alphanumérique entre « Ex » et « F ».
  • poolName[gte]=Example - Rechercher une valeur alphanumérique après ou égale à « Example ».

Filtre pour rechercher le nom du pool de la ressource.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • activeSessionCount[eq]=123 - Rechercher une valeur égale à 123.
  • activeSessionCount[gte]=123&activeSessionCount[lte]=321 - Rechercher une valeur comprise entre 123 et 321 inclus.
  • activeSessionCount[lte]=123 - Rechercher une valeur inférieure ou égale à 123.

Filtre pour rechercher le nombre de sessions actives de la ressource.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • pendingSessionCount[eq]=123 - Rechercher une valeur égale à 123.
  • pendingSessionCount[gte]=123&pendingSessionCount[lte]=321 - Rechercher une valeur comprise entre 123 et 321 inclus.
  • pendingSessionCount[lte]=123 - Rechercher une valeur inférieure ou égale à 123.

Filtre pour rechercher le nombre de sessions en attente de la ressource.

displayStatus
Array of strings
Items Enum: "Working" "Idle" "Warning" "Offline" "Missing" "LoggedOut" "Private"

Filtre pour rechercher le statut actuel de la ressource.

sortBy
string
Enum: "NameAsc" "NameDesc" "PoolAsc" "PoolDesc" "GroupAsc" "GroupDesc" "PendingAsc" "PendingDesc" "ActiveAsc" "ActiveDesc" "DisplayStatusAsc" "DisplayStatusDesc"

Champ selon lequel les résultats doivent être triés et ordre dans lequel ils doivent être triés.

itemsPerPage
integer >= 1

Nombre maximal d'éléments à récupérer sur cette page.

pagingToken
string

Jeton à pointer vers le dernier élément renvoyé précédemment.

Responses

Response samples

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

Plannings

Renvoyer la liste des plannings dans l'environnement

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 - Rechercher une valeur égale à « Example ».
  • name[strtw]=Exa - Rechercher une valeur commençant par « Exa ».
  • name[gte]=Ex&name[lte]=F - Rechercher une valeur alphanumérique entre « Ex » et « F ».
  • name[gte]=Example - Rechercher une valeur alphanumérique après ou égale à « Example ».

Filtre pour rechercher le nom du planning.

retirementStatus
Array of strings
Items Enum: "Active" "Retired"

Filtre pour rechercher le statut de classement du planning. Le comportement par défaut consiste à rechercher tous les statuts.

itemsPerPage
integer >= 1

Nombre maximal d'éléments à récupérer

pagingToken
string

Jeton à pointer vers le dernier élément renvoyé précédemment

Responses

Response samples

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

Mettre à jour un planning donné

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

ID du planning à mettre à jour

Request Body schema: application/json
isRetired
boolean

Nouvelle valeur pour le statut de classement du planning

Responses

Request samples

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

Response samples

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

Renvoyer tous les logs de plannings

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
query Parameters
itemsPerPage
integer

Nombre d'éléments à afficher par page

scheduleLogStatus
Array of strings
Items Enum: "Pending" "Running" "Terminated" "Completed" "PartExceptioned"

Filtre pour rechercher le statut du log.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • startTime[eq]=2020-10-02T12:34:56+01:00 - Rechercher une valeur égale à 2020-10-02 à 12:34:56 (GMT+1).
  • startTime[gte]=2020-10-02T12:34:56+01:00&startTime[lte]=2020-11-02T12:34:56+01:00 - Rechercher une valeur comprise entre 2020-10-02 à 12:34:56 (GMT+1) et 2020-11-02 à 12:34:56 (GMT+1) (inclus).
  • startTime[gte]=2020-10-02T12:34:56+01:00 - Rechercher une valeur ultérieure ou égale à 2020-10-02 à 12:34:56 (GMT+1).

Filtre pour rechercher l'heure de début du log.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • endTime[eq]=2020-10-02T12:34:56+01:00 - Rechercher une valeur égale à 2020-10-02 à 12:34:56 (GMT+1).
  • endTime[gte]=2020-10-02T12:34:56+01:00&endTime[lte]=2020-11-02T12:34:56+01:00 - Rechercher une valeur comprise entre 2020-10-02 à 12:34:56 (GMT+1) et 2020-11-02 à 12:34:56 (GMT+1) (inclus).
  • endTime[gte]=2020-10-02T12:34:56+01:00 - Rechercher une valeur ultérieure ou égale à 2020-10-02 à 12:34:56 (GMT+1).

Filtre pour rechercher l'heure de fin du log.

pagingToken
string

Jeton à pointer vers le dernier élément renvoyé précédemment

Responses

Response samples

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

Renvoyer tous les logs d'un planning spécifié

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

ID du planning pour lequel récupérer les données

query Parameters
itemsPerPage
integer

Nombre d'éléments à afficher par page

scheduleLogStatus
Array of strings
Items Enum: "Pending" "Running" "Terminated" "Completed" "PartExceptioned"

Filtre pour rechercher le statut du log.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • startTime[eq]=2020-10-02T12:34:56+01:00 - Rechercher une valeur égale à 2020-10-02 à 12:34:56 (GMT+1).
  • startTime[gte]=2020-10-02T12:34:56+01:00&startTime[lte]=2020-11-02T12:34:56+01:00 - Rechercher une valeur comprise entre 2020-10-02 à 12:34:56 (GMT+1) et 2020-11-02 à 12:34:56 (GMT+1) (inclus).
  • startTime[gte]=2020-10-02T12:34:56+01:00 - Rechercher une valeur ultérieure ou égale à 2020-10-02 à 12:34:56 (GMT+1).

Filtre pour rechercher l'heure de début du log.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • endTime[eq]=2020-10-02T12:34:56+01:00 - Rechercher une valeur égale à 2020-10-02 à 12:34:56 (GMT+1).
  • endTime[gte]=2020-10-02T12:34:56+01:00&endTime[lte]=2020-11-02T12:34:56+01:00 - Rechercher une valeur comprise entre 2020-10-02 à 12:34:56 (GMT+1) et 2020-11-02 à 12:34:56 (GMT+1) (inclus).
  • endTime[gte]=2020-10-02T12:34:56+01:00 - Rechercher une valeur ultérieure ou égale à 2020-10-02 à 12:34:56 (GMT+1).

Filtre pour rechercher l'heure de fin du log.

pagingToken
string

Jeton à pointer vers le dernier élément renvoyé précédemment

Responses

Response samples

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

Définir l'exécution d'un planning à une date et une heure spécifiques

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

ID du planning à démarrer

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

Date et heure auxquelles le planning doit être exécuté

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"
}

Récupérer la liste de tâches dans un planning

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

ID du planning pour lequel récupérer les tâches

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Renvoyer la liste des sessions planifiées pour une tâche spécifiée

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

ID de la tâche pour laquelle récupérer les données

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sessions

Renvoyer la liste des sessions dans l'environnement

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"

Champ selon lequel les résultats doivent être triés et ordre dans lequel ils doivent être triés.

itemsPerPage
integer >= 1

Nombre maximal d'éléments à récupérer.

pagingToken
string

Jeton à pointer vers le dernier élément renvoyé précédemment.

(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter)
Examples:
  • processName[eq]=Example - Rechercher une valeur égale à « Example ».
  • processName[strtw]=Exa - Rechercher une valeur commençant par « Exa ».
  • processName[gte]=Ex&processName[lte]=F - Rechercher une valeur alphanumérique entre « Ex » et « F ».
  • processName[gte]=Example - Rechercher une valeur alphanumérique après ou égale à « Example ».

Filtre pour rechercher le nom du processus exécuté par la session.

(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter)
Examples:
  • sessionNumber[eq]=Example - Rechercher une valeur égale à « Example ».
  • sessionNumber[strtw]=Exa - Rechercher une valeur commençant par « Exa ».
  • sessionNumber[gte]=Ex&sessionNumber[lte]=F - Rechercher une valeur alphanumérique entre « Ex » et « F ».
  • sessionNumber[gte]=Example - Rechercher une valeur alphanumérique après ou égale à « Example ».

Filtre pour rechercher le numéro de session.

(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter)
Examples:
  • resourceName[eq]=Example - Rechercher une valeur égale à « Example ».
  • resourceName[strtw]=Exa - Rechercher une valeur commençant par « Exa ».
  • resourceName[gte]=Ex&resourceName[lte]=F - Rechercher une valeur alphanumérique entre « Ex » et « F ».
  • resourceName[gte]=Example - Rechercher une valeur alphanumérique après ou égale à « Example ».

Filtre pour rechercher le nom de la ressource sur laquelle la session est en cours d'exécution/a été exécutée.

(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter)
Examples:
  • userName[eq]=Example - Rechercher une valeur égale à « Example ».
  • userName[strtw]=Exa - Rechercher une valeur commençant par « Exa ».
  • userName[gte]=Ex&userName[lte]=F - Rechercher une valeur alphanumérique entre « Ex » et « F ».
  • userName[gte]=Example - Rechercher une valeur alphanumérique après ou égale à « Example ».

Filtre pour rechercher le nom de l'utilisateur qui a déclenché la session.

status
Array of strings
Items Enum: "Pending" "Running" "Terminated" "Stopped" "Completed" "Stopping" "Warning"

Statut des sessions à rechercher.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • startTime[eq]=2020-10-02T12:34:56+01:00 - Rechercher une valeur égale à 2020-10-02 à 12:34:56 (GMT+1).
  • startTime[gte]=2020-10-02T12:34:56+01:00&startTime[lte]=2020-11-02T12:34:56+01:00 - Rechercher une valeur comprise entre 2020-10-02 à 12:34:56 (GMT+1) et 2020-11-02 à 12:34:56 (GMT+1) (inclus).
  • startTime[gte]=2020-10-02T12:34:56+01:00 - Rechercher une valeur ultérieure ou égale à 2020-10-02 à 12:34:56 (GMT+1).

Filtre pour rechercher l'heure à laquelle la session a démarré.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • endTime[eq]=2020-10-02T12:34:56+01:00 - Rechercher une valeur égale à 2020-10-02 à 12:34:56 (GMT+1).
  • endTime[gte]=2020-10-02T12:34:56+01:00&endTime[lte]=2020-11-02T12:34:56+01:00 - Rechercher une valeur comprise entre 2020-10-02 à 12:34:56 (GMT+1) et 2020-11-02 à 12:34:56 (GMT+1) (inclus).
  • endTime[gte]=2020-10-02T12:34:56+01:00 - Rechercher une valeur ultérieure ou égale à 2020-10-02 à 12:34:56 (GMT+1).

Filtre pour rechercher l'heure à laquelle la session s'est terminée.

(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter)
Examples:
  • latestStage[eq]=2020-10-02T12:34:56+01:00 - Rechercher une valeur égale à 2020-10-02 à 12:34:56 (GMT+1).
  • latestStage[gte]=2020-10-02T12:34:56+01:00&latestStage[lte]=2020-11-02T12:34:56+01:00 - Rechercher une valeur comprise entre 2020-10-02 à 12:34:56 (GMT+1) et 2020-11-02 à 12:34:56 (GMT+1) (inclus).
  • latestStage[gte]=2020-10-02T12:34:56+01:00 - Rechercher une valeur ultérieure ou égale à 2020-10-02 à 12:34:56 (GMT+1).

Filtre pour rechercher le nom de la dernière étape.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • stageStarted[eq]=2020-10-02T12:34:56+01:00 - Rechercher une valeur égale à 2020-10-02 à 12:34:56 (GMT+1).
  • stageStarted[gte]=2020-10-02T12:34:56+01:00&stageStarted[lte]=2020-11-02T12:34:56+01:00 - Rechercher une valeur comprise entre 2020-10-02 à 12:34:56 (GMT+1) et 2020-11-02 à 12:34:56 (GMT+1) (inclus).
  • stageStarted[gte]=2020-10-02T12:34:56+01:00 - Rechercher une valeur ultérieure ou égale à 2020-10-02 à 12:34:56 (GMT+1).

Filtre pour rechercher l'heure à laquelle la dernière étape a démarré.

Responses

Response samples

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

Obtenir les détails d'une session spécifiée

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

ID de la session pour laquelle récupérer les données

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"
}

Renvoyer tous les logs d'une session spécifiée

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

ID de la session pour laquelle récupérer les données

query Parameters
itemsPerPage
integer >= 1

Nombre maximal d'éléments à récupérer

pagingToken
string

Jeton à pointer vers le dernier élément renvoyé précédemment

Responses

Response samples

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

Renvoyer tous les paramètres d'un log de session spécifié

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

ID de la session pour laquelle récupérer les données

logId
required
integer >= 1

ID du log à récupérer pour la session

Responses

Response samples

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

Files d'attente de travaux

Renvoyer la liste des files d'attente de travaux dans l'environnement

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"

Champ selon lequel les résultats doivent être triés et ordre dans lequel ils doivent être triés.

(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter)
Examples:
  • name[eq]=Example - Rechercher une valeur égale à « Example ».
  • name[strtw]=Exa - Rechercher une valeur commençant par « Exa ».
  • name[ctn]=amp - Rechercher une valeur contenant « amp »
  • name[gte]=Ex&name[lte]=F - Rechercher une valeur alphanumérique entre « Ex » et « F ».
  • name[gte]=Example - Rechercher une valeur alphanumérique après ou égale à « Example ».

Filtre pour rechercher le nom de la file d'attente de travaux.

(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter)
Examples:
  • keyField[eq]=Example - Rechercher une valeur égale à « Example ».
  • keyField[strtw]=Exa - Rechercher une valeur commençant par « Exa ».
  • keyField[ctn]=amp - Rechercher une valeur contenant « amp »
  • keyField[gte]=Ex&keyField[lte]=F - Rechercher une valeur alphanumérique entre « Ex » et « F ».
  • keyField[gte]=Example - Rechercher une valeur alphanumérique après ou égale à « Example ».

Filtre pour rechercher le nom du champ de clé de la file d'attente de travaux.

status.eq
string (QueueStatus)
Enum: "Running" "Paused"

Filtre pour rechercher le statut actuel de la file d'attente de travaux.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Rechercher une valeur égale à 123.
  • gte=123&lte=321 - Rechercher une valeur comprise entre 123 et 321 inclus.
  • lte=123 - Rechercher une valeur inférieure ou égale à 123.

Filtre pour rechercher le nombre maximum de tentatives configuré de la file d'attente de travaux.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Rechercher une valeur égale à 123.
  • gte=123&lte=321 - Rechercher une valeur comprise entre 123 et 321 inclus.
  • lte=123 - Rechercher une valeur inférieure ou égale à 123.

Filtre pour rechercher le nombre d'éléments en attente de la file d'attente de travaux.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Rechercher une valeur égale à 123.
  • gte=123&lte=321 - Rechercher une valeur comprise entre 123 et 321 inclus.
  • lte=123 - Rechercher une valeur inférieure ou égale à 123.

Filtre pour rechercher le nombre d'éléments verrouillés de la file d'attente de travaux.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Rechercher une valeur égale à 123.
  • gte=123&lte=321 - Rechercher une valeur comprise entre 123 et 321 inclus.
  • lte=123 - Rechercher une valeur inférieure ou égale à 123.

Filtre pour rechercher le nombre d'éléments terminés de la file d'attente de travaux.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Rechercher une valeur égale à 123.
  • gte=123&lte=321 - Rechercher une valeur comprise entre 123 et 321 inclus.
  • lte=123 - Rechercher une valeur inférieure ou égale à 123.

Filtre pour rechercher le nombre d'éléments avec exception de la file d'attente de travaux.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Rechercher une valeur égale à 123.
  • gte=123&lte=321 - Rechercher une valeur comprise entre 123 et 321 inclus.
  • lte=123 - Rechercher une valeur inférieure ou égale à 123.

Filtre pour rechercher le nombre total d'éléments de la file d'attente de travaux.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=12:34:56 - Rechercher une valeur égale à 12:34:56.
  • gte=01:23:45&lte=12:34:56 - Rechercher une valeur comprise entre 01:23:45 et 12:34:56 (inclus)
  • lte=12:34:56 - Rechercher une valeur antérieure ou égale à 12:34:56

Filtre pour rechercher le temps moyen de travail de la file d'attente de travaux.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=12:34:56 - Rechercher une valeur égale à 12:34:56.
  • gte=01:23:45&lte=12:34:56 - Rechercher une valeur comprise entre 01:23:45 et 12:34:56 (inclus)
  • lte=12:34:56 - Rechercher une valeur antérieure ou égale à 12:34:56

Filtre pour rechercher la durée totale des cas de la file d'attente de travaux.

itemsPerPage
integer >= 1

Nombre maximal d'éléments à renvoyer sur la page actuelle.

pagingToken
string

Jeton à pointer vers le dernier élément renvoyé précédemment

Responses

Response samples

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

Créer une file d'attente de travaux

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

Détails de la file d'attente à créer

name
string [ 1 .. 255 ] characters

Nom de la file d'attente à créer

keyField
string [ 0 .. 255 ] characters

Nom de la colonne à utiliser comme clé de la file d'attente

maxAttempts
integer [ 1 .. 999999 ]

Nombre maximal de nouvelles tentatives pour les éléments dans la file d'attente

status
string (QueueStatus)
Enum: "Running" "Paused"

Statut actuel de la file d'attente.

encryptionKeyId
integer

ID de la clé de chiffrement à utiliser pour la file d'attente. Si aucun chiffrement n'est requis, ce champ doit être 0.

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"
}

Renvoyer les détails d'une file d'attente de travaux

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

ID de la file d'attente pour laquelle récupérer les détails

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"
}

Modifier la file d'attente de travaux comme décrit dans le document de correctif

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

ID de la file d'attente à modifier

Request Body schema: application/json
Array
op
required
string
Enum: "add" "remove" "replace" "move" "copy" "test"

Opération à effectuer

path
required
string

Pointeur JSON

value
object

Valeur à utiliser dans les opérations.

from
string

Chaîne contenant une valeur de pointeur JSON.

Responses

Request samples

Content type
application/json
Example
Ajouter des valeurs à une collection.
Ajouter des valeurs à une collection.
Ajouter de nouvelles valeurs de propriété à un objet.
Copier une valeur d'une propriété à une autre.
Déplacer une valeur d'une propriété à une autre.
Supprimer une valeur de propriété.
Remplacer la valeur dans une propriété.
[
  • {
    }
]

Response samples

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

Supprimer une file d'attente de travaux spécifiée

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

ID de la file d'attente à supprimer

Responses

Response samples

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

Renvoyer les éléments dans une file d'attente de travaux spécifiée

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

ID de la file d'attente à partir de laquelle obtenir un élément

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"

Champ selon lequel les résultats doivent être triés et ordre dans lequel ils doivent être triés.

(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter)
Examples:
  • eq=Example - Rechercher une valeur égale à « Example ».
  • strtw=Exa - Rechercher une valeur commençant par « Exa ».
  • ctn=amp - Rechercher une valeur contenant « amp »
  • gte=Ex&lte=F - Rechercher une valeur alphanumérique entre « Ex » et « F ».
  • gte=Example - Rechercher une valeur alphanumérique après ou égale à « Example ».

Filtre pour rechercher la valeur du champ de clé de l'élément de la file d'attente de travaux.

(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter)
Examples:
  • eq=Example - Rechercher une valeur égale à « Example ».
  • strtw=Exa - Rechercher une valeur commençant par « Exa ».
  • ctn=amp - Rechercher une valeur contenant « amp »
  • gte=Ex&lte=F - Rechercher une valeur alphanumérique entre « Ex » et « F ».
  • gte=Example - Rechercher une valeur alphanumérique après ou égale à « Example ».

Filtre pour rechercher le statut de l'élément de la file d'attente de travaux.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=12:34:56 - Rechercher une valeur égale à 12:34:56.
  • gte=01:23:45&lte=12:34:56 - Rechercher une valeur comprise entre 01:23:45 et 12:34:56 (inclus)
  • lte=12:34:56 - Rechercher une valeur antérieure ou égale à 12:34:56

Filtre pour rechercher le temps total de travail de l'élément de la file d'attente de travaux.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=2020-10-02T12:34:56+01:00 - Rechercher une valeur égale à 2020-10-02 à 12:34:56 (GMT+1).
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - Rechercher une valeur comprise entre 2020-10-02 à 12:34:56 (GMT+1) et 2020-11-02 à 12:34:56 (GMT+1) (inclus).
  • gte=2020-10-02T12:34:56+01:00 - Rechercher une valeur ultérieure ou égale à 2020-10-02 à 12:34:56 (GMT+1).

Filtre pour rechercher l'heure à laquelle l'élément de la file d'attente de travaux a été chargé dans la file d'attente.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=2020-10-02T12:34:56+01:00 - Rechercher une valeur égale à 2020-10-02 à 12:34:56 (GMT+1).
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - Rechercher une valeur comprise entre 2020-10-02 à 12:34:56 (GMT+1) et 2020-11-02 à 12:34:56 (GMT+1) (inclus).
  • gte=2020-10-02T12:34:56+01:00 - Rechercher une valeur ultérieure ou égale à 2020-10-02 à 12:34:56 (GMT+1).

Filtre pour rechercher l'heure jusqu'à laquelle l'élément de la file d'attente de travaux est reporté.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=2020-10-02T12:34:56+01:00 - Rechercher une valeur égale à 2020-10-02 à 12:34:56 (GMT+1).
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - Rechercher une valeur comprise entre 2020-10-02 à 12:34:56 (GMT+1) et 2020-11-02 à 12:34:56 (GMT+1) (inclus).
  • gte=2020-10-02T12:34:56+01:00 - Rechercher une valeur ultérieure ou égale à 2020-10-02 à 12:34:56 (GMT+1).

Filtre pour rechercher l'heure à laquelle l'élément de la file d'attente de travaux a été verrouillé.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=2020-10-02T12:34:56+01:00 - Rechercher une valeur égale à 2020-10-02 à 12:34:56 (GMT+1).
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - Rechercher une valeur comprise entre 2020-10-02 à 12:34:56 (GMT+1) et 2020-11-02 à 12:34:56 (GMT+1) (inclus).
  • gte=2020-10-02T12:34:56+01:00 - Rechercher une valeur ultérieure ou égale à 2020-10-02 à 12:34:56 (GMT+1).

Filtre pour rechercher l'heure à laquelle l'élément de la file d'attente de travaux a été terminé.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=2020-10-02T12:34:56+01:00 - Rechercher une valeur égale à 2020-10-02 à 12:34:56 (GMT+1).
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - Rechercher une valeur comprise entre 2020-10-02 à 12:34:56 (GMT+1) et 2020-11-02 à 12:34:56 (GMT+1) (inclus).
  • gte=2020-10-02T12:34:56+01:00 - Rechercher une valeur ultérieure ou égale à 2020-10-02 à 12:34:56 (GMT+1).

Filtre pour rechercher l'heure à laquelle l'élément de la file d'attente de travaux a eu une exception.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=2020-10-02T12:34:56+01:00 - Rechercher une valeur égale à 2020-10-02 à 12:34:56 (GMT+1).
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - Rechercher une valeur comprise entre 2020-10-02 à 12:34:56 (GMT+1) et 2020-11-02 à 12:34:56 (GMT+1) (inclus).
  • gte=2020-10-02T12:34:56+01:00 - Rechercher une valeur ultérieure ou égale à 2020-10-02 à 12:34:56 (GMT+1).

Filtre pour rechercher l'heure à laquelle l'élément de la file d'attente de travaux a été mis à jour pour la dernière fois.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Rechercher une valeur égale à 123.
  • gte=123&lte=321 - Rechercher une valeur comprise entre 123 et 321 inclus.
  • lte=123 - Rechercher une valeur inférieure ou égale à 123.

Filtre pour rechercher le nombre actuel de tentatives de l'élément de la file d'attente de travaux.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Rechercher une valeur égale à 123.
  • gte=123&lte=321 - Rechercher une valeur comprise entre 123 et 321 inclus.
  • lte=123 - Rechercher une valeur inférieure ou égale à 123.

Filtre pour rechercher la priorité de l'élément de la file d'attente de travaux.

(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter)
Examples:
  • eq=Example - Rechercher une valeur égale à « Example ».
  • ctn=amp - Rechercher une valeur contenant « amp »
  • strtw=Exa - Rechercher une valeur commençant par « Exa ».
  • gte=Ex&lte=F - Rechercher une valeur alphanumérique entre « Ex » et « F ».
  • gte=Example - Rechercher une valeur alphanumérique après ou égale à « Example ».

Filtre pour rechercher la raison pour laquelle l'élément de file d'attente de travail a eu une exception.

itemsPerPage
integer

Nombre maximal d'éléments à récupérer

pagingToken
string

Jeton à pointer vers le dernier élément renvoyé précédemment

Responses

Response samples

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

Ajouter des éléments à une file d'attente

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

ID de la file d'attente dans laquelle insérer

Request Body schema: application/json

Détails des éléments de file d'attente à créer

Array
object (DataCollection)

Représente une collection Blue Prism.

deferredDate
string <date-time>

Heure et date les plus proches jusqu'auxquelles cet élément est reporté

priority
integer <integer>

Valeur de priorité attribuée à l'élément

tags
Array of strings

Collection de balises attribuées à l'élément

status
string

Valeur de statut fournie par l'utilisateur

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Renvoyer les détails d'un élément spécifié dans une file d'attente de travaux

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

ID de l'élément à obtenir

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": {
    }
}