Search projects

GET

https://example.itential.io/automation-studio/projects

GET

/automation-studio/projects

$ curl https://example.itential.io/automation-studio/projects \
>      -u "<username>:<password>"

1 {
2   "message": "Successfully retrieved projects",
3   "data": [
4     {
5       "_id": "62a1f3d2ebedfc54e6e0065c",
6       "iid": 1,
7       "name": "Firewall Service Provisioning",
8       "description": "This project is used at Acme Corp as the foundation of some major parts of our business process.",
9       "members": [
10         {
11           "type": "account",
12           "reference": "62a1f3d2ebedfc54e6e0065c",
13           "role": "owner",
14           "missing": true,
15           "username": "admin@pronghorn",
16           "name": "admin",
17           "provenance": "Pronghorn"
18         }
19       ],
20       "accessControl": {
21         "read": [
22           "account:67d3108eddcf3e66cc0efbac"
23         ],
24         "execute": [
25           "account:67d3108eddcf3e66cc0efbac"
26         ],
27         "write": [
28           "account:67d3108eddcf3e66cc0efbac"
29         ],
30         "manage": [
31           "account:67d3108eddcf3e66cc0efbac"
32         ]
33       },
34       "componentIidIndex": 1,
35       "components": [
36         {
37           "iid": 1,
38           "type": "workflow",
39           "reference": "1Ac4B2268489019745B5baa4",
40           "folder": "string"
41         }
42       ],
43       "folders": [
44         {
45           "children": [
46             null
47           ],
48           "name": "folder-1",
49           "nodeType": "folder"
50         }
51       ],
52       "created": "2019-11-25T22:51:39.201Z",
53       "lastUpdated": "2019-11-25T22:51:39.201Z",
54       "versionHistory": [
55         {
56           "versionNumber": 1,
57           "commitMessage": "string",
58           "author": "admin@pronghorn",
59           "branchName": "master"
60         }
61       ],
62       "gitConfiguration": {
63         "connectionType": "GitHub",
64         "repositoryPath": "Itential Open Source",
65         "branchName": "master",
66         "projectPath": "Projects"
67       }
68     }
69   ],
70   "metadata": {
71     "skip": 1.1,
72     "limit": 1.1,
73     "total": 1.1,
74     "previousPageSkip": null,
75     "nextPageSkip": null
76   }
77 }

Searches projects.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Query parameters

equalsobjectOptional

equals

inobjectOptional

starts-withobjectOptional

starts-with

containsobjectOptional

contains

sortenumOptional

sort

orderenumOptional

order

Allowed values:

skipdouble or stringOptional

skip

limitdouble or stringOptional

limit

Response

Projects

messagestring

datalist of objects

metadataobject

Errors

500

Internal Server Error