Get a list of applications and status (GET)

Edit online

Description

URL

scheme://domain:port/platform/ws/applications/appStatus

Description

Get a list of all applications and application status.

HTTP Method

GET

Parameters

None

Request

Request-Method

GET

Request-URI

 /platform/ws/applications/appStatus

Request-Header

 Name Value

Accept

application/xml or application/json

Message-body

empty

Response

Response-Code

  • 200 Successful: Request was successful.
  • 403 Forbidden: Access restricted by role-based access control permissions.
  • 404 Not Found: No applications that match the specified criteria found.
  • 500 Internal Server Error: Exception occurred.

Response-Header

 Name Value

Content-Type

application/xml or application/json

Message-body

 Success Message

If successful, returns a list of all applications along with their status.


<Applications total="%s">
    <AppInfo>
     <AppName>%s</appName>
     <status>%s</status>
     </AppInfo> 
    <AppInfo>
      ... 
    </AppInfo>
     ...
</Applications>
Failure Message

If not successful, returns an error message.

For additional information, refer to the schema file ./schemas/jobs/error.xsd.

<error>
  <message>
     %s
  </message>
</error>

Example


# Response
200 Successful
Content-Type: application/xml;

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Applications total="27">
<AppInfo>
 <appName>Windows_Remote_Desktop</appName> 
 <status>Unpublished</status>
</AppInfo>
 ...
</Applications>