apps
latest
false
Apps API guide
important :
For documentation on app projects in Studio Web, refer to the App Projects chapter in the Studio Web documentation: https://docs.uipath.com/studio-web/automation-cloud/latest/user-guide/apps-in-studio-web.
API reference for retrieving all published versions of an app in a tenant.
Retrieves all published versions of a specific app in a tenant.
API endpoint
GET <BaseURL>/models/{appSystemName}/tenants/{cloudTenantId}/publish/versions
See Base URL for the root endpoint path.
Request headers
| Header | Value |
|---|---|
| Authorization | Bearer <your-access-token> |
| X-UiPath-Internal-TenantId | <tenant_id> |
Note:
Replace all the values between the angle brackets <...> with their corresponding use-case values.
The <access_token> is the one you received when you authorized the external application with the Apps or Apps.Read scope. It is available for 1 hour, then you need to generate a new one, or request a refresh token.
Path variables
| Path variable | Data type | Description |
|---|---|---|
| appSystemName (required) | string | The system name of the app. |
| cloudTenantId (required) | string | The cloud tenant ID. |
Query parameters
| Query parameter | Data type | Description | Default value |
|---|---|---|---|
| top (optional) | int32 | The number of results to return. | N/A |
| skip (optional) | int32 | The number of results to skip. | N/A |
| orderBy (optional) | string | The field to order results by. | N/A |
Responses
200 OK
{
"@odata.context": "string",
"@odata.count": 2,
"value": [
{
"systemName": "string",
"title": "string",
"deployVersion": 1
},
{
"systemName": "string",
"title": "string",
"deployVersion": 2
}
]
}
{
"@odata.context": "string",
"@odata.count": 2,
"value": [
{
"systemName": "string",
"title": "string",
"deployVersion": 1
},
{
"systemName": "string",
"title": "string",
"deployVersion": 2
}
]
}
| Field | Data type | Description |
|---|---|---|
| @odata.context | string | The OData context URL. |
| @odata.count | number | The total number of published versions for the app. |
| value | array | The list of published app versions. |
| value[].systemName | string | The system name of the version. |
| value[].title | string | The display title of the app version. |
| value[].deployVersion | number | The version number. |
401 Unauthorized
You are not authenticated. Make sure you are using a valid access token with the Apps or Apps.Read scope.
403 Forbidden
You don't have permission to view app versions in the specified tenant.