Versions Compared

Key

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

...

Application Server REST Endpoints

MC2 exposes a set of REST Endpoints. The REST endpoints are exposed directly on the Application Server on baseport + 207. For more information about calculating the REST endpoint port number, see Calculate MC2 Endpoints Port Numbers

The basePort is 20000 + 220 = 20220 and the REST API port is 20427.

You can access the page with the list of available Swagger definitions at http://appserverhostname:20427/eagle/v2/api-doc. This link returns a JSON document with the list of all available APIs grouped by resources.

You can retrieve the full extract SWAGGER definition at http://appserverhostname:20427/eagle/v2/extract/api-doc.

You can retrieve the SWAGGER for a Warehouse group that only you can use at http://appserverhostname:20427/eagle/v2/warehouse/api-doc.

Web Server REST Endpoints

...

Executing Extract Service REST Requests

To execute an extract, you can use the SWAGGER definition to see all resource endpoints and parameters supported to build the URL. You can use either a Web Browser or a command line tool, like such as curl, to execute REST requests.

For example, to retrieve an extract with one entity in JSON you can use either a HTTP GET or POST request either.

In case of a GET request, you can pass filter parameters should be passed as a query parametersparameter as shown below:

...

http://appserverhostname:20427/eagle/v2/entities?maxrows=1

The same Similarly, with a POST request, you can pass filter parameters are passed within a JSON body (with multiple parameters should be divided separated by a comma):

	http://appserverhostname:20427/eagle/v2/entities
	{
"maxrows": "1"
}

or in 2017R2In 2017R2, you can access:

        http://webserver/eagle/v2/entities?maxrows=1

...