Runtime configuration (PUT)

Sets the user configuration of a specific runtime.

Description

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 with the transaction REST service.

Roles

Users in the following roles are authorized to perform this operation:

  • mfpadmin
  • mfpdeployer

Method

PUT

Path

/management-apis/2.0/runtimes/runtime-name/config

Example

https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/config?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. Allowed values are true and false. The default is synchronous processing.
locale
The locale used for error messages.

Consumes

application/json, application/xml, text/xml

Produces

application/json, application/xml, text/xml

Payload

JSON Example

{
  "adapters" : {
    "compressResponseThreshold" : {
      "value" : 20480,
    },
  },
  "analytics" : {
    "additionalPackages" : {
      "value" : "com.admin.util",
    },
  },
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<runtimeconfig>
  <adapters>
    <compressResponseThreshold value="20480"/>
  </adapters>
  <analytics>
    <additionalPackages value="com.admin.util"/>
  </analytics>
</runtimeconfig>

Payload Properties

The payload has the following properties:
adapters
The runtime properties for adapter.
analytics
The runtime properties for analtyics

The adapter-property has the following properties:

compressResponseThreshold
Compression threshold, in bytes, from which the server tries to compress the MobileFirst adapter response if the client accepts gzip.

The compressthreshold has the following properties:

value
The value of the compression threshold

The analytics-property has the following properties:

additionalPackages
A comma-separated list of packages that the logger uses to generate the output sent to the MobileFirst Analytics server.

The additional package has the following properties:

value
The list of packages that the logger uses

Response

The configuration of the specified runtime.

JSON Example

{
  "ok" : false,
  "productVersion" : "8.0",
  "transaction" : {
    "appServerId" : "Tomcat",
    "description" : {
      "name" : "myname",
      "type" : "mytype",
    },
    "errors" : [
      {
        "details" : "An internal error occured.",
      },
      ...
    ],
    "id" : 1,
    "project" : {
      "name" : "myproject",
    },
    "status" : "FAILURE",
    "timeCreated" : "2014-04-13T00:18:36.979Z",
    "timeUpdated" : "2014-04-14T00:18:36.979Z",
    "type" : "SET_APPLICATION_ENV_VERSION_ACCESS_RULE",
    "userName" : "demouser",
  },
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<set-runtimeconfig-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="SET_APPLICATION_ENV_VERSION_ACCESS_RULE"
    userName="demouser">
    <description
      name="myname"
      type="mytype"/>
    <errors>
      <error details="An internal error occured."/>
      ...
    </errors>
    <project name="myproject"/>
  </transaction>
</set-runtimeconfig-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 application.
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 state SUCCESS and FAILURE. 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 SET_APPLICATION_ENV_VERSION_ACCESS_RULE.
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

400
The payload is invalid.
403
The user is not authorized to call this service.
404
The corresponding runtime is not found.
500
An internal error occurred.