Update a project variable

put/projects/{projectId}/variables/{variableId}
Internal-Use Only

Updates the project variable that is associated with the specified project ID and variable ID.

Request Samples

1

Response Samples

1{
2 "createdBy": "string",
3 "modifiedBy": "string",
4 "creationTimeStamp": "2019-08-24T14:15:22Z",
5 "modifiedTimeStamp": "2019-08-24T14:15:22Z",
6 "name": "string",
7 "description": "string",
8 "role": "string",
9 "type": "string",
10 "level": "string",
11 "format": "string",
12 "length": 0,
13 "version": 2
14}

Path Parameters

NameTypeRequiredDescription
projectId
string
true

The unique identifier for the project.

variableId
string
true

The unique identifier for the project variable.

Header Parameters

NameTypeRequiredDescription
If-Match
string
false

The entity tag obtained from the most recent ETag response header. Must match the current entity tag for the project variable.

Request Body

The representation of the updated project variable.

Contains information about a variable.

NameTypeRequiredDescription
createdBy
string
false

The user that created the variable.

modifiedBy
string
false

The user that last modified the variable.

creationTimeStamp
string<date-time>
false

The timestamp for when the variable was created, in the format of YYYY-MM-DDThh:mm:ss.sssZ.

modifiedTimeStamp
string<date-time>
false

The timestamp for when the variable was last modified, in the format of YYYY-MM-DDThh:mm:ss.sssZ.

name
string
false

The name of the variable.

description
string
false

The description of this variable.

role
string
false

The role of the variable. Valid values are: input, output, target

type
string
false

The type of variable. Valid values are: string, decimal, integer, boolean, date, datetime

level
string
false

The measurement level of the variable. Valid values are: binary, interval, nominal, ordinal

format
string
false

The format of the variable. An example is int32.

length
integer
false

The length of the variable.

version
integer
false

The variable representation version. The version is 2.

Default:
2

Responses

StatusMeaningDescription
200OKThe request succeeded. The project variable was updated.HeadersSchema
400Bad RequestThe request was invalid.Schema
404Not FoundNo project variable exists at the requested path.Schema
412Precondition FailedThe `If-Match` request header did not match the resource's entity tag, or the `If-Unmodified-Since` request header did not match the resource's last modified timestamp.Schema
428Precondition RequiredThe request headers did not include a `If-Match` or `If-Unmodified-Since` precondition.Schema