Application (POST)
Deploys an application.
Description
A deployable application
It first checks whether the input deployable is valid. Then, it transfers the deployable to the database and to the runtime.
This transaction can run synchronously or asynchronously. If processed asynchronously, the REST service returns before the transaction is completed. In this case, you can query the transaction result later by using the transaction REST service.
Roles
Users in the following roles are authorized to perform this operation:
- mfpadmin
- mfpdeployer
Method
POST
Path
/management-apis/2.0/runtimes/runtime-name/applications
Example
https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/applications?async=false&locale=de_DE
Path Parameters
- runtime-name
- The name of the runtime. This is the context root of the runtime web application, without the leading slash.
Query Parameters
Query parameters are optional.
- async
- Whether the transaction is processed synchronously or asynchronously. The allowed values are
true
andfalse
. By default, transactions are processed in synchronous mode. - locale
- The locale used for error messages.
Consumes
application/json
Produces
application/json, application/xml, text/xml
Payload
JSON Example
Android
{
"applicationKey" : {
"packageName" : "com.example.android",
"clientPlatform" : "android",
"version" : "1.0"
},
"displayName" : "android_sample",
"mandatoryScope" : "appAuthenticity",
"securityCheckConfigurations" : {
"appAuthenticity" : {
"expirationSec" : "1200"
}
},
"scopeElementMapping": {
"UserNamePassword": "LtpaBasedSSO appAuthenticity"
}
}
iOS
{
"applicationKey" : {
"bundleId" : "com.example.ios",
"clientPlatform" : "ios",
"version" : "1.0"
},
"displayName" : "ios_sample",
"mandatoryScope" : "appAuthenticity",
"securityCheckConfigurations" : {
"appAuthenticity" : {
"expirationSec" : "1200"
}
},
"scopeElementMapping": {
"UserNamePassword": "LtpaBasedSSO appAuthenticity"
}
}
Payload Properties
The payload has the following properties:- applicationKey
- application key
- displayName
- Display Name
- mandatoryScope
- scope
- scopeElementMapping
- scope element mapping
- securityCheckConfigurations
- security check configuration
The applicationKey has the following properties:
- bundleId
- this is for iOS. Note: For Android, use packageName. For Windows, use assemblyName.
- clientPlatform
- The client platform
- version
- version
The securityCheckConfigurations has the following properties:
- appAuthenticity
- app auth configurations
The expirationSec has the following properties:
- expirationSec
- expiration in sec
Response
The metadata of the deployable.
XML Example
<?xml version="1.0" encoding="UTF-8"?>
<deploy-application-result
ok="false"
productVersion="8.0">
<transaction
appServerId="Tomcat"
id="1"
status="FAILURE"
timeCreated="2014-04-13T00:18:36.979Z"
timeUpdated="2014-04-14T00:18:36.979Z"
type="UPLOAD_ARTIFACT"
userName="demouser">
<description
name="myname"
type="mytype"/>
<errors>
<error details="An internal error occured."/>
...
</errors>
<project name="myproject"/>
</transaction>
</deploy-application-result>
Response Properties
The response has the following properties:
- ok
- Whether the transaction was successful.
- productVersion
- The exact product version.
- transaction
- The details of the transaction.
The transaction has the following properties:
- appServerId
- The id of the web application server.
- description
- The details of the deployable.
- errors
- The errors occurred during the transaction.
- id
- The id of the transaction.
- project
- The current project.
- status
- The state of the transaction:
PENDING
,PREPARING
,COMMITTING
,REJECTING
,SUCCESS
,FAILURE
,CANCELED
. Synchronous transactions can have the stateSUCCESS
andFAILURE
. Asynchronous transactions can also have the other states. - timeCreated
- The date in ISO 8601 format when the adapter was created.
- timeUpdated
- The date in ISO 8601 format when the adapter was updated.
- type
- The type of the transaction, here always
UPLOAD_ARTIFACT
. - userName
- The user that initiated the transaction.
The description has the following properties:
- contentNames
- The optional names of the contained artifacts if multiple artifacts were deployed at once.
- filename
- The optional file name of the artifact.
- name
- The name of the artifact.
- type
- The type of the artifact.
The error has the following properties:
- details
- The main error message.
The project has the following properties:
- name
- The name of the project, which is the context root of the runtime.
Errors
400No deployable data is provided.403
The user is not authorized to call this service.404
The corresponding runtime is not found or not running.500
An internal error occurred.