Update Using PUT 5 | vRealize Automation Code Stream API

Update Using PUT 5

Update an Variable with the given project and name

Request

URI

PUT

http://cava-s-182-041.eng.vmware.com//codestream/api/variables/{project}/{name}

COPY

Path Parameters

string

name

Required

The name of the Variable

string

project

Required

The project the Variable belongs to

Query Parameters

string

apiVersion

Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

Request Body

VariableSpec of type(s) application/json

Optional

{
    "description": "string",
    "name": "My-Name",
    "project": "My-Project",
    "type": "REGULAR",
    "value": "my-value"
}

string

description

Required

A human-friendly description.

string

name

Required

A human-friendly name used as an identifier in APIs that support this option

string

project

Optional

The project this entity belongs to.

string

type

Required

The type of this Variable. Ex: REGULAR / SECRET / RESTRICTED

string

value

Required

The value for this Variable.

Authentication

This operation uses the following authentication methods.

Authorization

Responses

200

'Success' with updated Variable

Returns Variable of type(s) */*

{
    "_createTimeInMicros": 1568625938000000,
    "_createdBy": "exampleuser",
    "_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "_updateTimeInMicros": 1568625938000000,
    "_updatedBy": "exampleuser",
    "createdAt": "2019-09-16 09:25:38.065065+00",
    "createdBy": "exampleuser",
    "description": "string",
    "id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "name": "My-Name",
    "project": "My-Project",
    "type": "REGULAR",
    "updatedAt": "2019-09-16 09:25:38.065065+00",
    "updatedBy": "exampleuser",
    "version": "v1"
}

integer As int64 As int64

_createTimeInMicros

Optional

This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds

string

_createdBy

Optional

This field is provided for backward compatibility. Contains the same value as the 'createdBy' field

string

_link

Optional

Partial URL that provides details of the resource.