This topic describes the response parameters returned from Alibaba Cloud Robotic Process Automation (RPA) API calls.
Response parameters
Name | Type | Example value | Description |
|---|---|---|---|
requestId | String | 7906bcd8-5054-4be4-a08f-27e13630607e | The request ID. |
success | Boolean | true | Indicates whether the request was successful. |
code | Integer | 0 | The status code. |
msg | String | The call was successful. | The message returned for the request. |
msgCode | String | result.success | The message code returned for the request. |
data | List | The detailed data returned for the request. For more information, see the response parameter description for each API. | |
pager | Object | If paging is not used, this parameter is null. If paging is used, this parameter contains the paging details. |
Paging data (pager)
Name | Type | Description |
|---|---|---|
currentPage | Integer | The current page number. |
totalPage | Integer | The total number of pages. |
pageSize | Integer | Page size |
total | Long | The total number of data entries. |
Normal response example
If an API call is successful, the response parameters and the request ID are returned. The HTTP status code for a successful call is in the 2xx range.
{
"requestId":"7906bcd8-5054-4be4-a08f-27e13630607e",
"success":true,
"code":0,
"msg":"The call was successful.",
"msgCode":"result.success",
"data":[
# The data returned varies by API. For more information, see the response parameter description for each API.
],
"pager":null
}Error response example
If an API call fails, an error code, an error message, and the request ID are returned. The HTTP status code for a failed call is in the 4xx or 5xx range. You can troubleshoot the error based on the API error code. For more information, see Common error codes and API Error Center.
{
"timestamp":1589095122608,
"status":403,
"error":"Forbidden",
"message":"Forbidden",
"path":"/rpa/openapi/client/updateClientInfo"
}