Jump to

• Request
• Response

Update an existing parameter

patch

/service/v1/sysParams/{key}

This endpoint is used to update an existing parameter.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• key: string
  key of the parameter that need to be updated

Header Parameters

• appId: string
  App ID
• branchCode: string
  Branch Code
• userId: string
  User ID

Body ()

Request Body that contains data required for updating an existing System Parameter

Root Schema : ScfSystemParamModel

Type: object

Scf System Param model

Show Source

• id(optional): integer(int64)
  Id of the Parameter
• key(optional): string
  Key for the parameter.This is a unique constraint
• value(optional): string
  Configured value which will be used in rest of application.

{
    "description":"Scf System Param model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the Parameter",
            "type":"integer",
            "format":"int64"
        },
        "key":{
            "description":"Key for the parameter.This is a unique constraint",
            "type":"string"
        },
        "value":{
            "description":"Configured value which will be used in rest of application.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns updated parameter

Body ()

Root Schema : ScfSystemParamModel

Type: object

Scf System Param model

Show Source

• id(optional): integer(int64)
  Id of the Parameter
• key(optional): string
  Key for the parameter.This is a unique constraint
• value(optional): string
  Configured value which will be used in rest of application.

{
    "description":"Scf System Param model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the Parameter",
            "type":"integer",
            "format":"int64"
        },
        "key":{
            "description":"Key for the parameter.This is a unique constraint",
            "type":"string"
        },
        "value":{
            "description":"Configured value which will be used in rest of application.",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top