CHOReVOLUTION Enactment Engine Development Guide

Table of content

Developer Guide

In order to modify/extend the CHOReVOLUTION Enactment Engine and ChorSpec library, the source code can be checked out anonymously over HTTPs by doing:
git clone https://tuleap.ow2.org/plugins/git/chorevolution/enactment-engine.git

The EE source code is located inside the enactment-engine subdirectory, and the ChorSpec library is located inside the chorspec subdirectory.

You will find a Swagger description of the provided Web API at http://enactment_engine_host:port/v1/apidoc/swagger.json.

Building

Building the ChorSpec library

To build the library, run:

cd chorspec
mvn clean install

Building the Enactment Engine

To build the Enactment Engine, simply run:

cd enactment-engine
mvn clean package

This creates an OSGi bundle at:

target/ee2-0.1.0-SNAPSHOT.jar

Adding EE to Brooklyn

Download the Apache Brooklyn binary. Once installed/unpacked, place the Enactment Engine OSGi jar bundle and the ChorSpec library jar file inside

ee-install-dir/lib/patch

Enactment Engine REST API

CHOReVOLUTION Enactment Engine
More information: http://www.chorevolution.eu/bin/view/Documentation/Enactment+Engine
Contact Info: alessio.carenini@cefriel.com
Version: 1.0.0-SNAPSHOT
BasePath:/v1
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

AccessControl

Activities

Applications

Catalog

Choreography

Entities

EntityConfig

EntityEffectors

EntityPolicies

EntityPolicyConfig

EntitySensors

Locations

Scripting

Server

Usage

Version

AccessControl

Up 
get /access
Fetch access control summary (get)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

AccessSummary

Example data

Content-Type: application/json
{
  "links" : {
    "key" : "aeiou"
  },
  "locationProvisioningAllowed" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation AccessSummary
Up 
post /access/locationProvisioningAllowed
Sets whether location provisioning is permitted (beta feature) (locationProvisioningAllowed)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

allowed (required)
Query Parameter — Whether allowed or not

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

0

successful operation

Activities

Up 
get /activities/{task}/children
Fetch list of children tasks of this task (children)

Path parameters

task (required)
Path Parameter — Task ID

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[TaskSummary]

Example data

Content-Type: application/json
[ {
  "submitTimeUtc" : 123456789,
  "endTimeUtc" : 123456789,
  "currentStatus" : "aeiou",
  "blockingTask" : "",
  "displayName" : "aeiou",
  "streams" : {
    "key" : ""
  },
  "description" : "aeiou",
  "entityId" : "aeiou",
  "entityDisplayName" : "aeiou",
  "error" : true,
  "tags" : [ "{}" ],
  "result" : "{}",
  "submittedByTask" : "",
  "detailedStatus" : "aeiou",
  "children" : [ {
    "metadata" : {
      "key" : "{}"
    },
    "link" : "aeiou"
  } ],
  "blockingDetails" : "aeiou",
  "cancelled" : true,
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "startTimeUtc" : 123456789
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Could not find task
Up 
get /activities/{task}
Fetch task details (get09)

Path parameters

task (required)
Path Parameter — Task ID

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

TaskSummary

Example data

Content-Type: application/json
{
  "submitTimeUtc" : 123456789,
  "endTimeUtc" : 123456789,
  "currentStatus" : "aeiou",
  "blockingTask" : "",
  "displayName" : "aeiou",
  "streams" : {
    "key" : ""
  },
  "description" : "aeiou",
  "entityId" : "aeiou",
  "entityDisplayName" : "aeiou",
  "error" : true,
  "tags" : [ "{}" ],
  "result" : "{}",
  "submittedByTask" : "",
  "detailedStatus" : "aeiou",
  "children" : [ {
    "metadata" : {
      "key" : "{}"
    },
    "link" : "aeiou"
  } ],
  "blockingDetails" : "aeiou",
  "cancelled" : true,
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "startTimeUtc" : 123456789
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation TaskSummary

404

Could not find task
Up 
get /activities/{task}/stream/{streamId}
Return the contents of the given stream (stream)

Path parameters

task (required)
Path Parameter — Task ID
streamId (required)
Path Parameter — Stream ID

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation String

404

Could not find task or stream

Applications

Up 
post /applications/createLegacy
Create and start a new application from miscellaneous types, including JSON either new CAMP format or legacy AppSpec format (create02)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • application/octet-stream
  • text/plain

Request body

body (optional)
Body Parameter —

Return type

TaskSummary

Example data

Content-Type: application/json
{
  "submitTimeUtc" : 123456789,
  "endTimeUtc" : 123456789,
  "currentStatus" : "aeiou",
  "blockingTask" : "",
  "displayName" : "aeiou",
  "streams" : {
    "key" : ""
  },
  "description" : "aeiou",
  "entityId" : "aeiou",
  "entityDisplayName" : "aeiou",
  "error" : true,
  "tags" : [ "{}" ],
  "result" : "{}",
  "submittedByTask" : "",
  "detailedStatus" : "aeiou",
  "children" : [ {
    "metadata" : {
      "key" : "{}"
    },
    "link" : "aeiou"
  } ],
  "blockingDetails" : "aeiou",
  "cancelled" : true,
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "startTimeUtc" : 123456789
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation TaskSummary

404

Undefined entity or location

412

Application already registered
Up 
post /applications
Create and start a new application from form URL-encoded contents (underlying type autodetected) (createFromForm)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/x-www-form-urlencoded

Request body

applicationSpec (required)
Body Parameter — App spec in form-encoded YAML, JSON, or other (auto-detected) format

Return type

TaskSummary

Example data

Content-Type: application/json
{
  "submitTimeUtc" : 123456789,
  "endTimeUtc" : 123456789,
  "currentStatus" : "aeiou",
  "blockingTask" : "",
  "displayName" : "aeiou",
  "streams" : {
    "key" : ""
  },
  "description" : "aeiou",
  "entityId" : "aeiou",
  "entityDisplayName" : "aeiou",
  "error" : true,
  "tags" : [ "{}" ],
  "result" : "{}",
  "submittedByTask" : "",
  "detailedStatus" : "aeiou",
  "children" : [ {
    "metadata" : {
      "key" : "{}"
    },
    "link" : "aeiou"
  } ],
  "blockingDetails" : "aeiou",
  "cancelled" : true,
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "startTimeUtc" : 123456789
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation TaskSummary

404

Undefined entity or location

412

Application already registered
Up 
delete /applications/{application}
Delete a specified application (delete)

Path parameters

application (required)
Path Parameter — Application name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

TaskSummary

Example data

Content-Type: application/json
{
  "submitTimeUtc" : 123456789,
  "endTimeUtc" : 123456789,
  "currentStatus" : "aeiou",
  "blockingTask" : "",
  "displayName" : "aeiou",
  "streams" : {
    "key" : ""
  },
  "description" : "aeiou",
  "entityId" : "aeiou",
  "entityDisplayName" : "aeiou",
  "error" : true,
  "tags" : [ "{}" ],
  "result" : "{}",
  "submittedByTask" : "",
  "detailedStatus" : "aeiou",
  "children" : [ {
    "metadata" : {
      "key" : "{}"
    },
    "link" : "aeiou"
  } ],
  "blockingDetails" : "aeiou",
  "cancelled" : true,
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "startTimeUtc" : 123456789
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation TaskSummary

404

Application not found
Up 
get /applications/fetch
Fetch display details for all applications and optionally selected additional entities (fetch)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

items (optional)
Query Parameter — Selected additional entity ID's to include, comma-separated

Return type

array[EntityDetail]

Example data

Content-Type: application/json
[ {
  "type" : "aeiou",
  "parentId" : "aeiou",
  "serviceState" : "aeiou",
  "catalogItemId" : "aeiou",
  "children" : [ {
    "catalogItemId" : "aeiou",
    "name" : "aeiou",
    "links" : {
      "key" : "aeiou"
    },
    "id" : "aeiou",
    "type" : "aeiou"
  } ],
  "groupIds" : [ "aeiou" ],
  "members" : [ {
    "key" : "aeiou"
  } ],
  "name" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "iconUrl" : "aeiou",
  "applicationId" : "aeiou",
  "serviceUp" : true
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation
Up 
get /applications/{application}
Fetch a specific application (get01)

Path parameters

application (required)
Path Parameter — ID or name of application whose details will be returned

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

ApplicationSummary

Example data

Content-Type: application/json
{
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "spec" : {
    "entities" : [ {
      "name" : "aeiou",
      "type" : "aeiou",
      "config" : {
        "key" : "aeiou"
      }
    } ],
    "name" : "aeiou",
    "locations" : [ "aeiou" ],
    "type" : "aeiou",
    "config" : {
      "key" : "aeiou"
    }
  },
  "status" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation ApplicationSummary

404

Application not found
Up 
get /applications/{application}/descendants
Fetch entity info for all (or filtered) descendants (getDescendants01)

Path parameters

application (required)
Path Parameter — Application ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

typeRegex (optional)
Query Parameter — Regular expression for an entity type which must be matched default: .*

Return type

EntitySummary

Example data

Content-Type: application/json
{
  "catalogItemId" : "aeiou",
  "name" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "type" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation EntitySummary

404

Application or entity missing
Up 
get /applications/{application}/descendants/sensor/{sensor}
Fetch values of a given sensor for all (or filtered) descendants (getDescendantsSensor01)

Path parameters

application (required)
Path Parameter — Application ID or name
sensor (required)
Path Parameter — Sensor name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

typeRegex (optional)
Query Parameter — Regular expression for an entity type which must be matched default: .*

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : "{}"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Application or entity missing
Up 
get /applications
Fetch list of applications, as ApplicationSummary objects (list07)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

typeRegex (optional)
Query Parameter — Regular expression to filter by default: .*

Return type

ApplicationSummary

Example data

Content-Type: application/json
{
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "spec" : {
    "entities" : [ {
      "name" : "aeiou",
      "type" : "aeiou",
      "config" : {
        "key" : "aeiou"
      }
    } ],
    "name" : "aeiou",
    "locations" : [ "aeiou" ],
    "type" : "aeiou",
    "config" : {
      "key" : "aeiou"
    }
  },
  "status" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation ApplicationSummary

Catalog

Up 
post /catalog
Add a catalog item (e.g. new type of entity, policy or location) by uploading YAML descriptor Return value is map of ID to CatalogItemSummary, with code 201 CREATED. (create01)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • */*

Request body

yaml (required)
Body Parameter — YAML descriptor of catalog item

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation String
Up 
delete /catalog/applications/{symbolicName}/{version}
Deletes a specific version of an application's definition from the catalog (deleteApplication)

Path parameters

symbolicName (required)
Path Parameter — The symbolic name of the application or template to delete
version (required)
Path Parameter — The version identifier of the application or template to delete

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Entity not found
Up 
delete /catalog/entities/{symbolicName}/{version}
Deletes a specific version of an entity's definition from the catalog (deleteEntity)

Path parameters

symbolicName (required)
Path Parameter — The symbolic name of the entity or template to delete
version (required)
Path Parameter — The version identifier of the entity or template to delete

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Entity not found
Up 
delete /catalog/entities/{entityId}
Deletes a specific version of an entity's definition from the catalog (deleteEntity070)

Path parameters

entityId (required)
Path Parameter — The ID of the entity or template to delete

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Entity not found
Up 
delete /catalog/locations/{locationId}/{version}
Deletes a specific version of an location's definition from the catalog (deleteLocation)

Path parameters

locationId (required)
Path Parameter — The ID of the location to delete
version (required)
Path Parameter — The version identifier of the location to delete

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Location not found
Up 
delete /catalog/policies/{policyId}/{version}
Deletes a specific version of an policy's definition from the catalog (deletePolicy)

Path parameters

policyId (required)
Path Parameter — The ID of the policy to delete
version (required)
Path Parameter — The version identifier of the policy to delete

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Policy not found
Up 
get /catalog/applications/{symbolicName}/{version}
Fetch a specific version of an application's definition from the catalog (getApplication)

Path parameters

symbolicName (required)
Path Parameter — The symbolic name of the application to retrieve
version (required)
Path Parameter — The version identifier of the application to retrieve

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[CatalogEntitySummary]

Example data

Content-Type: application/json
[ {
  "deprecated" : true,
  "description" : "aeiou",
  "effectors" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "links" : {
      "key" : "aeiou"
    },
    "parameters" : [ {
      "defaultValue" : "{}",
      "name" : "aeiou",
      "description" : "aeiou",
      "type" : "aeiou"
    } ],
    "returnType" : "aeiou"
  } ],
  "type" : "aeiou",
  "version" : "aeiou",
  "javaType" : "aeiou",
  "tags" : [ "{}" ],
  "planYaml" : "aeiou",
  "sensors" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "links" : {
      "key" : "aeiou"
    },
    "type" : "aeiou"
  } ],
  "symbolicName" : "aeiou",
  "name" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "iconUrl" : "aeiou",
  "id" : "aeiou",
  "config" : [ {
    "reconfigurable" : true,
    "possibleValues" : [ {
      "key" : "aeiou"
    } ],
    "defaultValue" : "{}",
    "name" : "aeiou",
    "description" : "aeiou",
    "links" : {
      "key" : "aeiou"
    },
    "label" : "aeiou",
    "type" : "aeiou",
    "priority" : 1.3579000000000001069366817318950779736042022705078125
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Entity not found
Up 
get /catalog/applications/{applicationId}
Fetch a specific version of an application's definition from the catalog (getApplication070)

Path parameters

applicationId (required)
Path Parameter — The ID of the application to retrieve

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[CatalogEntitySummary]

Example data

Content-Type: application/json
[ {
  "deprecated" : true,
  "description" : "aeiou",
  "effectors" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "links" : {
      "key" : "aeiou"
    },
    "parameters" : [ {
      "defaultValue" : "{}",
      "name" : "aeiou",
      "description" : "aeiou",
      "type" : "aeiou"
    } ],
    "returnType" : "aeiou"
  } ],
  "type" : "aeiou",
  "version" : "aeiou",
  "javaType" : "aeiou",
  "tags" : [ "{}" ],
  "planYaml" : "aeiou",
  "sensors" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "links" : {
      "key" : "aeiou"
    },
    "type" : "aeiou"
  } ],
  "symbolicName" : "aeiou",
  "name" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "iconUrl" : "aeiou",
  "id" : "aeiou",
  "config" : [ {
    "reconfigurable" : true,
    "possibleValues" : [ {
      "key" : "aeiou"
    } ],
    "defaultValue" : "{}",
    "name" : "aeiou",
    "description" : "aeiou",
    "links" : {
      "key" : "aeiou"
    },
    "label" : "aeiou",
    "type" : "aeiou",
    "priority" : 1.3579000000000001069366817318950779736042022705078125
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Entity not found
Up 
get /catalog/entities/{symbolicName}/{version}
Fetch a specific version of an entity's definition from the catalog (getEntity)

Path parameters

symbolicName (required)
Path Parameter — The symbolic name of the entity or template to retrieve
version (required)
Path Parameter — The version identifier of the entity or template to retrieve

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[CatalogEntitySummary]

Example data

Content-Type: application/json
[ {
  "deprecated" : true,
  "description" : "aeiou",
  "effectors" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "links" : {
      "key" : "aeiou"
    },
    "parameters" : [ {
      "defaultValue" : "{}",
      "name" : "aeiou",
      "description" : "aeiou",
      "type" : "aeiou"
    } ],
    "returnType" : "aeiou"
  } ],
  "type" : "aeiou",
  "version" : "aeiou",
  "javaType" : "aeiou",
  "tags" : [ "{}" ],
  "planYaml" : "aeiou",
  "sensors" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "links" : {
      "key" : "aeiou"
    },
    "type" : "aeiou"
  } ],
  "symbolicName" : "aeiou",
  "name" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "iconUrl" : "aeiou",
  "id" : "aeiou",
  "config" : [ {
    "reconfigurable" : true,
    "possibleValues" : [ {
      "key" : "aeiou"
    } ],
    "defaultValue" : "{}",
    "name" : "aeiou",
    "description" : "aeiou",
    "links" : {
      "key" : "aeiou"
    },
    "label" : "aeiou",
    "type" : "aeiou",
    "priority" : 1.3579000000000001069366817318950779736042022705078125
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Entity not found
Up 
get /catalog/entities/{entityId}
Fetch an entity's definition from the catalog (getEntity070)

Path parameters

entityId (required)
Path Parameter — The ID of the entity or template to retrieve

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[CatalogEntitySummary]

Example data

Content-Type: application/json
[ {
  "deprecated" : true,
  "description" : "aeiou",
  "effectors" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "links" : {
      "key" : "aeiou"
    },
    "parameters" : [ {
      "defaultValue" : "{}",
      "name" : "aeiou",
      "description" : "aeiou",
      "type" : "aeiou"
    } ],
    "returnType" : "aeiou"
  } ],
  "type" : "aeiou",
  "version" : "aeiou",
  "javaType" : "aeiou",
  "tags" : [ "{}" ],
  "planYaml" : "aeiou",
  "sensors" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "links" : {
      "key" : "aeiou"
    },
    "type" : "aeiou"
  } ],
  "symbolicName" : "aeiou",
  "name" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "iconUrl" : "aeiou",
  "id" : "aeiou",
  "config" : [ {
    "reconfigurable" : true,
    "possibleValues" : [ {
      "key" : "aeiou"
    } ],
    "defaultValue" : "{}",
    "name" : "aeiou",
    "description" : "aeiou",
    "links" : {
      "key" : "aeiou"
    },
    "label" : "aeiou",
    "type" : "aeiou",
    "priority" : 1.3579000000000001069366817318950779736042022705078125
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Entity not found
Up 
get /catalog/icon/{itemId}/{version}
Return the icon for a given catalog entry (application/image or HTTP redirect) (getIcon01)

Path parameters

itemId (required)
Path Parameter — ID of catalog item (application, entity, policy, location)
version (required)
Path Parameter — version identifier of catalog item (application, entity, policy, location)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/image

Responses

404

Item not found
Up 
get /catalog/icon/{itemId}
Return the icon for a given catalog entry (application/image or HTTP redirect) (getIcon070)

Path parameters

itemId (required)
Path Parameter — ID of catalog item (application, entity, policy, location)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/image

Responses

404

Item not found
Up 
get /catalog/locations/{locationId}/{version}
Fetch a location's definition from the catalog (getLocation)

Path parameters

locationId (required)
Path Parameter — The ID of the location to retrieve
version (required)
Path Parameter — The version identifier of the application to retrieve

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[CatalogItemSummary]

Example data

Content-Type: application/json
[ {
  "planYaml" : "aeiou",
  "deprecated" : true,
  "symbolicName" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "iconUrl" : "aeiou",
  "id" : "aeiou",
  "type" : "aeiou",
  "version" : "aeiou",
  "javaType" : "aeiou",
  "tags" : [ "{}" ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Entity not found
Up 
get /catalog/locations/{locationId}
Fetch a location's definition from the catalog (getLocation070)

Path parameters

locationId (required)
Path Parameter — The ID of the location to retrieve

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[CatalogItemSummary]

Example data

Content-Type: application/json
[ {
  "planYaml" : "aeiou",
  "deprecated" : true,
  "symbolicName" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "iconUrl" : "aeiou",
  "id" : "aeiou",
  "type" : "aeiou",
  "version" : "aeiou",
  "javaType" : "aeiou",
  "tags" : [ "{}" ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Entity not found
Up 
get /catalog/policies/{policyId}/{version}
Fetch a policy's definition from the catalog (getPolicy)

Path parameters

policyId (required)
Path Parameter — The ID of the policy to retrieve
version (required)
Path Parameter — The version identifier of the application to retrieve

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[CatalogItemSummary]

Example data

Content-Type: application/json
[ {
  "planYaml" : "aeiou",
  "deprecated" : true,
  "symbolicName" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "iconUrl" : "aeiou",
  "id" : "aeiou",
  "type" : "aeiou",
  "version" : "aeiou",
  "javaType" : "aeiou",
  "tags" : [ "{}" ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Entity not found
Up 
get /catalog/policies/{policyId}
Fetch a policy's definition from the catalog (getPolicy070)

Path parameters

policyId (required)
Path Parameter — The ID of the policy to retrieve

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[CatalogItemSummary]

Example data

Content-Type: application/json
[ {
  "planYaml" : "aeiou",
  "deprecated" : true,
  "symbolicName" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "iconUrl" : "aeiou",
  "id" : "aeiou",
  "type" : "aeiou",
  "version" : "aeiou",
  "javaType" : "aeiou",
  "tags" : [ "{}" ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Entity not found
Up 
get /catalog/applications
Fetch a list of application templates optionally matching a query (listApplications)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

regex (optional)
Query Parameter — Regular expression to search for
fragment (optional)
Query Parameter — Substring case-insensitive to search for
allVersions (optional)
Query Parameter — Include all versions (defaults false, only returning the best version) default: false

Return type

array[CatalogItemSummary]

Example data

Content-Type: application/json
[ {
  "planYaml" : "aeiou",
  "deprecated" : true,
  "symbolicName" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "iconUrl" : "aeiou",
  "id" : "aeiou",
  "type" : "aeiou",
  "version" : "aeiou",
  "javaType" : "aeiou",
  "tags" : [ "{}" ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation
Up 
get /catalog/entities
List available entity types optionally matching a query (listEntities)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

regex (optional)
Query Parameter — Regular expression to search for
fragment (optional)
Query Parameter — Substring case-insensitive to search for
allVersions (optional)
Query Parameter — Include all versions (defaults false, only returning the best version) default: false

Return type

array[CatalogItemSummary]

Example data

Content-Type: application/json
[ {
  "planYaml" : "aeiou",
  "deprecated" : true,
  "symbolicName" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "iconUrl" : "aeiou",
  "id" : "aeiou",
  "type" : "aeiou",
  "version" : "aeiou",
  "javaType" : "aeiou",
  "tags" : [ "{}" ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation
Up 
get /catalog/locations
List available locations optionally matching a query (listLocations)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

regex (optional)
Query Parameter — Regular expression to search for
fragment (optional)
Query Parameter — Substring case-insensitive to search for
allVersions (optional)
Query Parameter — Include all versions (defaults false, only returning the best version) default: false

Return type

array[CatalogLocationSummary]

Example data

Content-Type: application/json
[ {
  "deprecated" : true,
  "description" : "aeiou",
  "type" : "aeiou",
  "version" : "aeiou",
  "javaType" : "aeiou",
  "tags" : [ "{}" ],
  "planYaml" : "aeiou",
  "symbolicName" : "aeiou",
  "name" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "iconUrl" : "aeiou",
  "id" : "aeiou",
  "config" : [ {
    "reconfigurable" : true,
    "possibleValues" : [ {
      "key" : "aeiou"
    } ],
    "defaultValue" : "{}",
    "name" : "aeiou",
    "description" : "aeiou",
    "links" : {
      "key" : "aeiou"
    },
    "label" : "aeiou",
    "type" : "aeiou",
    "priority" : 1.3579000000000001069366817318950779736042022705078125
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation
Up 
get /catalog/policies
List available policies optionally matching a query (listPolicies)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

regex (optional)
Query Parameter — Regular expression to search for
fragment (optional)
Query Parameter — Substring case-insensitive to search for
allVersions (optional)
Query Parameter — Include all versions (defaults false, only returning the best version) default: false

Return type

array[CatalogPolicySummary]

Example data

Content-Type: application/json
[ {
  "deprecated" : true,
  "description" : "aeiou",
  "type" : "aeiou",
  "version" : "aeiou",
  "javaType" : "aeiou",
  "tags" : [ "{}" ],
  "planYaml" : "aeiou",
  "symbolicName" : "aeiou",
  "name" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "iconUrl" : "aeiou",
  "id" : "aeiou",
  "config" : [ {
    "reconfigurable" : true,
    "possibleValues" : [ {
      "key" : "aeiou"
    } ],
    "defaultValue" : "{}",
    "name" : "aeiou",
    "description" : "aeiou",
    "links" : {
      "key" : "aeiou"
    },
    "label" : "aeiou",
    "type" : "aeiou",
    "priority" : 1.3579000000000001069366817318950779736042022705078125
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation
Up 
post /catalog/reset
Resets the catalog to the given (XML) format (resetXml)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/xml

Request body

xml (required)
Body Parameter — XML descriptor of the entire catalog to install

Query parameters

ignoreErrors (optional)
Query Parameter — Don't fail on invalid bundles, log the errors only default: false

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

0

successful operation
Up 
post /catalog/entities/{itemId}/deprecated
(setDeprecated)

Path parameters

itemId (required)
Path Parameter — The ID of the catalog item to be deprecated

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

deprecated (required)
Body Parameter — Whether or not the catalog item is deprecated

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Undefined catalog item
Up 
post /catalog/entities/{itemId}/deprecated/{deprecated}
(setDeprecatedLegacy)

Path parameters

itemId (required)
Path Parameter — The ID of the catalog item to be deprecated
deprecated (required)
Path Parameter — Whether or not the catalog item is deprecated

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

0

successful operation
Up 
post /catalog/entities/{itemId}/disabled
(setDisabled)

Path parameters

itemId (required)
Path Parameter — The ID of the catalog item to be disabled

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

disabled (required)
Body Parameter — Whether or not the catalog item is disabled

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Undefined catalog item

Choreography

Up 
get /v1/choreography/{choreographyId}/check_status
(checkStatus)

Path parameters

choreographyId (required)
Path Parameter — The ID of the choregraphy to check

Responses

0

successful operation
Up 
post /v1/choreography
Deploy a choreography onto a cloud environment. (deploy)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/xml

Request body

chorSpec (required)
Body Parameter — Choreography specifications

Query parameters

choreographyName (required)
Query Parameter — Choreography name

Return type

TaskSummary

Example data

Content-Type: application/json
{
  "submitTimeUtc" : 123456789,
  "endTimeUtc" : 123456789,
  "currentStatus" : "aeiou",
  "blockingTask" : "",
  "displayName" : "aeiou",
  "streams" : {
    "key" : ""
  },
  "description" : "aeiou",
  "entityId" : "aeiou",
  "entityDisplayName" : "aeiou",
  "error" : true,
  "tags" : [ "{}" ],
  "result" : "{}",
  "submittedByTask" : "",
  "detailedStatus" : "aeiou",
  "children" : [ {
    "metadata" : {
      "key" : "{}"
    },
    "link" : "aeiou"
  } ],
  "blockingDetails" : "aeiou",
  "cancelled" : true,
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "startTimeUtc" : 123456789
}

Responses

200

successful operation TaskSummary
Up 
post /v1/choreography/{choreographyId}/pause
Pause a running choreography. (pause)

Path parameters

choreographyId (required)
Path Parameter — The ID of the choregraphy to pause

Responses

0

successful operation
Up 
put /v1/choreography/{choreographyId}/replaceService/{serviceRole}/{serviceName}
Replace the given service endpoint (replaceService)

Path parameters

choreographyId (required)
Path Parameter — Choreography ID
serviceRole (required)
Path Parameter — Service name
serviceName (required)
Path Parameter — Service name

Query parameters

serviceEndpoint (optional)
Query Parameter —

Return type

TaskSummary

Example data

Content-Type: application/json
{
  "submitTimeUtc" : 123456789,
  "endTimeUtc" : 123456789,
  "currentStatus" : "aeiou",
  "blockingTask" : "",
  "displayName" : "aeiou",
  "streams" : {
    "key" : ""
  },
  "description" : "aeiou",
  "entityId" : "aeiou",
  "entityDisplayName" : "aeiou",
  "error" : true,
  "tags" : [ "{}" ],
  "result" : "{}",
  "submittedByTask" : "",
  "detailedStatus" : "aeiou",
  "children" : [ {
    "metadata" : {
      "key" : "{}"
    },
    "link" : "aeiou"
  } ],
  "blockingDetails" : "aeiou",
  "cancelled" : true,
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "startTimeUtc" : 123456789
}

Responses

200

successful operation TaskSummary
Up 
post /v1/choreography/{choreographyId}/resize
Resize VM pool running a running choreography. (resize)

Path parameters

choreographyId (required)
Path Parameter — Choreography ID

Query parameters

desired_pool_size (required)
Query Parameter — Desired size of the VMs pool format: int32

Return type

TaskSummary

Example data

Content-Type: application/json
{
  "submitTimeUtc" : 123456789,
  "endTimeUtc" : 123456789,
  "currentStatus" : "aeiou",
  "blockingTask" : "",
  "displayName" : "aeiou",
  "streams" : {
    "key" : ""
  },
  "description" : "aeiou",
  "entityId" : "aeiou",
  "entityDisplayName" : "aeiou",
  "error" : true,
  "tags" : [ "{}" ],
  "result" : "{}",
  "submittedByTask" : "",
  "detailedStatus" : "aeiou",
  "children" : [ {
    "metadata" : {
      "key" : "{}"
    },
    "link" : "aeiou"
  } ],
  "blockingDetails" : "aeiou",
  "cancelled" : true,
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "startTimeUtc" : 123456789
}

Responses

200

successful operation TaskSummary
Up 
post /v1/choreography/{choreographyId}/start
Start a stopped/paused choreography. (start01)

Path parameters

choreographyId (required)
Path Parameter — The ID of the choregraphy to start

Responses

0

successful operation
Up 
post /v1/choreography/{choreographyId}/stop
Stop a running choreography. (stop01)

Path parameters

choreographyId (required)
Path Parameter — The ID of the choregraphy to stop

Responses

0

successful operation
Up 
delete /v1/choreography/{choreographyId}
Undeploy a choreography. (undeploy)

Path parameters

choreographyId (required)
Path Parameter — The ID of the choregraphy to undeploy

Responses

0

successful operation
Up 
put /v1/choreography/{choreographyId}
Update an existing choreography onto a cloud environment. (update)

Path parameters

choreographyId (required)
Path Parameter — Choreography ID

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/xml

Request body

chorSpec (required)
Body Parameter — Choreography specifications

Query parameters

choreographyName (required)
Query Parameter — Choreography name

Return type

TaskSummary

Example data

Content-Type: application/json
{
  "submitTimeUtc" : 123456789,
  "endTimeUtc" : 123456789,
  "currentStatus" : "aeiou",
  "blockingTask" : "",
  "displayName" : "aeiou",
  "streams" : {
    "key" : ""
  },
  "description" : "aeiou",
  "entityId" : "aeiou",
  "entityDisplayName" : "aeiou",
  "error" : true,
  "tags" : [ "{}" ],
  "result" : "{}",
  "submittedByTask" : "",
  "detailedStatus" : "aeiou",
  "children" : [ {
    "metadata" : {
      "key" : "{}"
    },
    "link" : "aeiou"
  } ],
  "blockingDetails" : "aeiou",
  "cancelled" : true,
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "startTimeUtc" : 123456789
}

Responses

200

successful operation TaskSummary

Entities

Up 
post /applications/{application}/entities/{entity}/children
Add a child or children to this entity given a YAML spec (addChildren)

Path parameters

application (required)
Path Parameter —
entity (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/x-yaml
  • text/yaml
  • text/x-yaml
  • application/yaml
  • application/json

Request body

childrenSpec (required)
Body Parameter — Entity spec in CAMP YAML format (including 'services' root element)

Query parameters

start (optional)
Query Parameter — Whether to automatically start this child; if omitted, true for Startable entities
timeout (optional)
Query Parameter — Delay before server should respond with incomplete activity task, rather than completed task: 'never' means block until complete; '0' means return task immediately; and e.g. '20ms' (the default) will wait 20ms for completed task information to be available default: 20ms

Return type

TaskSummary

Example data

Content-Type: application/json
{
  "submitTimeUtc" : 123456789,
  "endTimeUtc" : 123456789,
  "currentStatus" : "aeiou",
  "blockingTask" : "",
  "displayName" : "aeiou",
  "streams" : {
    "key" : ""
  },
  "description" : "aeiou",
  "entityId" : "aeiou",
  "entityDisplayName" : "aeiou",
  "error" : true,
  "tags" : [ "{}" ],
  "result" : "{}",
  "submittedByTask" : "",
  "detailedStatus" : "aeiou",
  "children" : [ {
    "metadata" : {
      "key" : "{}"
    },
    "link" : "aeiou"
  } ],
  "blockingDetails" : "aeiou",
  "cancelled" : true,
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "startTimeUtc" : 123456789
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation TaskSummary
Up 
post /applications/{application}/entities/{entity}/expunge
Expunge an entity (expunge)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

release (required)
Query Parameter — Whether to gracefully release all resources

Return type

TaskSummary

Example data

Content-Type: application/json
{
  "submitTimeUtc" : 123456789,
  "endTimeUtc" : 123456789,
  "currentStatus" : "aeiou",
  "blockingTask" : "",
  "displayName" : "aeiou",
  "streams" : {
    "key" : ""
  },
  "description" : "aeiou",
  "entityId" : "aeiou",
  "entityDisplayName" : "aeiou",
  "error" : true,
  "tags" : [ "{}" ],
  "result" : "{}",
  "submittedByTask" : "",
  "detailedStatus" : "aeiou",
  "children" : [ {
    "metadata" : {
      "key" : "{}"
    },
    "link" : "aeiou"
  } ],
  "blockingDetails" : "aeiou",
  "cancelled" : true,
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "startTimeUtc" : 123456789
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation TaskSummary

404

Undefined application or entity
Up 
get /applications/{application}/entities/{entity}
Fetch details about a specific application entity (get02)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

EntitySummary

Example data

Content-Type: application/json
{
  "catalogItemId" : "aeiou",
  "name" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "type" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation EntitySummary

404

Application or entity missing
Up 
get /applications/{application}/entities/{entity}/children
Fetch details about a specific application entity's children (getChildren)

Path parameters

application (required)
Path Parameter —
entity (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

EntitySummary

Example data

Content-Type: application/json
{
  "catalogItemId" : "aeiou",
  "name" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "type" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation EntitySummary
Up 
get /applications/{application}/entities/{entity}/descendants
Fetch entity info for all (or filtered) descendants (getDescendants02)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

typeRegex (optional)
Query Parameter — Regular expression for an entity type which must be matched default: .*

Return type

EntitySummary

Example data

Content-Type: application/json
{
  "catalogItemId" : "aeiou",
  "name" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "type" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation EntitySummary

404

Application or entity missing
Up 
get /applications/{application}/entities/{entity}/descendants/sensor/{sensor}
Fetch values of a given sensor for all (or filtered) descendants (getDescendantsSensor02)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name
sensor (required)
Path Parameter — Sensor name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

typeRegex (optional)
Query Parameter — Regular expression applied to filter descendant entities based on their type default: .*

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : "{}"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Application or entity missing
Up 
get /applications/{application}/entities/{entity}/icon
Returns an icon for the entity, if defined (getIcon02)

Path parameters

application (required)
Path Parameter —
entity (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

0

successful operation
Up 
get /applications/{application}/entities/{entity}/locations
List the locations set on the entity (getLocations)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[LocationSummary]

Example data

Content-Type: application/json
[ {
  "catalog" : {
    "deprecated" : true,
    "description" : "aeiou",
    "type" : "aeiou",
    "version" : "aeiou",
    "javaType" : "aeiou",
    "tags" : [ "{}" ],
    "planYaml" : "aeiou",
    "symbolicName" : "aeiou",
    "name" : "aeiou",
    "links" : {
      "key" : "aeiou"
    },
    "iconUrl" : "aeiou",
    "id" : "aeiou",
    "config" : [ {
      "reconfigurable" : true,
      "possibleValues" : [ {
        "key" : "aeiou"
      } ],
      "defaultValue" : "{}",
      "name" : "aeiou",
      "description" : "aeiou",
      "links" : {
        "key" : "aeiou"
      },
      "label" : "aeiou",
      "type" : "aeiou",
      "priority" : 1.3579000000000001069366817318950779736042022705078125
    } ]
  },
  "name" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "type" : "aeiou",
  "config" : {
    "key" : "{}"
  },
  "spec" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Application or entity missing
Up 
get /applications/{application}/entities/{entity}/spec
Get the YAML spec used to create the entity, if available (getSpec)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation String

404

Application or entity missing
Up 
get /applications/{application}/entities/{entity}/activities/{task}
Fetch task details (getTask)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name
task (required)
Path Parameter — Task ID

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

TaskSummary

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/json

Responses

200

successful operation TaskSummary

404

Could not find application, entity or task
Up 
get /applications/{application}/entities
Fetch the list of entities for a given application (list06)

Path parameters

application (required)
Path Parameter — Application ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[EntitySummary]

Example data

Content-Type: application/json
[ {
  "catalogItemId" : "aeiou",
  "name" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "type" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Application not found
Up 
get /applications/{application}/entities/{entity}/tags
Fetch list of tags on this entity (listTags)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[Object]

Example data

Content-Type: application/json
[ "{}" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Could not find application or entity
Up 
get /applications/{application}/entities/{entity}/activities
Fetch list of tasks for this entity (listTasks)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[TaskSummary]

Example data

Content-Type: application/json
[ {
  "submitTimeUtc" : 123456789,
  "endTimeUtc" : 123456789,
  "currentStatus" : "aeiou",
  "blockingTask" : "",
  "displayName" : "aeiou",
  "streams" : {
    "key" : ""
  },
  "description" : "aeiou",
  "entityId" : "aeiou",
  "entityDisplayName" : "aeiou",
  "error" : true,
  "tags" : [ "{}" ],
  "result" : "{}",
  "submittedByTask" : "",
  "detailedStatus" : "aeiou",
  "children" : [ {
    "metadata" : {
      "key" : "{}"
    },
    "link" : "aeiou"
  } ],
  "blockingDetails" : "aeiou",
  "cancelled" : true,
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "startTimeUtc" : 123456789
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Could not find application or entity
Up 
post /applications/{application}/entities/{entity}/name
Rename an entity (rename)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

name (required)
Query Parameter — New name for this entity

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Undefined application or entity

EntityConfig

Up 
get /applications/{application}/entities/{entity}/config/current-state
Fetch config key values in batch (batchConfigRead)
Returns a map of config name to value

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

raw (optional)
Query Parameter — Return raw config data instead of display values default: false

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : "{}"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation
Up 
get /applications/{application}/entities/{entity}/config/{config}
Fetch config value (json) (get03)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name
config (required)
Path Parameter — Config key ID

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

raw (optional)
Query Parameter — Return raw config data instead of display values default: false

Return type

Object

Example data

Content-Type: application/json
"{}"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation Object

404

Could not find application, entity or config key
Up 
get /applications/{application}/entities/{entity}/config
Fetch the config keys for a specific application entity (list05)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[ConfigSummary]

Example data

Content-Type: application/json
[ {
  "reconfigurable" : true,
  "possibleValues" : [ {
    "key" : "aeiou"
  } ],
  "defaultValue" : "{}",
  "name" : "aeiou",
  "description" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "label" : "aeiou",
  "type" : "aeiou",
  "priority" : 1.3579000000000001069366817318950779736042022705078125
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Could not find application or entity
Up 
post /applications/{application}/entities/{entity}/config/{config}
Manually set a config value (set)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name
config (required)
Path Parameter — Config key name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body (optional)
Body Parameter — Value to set

Query parameters

recurse (optional)
Query Parameter — Apply the config to all pre-existing descendants default: false

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Could not find application, entity or config key
Up 
post /applications/{application}/entities/{entity}/config
Manually set multiple config values (setFromMap01)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body (required)
Body Parameter — Map of config key names to values

Query parameters

recurse (optional)
Query Parameter — Apply the config to all pre-existing descendants default: false

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Could not find application or entity

EntityEffectors

Up 
post /applications/{application}/entities/{entity}/effectors/{effector}
Trigger an effector (invoke)
Returns the return value (status 200) if it completes, or an activity task ID (status 202) if it times out

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name
effector (required)
Path Parameter — Name of the effector to trigger

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • application/x-www-form-urlencoded

Request body

parameters (optional)
Body Parameter — Effector parameters (as key value pairs)

Query parameters

timeout (optional)
Query Parameter — Delay before server should respond with activity task ID rather than result (in millis if no unit specified): 'never' (blocking) is default; '0' means 'always' return task activity ID; and e.g. '1000' or '1s' will return a result if available within one second otherwise status 202 and the activity task ID default: never

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Could not find application, entity or effector
Up 
get /applications/{application}/entities/{entity}/effectors
Fetch the list of effectors (list04)

Path parameters

application (required)
Path Parameter — Application name
entity (required)
Path Parameter — Entity name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[EffectorSummary]

Example data

Content-Type: application/json
[ {
  "name" : "aeiou",
  "description" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "parameters" : [ {
    "defaultValue" : "{}",
    "name" : "aeiou",
    "description" : "aeiou",
    "type" : "aeiou"
  } ],
  "returnType" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Could not find application or entity

EntityPolicies

Up 
post /applications/{application}/entities/{entity}/policies
Add a policy (addPolicy)
Returns a summary of the new policy

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

config (required)
Body Parameter — Configuration for the policy (as key value pairs)

Query parameters

policyType (required)
Query Parameter — Class of policy to add

Return type

PolicySummary

Example data

Content-Type: application/json
{
  "catalogItemId" : "aeiou",
  "name" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "state" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation PolicySummary

400

Type is not a class implementing Policy

404

Could not find application or entity
Up 
get /applications/{application}/entities/{entity}/policies/current-state
Fetch policy states in batch (batchConfigRead02)
Returns a map of policy ID to whether it is active

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

map[String, Boolean]

Example data

Content-Type: application/json
{
  "key" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation
Up 
post /applications/{application}/entities/{entity}/policies/{policy}/destroy
Destroy a policy (destroy)
Removes a policy from being associated with the entity and destroys it (stopping first if running)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name
policy (required)
Path Parameter — Policy ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Could not find application, entity or policy
Up 
get /applications/{application}/entities/{entity}/policies/{policy}
Gets status of a policy (RUNNING / SUSPENDED) (getStatus02)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name
policy (required)
Path Parameter — Policy ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation String

404

Could not find application, entity or policy
Up 
get /applications/{application}/entities/{entity}/policies
Fetch the policies attached to a specific application entity (list03)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[PolicySummary]

Example data

Content-Type: application/json
[ {
  "catalogItemId" : "aeiou",
  "name" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "state" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Could not find application or entity
Up 
post /applications/{application}/entities/{entity}/policies/{policy}/start
Start or resume a policy (start02)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name
policy (required)
Path Parameter — Policy ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Could not find application, entity or policy
Up 
post /applications/{application}/entities/{entity}/policies/{policy}/stop
Suspends a policy (stop02)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name
policy (required)
Path Parameter — Policy ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Could not find application, entity or policy

EntityPolicyConfig

Up 
get /applications/{application}/entities/{entity}/policies/{policy}/config/current-state
Fetch config key values in batch (batchConfigRead01)
Returns a map of config name to value

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name
policy (required)
Path Parameter — Policy ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : "{}"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation
Up 
get /applications/{application}/entities/{entity}/policies/{policy}/config/{config}
Fetch config value (get04)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name
policy (required)
Path Parameter — Policy ID or name
config (required)
Path Parameter — Config key ID

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Object

Example data

Content-Type: application/json
"{}"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation Object

404

Could not find application, entity, policy or config key
Up 
get /applications/{application}/entities/{entity}/policies/{policy}/config
Fetch the config keys for a specific policy (list02)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name
policy (required)
Path Parameter — Policy ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[ConfigSummary]

Example data

Content-Type: application/json
[ {
  "reconfigurable" : true,
  "possibleValues" : [ {
    "key" : "aeiou"
  } ],
  "defaultValue" : "{}",
  "name" : "aeiou",
  "description" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "label" : "aeiou",
  "type" : "aeiou",
  "priority" : 1.3579000000000001069366817318950779736042022705078125
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Could not find application or entity or policy
Up 
post /applications/{application}/entities/{entity}/policies/{policy}/config/{config}
Sets the given config on this policy (set01)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name
policy (required)
Path Parameter — Policy ID or name
config (required)
Path Parameter — Config key ID

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

value (required)
Body Parameter — New value for the configuration

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Could not find application, entity, policy or config key
Up 
post /applications/{application}/entities/{entity}/policies/{policy}/config/{config}/set
Sets the given config on this policy (set02)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name
policy (required)
Path Parameter — Policy ID or name
config (required)
Path Parameter — Config key ID

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

value (required)
Query Parameter — New value for the configuration

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Could not find application, entity, policy or config key

EntitySensors

Up 
get /applications/{application}/entities/{entity}/sensors/current-state
Fetch sensor values in batch (batchSensorRead)
Returns a map of sensor name to value

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

raw (optional)
Query Parameter — Return raw sensor data instead of display values default: false

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : "{}"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation
Up 
delete /applications/{application}/entities/{entity}/sensors/{sensor}
Manually clear a sensor value (delete01)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name
sensor (required)
Path Parameter — Sensor name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Could not find application, entity or sensor
Up 
get /applications/{application}/entities/{entity}/sensors/{sensor}
Fetch sensor value (json) (get05)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name
sensor (required)
Path Parameter — Sensor name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

raw (optional)
Query Parameter — Return raw sensor data instead of display values default: false

Return type

Object

Example data

Content-Type: application/json
"{}"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation Object

404

Could not find application, entity or sensor
Up 
get /applications/{application}/entities/{entity}/sensors
Fetch the sensor list for a specific application entity (list01)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[SensorSummary]

Example data

Content-Type: application/json
[ {
  "name" : "aeiou",
  "description" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "type" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Could not find application or entity
Up 
post /applications/{application}/entities/{entity}/sensors/{sensor}
Manually set a sensor value (set03)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name
sensor (required)
Path Parameter — Sensor name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body (optional)
Body Parameter — Value to set

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Could not find application, entity or sensor
Up 
post /applications/{application}/entities/{entity}/sensors
Manually set multiple sensor values (setFromMap02)

Path parameters

application (required)
Path Parameter — Application ID or name
entity (required)
Path Parameter — Entity ID or name

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body (required)
Body Parameter — Map of sensor names to values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

404

Could not find application or entity

Locations

Up 
post /locations
Create a new location definition (create03)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

locationSpec (required)
Body Parameter — Location specification object

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation String
Up 
delete /locations/{locationId}
Deletes a location definition by id (delete02)

Path parameters

locationId (required)
Path Parameter — Location id to delete

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

0

successful operation
Up 
get /locations/{locationId}
Fetch details about a location instance, or a location definition (get06)

Path parameters

locationId (required)
Path Parameter — Location id to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

full (optional)
Query Parameter — Whether full (inherited) config should be compiled default: false

Return type

array[LocationSummary]

Example data

Content-Type: application/json
[ {
  "catalog" : {
    "deprecated" : true,
    "description" : "aeiou",
    "type" : "aeiou",
    "version" : "aeiou",
    "javaType" : "aeiou",
    "tags" : [ "{}" ],
    "planYaml" : "aeiou",
    "symbolicName" : "aeiou",
    "name" : "aeiou",
    "links" : {
      "key" : "aeiou"
    },
    "iconUrl" : "aeiou",
    "id" : "aeiou",
    "config" : [ {
      "reconfigurable" : true,
      "possibleValues" : [ {
        "key" : "aeiou"
      } ],
      "defaultValue" : "{}",
      "name" : "aeiou",
      "description" : "aeiou",
      "links" : {
        "key" : "aeiou"
      },
      "label" : "aeiou",
      "type" : "aeiou",
      "priority" : 1.3579000000000001069366817318950779736042022705078125
    } ]
  },
  "name" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "type" : "aeiou",
  "config" : {
    "key" : "{}"
  },
  "spec" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation
Up 
get /locations/usage/LocatedLocations
Return a summary of all usage (getLocatedLocations)
interim API, expected to change

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

map[String, map[String, Object]]

Example data

Content-Type: application/json
{
  "key" : {
    "key" : "{}"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation
Up 
get /locations
Fetch the list of location definitions (list)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[LocationSummary]

Example data

Content-Type: application/json
[ {
  "catalog" : {
    "deprecated" : true,
    "description" : "aeiou",
    "type" : "aeiou",
    "version" : "aeiou",
    "javaType" : "aeiou",
    "tags" : [ "{}" ],
    "planYaml" : "aeiou",
    "symbolicName" : "aeiou",
    "name" : "aeiou",
    "links" : {
      "key" : "aeiou"
    },
    "iconUrl" : "aeiou",
    "id" : "aeiou",
    "config" : [ {
      "reconfigurable" : true,
      "possibleValues" : [ {
        "key" : "aeiou"
      } ],
      "defaultValue" : "{}",
      "name" : "aeiou",
      "description" : "aeiou",
      "links" : {
        "key" : "aeiou"
      },
      "label" : "aeiou",
      "type" : "aeiou",
      "priority" : 1.3579000000000001069366817318950779736042022705078125
    } ]
  },
  "name" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "id" : "aeiou",
  "type" : "aeiou",
  "config" : {
    "key" : "{}"
  },
  "spec" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

Scripting

Up 
post /script/groovy
Execute a groovy script (groovy)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/text

Request body

script (required)
Body Parameter — Groovy script to execute

Return type

SensorSummary

Example data

Content-Type: application/json
{
  "name" : "aeiou",
  "description" : "aeiou",
  "links" : {
    "key" : "aeiou"
  },
  "type" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation SensorSummary

Server

Up 
post /server/ha/states/clear
Clears HA node information for non-master nodes; active nodes will repopulate and other records will be erased (clearHighAvailabilityPlaneStates)

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

0

successful operation
Up 
get /server/ha/persist/export
Retrieves the persistence store data, as an archive (exportPersistenceData)

Query parameters

origin (optional)
Query Parameter — Whether to take from LOCAL or REMOTE state; default to AUTO detect, using LOCAL as master and REMOTE for other notes default: AUTO

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/zip

Responses

0

successful operation
Up 
get /server/config/{configKey}
Get the value of the specified config key from brooklyn properties (getConfig)

Path parameters

configKey (required)
Path Parameter — Config key ID

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation String

204

Could not find config key
Up 
get /server/highAvailability
Returns the status of all Brooklyn instances in the management plane [DEPRECATED; see ../ha/states] (getHighAvailability)

Return type

HighAvailabilitySummary

Example data

Content-Type: application/json
{
  "masterId" : "aeiou",
  "ownId" : "aeiou",
  "nodes" : {
    "key" : {
      "localTimestamp" : 123456789,
      "remoteTimestamp" : 123456789,
      "nodeId" : "aeiou",
      "nodeUri" : "aeiou",
      "status" : "aeiou"
    }
  },
  "links" : {
    "key" : "aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation HighAvailabilitySummary
Up 
get /server/ha/metrics
Returns a collection of HA metrics (getHighAvailabilityMetrics)

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : "{}"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation
Up 
get /server/ha/state
Returns the HA state of this management node (getHighAvailabilityNodeState)

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation String
Up 
get /server/ha/states
Returns the HA states and detail for all nodes in this management plane (getHighAvailabilityPlaneStates)

Return type

HighAvailabilitySummary

Example data

Content-Type: application/json
{
  "masterId" : "aeiou",
  "ownId" : "aeiou",
  "nodes" : {
    "key" : {
      "localTimestamp" : 123456789,
      "remoteTimestamp" : 123456789,
      "nodeId" : "aeiou",
      "nodeUri" : "aeiou",
      "status" : "aeiou"
    }
  },
  "links" : {
    "key" : "aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation HighAvailabilitySummary
Up 
get /server/ha/priority
Returns the HA node priority for MASTER failover (getHighAvailabitlityPriority)

Return type

Long

Example data

Content-Type: application/json
123456789

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation Long
Up 
get /server/status
Returns the status of this Brooklyn instance [DEPRECATED; see ../ha/state] (getStatus01)

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation
Up 
get /server/up/extended
Returns extended server-up information, a map including up (/up), shuttingDown (/shuttingDown), healthy (/healthy), and ha (/ha/states) (qv) (getUpExtended)

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : "{}"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation
Up 
get /server/user
Return user information for this Brooklyn instance (getUser)

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation
Up 
get /server/version
Return version identifier information for this Brooklyn instance (getVersion01)

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation
Up 
get /server/healthy
Returns whether this node is healthy - fully started, not stopping, and no errors (isHealthy)

Return type

Boolean

Example data

Content-Type: application/json
true

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation Boolean
Up 
get /server/shuttingDown
Returns whether this server is shutting down (isShuttingDown)

Return type

Boolean

Example data

Content-Type: application/json
true

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation Boolean
Up 
get /server/up
Returns whether this server is up - fully started, and not stopping, though it may have errors (isUp)

Return type

Boolean

Example data

Content-Type: application/json
true

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation Boolean
Up 
post /server/properties/reload
Reload brooklyn.properties (reloadBrooklynProperties)

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

0

successful operation
Up 
post /server/ha/state
Changes the HA state of this management node (setHighAvailabilityNodeState)

Form parameters

mode (optional)
Form Parameter — The state to change to

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation String
Up 
post /server/ha/priority
Sets the HA node priority for MASTER failover (setHighAvailabilityPriority)

Form parameters

priority (optional)
Form Parameter — The priority to be set format: int64

Return type

Long

Example data

Content-Type: application/json
123456789

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation Long
Up 
post /server/shutdown
Terminate this Brooklyn server instance (shutdown)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/x-www-form-urlencoded

Form parameters

stopAppsFirst (optional)
Form Parameter — Whether to stop running applications before shutting down default: false
forceShutdownOnError (optional)
Form Parameter — Force shutdown if apps fail to stop or timeout default: false
shutdownTimeout (optional)
Form Parameter — A maximum delay to wait for apps to gracefully stop before giving up or forcibly exiting, 0 to wait infinitely default: 20s
requestTimeout (optional)
Form Parameter — Maximum time to block the request for the shutdown to finish, 0 to wait infinitely default: 20s
delayForHttpReturn (optional)
Form Parameter — The delay before exiting the process, to permit the REST response to be returned default: 5s
delayMillis (optional)
Form Parameter — Deprecated, analogous to delayForHttpReturn format: int64

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

0

successful operation

Usage

Up 
get /usage/applications/{application}
Retrieve usage information about a specified application (getApplicationUsage)

Path parameters

application (required)
Path Parameter — Application id

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

start (optional)
Query Parameter — timestamp of start marker for usage reporting in format UTC millis or yyyy-MM-dd'T'HH:mm:ssZ
end (optional)
Query Parameter — timestamp of end marker for usage reporting in format UTC millis or yyyy-MM-dd'T'HH:mm:ssZ

Return type

UsageStatistics

Example data

Content-Type: application/json
{
  "links" : {
    "key" : "aeiou"
  },
  "statistics" : [ {
    "duration" : 123456789,
    "metadata" : {
      "key" : "aeiou"
    },
    "start" : "aeiou",
    "end" : "aeiou",
    "id" : "aeiou",
    "applicationId" : "aeiou",
    "status" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation UsageStatistics

404

Application not found
Up 
get /usage/machines/{machine}
Retrieve usage information about a specific machine location (getMachineUsage)

Path parameters

machine (required)
Path Parameter — Machine id

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

start (optional)
Query Parameter — timestamp of start marker for usage reporting in format UTC millis or yyyy-MM-dd'T'HH:mm:ssZ
end (optional)
Query Parameter — timestamp of end marker for usage reporting in format UTC millis or yyyy-MM-dd'T'HH:mm:ssZ

Return type

UsageStatistics

Example data

Content-Type: application/json
{
  "links" : {
    "key" : "aeiou"
  },
  "statistics" : [ {
    "duration" : 123456789,
    "metadata" : {
      "key" : "aeiou"
    },
    "start" : "aeiou",
    "end" : "aeiou",
    "id" : "aeiou",
    "applicationId" : "aeiou",
    "status" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation UsageStatistics

404

Machine not found
Up 
get /usage/applications
Retrieve usage information about all applications (listApplicationsUsage)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

start (optional)
Query Parameter — timestamp of start marker for usage reporting, in format UTC millis or yyyy-MM-dd'T'HH:mm:ssZ
end (optional)
Query Parameter — timestamp of end marker for usage reporting in format UTC millis or yyyy-MM-dd'T'HH:mm:ssZ

Return type

UsageStatistics

Example data

Content-Type: application/json
{
  "links" : {
    "key" : "aeiou"
  },
  "statistics" : [ {
    "duration" : 123456789,
    "metadata" : {
      "key" : "aeiou"
    },
    "start" : "aeiou",
    "end" : "aeiou",
    "id" : "aeiou",
    "applicationId" : "aeiou",
    "status" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation UsageStatistics
Up 
get /usage/machines
Retrieve usage information about all machine locations, optionally filtering for a specific application and/or time range (listMachinesUsage)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Query parameters

application (optional)
Query Parameter — Application id
start (optional)
Query Parameter — timestamp of start marker for usage reporting in format UTC millis or yyyy-MM-dd'T'HH:mm:ssZ
end (optional)
Query Parameter — timestamp of end marker for usage reporting in format UTC millis or yyyy-MM-dd'T'HH:mm:ssZ

Return type

UsageStatistics

Example data

Content-Type: application/json
{
  "links" : {
    "key" : "aeiou"
  },
  "statistics" : [ {
    "duration" : 123456789,
    "metadata" : {
      "key" : "aeiou"
    },
    "start" : "aeiou",
    "end" : "aeiou",
    "id" : "aeiou",
    "applicationId" : "aeiou",
    "status" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation UsageStatistics

404

Application not found

Version

Up 
get /version
Return version identifier information for this Brooklyn instance; deprecated, use /server/version (getVersion02)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation
Up

Models

[ Jump to Methods ]

Table of Contents

  1. AccessSummary
  2. ApplicationSpec
  3. ApplicationSummary
  4. CatalogEntitySummary
  5. CatalogItemSummary
  6. CatalogLocationSummary
  7. CatalogPolicySummary
  8. ConfigSummary
  9. EffectorSummary
  10. EntityConfigSummary
  11. EntityDetail
  12. EntitySpec
  13. EntitySummary
  14. HaNodeSummary
  15. HighAvailabilitySummary
  16. InputStream
  17. LinkWithMetadata
  18. LocationConfigSummary
  19. LocationSpec
  20. LocationSummary
  21. ParameterSummaryObject
  22. PolicyConfigSummary
  23. PolicySummary
  24. SensorSummary
  25. TaskSummary
  26. UsageStatistic
  27. UsageStatistics

AccessSummary - Up

locationProvisioningAllowed (optional)
Boolean
links (optional)
map[String, String]

ApplicationSpec - Up

name (optional)
String
type (optional)
String
entities (optional)
array[EntitySpec]
locations (optional)
array[String]
config (optional)
map[String, String]

ApplicationSummary - Up

id (optional)
String
spec (optional)
ApplicationSpec
status (optional)
String
Enum:
ACCEPTED
STARTING
RUNNING
STOPPING
STOPPED
DESTROYED
ERROR
UNKNOWN
links (optional)
map[String, String]

CatalogEntitySummary - Up

symbolicName (optional)
String
version (optional)
String
name (optional)
String
javaType (optional)
String
planYaml (optional)
String
description (optional)
String
iconUrl (optional)
String
tags (optional)
array[Object]
config (optional)
array[EntityConfigSummary]
sensors (optional)
array[SensorSummary]
effectors (optional)
array[EffectorSummary]
deprecated (optional)
Boolean
links (optional)
map[String, String]
id (optional)
String
type (optional)
String

CatalogItemSummary - Up

symbolicName (optional)
String
version (optional)
String
name (optional)
String
javaType (optional)
String
planYaml (optional)
String
description (optional)
String
iconUrl (optional)
String
tags (optional)
array[Object]
deprecated (optional)
Boolean
links (optional)
map[String, String]
id (optional)
String
type (optional)
String

CatalogLocationSummary - Up

symbolicName (optional)
String
version (optional)
String
name (optional)
String
javaType (optional)
String
planYaml (optional)
String
description (optional)
String
iconUrl (optional)
String
config (optional)
array[LocationConfigSummary]
tags (optional)
array[Object]
deprecated (optional)
Boolean
links (optional)
map[String, String]
id (optional)
String
type (optional)
String

CatalogPolicySummary - Up

symbolicName (optional)
String
version (optional)
String
name (optional)
String
javaType (optional)
String
planYaml (optional)
String
description (optional)
String
iconUrl (optional)
String
config (optional)
array[PolicyConfigSummary]
tags (optional)
array[Object]
deprecated (optional)
Boolean
links (optional)
map[String, String]
id (optional)
String
type (optional)
String

ConfigSummary - Up

name (optional)
String
type (optional)
String
description (optional)
String
defaultValue (optional)
Object
reconfigurable (optional)
Boolean
label (optional)
String
priority (optional)
Double format: double
possibleValues (optional)
array[map[String, String]]
links (optional)
map[String, String]

EffectorSummary - Up

name (optional)
String
returnType (optional)
String
parameters (optional)
array[ParameterSummaryObject]
description (optional)
String
links (optional)
map[String, String]

EntityConfigSummary - Up

name (optional)
String
type (optional)
String
description (optional)
String
defaultValue (optional)
Object
reconfigurable (optional)
Boolean
label (optional)
String
priority (optional)
Double format: double
possibleValues (optional)
array[map[String, String]]
links (optional)
map[String, String]

EntityDetail - Up

applicationId (optional)
String
id (optional)
String
parentId (optional)
String
name (optional)
String
type (optional)
String
serviceUp (optional)
Boolean
serviceState (optional)
String
Enum:
CREATED
STARTING
RUNNING
STOPPING
STOPPED
DESTROYED
ON_FIRE
iconUrl (optional)
String
catalogItemId (optional)
String
children (optional)
array[EntitySummary]
groupIds (optional)
array[String]
members (optional)
array[map[String, String]]
links (optional)
map[String, String]

EntitySpec - Up

name (optional)
String
type (optional)
String
config (optional)
map[String, String]

EntitySummary - Up

id (optional)
String
name (optional)
String
type (optional)
String
catalogItemId (optional)
String
links (optional)
map[String, String]

HaNodeSummary - Up

nodeId (optional)
String
nodeUri (optional)
String format: uri
status (optional)
String
localTimestamp (optional)
Long format: int64
remoteTimestamp (optional)
Long format: int64

HighAvailabilitySummary - Up

ownId (optional)
String
masterId (optional)
String
nodes (optional)
map[String, HaNodeSummary]
links (optional)
map[String, String]

InputStream - Up

LinkWithMetadata - Up

link (optional)
String
metadata (optional)
map[String, Object]

LocationConfigSummary - Up

name (optional)
String
type (optional)
String
description (optional)
String
defaultValue (optional)
Object
reconfigurable (optional)
Boolean
label (optional)
String
priority (optional)
Double format: double
possibleValues (optional)
array[map[String, String]]
links (optional)
map[String, String]

LocationSpec - Up

name (optional)
String
spec (optional)
String
config (optional)
map[String, Object]

LocationSummary - Up

id (optional)
String
name (optional)
String
spec (optional)
String
type (optional)
String
config (optional)
map[String, Object]
catalog (optional)
CatalogLocationSummary
links (optional)
map[String, String]

ParameterSummaryObject - Up

name (optional)
String
type (optional)
String
description (optional)
String
defaultValue (optional)
Object

PolicyConfigSummary - Up

name (optional)
String
type (optional)
String
description (optional)
String
defaultValue (optional)
Object
reconfigurable (optional)
Boolean
links (optional)
map[String, String]
label (optional)
String
priority (optional)
Double format: double
possibleValues (optional)
array[map[String, String]]

PolicySummary - Up

id (optional)
String
name (optional)
String
catalogItemId (optional)
String
state (optional)
String
Enum:
ACCEPTED
STARTING
RUNNING
STOPPING
STOPPED
DESTROYED
ERROR
UNKNOWN
links (optional)
map[String, String]

SensorSummary - Up

name (optional)
String
type (optional)
String
description (optional)
String
links (optional)
map[String, String]

TaskSummary - Up

id (optional)
String
displayName (optional)
String
description (optional)
String
entityId (optional)
String
entityDisplayName (optional)
String
tags (optional)
array[Object]
submitTimeUtc (optional)
Long format: int64
startTimeUtc (optional)
Long format: int64
endTimeUtc (optional)
Long format: int64
currentStatus (optional)
String
result (optional)
Object
children (optional)
array[LinkWithMetadata]
submittedByTask (optional)
LinkWithMetadata
blockingTask (optional)
LinkWithMetadata
blockingDetails (optional)
String
detailedStatus (optional)
String
streams (optional)
map[String, LinkWithMetadata]
links (optional)
map[String, String]
cancelled (optional)
Boolean
error (optional)
Boolean

UsageStatistic - Up

status (optional)
String
Enum:
ACCEPTED
STARTING
RUNNING
STOPPING
STOPPED
DESTROYED
ERROR
UNKNOWN
id (optional)
String
applicationId (optional)
String
start (optional)
String
end (optional)
String
duration (optional)
Long format: int64
metadata (optional)
map[String, String]

UsageStatistics - Up

statistics (optional)
array[UsageStatistic]
links (optional)
map[String, String]