Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

HTTP CodeDescription
200Projects were found and returned
400Bad request
401UnauthorizedAuthentication failure
403Authorization failure (no access to resource)
500Unexpected 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
themeEclipse
titleProject - "Project1"
{
      "priority": 1,
      "projectName": "Project1XXHR",
   
    "projectId": 10002,
    "description": "EBS Customizations"Our,
thoughts become our words. Our words become our actions.",
   "applicationId": 10001,
    "applicationId": 10011,
    "projectPath": "FlexDeploy/EBSCustomizations/HR/XXHR",
    "priorityScope": "Application",
      "partialDeployment": falsetrue,
      "isActive": true,
      "scmType": "NONEGIT",
   "streams
    "scmConfiguration": {
        "sources": [
      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

Code Block
themeEclipse
titleGET JSON Response
{
   "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
            {
                "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
    ],
    "mainStreamName": "master",
    "deployInfo": {
        "workflowId": 15529,
        "instanceIds": [
            11153,
            11168,
            11183,
            11198,
            11213,
            11228,
            11243
        ]
    },
    "buildInfo": {
        "workflowId": 10869,
        "instanceId": 11153
    },
    "utilityExecutionInfo": null,
    "projectType": "EBS"
}