EngineConfiguration

Get Engine Configurations

Endpoint:

GET api/v9/mapscale/engine-configurations

Description:

Gets all active engine configurations.

Success Response:

[
  {
    "id": "ed410099-3383-473c-b356-d57f90654bc5",
    "name": "MapScale Test 1",
    "host": "http://11.11.111.111",
    "apiKey": "123123"
  },
  {
    "id": "ed410099-3383-473c-b356-d57f90654bc6",
    "name": "MapScale Test 2",
    "host": "http://22.22.222.222",
    "apiKey": "321321321"
  }
]

* You can access the possible response codes you may encounter here.

---

Create Engine Configuration

Endpoint:

POST api/v9/mapscale/engine-configurations

Description:

Adds a new engine configuration.

Validations

• Name is required.
• Host address is required.
• Api key is required.

Request Body:

{
  "name": "MapScale Engine Test",
  "host": "http://11.11.111.111",
  "apiKey": "123asd123asd123"
}

Success Response:

{
  "message": "Engine configuration successfully created."
}

* You can access the possible response codes you may encounter here.

---

Update Engine Configuration

Endpoint:

PUT api/v9/mapscale/engine-configurations/{engineConfigurationId}

Description:

Updates an engine configuration.

Validations

• EngineConfigurationId given from the URL must be valid.
• Name is required.
• Host address is required.
• Api key is required.

Request Body:

{
  "name": "MapScale Engine Test",
  "host": "http://11.11.111.111",
  "apiKey": "123asd123asd123"
}

Success Response:

{
  "message": "Engine configuration is updated."
}

* You can access the possible response codes you may encounter here.

---

Delete Engine Configuration

Endpoint:

DELETE api/v9/mapscale/engine-configurations/{engineConfigurationId}

Description:

Deletes an engine configuration.

Success Response:

{
  "message": "Engine configuration is successfully deleted."
}

* You can access the possible response codes you may encounter here.