Cache Commands

getCachePath

get

Gets the location of the cache for the requested title / layer.

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

idstringOptional

optional: UUID of title/layer to operate on

Example: {218f46f9-e881-49a8-ab17-03c8f9cc8461}

titlestringOptional

optional: Name (or UUID) of the title to operate on.

Responses

200

successful operation

application/json

400

bad request

get

HTTPcURLJavaScriptPython

GET /api/command/getCachePath HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "getCachePath",
    "id": "{218f46f9-e881-49a8-ab17-03c8f9cc8461}",
    "reply": "getCachePath",
    "success": true
  }
}

rebuildCache

get

Forces a complete rebuild of the requested title/layer.

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

idstringOptional

optional: UUID of title/layer to operate on

Example: {218f46f9-e881-49a8-ab17-03c8f9cc8461}

titlestringOptional

optional: Name (or UUID) of the title to operate on.

Responses

200

successful operation

application/json

400

bad request

get

HTTPcURLJavaScriptPython

GET /api/command/rebuildCache HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "rebuildCache",
    "id": "{218f46f9-e881-49a8-ab17-03c8f9cc8461}",
    "reply": "rebuildCache",
    "success": true
  }
}

saveTitleCache

get

Forces a save of the title cache..

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

idstringOptional

optional: UUID of title/layer to operate on

Example: {218f46f9-e881-49a8-ab17-03c8f9cc8461}

titlestringOptional

optional: Name (or UUID) of the title to operate on.

Responses

200

successful operation

application/json

400

bad request

get

HTTPcURLJavaScriptPython

GET /api/command/saveTitleCache HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "saveTitleCache",
    "id": "{218f46f9-e881-49a8-ab17-03c8f9cc8461}",
    "reply": "saveTitleCache",
    "success": true
  }
}

setCachePath

get

Sets a unique location to build the cache for the requested title / layer.

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

idstringOptional

optional: UUID of title/layer to operate on

Example: {218f46f9-e881-49a8-ab17-03c8f9cc8461}

titlestringOptional

optional: Name (or UUID) of the title to operate on.

filestringOptional

File path to write the cache to.

Example: c:\desktop\cachefile.cache

Responses

200

successful operation

application/json

400

bad request

get

HTTPcURLJavaScriptPython

GET /api/command/setCachePath HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "setCachePath",
    "id": "{218f46f9-e881-49a8-ab17-03c8f9cc8461}",
    "reply": "setCachePath",
    "success": true
  }
}

setMaxCacheCount

get

Sets the number of variable variations to keep in memory and save to file.

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

maxCacheCountnumberOptional

Number of variations to keep in memory.

Example: 20

maxSaveCountnumberOptional

Number of variations to save to file.

Example: 10

Responses

200

successful operation

application/json

400

bad request

get

HTTPcURLJavaScriptPython

GET /api/command/setMaxCacheCount HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "setMaxCacheCount",
    "reply": "setMaxCacheCount",
    "success": true
  }
}