Import Application Endpoint

The Import Application is an endpoint in BuildMaster's Application Management API that can create an application from an exported package (i.e., template, sample, or backup) and return an ApplicationInfo object describing the imported application.

curl -X POST -H "Content-Type: application/json" -H "X-ApiKey: abc12345" -d "{\"name\": \"ImportedApp\",\"packageSource\": \"BackupResource\",\"packageId\": \"MyApp\",\"packageVersion\": \"1.0.0\",\"importHistory\": true,\"overwrite\": false,\"raft\": null}" https://proget.corp.local/api/applications/import

Importing and Exporting in BuildMaster can be quite complex, see Migrating Application-by-Application for more details on performing these.

Request

To import an application, simply POST to the URL with an appropriate API Key and an ImportApplication object as the request body.

POST /api/applications/import

Querystring parameters may be used for ImportApplication object properties instead of the Body

POST /api/applications/import?«ImportApplication-properties»

Importing an application with an ImportApplication body requires the URL and the body in the request:

POST /api/applications/import
{
   "name": "ImportedApp",
   "packageSource": "BackupResource",
   "packageId": "MyApp",
   "packageVersion": "1.0.0",
   "importHistory": true,
   "overwrite": false,
   "raft": null
}

Importing an application with querystring parameters requires the name (e.g. importedApp) and other querystring parameters specified in the ImportApplication object

POST /api/applications/import?name=ImportedApp&packageSource=BackupResource&packageId=MyApp&packageVersion=1.0.0&importHistory=true&overwrite=false&raft=null

Response

A successful (200) response body will contain an ApplicationInfo object. For example, to import a application named ImportedApp:

the request would return this:

POST /api/applications/clone

{
    "id":3,
    "name":"ImportedApp",
    "active":true,
    "buildNumberScheme":"Sequential",
    "releaseUsage":"Required",
    "allowIssues":false
}