Support DESK

Follow

H5.3.5 - Settings

Previous Article matchIT Hub Index Next Article 

Resources relative to http://host:8080/matchITHub/engines/<engine>

REST resource Summary
POST settings Apply settings supplied in an xml string.
Form data: xml=<xml>
POST settings Apply settings supplied in a stream.
Form data: file=<file>
GET settings Retrieve the engine’s current settings
GET settings/advanced Retrieve the engine’s current advanced settings
GET settings/matrices Retrieve the engine’s current matching matrices settings
GET settings/metadata Retrieve the engine’s settings metadata

POST /matchITHub/engines/<engine>/settings xml=<xml>

Request

Type Name Description
PathParam engine The id of the engine to modify
FormParam xml Xml settings string

Description

Applies the given settings.

Usage Example

Using cURL:

curl -X POST --data-urlencode "xml=<settings>...</settings>" http://localhost:8080/matchITHub/engines/1/settings
{"status":"OK"}

Or:

curl -X POST --data-urlencode "xml@settings.xml" http://localhost:8080/matchITHub/engines/1/settings
{"status":"OK"}

POST /matchITHub/engines/<engine>/settings file=<file>

Request

Type Name Description
PathParam engine The id of the engine to modify
FormDataParam file Xml settings file

Description

Uploads a file of settings to apply.

Usage Example

Using cURL:

curl -X POST --data-urlencode "file=settings.xml" http://localhost:8080/matchITHub/engines/1/settings
{"status":"OK"}

GET /matchITHub/engines/<engine>/settings

Request

Type Name Description
PathParam engine The id of the engine to query

Response

Name Value Description
configXML <xml string> Xml settings string

Description

Retrieves and returns the engine's current settings as an XML-formatted string.

Usage Examples

Using a browser:

Using cURL:

curl http://localhost:8080/matchITHub/engines/1/settings
{"status":"OK","configXML":"<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n<settings>\n...</settings>"}

GET /matchITHub/engines/<engine>/settings/advanced

Request

Type Name Description
PathParam engine The id of the engine to query

Response

Name Value Description
configXML <xml string> Xml settings string

Description

Retrieves and returns the engine's current advanced settings as an XML-formatted string.

Usage Example

Using cURL:

curl http://localhost:8080/matchITHub/engines/1/settings/advanced
{"status":"OK","configXML":"<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n<settings>\n...</settings>"}

GET /matchITHub/engines/<engine>/settings/matrices

Request

Type Name Description
PathParam engine The id of the engine to query

Response

Name Value Description
configXML <xml string> Xml settings string

Description

Retrieves and returns the engine's current matching matrices settings as an XML-formatted string.

Usage Example

Using cURL:

curl http://localhost:8080/matchITHub/engines/1/settings/matrices
{"status":"OK","configXML":"<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n<settings>\n...</settings>"}

GET /matchITHub/engines/<engine>/settings/metadata

Request

Type Name Description
PathParam engine The id of the engine to query

Response

Name Value Description
configXML <xml string> Xml settings string

Description

Retrieves and returns the engine's current settings metadata as an XML-formatted string.

Usage Example

Using cURL:

curl http://localhost:8080/matchITHub/engines/1/settings/metadata
{"status":"OK","configXML":"<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n<metadata>\n...</metadata>"}

 

Previous Article matchIT Hub Index Next Article 
Was this article helpful?
0 out of 0 found this helpful

0 Comments

Please sign in to leave a comment.