This GET service will find a project by querying based on a name and application id and return the JSON representations of the objects. If no query parameters are given this request will return the entire list of projects.
Info | ||
---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/project?
folderPath Format
Examples:
|
Tip |
---|
The query parameters are not case sensitive. Searching by projectName=NAME is the same as searching by projectName=name. |
Request
Parameter | Required | Type | Description | |
---|---|---|---|---|
projectName | No | Query - String | This is a URL query parameter for the name which is used to query the projects with. Contains ignore case search | |
applicationId | No | Query - Long | This is a URL query parameter for application id which is used to query the projects within an application. | |
folderPath | folderId | No | Query - String | This is a URL query parameter which specified the path id of the desired folders (and optionally the application, but not the project name)folder and it's subfolders All projects in provided path specific folder or all it's subfolders will be considered, i.e. including any sub folders of provided path as well. |
isActive | No | Query - Boolean | This is a URL query parameter which specifies whether returned projects should only include active or inactive projects. If this parameter is not provided, both active and inactive projects may be returned. |
Include Page | ||||
---|---|---|---|---|
|
Response Codes
HTTP Code | Description |
---|---|
200 | Search successful and results returned |
400 | Bad request |
401 | Authentication failure |
403 | Authorization failure (no access to resource) |
500 | Unexpected internal server error |
Example
...