Get All Projects
Get all projects with specified paging parameters.
Filters projects based on the viewer role. When the value is true it will not return the projects in which the current user is only viewer and will ignore privileged roles: CodeStream:Developer and CodeStream:Executor, if the user has them. Else it will return all projects that the user can read. The default value is false.
Filters projects based on the supervisor role. When the value istrue it will not return the projects in which the current user is having only supervisor role
Filters projects based on the member role and the access to the resources of the project. When the value is true it will not return the projects in which the current user is only member and the project is not with shared resources.
Optional permissions that, if granted to the users, allow them access to the proper set of projects. If the user actually has any of those permissions, the 'excludeViewer' parameter has no effect.
Select a subset of properties to include in the response. Possible values for this parameter are id, name, description, operationTimeout, constraints. Id will always be included in the response
id,name,constraintsResults page you want to retrieve (0..N)
5Number of records per page.
100Sorting criteria in the format: property (asc | desc). Default sort order is ascending.
The version of the API in yyyy-MM-dd format. For versioning information refer to /project-service/api/about.
'Success' with projects on pages
{
"totalElements": 0,
"totalPages": 0,
"size": 0,
"content": [
{
"id": "string",
"name": "my-name",
"description": "my-description",
"orgId": "string",
"administrators": [
{
"email": "[email protected]",
"type": "user"
}
],
"members": [
{
"email": "[email protected]",
"type": "user"
}
],
"viewers": [
{
"email": "[email protected]",
"type": "user"
}
],
"supervisors": [
{
"email": "[email protected]",
"type": "user"
}
],
"users": [
{
"email": "[email protected]",
"type": "user"
}
],
"auditors": [
{
"email": "[email protected]",
"type": "user"
}
],
"advancedUsers": [
{
"email": "[email protected]",
"type": "user"
}
],
"constraints": {
"network": {
"conditions": [
{
"type": "TAG",
"enforcement": "HARD",
"occurrence": "MUST_OCCUR",
"expression": {
"key": "key",
"value": "value"
}
}
]
}
},
"properties": {
"myproperty": "enforcement",
"__projectPlacementPolicy": "SPREAD",
"__namingTemplate": "my-resource-template",
"__allowTerraformCloudzoneMapping": "true"
},
"cost": {
"cost": "number",
"costSyncTime": "2011-12-03T10:15:30Z",
"costUnit": "USD",
"message": "string",
"code": "string"
},
"operationTimeout": 0,
"sharedResources": false
}
],
"number": 0,
"sort": [
{
"direction": "string",
"nullHandling": "string",
"ascending": false,
"property": "string",
"ignoreCase": false
}
],
"numberOfElements": 0,
"pageable": {
"offset": 0,
"sort": [
{
"direction": "string",
"nullHandling": "string",
"ascending": false,
"property": "string",
"ignoreCase": false
}
],
"paged": false,
"pageNumber": 0,
"pageSize": 0,
"unpaged": false
},
"first": false,
"last": false,
"empty": false
}totalElements
totalPages
size
A Project is a group of users.
number
sort
numberOfElements
pageable
first
last
empty
Unauthorized, the user is not authenticated
Forbidden, the user lacks permissions
curl -H 'Authorization: <value>' https://{api_host}/project-service/api/projects