Anchor
...
Include Page
...
title | Base URL for Project REST API |
---|
...
http://host:port/flexdeploy/rest/v1/project
REST V1 Authentication REST V1 Authentication
Table of Contents | ||
---|---|---|
|
Each function returns a JSON Project object. The Project Object is an object that has these attributes,
Valid Source Control Management Types
Valid Project Types
Valid Priority Scope Types
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
Response Codes
Example:
If we had a Project in our database with the name 'Project1' with the following attributes:
theme | Eclipse |
---|---|
title | Project - "Project1" |
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} |
Request
Parameter | Required | Type | Description |
---|---|---|---|
id | Yes | URL | This is a URL path parameter for the id which is used to find a project. |
Include Page | ||||
---|---|---|---|---|
|
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, "utilityInstanceIds": [11275], "deployWorkflowId": 10873, "deployInstanceIds": [ 11153, 11168, 11183, 11198, 11213, 11228, 11243 ], "buildWorkflowId": 10869, 11213"buildInstanceId": 11153, "projectType": null 11228, 11243 ], "buildWorkflowId": 10869, "buildInstanceId": 11153, "projectType": null } |
Get(Using Query Parameters)
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.
...
title | 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}
...
}
|
Get(Using Query Parameters)
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.
Info | ||
---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/project? projectName={name} applicationId={applicationid} folderPath={folderPath} folderPath Format
{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 Examples:
|
Tip |
---|
The query parameters are not case sensitive. Searching by projectName=NAME is the same as searching by projectName=name. |
Parameters
...
...
...
...
...
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
...
|
Tip |
---|
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) |
Include Page | ||||
---|---|---|---|---|
|
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, "utilityInstanceIds": [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, "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
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 }, { "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 } ] |
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 |
Request
Parameter | Required | Type | Description | id | Yes | URL|
---|---|---|---|---|---|---|
This is a URL path parameter for the id which is used to execute a project. |
Response Codes
HTTP Code | Description | |||
---|---|---|---|---|
201 | Project was found and executed | |||
400 | Bad request | |||
401 | Unauthorized | |||
500 | Unexpected internal server error | Yes | URL | This is a URL path parameter for the id which is used to execute a project. |
JSON Attributes
Attributes | Required | Type | Description |
---|---|---|---|
| Y | Long | The Id of the Environment the project should be executed in. |
| N | List<Long> | A list of Instance Ids that the project should be executed on. If not supplied, the project will execute on the instances that are associated to the utility project. |
| N | Boolean | Values are true or false. Indicates that the deployment is an exception to the deployment window. Defaults to false. |
| N | DateTime | The time when the deployment will be started. The expected time format is: |
| N | String | Optionally, specify a workflow version to override the active workflow version. |
| N | Array | This is a list of |
| N | Array | This is a list of the |
Response Codes
HTTP Code | Description |
---|---|
201 | Project was found and executed |
400 | Bad request |
401 | Unauthorized |
500 | Unexpected internal server error |
Example
We can execute a Utility Project with Id 10004 with this request:
URL: http://host:port/flexdeploy/rest/v1/project/10004/execute
Code Block |
---|
{ "environmentId":10045, "instanceIds":[10044], "exceptionToWindow":false, "startTime":"2018-07-20T11:31:06Z", "workflowVersionOverride":"1.0", "inputs":[ {"code":"INPUT1","value":"Test"}, {"code":"INPUT2","value":"1234"} ], "flexFields":[ {"code":"FLEXFIELD1","value":"123"}, {"code":"FLEXFIELD2","value":"abc"} ] } |
In response, we will receive the workflowRequestId:
Code Block |
---|
10001 |
...