AppList

Use this resource to retrieve a list of process apps that the user can start instances of.

Method summary

HTTP Method	Path	Description
GET	/scr/api/AppList	Retrieves a list of process apps that the user can start instances of.

GET /scr/api/AppList

Description: Use this method to retrieve a list of process apps that the user can start instances of.

Resource information

Requirements	Description
Response format	JSON
Requires authentication	Yes
Supports OAuth 2 client credentials	Yes using a User Service ID containing Work Management Category
Rate limited	Not yet

Parameters

Name	Location	Description	Required	Type
X-On-Behalf-Of	Header	The user context. The value must be a username in the account. The user must have permission to perform the action in the account and in the specified parent space, if any.	Required if Service ID OAuth credentials are used. Not required when using User Service ID OAuth credential.	String
version	Query	The version of the requested API. The only allowed value is `20110917`.	Yes	String

Response

Example input

Using User Service ID OAuth 2 client credentials:

curl -i -H "Authorization: Bearer access_token" 
"https://your_server_url/scr/api/AppList?version=20110917"

Using Service ID OAuth 2 client credentials:

curl -i -H "Authorization: Bearer access_token" -H "X-On-Behalf-Of:user_name@domain.com" 
    "https://your_server_url/scr/api/AppList?version=20110917"

Example output

{
  "more": false,
  "apps": [
    {
      "id": "31ea912ac7",
      "new": true,
      "processId": "31ea912ac3",
      "name": "develop process diagram",
      "type": "workflow"
    },
    {
      "id": "9bea79df89",
      "new": true,
      "processId": "9bea79df85",
      "name": "any process app",
      "type": "checklist"
    },
    {
      "id": "1000062ea88cacf",
      "new": true,
      "processId": "1000062ea88cacb",
      "name": "test due date in email",
      "type": "checklist"
    },
    {
      "id": "10000d6400c755d",
      "new": true,
      "processId": "10000d6400c7558",
      "name": "test notification email",
      "type": "workflow"
    },
    {
      "id": "1000062ea88f4cc",
      "new": true,
      "processId": "1000062ea88f4c8",
      "name": "test date on task",
      "type": "workflow"
    },
    {
      "id": "3f37005d",
      "new": true,
      "processId": "3f370019",
      "name": "Submit Process for Review",
      "type": "workflow"
    },
    {
      "id": "100004e3fe76b25",
      "new": true,
      "processId": "100004e3fe76b20",
      "name": "testing 2",
      "type": "workflow"
    },
     {
      "id": "400004cea8bdab9",
      "new": true,
      "processId": "400004cea8bd626",
      "name": "test due date in email",
      "type": "checklist"
    },
    {
      "id": "400004cea8bdacb",
      "new": true,
      "processId": "400004cea8bd625",
      "name": "test date on task",
      "type": "workflow"
    }
  ],
  "favorites": [],
  "version": "20110917"
}

Response properties

version: The version of the API used to create the response.
more: The value is true if there are more process app definition instances on the server, and false if the array of apps includes the available definitions.
apps: The array of process app instances listed in alphabetical order by name.
app.name: The name of the process app that the work instance was started from.
app.id: The ID of the process app that the work instance was started from.
app.processId: The ID of the process that is related to this app. Use this property to match news feed entries to an app.
app.type: The app type has two possible values, workflow or checklist.
app.new: This property is present only if the value is true. It indicates a process app that the user did not see before.
favorites: The array of apps that the user selected as favorites. The order matches the one provided in the previous call to UpdateFavorites. This list might include app IDs that are not returned in the app array. The app ID is not returned in the app array when a user tags an app as a favorite, but later the app becomes unshared. The ID is included in the favorites list, so the caller can access it by including it as part of a call to UpdateFavorites.
favorites.id: The ID of the favorite process app. An object with this ID appears in the app array.

Response messages

HTTP code	Reason
200	The request was completed successfully.
400	There was an error processing the request. Required parameters were missing or contained invalid values.
401	The user isn't authorized to make the request.