Skip to content

REST Applications Effectors

andreisavu edited this page May 1, 2012 · 2 revisions

Invoke Effector

Request

POST /v1/applications/{application}/entities/{entity}/effectors/{effector}

{"arg1": "val1", "arg2": "val2"}

Response

HTTP/1.1 202 Accepted

List Entity Effectors

Request

GET /v1/applications/{application}/entities/{entity}/effectors

Response

HTTP/1.1 200 OK
Content-Type: application/json


[
  {
    "name": "start",
    "description": "Start the process/service represented by an entity",
    "returnType": "void",
    "parameters": [
      {
        "name": "locations",
        "type": "java.util.Collection",
        "description": null
      }
    ],
    "links": {
      "self": "/v1/applications/redis/entities/IODz2uR3/effectors/start",
      "entity": "/v1/applications/redis/entities/IODz2uR3",
      "application": "/v1/applications/redis"
    }
  },
  {
    "name": "stop",
    "description": "Stop the process/service represented by an entity",
    "returnType": "void",
    "parameters": [

    ],
    "links": {
      "self": "/v1/applications/redis/entities/IODz2uR3/effectors/stop",
      "entity": "/v1/applications/redis/entities/IODz2uR3",
      "application": "/v1/applications/redis"
    }
  },
  {
    "name": "restart",
    "description": "Restart the process/service represented by an entity",
    "returnType": "void",
    "parameters": [

    ],
    "links": {
      "self": "/v1/applications/redis/entities/IODz2uR3/effectors/restart",
      "entity": "/v1/applications/redis/entities/IODz2uR3",
      "application": "/v1/applications/redis"
    }
  }
]