Versions Compared

Old Version 1

changes.mady.by.user Chandresh Patel

Saved on

compared with

New Version Current

changes.mady.by.user Emily Simon

Saved on

Key

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

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}
  • isActive={isActive}

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.
  • Forward and backward slashes are accepted
  • Project names are not considered path parameters. For example,
    • The folderPath used to access the 'AccountingApps' application :
    • /Flexdeploy/CommerceProjects/AccountingApps/
      • or
    • CommerceProjects\AccountingApps
    • i.e. you can omit FlexDeploy at start of folderPath

Examples:


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)Query - String

This is a URL query parameter for the name which is used to query the projects with.

Contains ignore case search

applicationIdNoURL(query)Query - LongThis is a URL query parameter for application id which is used to query the projects within an application.
folderPathNoURL(query)Query - String

This is a URL query parameter which specified the path of the desired folders (and optionally the application, but not the project name)

All projects in provided path will be considered, i.e. including any sub folders of provided path as well.

isActive


NoQuery - Boolean

@Since 5.1.0.2

This is a URL query parameter which specifies whether returned projects should only include active or inactive projects.

If this parameter is not provided, both active and inactive projects may be returned.

Include Page
REST V1 Project Response
REST V1 Project Response

Response Codes

HTTP Code
Description
200
Projects were found
Search successful and results returned
400Bad request
401
Unauthorized
Authentication failure
403Authorization failure (no access to resource)
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
themeEclipse
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
themeEclipse
{
   "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
}