queryApps
Request URL: console-rpa.aliyun.com/rpa/openapi/app/queryApps
HTTP method: GET
Response format: JSON
Retrieves a list of applications.
Request parameters
Parameter | Type | Required | Example | Description |
appName | String | No | TestAPP1 | Name of the application. |
appMarketStatus | String | No | publish | |
appMarketSource | String | No | project | |
currentPage | Integer | No | 1 | Page number. Default value: 1. |
pageSize | Integer | No | 1 | Page size. |
Response parameters
For the common fields in the response, see Response. The data field is described as follows:
Parameter | Type | Example | Description |
uuid | String | fb6a99a1-****-****-****-2ed9cb5a0c0d | The UUID of the application. |
name | String | TestAPP1 | Name of the application. |
catId | String | d296df85-****-****-****-0242ac120004 | Application type ID. |
catName | String | Data Processing | Name of the application type. |
creator | String | 93bf42a1-****-****-****-4d5ec0e6260a | The UUID of the creator. |
creatorName | String | ss-test | Creator account. |
creatorNickName | String | Super administrator | Creator nickname. |
introduction | String | TestAPP1 | The description of the application. |
iconUrl | String | Icon URL. | |
status | String | publish | |
version | String | 1.4.4 | The default version of the application to run. Important If you use an on-premises version of the RPA server:
|
groupId | String | b8e097d8-****-****-****-db5d13f8b4ca | The UUID of the enterprise. |
fromType | String | project |
Examples
Request example
https://console-rpa.aliyun.com/rpa/openapi/app/queryApps?<common request parameters>
&appName=TestAPP1
&appMarketStatus=publish
&appMarketSource=project
¤tPage=1
&pageSize=1Response example
{
"requestId":"41e05db4-****-****-****-c3371c2e048d",
"success":true,
"code":0,
"msg":"Call succeeded",
"msgCode":"result.success",
"data":[
{
"uuid":"fb6a99a1-****-****-****-2ed9cb5a0c0d",
"name":"TestAPP1",
"catId":"d296df85-****-****-****-0242ac120004",
"catName":"Data Processing",
"creator":"93bf42a1-****-****-****-4d5ec0e6260a",
"creatorName":"ss-test",
"creatorNickName":"Super administrator",
"introduction":"TestAPP1",
"iconUrl":"",
"status":"publish",
"version":"1.4.4",
"groupId":"b8e097d8-****-****-****-db5d13f8b4ca",
"fromType":"project"
}
],
"pager":{
"currentPage":1,
"totalPage":1,
"pageSize":1,
"total":0,
"limit":1,
"offset":0
}
}