DOCUMENTATIONAPI REFERENCEAI-Link
DownloadsSupport
Loading search results...
Engine

Engine

List All

HTTP REQUEST: GET 

GET/api/1.0/org/{orgId}/engine
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
503This error will occur if Design Center APIs are not enabled.
200 Response Body
{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": [
    {
      "engine_id": "94d12cde-7e75-4d45-53b8-1ec1d5b92982",
      "org_id": "default",
      "name": "My Engine",
      "protocol": "http",
      "host": "local.infra.atscale.com",
      "port": 10502,
      "properties": "{}",
      "default_engine": true
    }
  ]
}

HTTP REQUEST: POST 

POST/api/1.0/org/{orgId}/engine
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
503This error will occur if Design Center APIs are not enabled.
RESPONSE BODY DESCRIPTIONS
NameTypeDescription
engine_idstring-
org_idstring-
namestring-
protocolstring-
hoststring-
portstring-
propertiesobject-
default_enginebool-
Request Body
{
  "org_id": "default",
  "name": "My Engine",
  "protocol": "http",
  "host": "local.infra.atscale.com",
  "port": 10502,
  "properties": "{}",
  "default_engine": true
}
200 Response Body
{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": [
    {
      "engine_id": "94d12cde-7e75-4d45-53b8-1ec1d5b92982",
      "org_id": "default",
      "name": "My Engine",
      "protocol": "http",
      "host": "local.infra.atscale.com",
      "port": 10502,
      "properties": "{}",
      "default_engine": true
    }
  ]
}

Update & Delete

HTTP REQUEST: PUT

Update the Engine Definition

PUT/api/1.0/org/{orgId}/engine/{engineId}
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
engineIdstringThe Engine ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
503This error will occur if Design Center APIs are not enabled.
RESPONSE BODY DESCRIPTIONS
NameTypeDescription
engine_idstring-
org_idstring-
namestring-
protocolstring-
hoststring-
portstring-
propertiesobject-
default_enginebool-
Request Body
{
  "engine_id": "94d12cde-7e75-4d45-53b8-1ec1d5b92982",
  "org_id": "default",
  "name": "My Engine",
  "protocol": "http",
  "host": "local.infra.atscale.com",
  "port": 10502,
  "properties": "{}",
  "default_engine": false
}
200 Response Body
{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": [
    {
      "engine_id": "94d12cde-7e75-4d45-53b8-1ec1d5b92982",
      "org_id": "default",
      "name": "My Engine",
      "protocol": "http",
      "host": "local.infra.atscale.com",
      "port": 10502,
      "properties": "{}",
      "default_engine": false
    }
  ]
}

HTTP REQUEST: DELETE

Delete the Engine Definition

DELETE/api/1.0/org/{orgId}/engine/{engineId}
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
engineIdstringThe Engine ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
503This error will occur if Design Center APIs are not enabled.
200 Response Body
{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "engine_id": "abc123",
    "org_id": "default",
    "name": "My Engine 2",
    "protocol": "http",
    "host": "local.infra.atscale.com",
    "port": 10502,
    "properties": "{}",
    "default_engine": true
  }
}