queryMyApps

Updated at:

Endpoint: console-rpa.aliyun.com/rpa/openapi/app/queryMyApps

Method: GET

Response Format: JSON

Description: Retrieves a list of applications available to the current user.

Request parameters

Parameter

Type

Required

Example

Description

name

String

No

TestAPP1

The application name.

currentPage

Integer

No

1

The page number. The default value is 1.

pageSize

Integer

No

1

The page size.

Response parameters

For information about common response parameters, see response. The following table describes the fields in the data object.

Parameter

Type

Example

Description

catId

String

d296df85-****-****-****-0242ac120004

The unique identifier of the application category.

creator

String

c797b7d8-****-****-****-7c0277d731ff

If the application source is a project, this is the unique identifier of the user who published the application. If the application source is a purchase, this is the unique identifier of the enterprise super administrator.

fromType

String

project

application source

catName

String

Data Processing

The application category name.

name

String

Sample App Name

The application name.

marketStatus

String

publish

The status of the application in the marketplace.

iconUrl

String

null

The icon URL.

params

String

[{ "isMandatory": false, "description": "", "type": 0, "name": "test", "default": "", "value": "" }]

The input parameters of the application.

uuid

String

de6f8980-****-****-****-3b0090c2d12f

The unique identifier of the application.

version

String

0.1.0

The default runtime version of the application.

Important

For on-premises RPA servers:

  • For versions earlier than 4.16.0, the latest application version is used as the default.

introduction

String

Sample Introduction

The application introduction.

Example

Example request:

https://console-rpa.aliyun.com/rpa/openapi/app/queryMyApps?<common request parameters>
&name=ITDA-D-22633726
&currentPage=1
&pageSize=1

Example response:

{
    "requestId":"d1144670-****-****-****-16e2ec7c19d5",
    "success":true,
    "code":0,
    "msg":"The request was successful.",
    "msgCode":"result.success",
    "data":[
        {
            "catId":"d296df85-****-****-****-0242ac120004",
            "creator":"c797b7d8-****-****-****-7c0277d731ff",
            "fromType":"project",
            "catName":"Data Processing",
            "name":"Sample App Name",
            "marketStatus":"publish",
            "iconUrl":"null",
            "params":[{ "isMandatory": false, "description": "", "type": 0, "name": "test", "default": "", "value": "" }],
            "uuid":"de6f8980-****-****-****-3b0090c2d12f",
            "version":"0.1.0",
            "introduction":"Sample Introduction"
        }
    ],
    "pager":{
        "currentPage":1,
        "totalPage":1,
        "pageSize":1,
        "total":1,
        "limit":1,
        "offset":0
    }
}