GET /rest/bpm/wle/v1/processes/queries[?processAppName={string}][&kind={string}][&content={string}][&includeTaskData={boolean}]| Nom | Type de valeur | Description |
|---|---|---|
| processAppName | chaîne | Nom de l'application de processus utilisée pour un filtrage supplémentaire. Ce paramètre est prévu pour une utilisation future et n'a actuellement aucun effet sur les métadonnées de requête renvoyées.
|
| type | chaîne | Indique le type de requêtes à renvoyer. Si vous spécifiez ce paramètre, vous devez le définir sur
SAVED_SEARCH. |
| Content | chaîne | Indique une liste séparée par des virgules de valeurs de contenu. Une valeur de contenu est essentiellement un nom d'attribut canonique qui spécifie l'utilisation sémantique et la plage de valeurs implicites d'un attribut de requête. Par exemple, il peut y avoir plusieurs attributs de requête qui représentent une valeur de nom de processus, mais la valeur de contenu associée à chacun d'eux serait PROCESS_INSTANCE.NAME, identifiant ces attributs comme contenant une valeur de type "nom de processus". Lorsque ce paramètre est utilisé, seules les requêtes qui renvoient les valeurs de contenu spécifiées dans leur ensemble de résultats sont renvoyées. Par exemple, si vous avez spécifié |
| includeTaskData | booléen | Ce paramètre est un indicateur qui indique si les détails de la tâche sont inclus dans la réponse. Le paramétrage par défaut est
false. |
Aucun
Le type de contenu par défaut estapplication/json.
{ "description": "Requêtes WLE",
"type":"object",
"propriétés":
{ "identifier": {"type": "string"},
"éléments":
[
{ "name": { "type": "chaîne",
"description": "Nom de la requête."
},
"displayName": { "type": "chaîne",
"description": "Nom d'affichage de la requête (localisé)."
},
"description": { "type": "chaîne",
"description": "Description de la requête (localisée)."
},
"kind": { "type": "chaîne",
"description": "type de requête.",
"enum":
[
"RECHERCHE DE SAUVEGARDE"
]
},
"savedSearchId": { "type": "long",
"description": "Numéro d'ID associé à une recherche sauvegardée.",
"nillable": "true"
}
"authorizationType": { "type": "chaîne",
"description": "Type d'autorisation requis pour effectuer des requêtes à l'aide de cette requête.",
"enum":
[
"INSTANCE_BASED"
]
},
"entityTypeNom": { "type": "string",
"description": "Type d'entités renvoyées comme résultat de la requête."
},
"keyAttribute": { "type": "chaîne",
"description": "Nom de l'attribut identifiant de manière unique une entité."
},
"locales": { "type": [ "chaîne" ],
"description": "Liste des paramètres régionaux définis pour les noms d'affichage et les descriptions de cette requête."
},
"sortAttributes": {
[
{
"name": { "type": "string",
"description": "Nom de l'attribut de tri."
},
"sortOrder": { "type": "chaîne",
"description": "Ordre de tri.",
"enum":
[
"ASC",
"desc"
]
}
}
], "optional": true,
"description": "Liste ordonnée des noms d'attribut de tri par défaut."
},
"size": { "type": "entier", "facultatif": true,
"description": "Nombre par défaut d'entités renvoyées comme résultat de la requête."
}
}
]
}
}
{
"status": "200",
"données": {
"identifier": "nom",
"éléments": [
{
"name": "portal.savedsearch.help_reqs",
"displayName":"portal.savedsearch.help_reqs",
"description": "",
"kind": "SAVED_SEARCH",
"IDsavedSearch": 6,
"authorizationType": "INSTANCE_BASED",
"entityTypeName": "PROCESS_INSTANCE",
"keyAttribute":"PROCESS_INSTANCE.PIID",
"locales": [
],
"sortAttributes":[
{
"name": "DatetaskDue",
"sortOrder": "ASC"
},
{
"name": "taskPriority",
"sortOrder": "ASC"
}
],
"taille": 20
},
{
"name": "portal.savedsearch.history",
"displayName":"portal.savedsearch.history",
"description": "",
"kind": "SAVED_SEARCH",
"IDsavedSearch": 2,
"authorizationType": "INSTANCE_BASED",
"entityTypeName": "PROCESS_INSTANCE",
"keyAttribute":"PROCESS_INSTANCE.PIID",
"locales": [
],
"sortAttributes":[
{
"name": "DatetaskDue",
"sortOrder": "ASC"
},
{
"name": "taskPriority",
"sortOrder": "ASC"
}
],
"taille": 20
},
{
"name": "portal.savedsearch.inbox",
"displayName":"portal.savedsearch.inbox",
"description": "",
"kind": "SAVED_SEARCH",
"IDsavedSearch": 4,
"authorizationType": "INSTANCE_BASED",
"entityTypeName": "PROCESS_INSTANCE",
"keyAttribute":"PROCESS_INSTANCE.PIID",
"locales": [
],
"sortAttributes":[
{
"name": "DatetaskDue",
"sortOrder": "ASC"
},
{
"name": "taskPriority",
"sortOrder": "ASC"
}
],
"taille": 20
},
{
"name": "IBM.DEFAULTALLPROCESSLIST_75",
"displayName": "Tout",
"description": "",
"kind": "SAVED_SEARCH",
"IDsavedSearch": 0,
"authorizationType": "INSTANCE_BASED",
"entityTypeName": "PROCESS_INSTANCE",
"keyAttribute":"PROCESS_INSTANCE.PIID",
"locales": [
],
"sortAttributes":[
],
"taille": 20
}
]
}
}
<?xml version="1.0" encoding="UTF-8"?>
< schema targetNamespace= "http://rest.bpm.ibm.com/v1/data/query"
elementFormPar défaut = "unqualified" xmlns= "http://www.w3.org/2001/XMLSchema"
xmlns:tns = "http://rest.bpm.ibm.com/v1/data/query" xmlns:cmn = "http://rest.bpm.ibm.com/v1/data/common"
xmlns:pref = "http://rest.bpm.ibm.com/v1/data/root">
< import schemaLocation= "Common.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/common" />
< import schemaLocation= "BPMRestData.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/root" />
< ! -- Ce type est utilisé pour renvoyer une liste de requêtes sauvegardées. -- >
<complexType name= "QueryList">
<complexContent>
< extension base= " pref :Data">
<sequence>
< element name = "identifier "type = "chaîne" />
< ! -- Il s'agit d'une liste de zéro ou plusieurs requêtes sauvegardées -- >
< element name = "items "type="tns:QueryItem" minOccurs= "0 "
maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
< ! -- Ce type représente une seule requête sauvegardée. -- >
<complexType name= "QueryItem">
<sequence>
< ! -- Nom de la requête -- >
< element name = "name "type = "chaîne" />
< ! -- Nom d'affichage associé à la requête ; il contiendra le
même valeur que le nom -- >
< element name= "displayName" type = "string " />
< ! -- Description de la requête -- >
< element name = "description "type = "chaîne" />
< ! -- "kind" associé à la requête ; il sera défini sur "SAVED_SEARCH" -- >
< element name = "kind "type = "chaîne" />
< ! -- Numéro d'ID associé à une recherche sauvegardée -- >
< element name= "savedSearchID" type = "long "nillable = "true" />
< ! -- Type d'autorisation associé à la requête ; il sera défini
à "INSTANCE_BASED" -- >
< element name= "authorizationType" type = "string " />
< ! -- Cette zone indique le type des objets renvoyés par cette requête.
Il s'agit de "PROCESS_INSTANCE", "TASK", "TASK_TEMPL". -- >
< element name= "entityTypeName" type="string " />
< ! -- Cette zone indique le nom de l'attribut qui sert de
pour les objets renvoyés par cette requête. -- >
< element name= "keyAttribute" type = "chaîne " />
< ! -- non utilisé -- >
< element name = "locales "type="string" minOccurs= "0 "
maxOccurs="unbounded" />
< ! -- Attributs de tri présélectionnés pour la requête. -- >
< element name= "sortAttributes" type="tns:SortAttribute"
minOccurs= "0 " maxOccurs= "unbounded" />
< ! -- Taille prédéfinie des éléments à extraire. -- >
< element name = "size "type = "integer" nillable = "true " />
</sequence>
</complexType>
< ! -- Ce type est utilisé pour renvoyer les statistiques des lignes (éléments) dans le résultat
ensemble qui serait renvoyé par l'exécution d'une requête sauvegardée particulière. -- >
<complexType name= "QueryStats">
<sequence>
< ! -- Taille de l'ensemble de résultats (nombre de lignes) -- >
< element name = "total "type = "integer" />
< element name = "open "type = "integer" />
< element name= "onTrack" type = "integer " />
< element name= "atRisk" type = "integer " />
< element name = "en retard "type = "integer" />
< ! -- mettez en commentaire ces deux éléments car ils ne sont utilisés par aucun code, ce qui signifie qu'ils ne font pas partie de
depuis le premier jour.
< element name = "active "type = "integer" />
< element name = "completed "type = "integer" />
-->
</sequence>
</complexType>
< ! -- Ce type est utilisé pour renvoyer l'ensemble d'attributs (colonnes de données) qui
seront renvoyés suite à l'exécution d'une requête sauvegardée particulière. -- >
<complexType name= "QueryAttributes">
<complexContent>
< extension base= " pref :Data">
<sequence>
< element name = "identifier "type = "chaîne" />
< ! -- Nom de la requête associée à cet ensemble d'attributs -- >
< element name = "query "type = "chaîne" />
< ! -- Nom d'affichage de la requête ; il s'agit de la même valeur que le nom -- >
< element name= "displayName" type = "string " />
< ! -- non utilisé -- >
< element name = "description "type = "chaîne" />
< ! -- "kind" associé à la requête ; il sera défini sur "SAVED_SEARCH" -- >
< element name = "kind "type = "chaîne" />
< ! -- Type d'autorisation associé à la requête. Ce paramètre sera défini
à l'un des éléments suivants: "INSTANCE_BASED", "ROLE_BASED" -- >
< element name= "authorizationType" type = "string " />
< ! -- Cette zone indique le type d'objets renvoyés par cette requête.
Il s'agit de "PROCESS_INSTANCE", "TASK", "TASK_TEMPL". -- >
< element name= "entityTypeName" type="string " />
< ! -- Cette zone indique le nom de l'attribut qui sert
la clé des objets renvoyés par cette requête. -- >
< element name= "keyAttribute" type = "chaîne " />
< ! -- non utilisé -- >
< element name = "locales "type="string" minOccurs= "0 "
maxOccurs="unbounded" />
< ! -- Attributs de tri présélectionnés pour la requête. -- >
< element name= "sortAttributes" type="tns:SortAttribute"
minOccurs= "0 " maxOccurs= "unbounded" />
< ! -- Taille prédéfinie des éléments à extraire. -- >
< element name = "size "type = "integer" nillable = "true " />
< ! -- Liste de zéro ou plusieurs attributs -- >
< element name = "items "type="tns:QueryAttributeItem"
minOccurs= "0 " maxOccurs= "unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
< ! -- Ce type décrit un attribut unique qui serait renvoyé en tant que
résultat de l'exécution d'une requête sauvegardée particulière. -- >
<complexType name= "QueryAttributeArticle">
<sequence>
< ! -- Nom de l'attribut -- >
< element name = "name "type = "chaîne" />
< ! -- Nom d'affichage localisé de l'attribut -- >
< element name= "displayName" type = "string " />
< ! -- non utilisé -- >
< element name = "description "type = "chaîne" />
< ! -- Type de données de l'attribut -- >
< element name = "type "type = "chaîne" />
< ! -- non utilisé ; défini sur false -- >
< element name= "isArray" type = "booléen" />
< ! -- Requête et attribut associés qui fournissent les informations de ces attributs -- >
< element name= "sourceAttribute" type = "string " />
< ! -- Chaîne qui identifie les attributs avec une plage de valeurs connue -- >
< element name = "content "type = "string" />
< ! -- ID de la table de l'attribut source, tel que défini dans la table de requête
définition -- >
< element name= "sourceQueryTableIdentifier" type = "string " />
< ! -- Indique si l'attribut peut être utilisé comme attribut de tri -- >
< element name= "isSortable" type= "boolean" minOccurs= "0 "
maxOccurs= "1 "default="true" />
< ! -- Indique si l'attribut peut être utilisé comme attribut de filtre -- >
< element name= "isFilterable" type= "boolean" minOccurs= "0 "
maxOccurs= "1 "default="true" />
</sequence>
</complexType>
< ! -- Ce type est utilisé pour renvoyer les résultats de l'exécution d'une sauvegarde particulière
requête. -- >
<complexType name= "QueryResultEnsemble ">
<complexContent>
< extension base= " pref :Data">
<sequence>
< ! -- Attribut de clé associé à cet ensemble de résultats de requête. Ce
dépendra du type d'objets renvoyés par la requête, et
être l'un des suivants: "TASK.TKIID","TASK_TEMPL.TKTID","PROCESS_INSTANCE.PIID" -- >
< element name = "identifier "type = "chaîne" />
< ! -- Nom de la requête sauvegardée pour laquelle ces résultats ont été générés -- >
< element name = "query "type = "chaîne" />
< ! -- Cette zone indique le type des objets renvoyés par cette requête.
Il s'agit de "PROCESS_INSTANCE", "TASK", "TASK_TEMPL". -- >
< element name= "entityTypeName" type="string " />
< ! -- Liste des attributs (colonnes) renvoyés par cette requête -- >
< element name= "attributeInfo" type="tns:AttributeInfo"
minOccurs= "0 " maxOccurs= "unbounded" />
< ! -- Valeur de décalage spécifiée dans la demande d'origine. Ce
représente l'index (dans l'ensemble de résultats de requête global) du premier
en cours de renvoi. -- >
< element name = "offset "type = "integer" />
< ! -- Nombre d'éléments renvoyés -- >
< element name = "size "type = "integer" />
< ! -- Nombre d'éléments demandés dans la demande d'origine -- >
< element name= "requestedSize" type = "integer " />
< ! -- Nombre total de résultats -- >
< element name= "totalCount" type = "entier " />
< ! -- True si le nombre total de résultats dépasse une limite de recherche et est réellement
inconnu -- >
< element name= "countLimitExceeded" type= "boolean" />
< ! -- Indique la limite de recherche utilisée, le cas échéant, ou 0 si elle n'est pas définie -- >
< element name= "countLimit" type = "integer " />
< ! -- Ensemble de résultats renvoyés par cette requête. Ceci est représenté
sous la forme d'une liste de zéro ou plusieurs "éléments", où chaque élément représente une ligne dans la
ensemble de résultats. Chaque élément est représenté par une carte, où la carte contient
différentes colonnes de données associées à cet élément (ligne). -- >
< element name="items "type="cmn :Map" minOccurs= "0 "
maxOccurs="unbounded" />
< element name = "stats "type="tns:QueryStats" />
</sequence>
</extension>
</complexContent>
</complexType>
< ! -- Ce type contient les informations d'un attribut unique renvoyé
comme résultat de l'exécution d'une requête sauvegardée. -- >
<complexType name= "AttributeInfo">
<sequence>
< ! -- Nom de l'attribut -- >
< element name = "name "type = "chaîne" />
< ! -- Type de données de l'attribut -- >
< element name = "type "type = "chaîne" />
< ! -- Chaîne qui identifie les attributs avec une plage de valeurs connue -- >
< element name = "content "type = "string" />
< ! -- non utilisé ; défini sur false -- >
< element name= "isArray" type = "booléen" />
< ! -- Requête et attribut associés qui fournissent les informations de ces attributs -- >
< element name= "sourceAttribute" type = "string " />
< ! -- ID de la table de l'attribut source, tel que défini dans la table de requête
définition -- >
< element name= "sourceQueryTableIdentifier" type = "string " />
</sequence>
</complexType>
< ! -- Ce type est utilisé pour renvoyer le nombre de lignes (éléments) dans le résultat
ensemble qui serait renvoyé par l'exécution d'une requête sauvegardée particulière. -- >
<complexType name= "QueryResultSetCount">
<complexContent>
< extension base= " pref :Data">
<sequence>
< ! -- Taille de l'ensemble de résultats (nombre de lignes) -- >
< element name = "count "type = "integer" />
</sequence>
</extension>
</complexContent>
</complexType>
< ! -- Conteneur utilisé pour décrire un attribut de tri par son nom et son tri
commande. -- >
<complexType name= "SortAttribute">
<sequence>
< element name = "name "type = "chaîne" />
< element name= "sourceAttribute" type = "string " />
< element name= "sortOrder" type = "string " /> < ! -- ASC, DESC -- >
</sequence>
</complexType>
<complexType name= "ProcessInstanceNombre ">
<complexContent>
< extension base= " pref :Data">
<sequence>
< element name="overview "type="cmn :Map" />
</sequence>
</extension>
</complexContent>
</complexType>
</schema>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
< bpm:ResponseData xmlns:bpm ='http://rest.bpm.ibm.com/v1/data'>
<status>200</status>
< data xmlns:xsi ='http://www.w3.org/2001/XMLSchema-instance'xmlns:qry ='http://rest.bpm.ibm.com/v1/data/query'xsi:type ='qry:QueryList'>
< identifier> nom < /identifier>
<items>
< name>portal.savedsearch.help_reqs< /name>
<displayName>portal.savedsearch.help_reqs</displayName>
<description></description>
< kind> SAVED_SEARCH < /kind>
<savedSearchId>6</savedSearchId>
<authorizationType> INSTANCE_BASED < /authorizationType>
<entityTypeName> PROCESS_INSTANCE < /entityTypeName >
<keyAttribute>PROCESS_INSTANCE.PIID</keyAttribute>
<sortAttributes>
< name>taskDueDate < /name>
<sortOrder> ASC < /sortOrder>
</sortAttributes>
<sortAttributes>
< name>taskPriority< /name>
<sortOrder> ASC < /sortOrder>
</sortAttributes>
<size>20</size>
</items>
<items>
< name>portal.savedsearch.history< /name>
<displayName>portal.savedsearch.history</displayName>
<description></description>
< kind> SAVED_SEARCH < /kind>
<savedSearchId>2</savedSearchId>
<authorizationType> INSTANCE_BASED < /authorizationType>
<entityTypeName> PROCESS_INSTANCE < /entityTypeName >
<keyAttribute>PROCESS_INSTANCE.PIID</keyAttribute>
<sortAttributes>
< name>taskDueDate < /name>
<sortOrder> ASC < /sortOrder>
</sortAttributes>
<sortAttributes>
< name>taskPriority< /name>
<sortOrder> ASC < /sortOrder>
</sortAttributes>
<size>20</size>
</items>
<items>
< nom>portal.savedsearch.inbox< /name>
<displayName>portal.savedsearch.inbox</displayName>
<description></description>
< kind> SAVED_SEARCH < /kind>
<savedSearchId>4</savedSearchId>
<authorizationType> INSTANCE_BASED < /authorizationType>
<entityTypeName> PROCESS_INSTANCE < /entityTypeName >
<keyAttribute>PROCESS_INSTANCE.PIID</keyAttribute>
<sortAttributes>
< name>taskDueDate < /name>
<sortOrder> ASC < /sortOrder>
</sortAttributes>
<sortAttributes>
< name>taskPriority< /name>
<sortOrder> ASC < /sortOrder>
</sortAttributes>
<size>20</size>
</items>
<items>
<name>IBM.DEFAULTALLPROCESSLIST_75</name>
<displayName> Tout < /displayName>
<description></description>
< kind> SAVED_SEARCH < /kind>
<savedSearchId>0</savedSearchId>
<authorizationType> INSTANCE_BASED < /authorizationType>
<entityTypeName> PROCESS_INSTANCE < /entityTypeName >
<keyAttribute>PROCESS_INSTANCE.PIID</keyAttribute>
<size>20</size>
</items>
</data>
< /bpm:ResponseData>
Le type de contenu par défaut estapplication/json.
{ "description": "Réponse d'erreur WLE",
"type":"object",
"propriétés":
{ "status": { "type": "chaîne",
"description": "Statut de l'appel API précédent."
},
"exceptionType": { "type": "chaîne",
"description": "Nom de classe associé à l'exception."
},
"errorNumber": { "type": "chaîne",
"description": "ID de message de l'exception."
},
"errorMessage": { "type": "string",
"description": "Texte de message de l'exception."
},
"errorMessageParameters": { "type": [ "string" ], "optional": true,
"description": "Paramètres de texte de message de l'exception."
},
"programmersDetails": { "type": "object", "optional": true,
"description": "Détails de l'exception supplémentaires, par exemple, une trace de pile."
}
}
}
<?xml version="1.0" encoding="UTF-8"?>
< schema targetNamespace= "http://rest.bpm.ibm.com/v1/data/exception"
elementFormPar défaut = "unqualified" xmlns= "http://www.w3.org/2001/XMLSchema"
xmlns:tns = "http://rest.bpm.ibm.com/v1/data/exception"
xmlns:dat = "http://rest.bpm.ibm.com/v1/data/root">
< import schemaLocation= "BPMRestData.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/root" />
<!--
Ce type représente une réponse d'erreur.
-->
< element name= "RestRuntimeException ">
<complexType>
<sequence>
< element name = "status "type="chaîne" />
< element name="Data " type="tns:ExceptionData">
</element>
</sequence>
</complexType>
</element>
<!--
Ce type contient des informations d'erreur détaillées associées à une exception.
-->
<complexType name= "ExceptionData">
<sequence>
< element name = "status "type="chaîne" />
< ! -- Indique le nom de classe Java de l'exception -- >
< element name= "exceptionType" type="chaîne " />
< ! -- ID du message d'erreur -- >
< element name= "errorNumber" type="string " minOccurs= "0" />
< ! -- Message d'erreur complet -- >
< element name= "errorMessage" type="string " />
< ! -- Liste des chaînes insérées dans le message d'erreur -- >
< element name= "errorMessageParameters" type="string " minOccurs= "0" maxOccurs= "unbounded " />
<!--
Trace de pile associée à l'exception.
Notez que cela sera omis sauf si la propriété "server-stacktrace-enabled"
est activé dans le fichier 100Custom.xml du serveur.
-->
< element name= "programmersDetails" type="string"> < /element>
< ! -- Réponses précédentes. Définir si une commande en bloc a été utilisée -- >
< element name = "responses "type="dat:BulkCommandResponses" minOccurs= "0"> < /element>
< element name= "errorData" type="tns:ErrorData" minOccurs= "0" />
</sequence>
</complexType>
<complexType name= "ErrorData">
<sequence>
< element name = "code "type = "chaîne" />
< element name = "data "type="string" minOccurs= "0 " />
</sequence>
</complexType>
</schema>
| Coder | Description |
|---|---|
| 200 OK | Achèvement réussi-les données demandées ont été renvoyées. Notez que la liste peut être vide.
|
| 400 Demande incorrecte | Les paramètres ne sont pas valides ou ils sont manquants. |
| 406 Not Acceptable (Non acceptable) | Le type de contenu ou le codage du contenu demandé n'est pas pris en charge. |
| 500 Erreur de serveur interne | Un problème grave s'est produit, les détails du programmeur sont fournis. |
| Edition (Release) | Description |
|---|---|
| 7.5.1 | Un nouveau paramètre a été ajouté à cette méthode pour permettre un filtrage supplémentaire à l'aide d'un nom d'application de processus.
|
7.5.0
Rubrique parent: Ressource de requêtes d'instance de processus