Set Parameter

Set Parameter

Sets the value of one CM parameter according to value in request.

Request
URI
PUT
https://{api_host}/v0alpha1/cmdata/{id}/{parameter_name}
COPY
Request Body
CMAtom of type(s) application/json
Required
value
Required

One value for a CM parameter may be a string, number, boolean or an array of any one of those. Or the value may be an object.

Responses
200

One value for the CM parameter to be set on the cell identified in the request URI. The value can be a string, number, boolean or an array of any one of those.

Returns CMAtom of type(s) application/json
"CMAtom Object"
value
Required

One value for a CM parameter may be a string, number, boolean or an array of any one of those. Or the value may be an object.


400

Request body is incorrectly formed.

Returns ProblemDetails of type(s) application/problem+json
"ProblemDetails Object"
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


404

The requested parameter does not exist.

Returns ProblemDetails of type(s) application/problem+json
"ProblemDetails Object"
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"value:"undefined"}' https://{api_host}/v0alpha1/cmdata/{id}/{parameter_name}