Get projects

get/projects

Returns a list of all projects, including basic information about the projects.

Request Samples

1

Response Samples

1{
2 "accept": "application/json",
3 "count": 4,
4 "items": [
5 {
6 "createdBy": "user1",
7 "createdOn": 0,
8 "description": "This is the project's description.",
9 "uuid": "020944ae-d714-47c8-b7b6-6cad763bb223",
10 "friendlyName": "tradesproj",
11 "label": "tradesproj",
12 "lastModifiedTime": 1674733254368,
13 "modifiedBy": "user1",
14 "privateProject": true,
15 "tags": [
16 "Project"
17 ],
18 "type": "ESP Project",
19 "uploadTime": 1674733254368,
20 "uploadedBy": "user1",
21 "version": 1,
22 "versionNotes": "This is the initial version."
23 },
24 {
25 "createdBy": "user1",
26 "createdOn": 0,
27 "description": "This is the project's description.",
28 "uuid": "08cb631a-a037-4595-862e-c183a007dac2",
29 "friendlyName": "patternProject",
30 "label": "patternProject",
31 "lastModifiedTime": 1674731994270,
32 "modifiedBy": "user1",
33 "privateProject": true,
34 "tags": [
35 "Project"
36 ],
37 "type": "ESP Project",
38 "uploadTime": 1674731993985,
39 "uploadedBy": "user1",
40 "version": 1,
41 "versionNotes": "This is the initial version."
42 },
43 {
44 "createdBy": "user1",
45 "createdOn": 0,
46 "description": "This is the project's description.",
47 "uuid": "8d18545d-c3dc-429d-91f1-4d96e5247f32",
48 "friendlyName": "sailingProject",
49 "label": "sailingProject",
50 "lastModifiedTime": 1674731978108,
51 "modifiedBy": "user1",
52 "privateProject": true,
53 "tags": [
54 "Project"
55 ],
56 "type": "ESP Project",
57 "uploadTime": 1674731977710,
58 "uploadedBy": "user1",
59 "version": 1,
60 "versionNotes": "This is the initial version."
61 },
62 {
63 "createdBy": "user1",
64 "createdOn": 0,
65 "description": "This is the project's description.",
66 "uuid": "f4e30745-fce4-4700-8d6a-277567a4effb",
67 "friendlyName": "arrayProjectForCluster",
68 "label": "arrayProjectForCluster",
69 "lastModifiedTime": 1674731963595,
70 "modifiedBy": "user1",
71 "privateProject": true,
72 "tags": [
73 "Project"
74 ],
75 "type": "ESP Project",
76 "uploadTime": 1674731963386,
77 "uploadedBy": "user1",
78 "version": 1,
79 "versionNotes": "This is the initial version."
80 }
81 ],
82 "limit": 50,
83 "name": "items",
84 "start": 0,
85 "version": 2
86}

Query Parameters

NameTypeRequiredDescription
filter
string
false

The filter parameter.

limit
integer<int32>
false

The maximum number of records to be returned.

>= -1<= 100
Default:
50
start
integer<int64>
false

The number of the first record to be returned.

>= 0
Default:
0

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema