Get all available projects

get/projects

Returns a list of all projects that SAS Event Stream Manager is aware of. The project's XML code is not returned. You can return basic information that includes the project's ID, name, and version number.

Request Samples

1

Response Samples

1{
2 "accept": "application/json",
3 "count": 3,
4 "items": [
5 {
6 "archived": false,
7 "configurationLevel": 0,
8 "deployments": 0,
9 "description": "Project description.",
10 "flowId": "77d60de4-5950-4b2e-9971-2b1dc44a441e",
11 "friendlyName": "simple2",
12 "hasMasModules": false,
13 "majorVersion": 1,
14 "minorVersion": 0,
15 "packaged": false,
16 "production": true,
17 "promotionLevel": 0,
18 "tags": [
19 "Tag1",
20 "Tag2"
21 ],
22 "updateTime": 1675175938303,
23 "uploadTime": 1675175938303,
24 "uploadedBy": "user1",
25 "uuid": "547340017",
26 "version": 1,
27 "versionNotes": "This is the initial version."
28 },
29 {
30 "archived": false,
31 "configurationLevel": 0,
32 "deployments": 0,
33 "description": "Project description.",
34 "flowId": "df9cba7c-78dc-49d2-bd0b-0079dc0d27f1",
35 "friendlyName": "simple1",
36 "hasMasModules": false,
37 "majorVersion": 1,
38 "minorVersion": 0,
39 "packaged": false,
40 "production": false,
41 "promotionLevel": 0,
42 "tags": [
43 "Tag1",
44 "Tag2"
45 ],
46 "updateTime": 1675175938265,
47 "uploadTime": 1675175938265,
48 "uploadedBy": "user1",
49 "uuid": "1245504538",
50 "version": 1,
51 "versionNotes": "This is the initial version."
52 },
53 {
54 "archived": false,
55 "configurationLevel": 0,
56 "deployments": 0,
57 "description": "Project description.",
58 "flowId": "3f783dd4-534a-4511-a958-0c406531ecf4",
59 "friendlyName": "timerDemo",
60 "hasMasModules": false,
61 "majorVersion": 1,
62 "minorVersion": 0,
63 "packaged": false,
64 "production": false,
65 "promotionLevel": 0,
66 "tags": [
67 "connector"
68 ],
69 "updateTime": 1675175922858,
70 "uploadTime": 1675175922858,
71 "uploadedBy": "user1",
72 "uuid": "2001076455",
73 "version": 1,
74 "versionNotes": "This is the initial version."
75 }
76 ],
77 "limit": 50,
78 "name": "items",
79 "start": -1,
80 "version": 2
81}

Query Parameters

NameTypeRequiredDescription
filter
string
false

The filter parameter. For example, to filter by name use filter=eq(name,theProjectName).

limit
integer<int32>
false

The maximum number of records to be returned.

Default:
50
noDetails
boolean
false

If this parameter is set to true, then the project representations contain minimal details.

Default:
false
sort
string
false

When this parameter is provided, it specifies the type of sort that should be applied to the returned list. If the type of sort is not specified, the representations are returned with the most recent listed first. The only supported sort is alphabetical (a locale-sensitive alphabetical sort in ascending order).

Default:
start
integer<int64>
false

The number of the first record to be returned.

Default:
-1
suitableFor
string
false

If this parameter is set to production, then only production projects are returned. If this parameter is set to test, then only non-production projects are returned. Otherwise, projects are returned regardless of their production status.

Allowed values:
productiontest
Default:
test

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema