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.
API URLs
http://host:port/flexdeploy/rest/v1/project?
Append the following character sequences to the above URL to specify Query parameters. Use '&' between successive query parameters:
- projectName={name}
- applicationId={applicationid}
- folderPath={folderPath}
folderPath Format
- Path parameters are separated by slashes(forward or backward).
- Trailing slashes will be ignored.
- Single leading slashes are ignored.
- To access a folder or application, it's full path from the project archive root folder must be used.
- A shorted path is valid, but will return more results.
- The project archive root folder is an optional path parameter.
- Folders and applications are considered path parameters.
- Forward and backward slashes are accepted
- Project names are not considered path parameters. For example,
- The folderPath used to access the 'AccountingApps' application :
- /Flexdeploy/CommerceProjects/AccountingApps/
- or
- CommerceProjects\AccountingApps
- i.e. you can omit FlexDeploy at start of folderPath
Examples:
- To search by name only: http://host:port/flexdeploy/rest/v1/project?projectName={name}
- To search by group only: http://host:port/flexdeploy/rest/v1/project?applicationId={applicationid}
- To search by folderPathonly: http://host:port/flexdeploy/rest/v1/project?folderPath={folderPath}
- To search by name and applicationId: http://host:port/flexdeploy/rest/v1/project?projectName={name}&applicationId={applicationid}
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 | URL(query) | This is a URL query parameter for the name which is used to query the projects with. |
| applicationId | No | URL(query) | This is a URL query parameter for application id which is used to query the projects within an application. |
| folderPath | No | URL(query) | This is a URL query parameter which specified the path of the desired folders (and optionally the application, but not the project name) |
Response
| Attributes | Type | Description |
|---|---|---|
| projectName | String | This is the name of the project. |
| applicationId | String | This is the type of the project. |
| projectPath | String | Fully qualified project path. |
| isActive | Boolean | This is a Boolean that tracks whether or not the project is active. Null input defaults to true. |
| description | String | This is the group of the project. |
| partialDeployment | Boolean | This is the subgroup of the project. Null input defaults to false. |
| priority | Integer | This is the description of the project. |
| projectType | String | This is the id of the active version of the workflow. Must be a valid project type. |
| scmType | String | This specifies the source control management system used by this project. Must be a valid source control management system. |
| priorityScope | String | This specifies the priority scope of the current project. Either 'Global', 'Folder' or 'Application' |
| buildWorkflowId | Long | This Long specifies the id of the build workflow used by this project. |
| buildInstanceId | Long | This id the build instance used by this project. |
| utilityWorkflowId | Long | This id specifies the utility workflow used by this project. |
| utilityInstanceIds | List<Long> | This id specifies the utility instance used by this project. |
| deployWorkflowId | Long | This id specifies the deployment workflow used by this project. |
| deployInstanceIds | List<Long> | This is a list of id's which identify the deployment instances for this project. |
| streams | List<Long> | This is a list of id's which identify the Project Streams associated with this project. |
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Projects were found and returned |
| 400 | Bad request |
| 401 | Unauthorized |
| 500 | Unexpected internal server error |
Example
If we had Projects in our database with the names 'Project1' and 'Project2' and the following attributes:
Project - "Project1"
{
"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
}
Project - "Project2"
{
"priority": 1,
"description": "No Permissions",
"applicationId": 10001,
"isActive": true,
"scmType": "SVN",
"projectType": null,
"projectName": "Project2",
"streams": [],
"priorityScope": "Application",
"partialDeployment": false,
"utilityWorkflowId": null,
"utilityInstanceIds": null,
"deployWorkflowId": null,
"buildWorkflowId": null,
"deployInstanceIds": null,
"buildInstanceId": null
}
When we run a GET request at the following URL
http://host:port/flexdeploy/rest/v1/project?applicationId=10001
The GET request would return the following JSON workflow object
{
"priority": 1,
"description": "No Permissions",
"applicationId": 10001,
"isActive": true,
"scmType": "SVN",
"projectType": null,
"projectName": "Project2",
"streams": [],
"priorityScope": "Application",
"partialDeployment": false,
"utilityWorkflowId": null,
"utilityInstanceIds": null,
"deployWorkflowId": null,
"buildWorkflowId": null,
"deployInstanceIds": null,
"buildInstanceId": null
}