...
| HTTP Code | Description |
|---|---|
| 200 | Projects were found and returned |
| 400 | Bad request |
| 401Unauthorized | 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 attributesid 10002, 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:
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"priority": 1,
"projectName": "Project1",
"XXHR",
"projectId": 10002,
"description": "OurEBS Customizations",
thoughts become our words. Our words become our actions.",
"applicationId": 10001,
"applicationId": 10011,
"projectPath": "FlexDeploy/EBSCustomizations/HR/XXHR",
"priorityScope": "Application",
"partialDeploymentprojectClassification": false"PartialDeployments",
"isActive": true,
"scmType": "NONE",
"scmType": "GIT",
"scmConfiguration": {
"sources": [
{
"instanceId": 15551,
"configValues": [
{
"configName": "BranchScript",
"configValue": "StreamName"
},
{
"configName": "TagScript",
"configValue": "ProjectVersion"
},
{
"configName": "SparseCheckoutFoldersScript",
"configValue": "\"EBSCustomizations/XXHR\""
},
{
"configName": "CheckoutFolderScript",
"configValue": "ProjectName"
}
],
"sourceNumber": 1
}
]
},
"streams": [
10802,
10803,
10804,
10805
],
"deployWorkflowId
"mainStreamName": "master",
"deployInfo": {
"workflowId": 1087315529,
"deployInstanceIds "instanceIds": [
11153,
11168,
11183,
11198,
11213,
11228,
11243
],
"buildWorkflowId
11243
]
},
"buildInfo": {
"workflowId": 10869,
"buildInstanceIdinstanceId": 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
| Code Block | ||||
|---|---|---|---|---|
| ||||
{ "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 "preDeployInfo": { "workflowId": 42978 }, "utilityExecutionInfo": null, "projectType": "EBS", "packageBuildType": "BOTH", "webhooksEnabled": false, "containerConfiguration": { "dockerfile": "docker file name" "dockerStreams": [ { "isImageBuild": true, "isImagePush": false, "streamName": "master", "streamId": 12345, "imageName": "image name" } ], "kubernetesConfiguration": { "manifestsToDeploy": [ "deploymanifest1" ], "blueGreenManifests": [ "bluegreenmanifest1", "bluegreenmanifest2" ], "canaryManifests": [ "canarymanifest1" ], "abmanifests": [ "abmanifest1", "abmanifest2", "abmanifest3" ], "helmConfiguration": { "parametersMap": [ { "key": "key1", "valueScript": "value1" }, { "key": "key2", "valueScript": "value2" } ], "releaseName": "release name", "chart": "chart name" }, "deploymentName": "deployment name" } } } |