Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
Description

Update the notification frequency using this REST API.

Resource Path/
URL/mdm-admin/configuration/
HTTP MethodPUT
Request/Response Formatapplication/json
cURL command
Code Block
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:

Code Block
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
Code Block
> 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."}
Anchor
sampleUpdatePlatform
sampleUpdatePlatform
Sample JSON
Definition 
Code Block
{
  "configuration": [
    {
      "name": "notifierFrequency",
      "value": "400000",
      "contentType": "text"
    }
  ]
} 

Property Value

Description

configurationDefines the configuration properties.
nameThe configuration property name.
contentTypeWhen passing the configuration details to the EMM registry the contentType must be defined. The content type for notification frequency is text.
valueThe value assigned to the respective configuration property. The notifier frequency value is given in milliseconds.