REST API for System Property in OIG

Update a System Property

put

/iam/governance/api/v1/systemconfiguration/systemproperty

Updates existing System Property in OIG.

Request

Supported Media Types

application/json

System Property details to update an already existing property.

Root Schema : SystemPropertyBody

Type: object

Show Source

ptyKeyword(optional): string

Property keyword for new system property.
ptyName(optional): string

Property name for new system property.
ptyValue(optional): string

Property value for new system property.

{
    "type":"object",
    "properties":{
        "ptyKeyword":{
            "type":"string",
            "description":"Property keyword for new system property."
        },
        "ptyValue":{
            "type":"string",
            "description":"Property value for new system property."
        },
        "ptyName":{
            "type":"string",
            "description":"Property name for new system property."
        }
    }
}

Response

204 Response

successful operation.

Root Schema : ReturnedId

Type: object

Show Source

id(optional): string

Id of system property.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of system property."
        }
    }
}

400 Response

Invalid input.

Examples

The following example shows how to update the exisiting system property by submitting PUT request submission on the REST resource using cURL. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl -i -X PUT -u username:password  \
--header 'Content-Type: application/json' \
--header 'X-Requested-By: <anyvalue>' \
--data-raw '{"id":"demoKey1","ptyKeyword":"demoKey2","ptyValue":"demoValue2","ptyName":"demoName2"}' \
'http://pseudo.com/iam/governance/adminservice/api/v1/systemconfiguration/systemproperty'

Example of Response Body

The following example shows the JSON response for a request to update the existing system property:

{
    "sysPropertyKey": 0
}