AppDetail

Use this resource to retrieve information about a process app definition.

Method summary

HTTP Method	Path	Description
GET	/scr/api/AppDetail	Retrieves information about a process app definition.

GET /scr/api/AppDetail

Description: Use this method to retrieve information about a process app definition. This resource can form the basis of a call to /scr/api/LaunchInstance to launch a new instance of the app.

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
appId	Query	The ID of the requested process app.	Yes	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/AppDetail?version=20110917&appId=44eaaadd6d"

Using Service ID OAuth 2 client credentials:

curl -i -H "Authorization: Bearer access_token" 
"https://your_server_url/scr/api/AppDetail?version=20110917&appId=44eaaadd6d"

Using Service ID OAuth 2 client credentials with user context:

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

Example output

{
  "app": {
    "id": "44eaaadd6d",
    "mailOnCompletion": false,
    "instructions": null,
    "subjectTitle": null,
    "processId": "44eaaadd69",
    "name": "ProcApp",
    "attachments": [],
    "tasks": [
      {
        "id": "44eaaade02",
        "approvalStep": false,
        "name": "",
        "assignedTo": null
      }
    ],
    "type": "workflow",
    "detailsTitle": null
  },
  "users": [],
  "version": "20110917"
}

Response properties

version: The version of the API used to create a response.
app.name: The name of the process app.
app.id: The ID of the process app.
app.processId: The ID of the process app. Use this process ID together with the attachment ID to retrieve files attached to this app.
app.instructions: The instructions for creating an instance of a process app. Text length limit is 200 characters. The default value is null.
app.subjectTitle: The title for the edit area in which the user entered a subject for the instance. The default value is null.
app.detailsTitle: The title for the edit area where the user entered details for the instance. The default value is null.
app.type: The app type has two possible values, workflow or checklist.
app.mailOnCompletion: If true, then upon completion, an email is sent to the user who created the instance.
app.tasks: The array of tasks associated with the instance.
app.tasks.name: The name of the task.
app.tasks.id: The ID of the task.
app.tasks.assignedTo: The ID of the user to whom the task is assigned. An object with this ID appears in the user's array.
app.tasks.approvalStep: Indicates whether this task is an approval step. This is only valid for instances of workflow type.
app.attachments: The array of attachments associated with this instance or the process app that it was started from.
app.attachments.name: The name of the attachment.
app.attachments.id: The ID of the attachment.
app.attachments.uploadedBy: The ID of the user who uploaded the attachment. An object with this ID appears in the user's array.
app.attachments.uploadedOn: The date and time when the attachment was uploaded. The value is expressed in milliseconds since epoch, that is 1 January 1970 at midnight Coordinated Universal Time (UTC).
app.attachments.size: The size of the attachment in bytes.
app.attachments.deletedOn: The date and time when the attachment was deleted. The value is expressed in milliseconds since epoch, that is, 1 January 1970 at midnight Coordinated Universal Time (UTC). This field is present only if the file was deleted from the account through the admin pages. In this case, the user is unable to download the file using FileDownload.
app.attachments.deletedBy: The name of the user who deleted the attachment. This field is present only if the file is deleted from the account through the admin pages.
users: The array of the users whose IDs are referenced from other locations in the JSON.
users.name: The full name of the user.
users.id: The ID of the user.
users.avatarId: The ID of the avatar set by the user. This is only present if the user set an avatar.
work: The work object.
work.name: The name displayed for the work instance.
work.id: The ID of the work instance.

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.