Project API GET By Id

This GET service will find a Project by Id and return a JSON representation of it.

API URLs

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.

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	Authentication failure
403	Authorization failure (no access to resource)
500	Unexpected internal server error

Example

If we had a Project in our database with the name 'Project1' with 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
   ],
   "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

GET 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,
   "buildInstanceId": 11153,
   "projectType": null
}

FlexDeploy 5.1

Project API GET By Id

Analytics

Request

Response

Response Codes

Example

Related content