Versions Compared

Old Version 32

changes.mady.by.user Chandresh Patel

Saved on

compared with

New Version 33

changes.mady.by.user Chandresh Patel

Saved on

Key

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

AnchorTopTopProjects can be accessed through this Projects can be accessed through this API using the GET service.

...

Include Page

...

titleBase URL for Project REST API

...

http://host:port/flexdeploy/rest/v1/project

REST V1 Authentication
REST V1 Authentication

Table of Contents
maxLevel2

Each function returns a JSON Project object. The Project Object is an object that has these attributes,

AttributesTypeDescriptionprojectNameStringThis is the name of the project.applicationIdStringThis is the type of the project.isActiveBooleanThis is a Boolean that tracks whether or not the project is active. Null input defaults to true.descriptionStringThis is the group of the project.partialDeploymentBooleanThis is the subgroup of the project. Null input defaults to false.priorityIntegerThis is the description of the project.projectTypeStringThis is the id of the active version of the workflow. Must be a valid project type.scmTypeStringThis specifies the source control management system used by this project. Must be a valid source control management system.priorityScopeStringThis specifies the priority scope of the current project. Either 'Global', 'Folder' or 'Application'buildWorkflowIdLongThis Long specifies the id of the build workflow used by this project.buildInstanceIdLongThis id the build instance used by this project.utilityWorkflowIdLongThis id specifies the utility workflow used by this project.utilityInstanceIdsList<Long>This id specifies the utility instance used by this project.deployWorkflowIdLongThis id specifies the deployment workflow used by this project.deployInstanceIdsList<Long>This is a list of id's which identify the deployment instances for this project.streamsList<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 SystemJSON String RepresentationClearCase 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 TypeJSON String RepresentationGeneral"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 TypesJSON String RepresentationApplication"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
titleAPI URLs

http://host:port/flexdeploy/rest/v1/project/{id}

Parameters

Parameter
Required
Type
Description
idYesURLThis is a URL path parameter for the id which is used to find a project.

Response Codes

HTTP CodeDescription200Projects were found and returned400Bad request401Unauthorized500Unexpected internal server error

Example:

If we had a Project in our database with the name 'Project1' with the following attributes:

Code Block
themeEclipse
titleProject - "Project1"
{    "priority": 1,    "projectName": "Project1",    "description": "Our thoughts become our words. Our words become our actions.",    "applicationId": 10001,    "priorityScope": "Application",    "partialDeployment": false,    "isActive":

Valid Source Control Management Types

Source Control Management SystemJSON 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 TypeJSON 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 TypesJSON 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
titleAPI URLs

http://host:port/flexdeploy/rest/v1/project/{id}

Request

Parameter
Required
Type
Description
idYesURLThis is a URL path parameter for the id which is used to find a project.

Include Page
REST V1 Project Response
REST V1 Project Response

Response Codes

HTTP CodeDescription
200Projects were found and returned
400Bad request
401Unauthorized
500Unexpected internal server error

Example

If we had a Project in our database with the name 'Project1' with the following attributes:

Code Block
themeEclipse
titleProject - "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
   ],
   "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,
      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.

...

titleAPI 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
titleAPI 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.
  • 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

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}
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

...

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

...

  • /v1/project?projectName={name}&applicationId={applicationid}


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
projectNameNoURL(query)This is a URL query parameter for the name which is used to query the projects with.
applicationIdNoURL(query)This is a URL query parameter for application id which is used to query the projects within an application.
folderPathNoURL(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
REST V1 Project Response
REST V1 Project Response

Response Codes

HTTP Code
Description
200Projects were found and returned
400Bad request
401Unauthorized
500Unexpected internal server error

Example

If we had Projects in our database with the names 'Project1' and 'Project2' and the following attributes:

Code Block
themeEclipse
titleProject - "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
}


Code Block
titleProject - "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

Code Block
titleSearch By applicationid={10001}
[
  {
   "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
titleAPI URLs

http://host:port/flexdeploy/rest/v1/project/{id}/execute


Parameters

Request

URL
Parameter
Required
Type
Description
idYes
This is a URL path parameter for the id which is used to execute a project.

Response Codes

HTTP CodeDescription
201Project was found and executed
400Bad request
401Unauthorized
500Unexpected internal server errorYesURLThis is a URL path parameter for the id which is used to execute a project.


JSON Attributes

Attributes

Required

Type

Description

environmentId

Y

Long

The Id of the Environment the project should be executed in.

instanceIds

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.

exceptionToWindow

N

Boolean

Values are true or false. Indicates that the deployment is an exception to the deployment window. Defaults to false.

startTime

N

DateTime

The time when the deployment will be started. The expected time format is: yyyy-MM-dd'T'HH:mm:ssXXX

workflowVersionOverride

N

String

Optionally, specify a workflow version to override the active workflow version.

inputs

N

Array

This is a list of code/value pairs for the inputs. Not all inputs need to be supplied. If an input has a default value that is acceptable for the Workflow to run, it does not need to be supplied.

flexFields

N

Array

This is a list of the code/value pairs for the Flexfields. Not all FlexFields need to be supplied. If a FlexField has a default value or options that are acceptable for the workflow to run, it does not need to be changed.

Response Codes

HTTP CodeDescription
201Project was found and executed
400Bad request
401Unauthorized
500Unexpected 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

...