ListAssetVariables

Updated at:

Description: Retrieves a list of asset variables.

Path: rpa/openapi/asset-variable/ListAssetVariables

Method: POST

Usage notes:

  • The scope of encryption varies by asset variable type: for a string, the value is encrypted; for a password, the password is encrypted; and for an account, both the account and password are encrypted.

Request parameters:

Parameter

Type

Required

Example

Description

CurrentPage

Integer

No

1

The page number to return. Default: 1.

PageSize

Integer

No

20

The number of entries to return on each page. Default: 20. Maximum: 100.

PublicKey

String

Yes

-----BEGIN PUBLIC KEY-----MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJB*********AwHrsmtnfchRzylr2tEhQHmgfcWiUCAwEAAQ==-----END PUBLIC KEY-----

The public key that you generate. The server uses this key to encrypt the asset variable before returning it. Note: Ensure that the RSA key size is large enough to encrypt the plaintext data. Use a larger RSA key size for large asset variable values.

AssetVariableName

String

No

exampelName2

The name of the asset variable to query. This parameter supports fuzzy queries.

Response parameters:

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

Parameter

Type

Example

Description

AssetVariableId

String

5743b65c-014e-4e63-816e-520af9bfab4a

The ID of the asset variable.

AssetVariableName

String

exampelName2

The name of the asset variable.

AssetVariableNickName

String

exampleNickName2

The nickname of the asset variable.

AssetVariableType

String

password

The type of the asset variable. Valid enum values: string, password, and account.

AuthorizedMemberIds

An array of strings. Serialization format: simple

["760526e3-709d-479a-a79a-430d8e51c448", "6c3c5113-11fd-453e-aa94-b7d9b23d46be"]

The IDs of the users who are authorized to access the asset variable.

AssetVariableValue

String

"AssetVariableValue":

{
"password": "pDVvDFtpnT+Yhd2GnMKEaJLdef8V5D5OhR1p71JFl/lcFuK1TOgNpqGeRoXTAJ**************8cN2tSwbxufa7BHa5HfizFabkLs\u003d",
"account": "bB9Aj/gdk0Sje7b4FEtd6H23GNa/ps+N0EeI00gIG1Nn1yv************6o3PfyFK9JRnJaquXrst6Iv3fV+38I3gdxL17T78wSSc\u003d"

}

The encrypted value of the asset variable.