This GET service will find a Project by Id and return a JSON representation of it.
http://host:port/flexdeploy/rest/v1/project/{id} |
Parameter | Required | Type | Description |
|---|---|---|---|
| id | Yes | URL | This is a URL path parameter for the id which is used to find a project. |
| HTTP Code | Description |
|---|---|
| 200 | Projects were found and returned |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 500 | Unexpected internal server error |
If we had a Project in our database with the name 'Project1' with the following attributes:
{
"priority": 1,
"projectName": "Project1",
"description": "Our thoughts become our words. Our words become our actions.",
"applicationId": 10001,
"priorityScope": "Application",
"partialDeployment": false,
"isActive": true,
"scmType": "NONE",
"streams": [
10802,
10803,
10804,
10805
],
"deployWorkflowId": 10873,
"deployInstanceIds": [
11153,
11168,
11183,
11198,
11213,
11228,
11243
],
"buildWorkflowId": 10869,
"buildInstanceId": 11153,
"projectType": null
}
|
When we run a GET request at the following URL:
http://host:port/flexdeploy/rest/v1/project/10002
The GET request would return the following JSON project object
{
"priority": 1,
"projectName": "Project1",
"description": "Our thoughts become our words. Our words become our actions.",
"applicationId": 10001,
"priorityScope": "Application",
"partialDeployment": false,
"isActive": true,
"scmType": "NONE",
"streams": [
10802,
10803,
10804,
10805
],
"utilityWorkflowId": 11434,
"utilityInstanceIds": [11275],
"deployWorkflowId": 10873,
"deployInstanceIds": [
11153,
11168,
11183,
11198,
11213,
11228,
11243
],
"buildWorkflowId": 10869,
"buildInstanceId": 11153,
"projectType": null
}
|