General Platform Configurations via the REST API

This section provides the details of the REST APIs used to manage general platform configurations via WSO2 EMM Console:

Configuring general platform settings

Description

Configure the general platform settings using this REST API. For more information on configuring the general platform settings via WSO2 EMM console, see General Platform Configurations.

Resource Path /

URL /mdm-admin/configuration/

HTTP Method POST

Request/Response Format application/json

cURL command

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -d @'<JSON_PAYLOAD>' -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-admin/configuration/

For more information on how to generate the <EMM_API_TOKEN>, see Generating the EMM API Token.
Define the path to the JSON file, which includes the required properties to update the platform configurations the as the <JSON_PAYLOAD> value. For more information, see the Sample JSON Definition.
By default, <EMM_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
By default, <EMM_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

Example:

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer f4c0c1b2b4ace7040132682139d51f74" -d @'configurations.json'-k -v https://localhost:9443/mdm-admin/configuration/

Sample output

> POST /mdm-admin/configuration/ HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 8e6ecc18eeec1c4f161e442aa2033146
> Content-Length: 86
< HTTP/1.1 201 Created
< Date: Fri, 11 Mar 2016 10:47:56 GMT
< Content-Type: application/json
< Content-Length: 81
< Server: WSO2 Carbon Server
{"statusCode":201,"messageFromServer":"Tenant configuration saved successfully."}

Sample JSON
Definition

{
  "configuration": [
    {
      "name": "notifierFrequency",
      "value": "600000",
      "contentType": "text"
    }
  ]
}

Property Value	Description
`configuration`	Defines the configuration properties.
`name`	The configuration property name.
`contentType`	When passing the configuration details to the EMM registry the contentType must be defined. The content type for notification frequency is text.
`value`	The value assigned to the respective configuration property. Define the notification frequency in milliseconds.

Getting general platform configurations

Description

Get the general platform level configuration details using this REST API.

Resource Path /

URL /mdm-admin/configuration/

HTTP Method GET

Request/Response Format application/json

cURL command

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-admin/configuration/

For more information on how to generate the <EMM_API_TOKEN>, see Generating the EMM API Token.
By default, <EMM_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
By default, <EMM_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

Example:

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer f4c0c1b2b4ace7040132682139d51f74" -k -v https://localhost:9443/mdm-admin/configuration/

Sample output

> GET /mdm-admin/configuration/ HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 83f5268347fa9590b7fb2cc18cf319bc
< HTTP/1.1 200 OK
< Cache-Control: private
< Expires: Thu, 01 Jan 1970 05:30:00 IST
< Date: Fri, 11 Mar 2016 05:30:33 GMT
< Content-Type: application/json
< Content-Length: 87
< Server: WSO2 Carbon Server
{"configuration":[{"name":"notifierFrequency","contentType":"text","value":"1000000"}]}

Sample JSON Output
Definition

{  
   "configuration":[  
      {  
         "name":"notifierFrequency",
         "contentType":"text",
         "value":"1000000"
      }
   ]
}

Property Value	Description
`configuration`	Defines the configuration properties.
`name`	The configuration property name.
`contentType`	When passing the configuration details to the EMM registry the contentType must be defined. The content type for notification frequency is text.
`value`	The value assigned to the respective configuration property. The notifier frequency value is given in milliseconds.

Updating general platform configurations

Description

Update the notification frequency using this REST API.

Resource Path /

URL /mdm-admin/configuration/

HTTP Method PUT

Request/Response Format application/json

cURL command

curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -d @'<JSON_PAYLOAD>' -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-admin/configuration/

For more information on how to generate the <EMM_API_TOKEN>, see Generating the EMM API Token.
Define the path to the JSON file, which includes the required properties to update the platform configurations the as the <JSON_PAYLOAD> value. For more information, see the Sample JSON Definition.
By default, <EMM_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
By default, <EMM_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

Example:

curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer f4c0c1b2b4ace7040132682139d51f74" -d @'configurations.json'-k -v https://localhost:9443/mdm-admin/configuration/

Sample output

> PUT /mdm-admin/configuration/ HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 8e6ecc18eeec1c4f161e442aa2033146
> Content-Length: 86
< HTTP/1.1 200 OK
< Cache-Control: private
< Expires: Thu, 01 Jan 1970 05:30:00 IST
< Date: Fri, 11 Mar 2016 10:53:49 GMT
< Content-Type: application/json
< Content-Length: 83
< Server: WSO2 Carbon Server
{"statusCode":200,"messageFromServer":"Platform configuration updated successfully."}

Sample JSON
Definition

{
  "configuration": [
    {
      "name": "notifierFrequency",
      "value": "400000",
      "contentType": "text"
    }
  ]
}

Property Value	Description
`configuration`	Defines the configuration properties.
`name`	The configuration property name.
`contentType`	When passing the configuration details to the EMM registry the contentType must be defined. The content type for notification frequency is text.
`value`	The value assigned to the respective configuration property. The notifier frequency value is given in milliseconds.