The List Specific Application call returns a JSON object representing the specified Application.


Query:


http://host/dmadminweb/API/application/identifier?

[latest=y&][branch=<name>]


Where:


Host

Is the hostname and port of the DeployHub Server (e.g.: hostname:8080 or for SaaS console.deployhub.com).

Identifier

Is the identifier of the Application. Either its name, its qualified name (i.e.: with its parent domain(s) included in dot notation), or its internal ID.


If latest is set to ‘Y’ then the latest Version of the Application is returned.  To use this flag, the specified identifier must refer to an Application Base Version, otherwise the flag has no effect.


If branch is set along with latest then the latest version on the specified branch name is returned.


NOTE:  the resulting JSON will vary slightly depending on whether the specified application is an Application Base Version or an Application Version.


Example Result:


Application Version:


{

       "success": true,

       "result": {

               "approvals": [

                       {

                               "domain": "Test",

                               "note": "",

                               "timestamp": 1455801949,

                               "user": "tester1"

                       }

                       Repeats for each approval

               ],

               "rejections": [

               ],

               "branch": "",

               "components": [

                       {

                               "id": 181,

                               "lastbuild": 155,

                               "name": "ITGuysApp",

                               "summary": ""

                       }

                       Repeats for each component

               ],

                               "domain": "FIS.Test",

               "id": 221,

               "name": "ITGuys;2",

               "owneruser": "fisadmin",

               "predecessor": {

                       "id": 220,

                       "name": "ITGuys;1",

                       "summary": ""

               },

                               "requests": [

                                       {

                                               "apiurl": "https://....",

                                               "htmlurl": "https://....",

                                               "id": "140",

                                               "status": "closed",

                                               "title": "Creation Rights Missing"

                                       },

                       Repeats for each change request

               ],

               "summary": "This is v2"

       }

}


Example Result:


Application Base Version:


{

       "success": true,

       "result": {

               "approvals": [

                       {

                               "domain": "Test",

                               "note": "",

                               "timestamp": 1455801949,

                               "user": "tester1"

                       }

                       Repeats for each approval

               ],

               "rejections": [

               ],

               "branch": "",

               "components": [

                       {

                               "id": 181,

                               "name": "ITGuysApp",

                               "summary": ""

                       }

                       Repeats for each component

               ],

                               "domain": "FIS.Test",

               "id": 221,

               "lastbuild": 179,

               "name": "ITGuys;2",

               "owneruser": "fisadmin",

                               "requests": [

                                       {

                                               "apiurl": "https://....",

                                               "htmlurl": "https://....",

                                               "id": "140",

                                               "status": "closed",

                                               "title": "Creation Rights Missing"

                                       },

                       Repeats for each change request

               ],

                               "versions": [

                               {

                                       "id": 220,

                                       "name": "ITGuys;1",

                                       "summary": ""

               }

               Repeats for each version

               ],

               "summary": "This is v2"

       }

}


success:

Is true or false depending on the success or failure of the query. If success is false, then result is not returned and a text field named “error” is returned instead.

result:

Is a JSON object representing the application being retrieved.

approvals:

Is a JSON array containing a list of JSON Objects representing the approvals that have been performed on this Application. Within each approval object:

Domain is the name of the approval Domain

Note is any note entered when the approval was executed

Timestamp is the time the approval was executed (epoch time)

User is the name of the user executing the approval

Rejections is a JSON array containing a list of JSON Objects representing the rejections that have been performed on this application. Within each rejection object:

Note is any note entered when the approval was executed

User is the name of the user executing the approval

Branch is the name of the branch on which this Application is located (if an Application Version. If no branch is specified, this string is zero length.

Components        are a JSON array containing a list of JSON Objects representing the Components that make up the application.

Summary is the summary text associated with the Application.




Within each Component object:


id:

Is the Component’s internal ID.

lastbuild:

Is the last build number associated with this Component (0 if never built or no associated build job).

name:

Is the name of the Component.

summary:

Is the summary text associated with the Component.

Domain:

The fully-qualified domain name of the Domain in which the Application is located.

id:

Is the internal ID of the Application.

name:

Is the name of the Application.

owneruser:

If the “owner” of the Application is a user, then this is the name of the User.

ownergroup:

If the “owner” of the application is a User Group, then this is the name of that Group.

predecessor:

Only returned for Application Versions. A JSON Object representing the predecessor of this Application (if the Application is a Version).


Within the predecessor object:


id:        

Is the internal Application ID.

name:        

Is the name of the predecessor Application.

summary:

Is the summary text associated with the predecessor Application.

versions:        

Only returned for Application Base Versions. A JSON Array of JSON objects representing the versions of this Application.


Within each version object:


id:

Is the internal Application ID.

name:

Is the name of the Application Version.

summary:

Is the summary text associated with the Application Version.



Within each request object:


id:

Is the ID of the Change Request as known by the external change tracking system.

title:

Is the description of the Change Request.

status:

Is the status of the Change Request.

api_url:

Is the URL of the API call to the external change tracking system that is required to return more data about the specified Change Request.

html_url:

Is the URL of the page in the external change tracking system which details more information about the Change Request.