Anchor

	Top
	Top

...

Table of Contents

maxLevel	1

...

Anchor

	Overview
	Overview

Overview

:

Environments can be accessed and modified through this API using four services: GET, POST, PUT, and PATCH. These four services allow for the retrieval, creation, complete update, and partial update of environments.
GET
POST
PUT
PATCH

You can find more information about the REST API functions on the Topology REST API page.

Each function returns a JSON environment object. The environment object has these attributes:
Attributes Type Description
description String This is a description of the environment
instances List<Long> This is a list of the Instance Ids associated with the environment
isActive Boolean This is a boolean that tracks whether or not the environment is active
environmentCode String This is the unique code of the environment
sortNumber Integer This is a number associated with the environment that sets the environments priority in a list of other environments
environmentId Long This is the unique Id of the environment
isBuildEnvironment Boolean This is a boolean that tracks whether or not the environment is a build environment
environmentName String This is the unique name of the environment

Back to Top

...

GET

...

GET

There are two implementations of GET. One will find an environment with the given Id and return the JSON representation of the environment. The other will find a list of environments matching the parameters supplied to it.

...

GET (Using Query Parameters)

This GET service will return a list of environments in the form of JSON objects based on the query parameters code and name. Environments are only returned if they match all of the specified query parameters. If no query parameters are given this request will return the entire list of environments.

Info

title	API URLs

http://host:port/flexdeploy/rest/topology/environment?

Append the following character sequences to the above URL to specify Query parameters.

Use '&' between successive query parameters:

code={code}

name={name}

Examples:

To search by code only:

http://host:port/flexdeploy/rest/topology/environment?code={code}

To search by name only:

http://host:port/flexdeploy/rest/topology/environment?name={name}

To search by code and name:

http://host:port/flexdeploy/rest/topology/environment?code={code}&name={name}

...

Expand

title	GET (Using Query Parameters) Example

Example

If we had an environment in our database with an Id of 11101 and had the following attributes

Code Block

theme	Eclipse
title	Environment - 11101

{
   "description": "This is Environment 1" 
   "instances": [15100],
   "isActive": true,
   "environmentCode": "ENV1",
   "sortNumber": 1,
   "environmentId": 11101,
   "isBuildEnvironment": true,
   "environmentName": "Env 1"
}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/topology/environment/?code=ENV1&name=Env 1

The GET request would return the following JSON environment object

Code Block

theme	Eclipse
title	Environment GET Return JSON

{
   "description": "This is Environment 1",
   "instances": [15100],
   "isActive": true,
   "environmentCode": "ENV1",
   "sortNumber": 1,
   "environmentId": 11101,
   "isBuildEnvironment": true,
   "environmentName": "Env 1"
}

Back to Top

...

POST

This POST service will create a new environment with the same attributes as the given JSON object.

...

Expand

title	Post Example

Example

If the POST request receives the following JSON environment object,

Code Block

theme	Eclipse
title	POST JSON

{
   "description": "This is Post 1",
   "instances": [15100,15101],
   "isActive": true,
   "environmentCode": "POST1",
   "sortNumber": 1,
   "environmentId":00000,
   "isBuildEnvironment": true,
   "environmentName": "Post 1"
}

The following environment object will then be created as a new row in the database.

Code Block

theme	Eclipse
title	Environment Post Return JSON

{
   "description": "This is Environment 1",
   "instances": [15100],
   "isActive": true,
   "environmentCode": "ENV1",
   "sortNumber": 1,
   "environmentId": 11101,
   "isBuildEnvironment": true,
   "environmentName": "Env 1"
}

Back to Top

...

PUT

This PUT service will update all attributes of an environment with the given Id based on the attributes of a JSON object parameters.

...

Expand

title	PUT Example

Example

If we had an environment in our database with an Id of 11101 and had the following attributes

Code Block

theme	Eclipse
title	Environment PUT JSON

{
   "description": "This is Environment 1" 
   "instances": [15100],
   "isActive": true,
   "environmentCode": "ENV1",
   "sortNumber": 1,
   "environmentId": 11101,
   "isBuildEnvironment": true,
   "environmentName": "Env 1"
}

When we run a PUT request at the following URL

http://host:port/flexdeploy/rest/topology/environment/11101

And the PUT request receives the following JSON environment object,

Code Block

theme	Eclipse
title	Environment PUT Receive JSON

{
   "description": "This is the updated Environment 1",
   "instances": [15101],
   "isActive": true,
   "environmentCode": "PUT2",
   "sortNumber": 2,
   "environmentId": 11101,
   "isBuildEnvironment": false,
   "environmentName": "PUT 2"
}

The PUT request would then update the environment with Id 11101 and return the following JSON environment object

Code Block

theme	Eclipse
title	Environment PUT Return JSON

{
   "description": "This is the updated Environment 1",
   "instances": [15101],
   "isActive": true,
   "environmentCode": "PUT2",
   "sortNumber": 2,
   "environmentId": 11101,
   "isBuildEnvironment": false,
   "environmentName": "PUT 2"
}

Back to Top

AnchorPATCHPATCH

PATCH

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

Info

title	API URL

http://host:port/flexdeploy/rest/topology/environment/{Id}

...

Parameters

Parameters	Required	Type	Description
Id	Yes	URL	This is a URL parameter for the Id which is used to find and return an environment with.
description	No	String	This is the description that the environment's description will be updated to.
instances	No	List<Long>	This is the list of instance Ids that will be assigned to the environment that is being updated.
isActive	No	Boolean	This is the isActive boolean that the environment's isActive boolean will be updated to.
environmentCode	No	String	This is the code that the environment's code will be update to.
sortNumber	No	Integer	This is the sort number that the environment's sort number will be updated to.
environmentId	No	Long	This is the Id place holder. It will not change the environment's Id that is being updated.
isBuildEnvironment	No	Boolean	This is the isActive boolean that the environment's isActive boolean will be updated to.
environmentName	No	String	This is the name that the environment's name will be updated to.

Expand

title	PATCH Example

Example

If we had an environment in our database with an Id of 11101 and had the following attributes

Code Block

theme	Eclipse
title	Environment PATCH JSON

{
   "description": "This is Environment 1",
   "instances": [15101],
   "isActive": true,
   "environmentCode": "ENV1",
   "sortNumber": 1,
   "environmentId": 11101,
   "isBuildEnvironment": false,
   "environmentName": "Env 1"
}

When we run a PATCH request at the following URL

http://host:port/flexdeploy/rest/topology/environment/11101

And the PATCH request receives the following JSON environment object,

Code Block

theme	Eclipse
title	Environment PATCH Receive JSON

{
   "description": "This is Patch with some null attributes",
   "instances": [15102,15103],
   "isActive": null,
   "environmentCode": null,
   "sortNumber": 7,
   "environmentId": null,
   "isBuildEnvironment": false,
   "environmentName": "Patch with some null"
}

The PATCH request would then update the environment with Id 11101 and return the following JSON environment object

Code Block

theme	Eclipse
title	Environment PATCH Return JSON

{
   "description": "This is Patch with some null attributes",
   "instances": [15102,15103],
   "isActive": true,
   "environmentCode": "ENV1",
   "sortNumber": 7,
   "environmentId": 11101,
   "isBuildEnvironment": false,
   "environmentName": "Patch with some null"
}

Back to Top

...

Versions Compared

Old Version 3

New Version 4

Key

Overview

GET

GET

GET (Using Query Parameters)

Append the following character sequences to the above URL to specify Query parameters.

Use '&' between successive query parameters:

Examples:

To search by code only:

To search by name only:

To search by code and name:

Example

POST

POST

Example

PUT

PUT

Example

PATCH

Parameters

Example

Attributes	Type	Description
description	String	This is a description of the environment
instances	List<Long>	This is a list of the Instance Ids associated with the environment
isActive	Boolean	This is a boolean that tracks whether or not the environment is active
environmentCode	String	This is the unique code of the environment
sortNumber	Integer	This is a number associated with the environment that sets the environments priority in a list of other environments
environmentId	Long	This is the unique Id of the environment
isBuildEnvironment	Boolean	This is a boolean that tracks whether or not the environment is a build environment
environmentName	String	This is the unique name of the environment

Page Comparison

Versions Compared

Old Version 3

New Version 4

Key

Overview

GET

GET

GET (Using Query Parameters)

Append the following character sequences to the above URL to specify Query parameters.

Use '&' between successive query parameters:

Examples:

To search by code only:

To search by name only:

To search by code and name:

Example

POST

POST

Example

PUT

PUT

Example

PATCH

Parameters

Example