Versions Compared

Key

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

Anchor
Top
Top

...

GET (Using Query Parameters)

This GET service will return a list of Project Streams from the specified project in the form of JSON objects based on the query parameter streamname. Project Streams are only returned if they match all of the specified query parameters and belong to the corresponding Project. If no query parameters are given this request will return the entire list of Streams within the specified Project.


Info
titleAPI URLs

http://host:port/flexdeploy/rest/project/{projectid}/stream?

Append the following character sequences to the above URL to specify Query parameters.
Use '&' between successive query parameters: 

name={name}

Examples:
To search by code only:

http://host:port/flexdeploy/rest/project/{projectid}/stream?name={name}

...

Example

If the POST request receives the following JSON Project Stream object and the project id of 10237

Code Block
themeEclipse
titlePOST JSON
{
      "description": "123",
      "streamName": "NewStream",
      "isActive": true,
      "attribute2": "2",
      "versionSyntaxScript": "\"1.0.\" + SequenceNumber",
      "attribute3": "3",
      "attribute1": "1",
      "projectId": 10237
  
}

The following Project Stream object will then be created as a new Stream for Project 10237

Code Block
themeEclipse
titleProject Stream Post Return JSON
{
      "description": "123",
      "streamName": "NewStream",
      "isActive": true,
      "streamId": 12723,
      "attribute2": "2",
      "versionSyntaxScript": "\"1.0.\" + SequenceNumber",
      "attribute3": "3",
      "attribute1": "1"
   }


...

PATCH

This PATCH service will update an existing Project Stream with the information passed through a JSON object. If an attribute of the JSON is null it will not be updated in the Project Stream.


Info
titleAPI URL

http://host:port/flexdeploy/rest/project/{projectid}/stream/{streamid}

...