| Anchor | ||||
|---|---|---|---|---|
|
Projects can be accessed through this API using the GET service.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/project |
...
Each function returns a JSON Project object. The Project Object is an object that has these attributes,
| Attributes | Type | Description |
|---|---|---|
| projectName | String | This is the name of the project. |
| applicationId | String | This is the type of the project. |
| 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. |
| utilityWorkflowInstanceIdsutilityInstanceIds | 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. |
Valid Source Control Management Types
| Source Control Management System | JSON String Representation |
|---|---|
| ClearCase Unified Control Management | "CCUCM" |
| Concurrent Version System | "CVS" |
| Git | "GIT" |
| File System | "FILE" |
| Perforce | "PERF" |
| Polytron Version Control System | "PVCS" |
| Subversion | "SVN" |
| Team Foundation Version Control | "TFVC" |
Valid Project Types
| Project Type | JSON String Representation |
|---|---|
| General | "GENERAL" |
| Managed File Transfer | "MFT" |
| Partial File | "PARTIAL_FILE" |
| Oracle Forms | "OracleForms" |
| Oracle Database | "ORACLE_DB" |
| Oracle Business Intelligence | "ORACLE_BI" |
| Sales Force | "SALESFORCE" |
| Utility | "UTILITY" |
| Generic | "GENERIC" |
Valid Priority Scope Types
| Priority Scope Types | JSON String Representation |
|---|---|
| Application | "Application" |
| Folder | "Folder" |
| Global | "Global" |
GET
There are two implementations of GET. One will find a Project with the given Id and return the JSON representation of the Project. The other will find a list of Projects matching the parameters supplied to it.
GET (Using Id)
This GET service will find a Project by Id and return a JSON representation of it.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/project/{id} |
Parameters
Parameter | Required | Type | Description |
|---|---|---|---|
| id | Yes | URL | This is a URL path parameter for the id which is used to find a 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 a Project in our database with the name 'Project1' with the following attributes:
| 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
],
"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 | ||||
|---|---|---|---|---|
| ||||
{
"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,
"utilityWorkflowInstanceIdsutilityInstanceIds": [11275],
"deployWorkflowId": 10873,
"deployInstanceIds": [
11153,
11168,
11183,
11198,
11213,
11228,
11243
],
"buildWorkflowId": 10869,
"buildInstanceId": 11153,
"projectType": null
}
|
Get(Using Query Parameters)
...
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/project? projectName={name} applicationId={applicationid} folderPath={folderPath} Path Format:{pathParam1}/{pathParam2}/{pathParam3}/... Example:Flexdeploy/CommerceProjects/AccountingApps/ Note: forward and backward slashes are accepted Examples:
|
| Tip |
|---|
The query parameters are not case sensitive. Searching by projectName=NAME is the same as searching by projectName=name. |
Parameters
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) |
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.
- Project names are not considered path parameters
{pathParam1}/{pathParam2}/{pathParam3}/...
Example:
The folderPath used to access the 'AccountingApps' application :
/Flexdeploy/CommerceProjects/AccountingApps/
or
CommerceProjects\AccountingApps
Note: forward and backward slashes are accepted
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:
| 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,
"utilityWorkflowInstanceIdsutilityInstanceIds": [11275],
"deployWorkflowId": 10873,
"deployInstanceIds": [
11153,
11168,
11183,
11198,
11213,
11228,
11243
],
"buildWorkflowId": 10869,
"buildInstanceId": 11153,
"projectType": null
}
|
| Code Block | ||
|---|---|---|
| ||
{
"priority": 1,
"description": "No Permissions",
"applicationId": 10001,
"isActive": true,
"scmType": "SVN",
"projectType": null,
"projectName": "Project2",
"streams": [],
"priorityScope": "Application",
"partialDeployment": false,
"utilityWorkflowId": null,
"utilityWorkflowInstanceIdsutilityInstanceIds": 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
| 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,
"utilityWorkflowInstanceIdsutilityInstanceIds": [11275],
"deployWorkflowId": 10873,
"deployInstanceIds": [
11153,
11168,
11183,
11198,
11213,
11228,
11243
],
"buildWorkflowId": 10869,
"buildInstanceId": 11153,
"projectType": null
},
{
"priority": 1,
"description": "No Permissions",
"applicationId": 10001,
"isActive": true,
"scmType": "SVN",
"projectType": null,
"projectName": "Project2",
"streams": [],
"priorityScope": "Application",
"partialDeployment": false,
"utilityWorkflowId": null,
"utilityWorkflowInstanceIdsutilityInstanceIds": null,
"deployWorkflowId": null,
"buildWorkflowId": null,
"deployInstanceIds": null,
"buildInstanceId": null
}
] |
POST
Execute Utility Project (Using Id)
This POST service will perform the same action found on the Execute Utility Project Request Form off the project screen. It will initiate a request to execute the project with the Project ID specified in the URL. The service will return the workflowRequestId which can be used by the getWorkflowRequestStatus call to determine when the workflow is complete.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/project/{id}/execute |
...