Versions Compared

Old Version 3

changes.mady.by.user Chandresh Patel

Saved on

compared with

New Version 4

changes.mady.by.user Cole Chronowski

Saved on

Key

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

Anchor
Top
Top

...


Anchor
Overview
Overview

Overview:

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


...

Parameters

Parameter
Required
Type
Description
IdYesURLURL parameter for the Id which is used to find and return an instance


Expand
titleGET by ID Example

Example

If we had an Instance in our database with an Id of 11004 with the following attributes

Code Block
themeEclipse
titleInstance - 11004
{
	"description": "GET example description",
	"environments": [11001],
	"workflows": [],
	"instanceId": 11004,
	"instanceName": "GET Example Name",
	"isActive": true, "plugins": [],
	"instanceCode": "GETEXAMPLECODE",
	"groupCode": "GET example group",
	"subGroupCode": "GET example sub group",
	"isDeploymentTarget": false
}


When we run a GET request at the following URL

http://host:port/flexdeploy/rest/topology/instance/11004

The GET request would return the following JSON Instance object

Code Block
themeEclipse
titleInstance GET Return JSON
{
	"description": "GET example description",
	"environments": [11001],
	"workflows": [],
	"instanceId": 11004,
	"instanceName": "GET Example Name",
	"isActive": true, "plugins": [],
	"instanceCode": "GETEXAMPLECODE",
	"groupCode": "GET example group",
	"subGroupCode": "GET example sub group",
	"isDeploymentTarget": false
}


Back to Top


GET by Query Parameters

This GET service will return a list of Instances in the form of JSON objects based on the query parameters code, name, group code, and sub group code. Instances 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 Instances.


Info
titleAPI URL

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

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

code={code}

name={name}

groupcode={groupcode}

subgroupcode={subgroupcode}

Examples:
To Specify the code parameter only:

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

To Specify the code and group code parameters:

http://host:port/flexdeploy/rest/topology/instance?code={code}&groupcode={groupcode}

To Specify the name, group code, and sub group code parameters:

http://host:port/flexdeploy/rest/topology/instance?name={name}&groupcode={groupcode}&subgroupcode={subgroupcode}

...