Application Object
Contains information about an app.
The full list of parameters included in the Application object is below. Parameter usage varies according to which operation is using the object and whether it's used as part of a request or response.
This object is used by the following operations:
- POST /api/apps (in request and response)
- PUT /api/apps/{AppID} (in response)
- GET /api/apps/{AppID} (in response)
- Operations that reference the ContractApplication object
- Operations that reference the Applications object
- Operations that reference the ReferencedObjects object
The properties included in the Application object are listed below.
| Property | Type | Description |
|---|---|---|
| AppID | string |
The unique ID for a specific app. Required except when adding an app. |
| Name | string |
The display name of the app version; for example, 1.0. Required when adding or modifying an app. |
| Description | string |
Text description of the app. Optional. |
| Summary | string |
A brief, plain-text description of the app. Optional. |
| Visibility | string |
The visibility setting for this resource. For a list of valid values, see Visibility Settings. In request messages, defaults to Public if not specified. |
| InitialEnvironment | string | The initial environment for the app (normally Sandbox). |
| DefaultVersionID | string |
Unique ID for the latest or only version of an app. Used in response objects; not needed for requests. |
| Tag | string[ ] |
One or more user-defined tags for the app version. Optional. |
| IsFollowed | boolean |
A flag indicating whether the resource is being followed. Response only. |
| RatingSummary | RatingSummary |
An aggregated, averaged summary of individual user ratings for the resource, including the current ratings count for each possible value (1, 2, 3, 4, or 5). Used only in response messages. Response only. |
| PictureID | long | The unique ID for the Dropbox image uploaded, to be assigned for the app as an avatar. Optional in request, not present in response. |
| State | string |
The current state of the app. For valid values, see App State Values. Response only. |
| Created | dateTime | The date/time stamp when the resource was first created. Used only in response messages. |
| Updated | dateTime | The date/time stamp when the resource was last updated. Used only in response messages. |
| AvatarURL | anyURI | URL for the avatar uploaded for the resource, if any. Used only in response messages. |
| ApplicationVersion | ApplicationVersion | Contains information about a version of an app. Required when adding an app. |
| AppSettings | AppSettings | Contains information about the settings for an app. Response only. |
| TeamID | string | The unique ID for the app team associated with the app. |
| Image | Image | Contains information about an avatar associated with a resource. |
| ApplicationVersions | ApplicationVersions | Contains information about one or more app versions. |
| Connections | long | The number of connections for the resource. |
| Followers | long | The number of users following the resource. |
| Rating | float | The overall rating for the resource. |
| BusinessID | string |
The unique ID for a specific business organization on the platform. Returned if the app is assigned to a business. |
| TargetResources | TargetResources | Contains information about one or more resources associated with the current resource. Used only in response messages. |
