Check if project variables exist

head/projects/{projectId}/variables
Internal-Use Only

Returns the header information for the project input variables and output variables that are associated with the specified project ID. Also used to determine whether project variables exist.

Request Samples

1

Response Samples

1{
2 "name": "string",
3 "start": 0,
4 "limit": 0,
5 "count": 0,
6 "accept": "string",
7 "links": [
8 {
9 "method": "string",
10 "rel": "string",
11 "uri": "string",
12 "href": "string",
13 "title": "string",
14 "type": "string",
15 "itemType": "string",
16 "responseType": "string",
17 "responseItemType": "string"
18 }
19 ],
20 "version": 0,
21 "items": [
22 {
23 "createdBy": "string",
24 "modifiedBy": "string",
25 "creationTimeStamp": "2019-08-24T14:15:22Z",
26 "modifiedTimeStamp": "2019-08-24T14:15:22Z",
27 "name": "string",
28 "description": "string",
29 "role": "string",
30 "type": "string",
31 "level": "string",
32 "format": "string",
33 "length": 0,
34 "version": 2
35 }
36 ]
37}

Path Parameters

NameTypeRequiredDescription
projectId
string
true

The unique identifier for the project.

Query Parameters

NameTypeRequiredDescription
filter
string<filter-criteria>
false

The criteria for filtering the projects. For more information, see Filtering in REST APIs.

limit
integer<int32>
false

The maximum number of items to return in this request.

Default:
20
name
string<sort-criteria>
false

A query string that allows a search by name to find a variable in a project.

sortBy
string
false

The criteria for sorting the projects. For more information, see Sorting in REST APIs.

start
integer<int32>
false

The 0-based start index of a paginated request.

>= 0
Default:
0

Responses

StatusMeaningDescription
200OKThe request succeeded.Schema
400Bad RequestThe request was invalid.Schema