Jump to

• Request
• Response
• Examples

Update Configuration Value

put

/ohfapi/cg/v3.3/config

This endpoint lets the admin to update the Configuration value. Make sure that the Configuration Key being updated already exists.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Root Schema : ConfigurationEntry

Type: object

Show Source

• configName: string
  The configuration name(API/NEXTGEN).
• key: string
  Key entry for the configuration. The typical ones are api.dateformat for date format , api.pagination.limit for default pagination limit.
• value: string
  The value for the configuration.

{
    "type":"object",
    "required":[
        "configName",
        "key",
        "value"
    ],
    "properties":{
        "key":{
            "type":"string",
            "description":"Key entry for the configuration. The typical ones are api.dateformat for date format ,  api.pagination.limit for default pagination limit. "
        },
        "value":{
            "type":"string",
            "description":"The value for the configuration."
        },
        "configName":{
            "type":"string",
            "description":"The configuration name(API/NEXTGEN)."
        }
    }
}

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

Default Response

successful operation

Back to Top

Examples

The following example submits a PUT request.

http://localhost:7010/ohfapi/cg/v3.3/config

Example of Request Body

The following example shows the contents of the response body in JSON format:

{
   "key":"api.pagination.limit",
   "value" : "200"
}

Back to Top