Get Using GET 5

Get Using GET 5

Gets a Variable with the given id

Request
URI
GET
http://cava-s-182-041.eng.vmware.com//codestream/api/variables/{id}
COPY
Path Parameters
string
id
Required

The ID of the Variable

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

Authentication
This operation uses the following authentication methods.
Responses
200

'Success' with the requested 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.

integer As int64 As int64
_updateTimeInMicros
Optional

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

string
_updatedBy
Optional

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

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 with time zone

string
createdBy
Optional

The user that created this entity

string
description
Required

A human-friendly description.

string
id
Optional

The id of this resource.

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
Optional

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

string
updatedAt
Optional

Date when the entity was last updated. The date is in ISO 8601 with time zone.

string
updatedBy
Optional

The user that last updated this entity

object
value
Optional

The value for this Variable.

string
version
Optional

Version of the resource.


401

Unauthorized Request

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

500

Server Error

Operation doesn't return any data structure

On This Page
Pipelines Operations
POST
Act On Pipeline Using POST
POST
Create Using POST 3
POST
Create Using POST 4
DELETE
Delete Using DELETE 11
DELETE
Delete Using DELETE 12
DELETE
Delete Using DELETE 8
DELETE
Delete Using DELETE 9
POST
Execute By Name Using POST
POST
Execute Using POST
GET
Export Using GET
GET
Get All Using GET 3
GET
Get All Using GET 5
GET
Get Execution By Index And Pipeline Id Using GET
GET
Get Execution By Name And Index Using GET
GET
Get Executions By Id Using GET
GET
Get Executions By Name Using GET
GET
Get Pipeline Tiles Using GET
GET
Get Using GET 2
GET
Get Using GET 3
GET
Get Using GET 5
GET
Get Using GET 6
POST
Import Yaml Using POST
PATCH
Patch Using PATCH
PATCH
Patch Using PATCH 1
PUT
Update Using PUT 2
PUT
Update Using PUT 3
PUT
Update Using PUT 4
PUT
Update Using PUT 5