Versions Compared

Key

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

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

Include Page
FD60:REST V1 Authentication
FD60:REST V1 Authentication

Table of Contents
maxLevel2

Valid Source Control Management Types

Source Control Management SystemJSON String Representation
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"

Valid Project Classifications

Classification TypesJSON String Representation
Standard"Standard"
Package Based (previously called Partial Deployments)"PackageBased"
Utility"Utility"
Container"Container"

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)

Include Page
FD70:Project API GET By IdFD70:
Project API GET By Id

GET (Using Query Parameters)

Include Page
FD70:Project API GET by ParametersFD70:
Project API GET by Parameters

PATCH

Include Page
FD70:Project API PATCHFD70:
Project API PATCH

POST

Create Project

Include Page
FD70:Project API CreateFD70:
Project API Create

Build Project (Using Id)

Anchor
buildproject
buildproject

Include Page
FD70:Project API BuildFD70:
Project API Build

Deploy Project (Using Id)

Anchor
deployproject
deployproject

Include Page
FD70:Project API DeployFD70:
Project API Deploy

Execute Utility Project (Using Id)

Anchor
executeutilityproject
executeutilityproject

Include Page
FD70:Project API ExecuteFD70:
Project API Execute

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

Include Page
FD60:REST V1 Authentication
FD60:REST V1 Authentication

Table of Contents
maxLevel2

Valid Source Control Management Types

Source Control Management SystemJSON String Representation
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"

Valid Project Classifications

Classification TypesJSON String Representation
Standard"Standard"
Package Based (previously called Partial Deployments)"PackageBased"
Utility"Utility"
Container"Container"

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)

Include Page
FD70:Project API GET By IdFD70:
Project API GET By Id

GET (Using Query Parameters)

Include Page
FD70:Project API GET by ParametersFD70:
Project API GET by Parameters

PATCH

Include Page
FD70:Project API PATCHFD70:
Project API PATCH

POST

Create Project

Include Page
FD70:Project API CreateFD70:
Project API Create

Build Project (Using Id)

Anchor
buildproject
buildproject

Include Page
FD70:Project API BuildFD70:
Project API Build

Deploy Project (Using Id)

Anchor
deployproject
deployproject

Include Page
FD70:Project API DeployFD70:
Project API Deploy

Execute Utility Project (Using Id)

Anchor
executeutilityproject
executeutilityproject

Include Page
FD70:Project API ExecuteFD70:
Project API Execute