Anchor

	Top
	Top

Project Properties can be accessed and modified through this API using three services: GET,PUT, and PATCH. These three services allow for the retrieval, complete update, and partial update of Project Properties.

...

Each function returns a JSON of Project Property objects. The Project Property object has these attributes:

Attributes	Type	Description
propertyName	String	This is the name of the definition of a Project Property
propertyValue	String	The value associated with the property name

Back to Top

...

GET

There is one implementation which will find a list of Project Properties associated with the URL specified Project and return the JSON representation of the list of Project Properties.

GET by ID

This GET service will find list of Project Properties associated with the given Project and return the JSON representation of the list.

...

Info

title	API URL

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

Parameters

Parameter	Type	Required	Description
projectid	URL	Yes	This is a URL parameter for the Project Id which is searched to find and return the Properties associated with it.

Response Codes

HTTP Code	Description
200	Project was found and it's properties returned
400	Bad request
401	Unauthorized
404	Project was not found with the specified project id
500	Unexpected internal server error

Example

If we had a Project in our database with an Id of 11101 and the following properties.

Code Block

theme	Eclipse
title	Project 11101 Properties

	{
      "propertyName": "Approved Check Script",
      "propertyValue": "MyCheckScript"
   },
      {
      "propertyName": "ServiceNow Password",
      "propertyValue": "Password"
   },
      {
      "propertyName": "ServiceNow Port",
      "propertyValue": "MyPort"
   },
      {
      "propertyName": "ServiceNow URL",
      "propertyValue": "MyURL"
   },
      {
      "propertyName": "ServiceNow User Name",
      "propertyValue": "MyUserName"
   }

When we run a GET request at the following URL

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

The GET request would return the following JSON Project Property list

Code Block

theme	Eclipse
title	Project 11101 Properties GET Return JSON

[
      {
      "propertyName": "Approved Check Script",
      "propertyValue": "MyCheckScript"
   },
      {
      "propertyName": "ServiceNow Password",
      "propertyValue": "*****"
   },
      {
      "propertyName": "ServiceNow Port",
      "propertyValue": "MyPort"
   },
      {
      "propertyName": "ServiceNow URL",
      "propertyValue": "MyURL"
   },
      {
      "propertyName": "ServiceNow User Name",
      "propertyValue": "MyUserName"
   }
]

Back to Top

PUT

This PUT service will update the propertyValue of each property in the project associated with the Project id specified in the URL.

Info

title	API URL

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

Code Block

theme	Eclipse
title	Sample PUT JSON Request

[
      {
      "propertyName": "Approved Check Script",
      "propertyValue": "Put1"
   },
      {
      "propertyName": "ServiceNow Password",
      "propertyValue": "Put2"
   },
      {
      "propertyName": "ServiceNow Port",
      "propertyValue": "Put3"
   },
      {
      "propertyName": "ServiceNow URL",
      "propertyValue": "Put4"
   },
      {
      "propertyName": "ServiceNow User Name",
      "propertyValue": "Put5"
   }
]

Parameters

Attributes	Type	Required	Description
projectid	URL	Yes	This is the Id of the Project which will have it's Properties updated.
propertyName	String	No	This is the name of the type of the single property associated with it. (Can be many)
propertyValue	String	No	This is the value that will be updated to for the property with the associated propertyName. (Can be many)

Note: unlisted properties will default to null.

Response Codes

HTTP Code	Description
200	Project was found and it's Properties were updated
400	Bad request
401	Unauthorized
404	Project not found
500	Unexpected internal server error

Example

If we had an Project in our database with a Project Id of 25262 and the following Properties

...

Code Block

theme	Eclipse
title	Project Properties PUT Return JSON

[
      {
      "propertyName": "Approved Check Script",
      "propertyValue": "Put1"
   },
      {
      "propertyName": "ServiceNow Password",
      "propertyValue": "*****"
   },
      {
      "propertyName": "ServiceNow Port",
      "propertyValue": "Put3"
   },
      {
      "propertyName": "ServiceNow URL",
      "propertyValue": "Put4"
   },
      {
      "propertyName": "ServiceNow User Name",
      "propertyValue": "Put5"
   }
]

Back to Top

PATCH

This PATCH service will update an existing Project's Properties with the information passed through a JSON object. If a property is not listed it will not be updated in the Project.

Info

title	API URL

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

Parameters

Attributes	Type	Required	Description
projectid	URL	Yes	This is the Id of the Project which will have it's Properties updated.
propertyName	String	No	This is the name of the type of the single property associated with it. (Can be many)
propertyValue	String	No	This is the value that will be updated to for the property with the associated propertyName. (Can be many)

Response Codes

HTTP Code	Description
200	Project was found and it's Properties were updated
400	Bad request
401	Unauthorized
404	Project not found
500	Unexpected internal server error

Example

If we had a Project in our database with an Id of 12723 and had the following attributes

Code Block

theme	Eclipse
title	Project Properties PATCH JSON

[
      {
      "propertyName": "Approved Check Script",
      "propertyValue": "MyCheckScript"
   },
      {
      "propertyName": "ServiceNow Password",
      "propertyValue": "MyPassword"
   },
      {
      "propertyName": "ServiceNow Port",
      "propertyValue": "MyPort"
   },
      {
      "propertyName": "ServiceNow URL",
      "propertyValue": "MyURL"
   },
      {
      "propertyName": "ServiceNow User Name",
      "propertyValue": "MyUserName"
   }
]

When we run a PATCH request at the following URL

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

And the PATCH request receives the following JSON Project Properties object,

Code Block

theme	Eclipse
title	Project PATCH Receive JSON

[ 
   {
       "propertyName": "ServiceNow URL",
       "propertyValue": "PatchedURL"
    },
       {
       "propertyName": "ServiceNow User Name",
       "propertyValue": "PatchedUserName"
    }
]

The PATCH request would then update the specified Project's Properties and return the following JSON object

Code Block

theme	Eclipse
title	Project Properties PATCH Return JSON

[
      {
      "propertyName": "Approved Check Script",
      "propertyValue": "MyCheckScript"
   },
      {
      "propertyName": "ServiceNow Password",
      "propertyValue": "MyPassword"
   },
      {
      "propertyName": "ServiceNow Port",
      "propertyValue": "MyPort"
   },
      {
      "propertyName": "ServiceNow URL",
      "propertyValue": "PatchedURL"
   },
      {
      "propertyName": "ServiceNow User Name",
      "propertyValue": "PatchedUserName"
   }
]

Back to Top

...

Versions Compared

Old Version 4

New Version 5

Key

GET

GET by ID

Parameters

Response Codes

Example

PUT

Parameters

Response Codes

Example

PATCH

Parameters

Response Codes

Example

Page Comparison

Versions Compared

Old Version 4

New Version 5

Key

GET

GET by ID

Parameters

Response Codes

Example

PUT

Parameters

Response Codes

Example

PATCH

Parameters

Response Codes

Example