REST API for System Property in OIG

Create a new System Property

post

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

Creates a new System Property in OIG.

Request

Supported Media Types

application/json

System Property details for new property to be created.

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

201 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 add system property details for a new property to be created by submitting a POST request 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 POST -u username:password \
--header 'Content-Type: application/json' \
--header 'X-Requested-By: <anyvalue>' \
--data-raw '{"ptyKeyword":"demoKey1","ptyValue":"demoValue1","ptyName":"demoName1"}' '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 create a new system property with the key ID 164:

{
    "sysPropertyKey": 164
}