Anchor
Top
Top

...

Overview

Anchor

	Overview
	Overview

:

Endpoints 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 Endpoints.

Each function returns a JSON

Endpoint

endpoint object.

An Endpoint

The endpoint object has these attributes:

Attributes	Type	Description
Description	String	This is a description of the Endpoint.
Connection Type	String	This specifies the connection Type. MANDATORY: "SSH" or "LOCALHOST"
isActive	Boolean	This is a Boolean that tracks whether or not the Endpoint is active.
Endpoint Address	String	This is a String associated with the address of the endpoint.
Endpoint Port	String	This is a port associated with an SSH connection. DEPENDENT: Mandatory when connectionType is "SSH", otherwise not used.
Endpoint Id	Long	This is a number associated with the identification number of an existing Endpoint.
Password	String	This is a character sequence used to access the corresponding remote connection. DEPENDENT: mandatory when connectionType is "SSH" otherwise not used.
Endpoint Name	String	This is the unique name of the corresponding Endpoint. UNIQUE
Private Key	String	This is a character sequence associated with the corresponding remote connection. DEPENDENT: Mandatory when connectionType is "SSH" otherwise not used.
OS Type	String	This is a character sequence which corresponds to the operating system type used in the corresponding remote connection. DEPENDENT: Mandatory when connectionType is "SSH" otherwise not used.
Base Directory	String	This is a character sequence which corresponds to the base directory of the corresponding Endpoint. MANDATORY
Endpoint Sub Group	String	This is a character sequence associated with this Endpoint's corresponding sub-group.
Passphrase	String	This is a character sequence associated with the correspond remote connection. DEPENDENT: Mandatory when connectionType is "SSH" otherwise not used.
Java Path	String	This is a character sequence that specifies the java path of the corresponding Endpoint. MANDATORY
Run As User Name	String	This is a character sequence that specifies the runAsUserName variable. Dependent: Mandatory when connection Type is "SSH" otherwise not used.

Back to Top

...

Parameter	Required	Type	Description
Id	Yes	URL	This is a URL parameter for the Id which is used to find and return an Endpoint

TODO: return codes table for each method and add parameter tables to PATCH etc.

Expand

title	Get by ID Example

Remote Connection Example:

output when the Id parameter specified is 13910 and the corresponding Endpoint is remotely connected (SSH).

Endpoint 13910

{

"password": "*****",
"description": "description",
"userName": "userName",
"privateKey": "privateKey",
"isActive": true,

"baseDirectory": "ServerInstallRoot +

Response Codes

HTTP Code	Description
200	Endpoint was found and returned
400	Bad request
401	Unauthorized
500	Unexpected internal server error

Example

If we had an endpoint in our database with an Id of 13901 and had the following attributes

{

"password": null,
"description": "description",
"userName": null,
"privateKey": null,
"isActive": true,
"baseDirectory": "ServerInstallRoot +

Passphrase"

}

Code Block

title	Endpoint 13910

{

"password": "Password",
"description": "description",
"userName": "userName",
"privateKey": "privateKey",
"isActive": true,
"baseDirectory": "ServerInstallRoot + '/localhost'",


"endpointName": "GOODPOST1",


"connectionType": "SSH",


"endpointAddress": "NotNeeded00",


"endpointId": 13910,


"endpointSubgroup": "subGroupTester",


"endpointPort": "1",


"endpointGroup": "endpointGroup",


"runAsUserName": "TestInput",


"osType": "UNIX",


"javaPath": "ServerJavaHome",


"passphrase": "

*****"

}

note:password and passphrase are always "*****" for security reasons if not null.

Local Connection Example:

Output when the connection type is LOCALHOST and the Id parameter specified is 13911.

Endpoint 13909

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/topology/endpoint/13901

The GET request would return the following JSON endpoint object

Code Block

title	Endpoint GET Return JSON

{

"password": "*****",
"description": "description",
"userName": "userName",
"privateKey": "privateKey",
"isActive": true,
"baseDirectory": "ServerInstallRoot + '/localhost'",


"endpointName": "

GOODPOST2

GOODPOST1",


"connectionType": "

LOCALHOST

SSH",


"endpointAddress": "

localhost

NotNeeded00",


"endpointId":

13911

 13910,


"endpointSubgroup": "

endpointSubgroup

subGroupTester",


"endpointPort":

null,

 "1",
"endpointGroup": "endpointGroup",


"runAsUserName":

null,

 "TestInput",
"osType":

null,

 "UNIX",
"javaPath": "ServerJavaHome",


"passphrase":

null

 "*****"

}

Back

...

To Top

...

GET

...

(Using Query Parameters)

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

Info

title	API URL

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

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

Use '&' between successive query parameters:

name={name}

address={address}

group={group}

subgroup={subgroup}

Examples:

To Specify the name parameter only:

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

To Specify the name and group parameters:

http://host:port/flexdeploy/rest/topology/endpoint?name={name}&group={group}

To Specify the name, address and group parameters:

http://host:port/flexdeploy/rest/topology/endpoint?name={name}&address={address}&group={group}

...

Parameter	Required	Type	Description
Name	No	URL	This is a URL query parameter for the name which is used to search the endpoints.
Address	No	URL	This is a URL query parameter for the address which is used to search the endpoints.
Group	No	URL	This is a URL query parameter for the group which is used to search the endpoints.
Sub Group	No	URL	This is a URL query parameter for the sub group which is used to search the endpoints.

Response Codes

expand

HTTP Code

title

Description

Get Example

Single Query Parameter Example:

Output when the group parameter specified is Germany (as indicated in the corresponding URL).

http://host:port/flexdeploy/rest/topology/endpoint?group=Germany

[
{
"description": null,
"password": null,
"userName": null,
"isActive": true,
"privateKey": null,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"osType": null,
"javaPath": "ServerJavaHome",
"endpointName": "Motel6",
"endpointAddress": "localhost",
"endpointId": 14517,
"passphrase": null,
"connectionType": "LOCALHOST",
"endpointPort": null,
"endpointGroup": "Germany",
"endpointSubgroup": "Munich"
"runAsUserName": null
},
{
"description": null,
"password": null,
"userName": null,
"isActive": true,
"privateKey": null,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"osType": null,
"javaPath": "ServerJavaHome",
"endpointName": "Raddison Hotel",
"endpointAddress": "localhost",
"endpointId": 14518,
"passphrase": null,
"connectionType": "LOCALHOST",
"endpointPort": null,
"endpointGroup": "Germany",
"endpointSubgroup": "Berlin",
"runAsUserName": null
}
]

Multiple Query Parameters Example:

Output when the group parameter is set to Germany and the subgroup parameter is set to Berlin.

200	Endpoint was found and returned
400	Bad request
401	Unauthorized
500	Unexpected internal server error

Example

If we had an endpoints in our database with a Ids of 14517, and 14518 and the following attributes

Code Block

theme	Eclipse
title	Endpoint - 14517

{
"description": null,
"password": null,
"userName": null,
"isActive": true,
"privateKey": null,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"osType": null,
"javaPath": "ServerJavaHome",
"endpointName": "Motel6",
"endpointAddress": "localhost",
"endpointId": 14517,
"passphrase": null,
"connectionType": "LOCALHOST",
"endpointPort": null,
"endpointGroup": "Germany",
"endpointSubgroup": "Munich"
"runAsUserName": null
}

Code Block

theme	Eclipse
title	Endpoint 14518

{
"description": null,
"password": null,
"userName": null,
"isActive": true,
"privateKey": null,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"osType": null,
"javaPath": "ServerJavaHome",
"endpointName": "Raddison Hotel",
"endpointAddress": "localhost",
"endpointId": 14518,
"passphrase": null,
"connectionType": "LOCALHOST",
"endpointPort": null,
"endpointGroup": "Germany",
"endpointSubgroup": "Berlin",
"runAsUserName": null
}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/topology/endpoint?group=

{Germany}&subgroup={Berlin}{
"description": null,

Germany

The GET request would return the following JSON environment object

Code Block

title	Endpoint GET Return JSON

[
{
"description": null,
"password": null,


"userName": null,


"isActive": true,


"privateKey": null,


"baseDirectory": "ServerInstallRoot + '/localhost'",


"osType": null,


"javaPath": "ServerJavaHome",


"endpointName": "

Raddison Hotel

Motel6",


"endpointAddress": "localhost",


"endpointId":

14518

 14517,


"passphrase": null,


"connectionType": "LOCALHOST",


"endpointPort": null,


"endpointGroup": "Germany",


"endpointSubgroup": "

Berlin

Munich"

,


"runAsUserName": null

}

Back to Top

...

POST

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

Info

title	API URL

http://host:port/flexdeploy/rest/topology/endpoint

Parameters

AttributesTypeDescription

{

"password": "myPassword",
"description": "description",
"userName": "userName",
"privateKey": "privateKey",
"isActive": true,
"baseDirectory": "ServerInstallRoot +


},
{
"description": null,
"password": null,
"userName": null,
"isActive": true,
"privateKey": null,
"baseDirectory": "ServerInstallRoot + '/localhost'",

"endpointName


"osType": null,
"javaPath": "

GoodPost

ServerJavaHome",

connectionType

endpointName": "

SSH

Raddison Hotel",


"endpointAddress": "

NotNeeded00

localhost",


"endpointId": 14518,
"passphrase": null,

endpointSubgroup

connectionType": "

subGroupTester

LOCALHOST",


"endpointPort":

"1",

 null,
"endpointGroup": "

endpointGroup

Germany",

runAsUserName

endpointSubgroup": "

TestInput

Berlin",

osType": "UNIX",
"javaPath": "ServerJavaHome",
"passphrase": "myPassphrase"

}

Endpoint with Endpoint Id 13922 created.

Expand

title	POST Example

JSON POST Input

GET - 13922

{

"password": "*****",
"description": "description",
"userName": "userName",
"privateKey": "privateKey",
"isActive": true,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"endpointName": "GoodPost",
"connectionType": "SSH",
"endpointAddress": "NotNeeded00",
"endpointId": 13922,
"endpointSubgroup": "subGroupTester",
"endpointPort": "1",
"endpointGroup": "endpointGroup",
"runAsUserName": "TestInput",
"osType": "UNIX",
"javaPath": "ServerJavaHome",
"passphrase": "*****"

}

Back to Top

...

PUT

This PUT service will update all attributes of an Endpoint with the given Id based on the attributes of a JSON objects parameter values.

Info

title	API URL

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

Code Block

title	Sample JSON Request

{
   "description": "description",
   "userName": "userName",
   "password": "password",
   "isActive": true,
   "privateKey": "privateKey",
   "endpointName": "GoodPost3",
   "osType": null,
   "connectionType": "SSH",
   "javaPath": "ServerJavaHome",
   "endpointAddress": "endpointAddress",
   "baseDirectory": "ServerInstallRoot + '/localhost'",
   "passphrase": "passphrase",
   "endpointId": null,
   "endpointGroup": "endpointGroup",
   "endpointPort": null,
   "runAsUserName": "runAsUserName",
   "endpointSubgroup": "endpointSubgroup"
}

Back to Top

...

PATCH

This PATCH service will update an existing endpoint with the information passed through a JSON object. If an attribute is absent of it's value is null it will not be updated in the Endpoint.

Info

title	API URL

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

Parameters

13909

Endpoint with Id 13909 altered

{

"password": null,
"description": null,
"userName": null,
"privateKey": null,
"isActive": true,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"endpointName": "PatchedEndpoint",
"connectionType": "LOCALHOST",
"endpointAddress": "localhost",
"endpointId": 13909,
"endpointSubgroup": null,
"endpointPort": null,
"endpointGroup": "TheGroup",
"runAsUserName": null,
"osType": null,
"javaPath": "ServerJavaHome",
"passphrase": null

runAsUserName": null
}
]

Expand

title	PATCH Example

Get - 13909

{

"password": null,
"description": null,
"userName": null,
"privateKey": null,
"isActive": true,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"endpointName": "NotPatchedYet",
"connectionType": "LOCALHOST",
"endpointAddress": "localhost",
"endpointId": 13909,
"endpointSubgroup": null,
"endpointPort": null,
"endpointGroup": "TheGroup",
"runAsUserName": null,
"osType": null,
"javaPath": "ServerJavaHome",
"passphrase": null

}

PATCH JSON

Id Parameter

{

"endpointName": "PatchedEndpoint",

"endpointId": 12005,

"endpointGroup": null

}

GET - 13909

Back to Top

Anchor

	POST
	POST

POST

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

Info

title	API URL

http://host:port/flexdeploy/rest/topology/endpoint

Parameters

Attributes	Type	Required	Description
Description	String	No	A description of the Endpoint.
Connection Type	String	Yes	This specifies the connection Type. 'SSH' or 'LOCALHOST'
isActive	Boolean	No	This is a Boolean that tracks whether or not the Endpoint is active. Default is true.
Endpoint Address	String	No	This is a String associated with the address of the endpoint.
Endpoint Port	String	Dependent	This is a port associated with an SSH connection. Dependency: Mandatory when connectionType is "SSH", otherwise not used.
Endpoint Id	Long	No	This is a number associated with the identification number of an existing Endpoint.
Password	String	Dependent	This is a character sequence used to access the corresponding remote connection. Dependency: mandatory when connectionType is "SSH" otherwise not used.
Endpoint Name	String	Yes	This is the unique name of the corresponding Endpoint. Must be unique.
Private Key	String	Dependent	This is a character sequence associated with the corresponding remote connection. Dependency: Mandatory when connectionType is "SSH" otherwise not used.
OS Type	String	Dependent	This is a character sequence which corresponds to the operating system type used in the corresponding remote connection. Dependency: Mandatory when connectionType is "SSH" otherwise not used.
Base Directory	String	Yes	This is a character sequence which corresponds to the base directory of the corresponding Endpoint.
Endpoint Sub Group	String	No	This is a character sequence associated with this Endpoint's corresponding sub-group.
Passphrase	String	Dependent	This is a character sequence associated with the correspond remote connection. Dependency: Mandatory when connectionType is "SSH" otherwise not used.
Java Path	String	Yes	This is a character sequence that specifies the java path of the corresponding Endpoint.
Run As User Name	String	Dependent	This is a character sequence that specifies the runAsUserName variable. Dependency: Mandatory when connection Type is "SSH" otherwise not used.

HTTP Code	Description
200	Endpoint was found and returned
400	Bad request
401	Unauthorized
500	Unexpected internal server error

Code Block

title	POST JSON

{

"password": "myPassword",
"description": "description",
"userName": "userName",
"privateKey": "privateKey",
"isActive": true,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"endpointName": "GoodPost",
"connectionType": "SSH",
"endpointAddress": "NotNeeded00",
"endpointId": null,
"endpointSubgroup": "subGroupTester",
"endpointPort": "1",
"endpointGroup": "endpointGroup",
"runAsUserName": "TestInput",
"osType": "UNIX",
"javaPath": "ServerJavaHome",
"passphrase": "myPassphrase"

}

Code Block

title	Endpoint POST Return JSON

{

"password": "*****",
"description": "description",
"userName": "userName",
"privateKey": "privateKey",
"isActive": true,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"endpointName": "GoodPost",
"connectionType": "SSH",
"endpointAddress": "NotNeeded00",
"endpointId": 13922,
"endpointSubgroup": "subGroupTester",
"endpointPort": "1",
"endpointGroup": "endpointGroup",
"runAsUserName": "TestInput",
"osType": "UNIX",
"javaPath": "ServerJavaHome",
"passphrase": "*****"

}

Back to Top

Anchor

	PUT
	PUT

PUT

This PUT service will update all attributes of an Endpoint with the given Id based on the attributes of a JSON objects parameter values.

Parameters

Attributes	Type	Required	Description
Description	String	No	A description of the Endpoint.
Connection Type	String	Yes	This specifies the connection Type. 'SSH' or 'LOCALHOST'
isActive	Boolean	No	This is a Boolean that tracks whether or not the Endpoint is active. Default is true.
Endpoint Address	String	No	This is a String associated with the address of the endpoint.
Endpoint Port	String	Dependent	This is a port associated with an SSH connection. Dependency: Mandatory when connectionType is "SSH", otherwise not used.
Endpoint Id	Long	No	This is a number associated with the identification number of an existing Endpoint.
Password	String	Dependent	This is a character sequence used to access the corresponding remote connection. Dependency: mandatory when connectionType is "SSH" otherwise not used.
Endpoint Name	String	Yes	This is the unique name of the corresponding Endpoint. Must be unique.
Private Key	String	Dependent	This is a character sequence associated with the corresponding remote connection. Dependency: Mandatory when connectionType is "SSH" otherwise not used.
OS Type	String	Dependent	This is a character sequence which corresponds to the operating system type used in the corresponding remote connection. Dependency: Mandatory when connectionType is "SSH" otherwise not used.
Base Directory	String	Yes	This is a character sequence which corresponds to the base directory of the corresponding Endpoint.
Endpoint Sub Group	String	No	This is a character sequence associated with this Endpoint's corresponding sub-group.
Passphrase	String	Dependent	This is a character sequence associated with the correspond remote connection. Dependency: Mandatory when connectionType is "SSH" otherwise not used.
Java Path	String	Yes	This is a character sequence that specifies the java path of the corresponding Endpoint.
Run As User Name	String	Dependent	This is a character sequence that specifies the runAsUserName variable. Dependency: Mandatory when connection Type is "SSH" otherwise not used.

Response Codes

HTTP Code	Description
201	Environment was created successfully
400	Bad request
401	Unauthorized
404	Environment not found
500	Unexpected internal server error

Info

title	API URL

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

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

Code Block

title	EndPoint Attributes as JSON

{
   "description": "description",
   "userName": "userName",
   "password": "password",
   "isActive": true,
   "privateKey": "privateKey",
   "endpointName": "GoodPost3",
   "osType": null,
   "connectionType": "SSH",
   "javaPath": "ServerJavaHome",
   "endpointAddress": "endpointAddress",
   "baseDirectory": "ServerInstallRoot + '/localhost'",
   "passphrase": "passphrase",
   "endpointId": null,
   "endpointGroup": "endpointGroup",
   "endpointPort": null,
   "runAsUserName": "runAsUserName",
   "endpointSubgroup": "endpointSubgroup"
}

Code Block

title	Endpoint PUT Receive JSON

{
   "description": "newDescription",
   "userName": "newUserName",
   "password": "newPassword",
   "isActive": true,
   "privateKey": "newPrivateKey",
   "endpointName": "GoodPost3",
   "osType": "UNIX",
   "connectionType": "SSH",
   "javaPath": "ServerJavaHome",
   "endpointAddress": "endpointAddress",
   "baseDirectory": "ServerInstallRoot + '/localhost'",
   "passphrase": "passphrase",
   "endpointId": null,
   "endpointGroup": "endpointGroup",
   "endpointPort": null,
   "runAsUserName": "runAsUserName",
   "endpointSubgroup": "endpointSubgroup"
}

Code Block

title	Endpoint PUT Return JSON

{
   "description": "newDescription",
   "userName": "newUserName",
   "password": "newPassword",
   "isActive": true,
   "privateKey": "newPrivateKey",
   "endpointName": "GoodPost3",
   "osType": "UNIX",
   "connectionType": "SSH",
   "javaPath": "ServerJavaHome",
   "endpointAddress": "endpointAddress",
   "baseDirectory": "ServerInstallRoot + '/localhost'",
   "passphrase": "passphrase",
   "endpointId": null,
   "endpointGroup": "endpointGroup",
   "endpointPort": null,
   "runAsUserName": "runAsUserName",
   "endpointSubgroup": "endpointSubgroup"
}

Back to Top

Anchor

	PATCH
	PATCH

PATCH

This PATCH service will update an existing endpoint with the information passed through a JSON object. If an attribute is absent of it's value is null it will not be updated in the Endpoint.

Info

title	API URL

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

Parameters

Attributes	Type	Required	Description
Description	String	No	A description of the Endpoint.
Connection Type	String	Yes	This specifies the connection Type. 'SSH' or 'LOCALHOST'
isActive	Boolean	No	This is a Boolean that tracks whether or not the Endpoint is active. Default is true.
Endpoint Address	String	No	This is a String associated with the address of the endpoint.
Endpoint Port	String	Dependent	This is a port associated with an SSH connection. Dependency: Mandatory when connectionType is "SSH", otherwise not used.
Endpoint Id	Long	No	This is a number associated with the identification number of an existing Endpoint.
Password	String	Dependent	This is a character sequence used to access the corresponding remote connection. Dependency: mandatory when connectionType is "SSH" otherwise not used.
Endpoint Name	String	Yes	This is the unique name of the corresponding Endpoint. Must be unique.
Private Key	String	Dependent	This is a character sequence associated with the corresponding remote connection. Dependency: Mandatory when connectionType is "SSH" otherwise not used.
OS Type	String	Dependent	This is a character sequence which corresponds to the operating system type used in the corresponding remote connection. Dependency: Mandatory when connectionType is "SSH" otherwise not used.
Base Directory	String	Yes	This is a character sequence which corresponds to the base directory of the corresponding Endpoint.
Endpoint Sub Group	String	No	This is a character sequence associated with this Endpoint's corresponding sub-group.
Passphrase	String	Dependent	This is a character sequence associated with the correspond remote connection. Dependency: Mandatory when connectionType is "SSH" otherwise not used.
Java Path	String	Yes	This is a character sequence that specifies the java path of the corresponding Endpoint.
Run As User Name	String	Dependent	This is a character sequence that specifies the runAsUserName variable. Dependency: Mandatory when connection Type is "SSH" otherwise not used.

Response Codes

HTTP Code	Description
200	Environment was found and updated
400	Bad request
401	Unauthorized
404	Environment not found
500	Unexpected internal server error

Code Block

title	Endpoint PATCH JSON

{

"password": null,
"description": null,
"userName": null,
"privateKey": null,
"isActive": true,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"endpointName": "NotPatchedYet",
"connectionType": "LOCALHOST",
"endpointAddress": "localhost",
"endpointId": 13909,
"endpointSubgroup": null,
"endpointPort": null,
"endpointGroup": "TheGroup",
"runAsUserName": null,
"osType": null,
"javaPath": "ServerJavaHome",
"passphrase": null

}

Code Block

title	Endpoint PATCH input JSON

{

"endpointName": "PatchedEndpoint",

"endpointId": 12005,

"endpointGroup": null

}

Code Block

title	Endpoint PATCH Return JSON

{

"password": null,
"description": null,
"userName": null,
"privateKey": null,
"isActive": true,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"endpointName": "PatchedEndpoint",
"connectionType": "LOCALHOST",
"endpointAddress": "localhost",
"endpointId": 13909,
"endpointSubgroup": null,
"endpointPort": null,
"endpointGroup": "TheGroup",
"runAsUserName": null,
"osType": null,
"javaPath": "ServerJavaHome",
"passphrase": null

}

Back to Top

...

Versions Compared

Old Version 3

New Version 4

Key

Anchor
Top
Top

Remote Connection Example:

Response Codes

Example

Local Connection Example:

GET

(Using Query Parameters)

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

Use '&' between successive query parameters:

Examples:

To Specify the name parameter only:

To Specify the name and group parameters:

To Specify the name, address and group parameters:

Response Codes

Single Query Parameter Example:

Multiple Query Parameters Example:

Example

POST

Parameters

PUT

PATCH

Parameters

POST

Parameters

PUT

Parameters

Response Codes

PATCH

Parameters

Response Codes

Page Comparison

Versions Compared

Old Version 3

New Version 4

Key

Remote Connection Example:

Response Codes

Example

Local Connection Example:

GET

(Using Query Parameters)

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

Use '&' between successive query parameters:

Examples:

To Specify the name parameter only:

To Specify the name and group parameters:

To Specify the name, address and group parameters:

Response Codes

Single Query Parameter Example:

Multiple Query Parameters Example:

Example

POST

Parameters

PUT

PATCH

Parameters

POST

Parameters

PUT

Parameters

Response Codes

PATCH

Parameters

Response Codes