{"_id":"582789abbe5c080f00a5a840","project":"568bdc1483d2061900d86cdc","version":{"_id":"582789aabe5c080f00a5a7fe","__v":10,"project":"568bdc1483d2061900d86cdc","createdAt":"2016-11-12T21:29:14.915Z","releaseDate":"2016-11-12T21:29:14.915Z","categories":["582789abbe5c080f00a5a7ff","582789abbe5c080f00a5a800","582789abbe5c080f00a5a801","582789abbe5c080f00a5a802","582789abbe5c080f00a5a803","582789abbe5c080f00a5a804","582789abbe5c080f00a5a805","582789abbe5c080f00a5a806","582789abbe5c080f00a5a807","582789abbe5c080f00a5a808","5827ea984ca29e0f00137a9e","583df597887db62f00644283","583df5d9c622791900e78da5","5845cd8763c11b250037967d","5845d13063c11b2500379681","5859e859e3306d1900126725","587aeb9a01cf3a0f008359eb","587c422af45e2d0f005e200d","587d84dc82f6f30f004ceee5"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"beta2","version_clean":"0.0.0","version":"0"},"category":{"_id":"582789abbe5c080f00a5a805","__v":0,"version":"582789aabe5c080f00a5a7fe","project":"568bdc1483d2061900d86cdc","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-17T20:30:59.492Z","from_sync":false,"order":13,"slug":"service-classes","title":"Service Classes"},"parentDoc":null,"__v":0,"user":"573b7f42fdc9d320001b777d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-18T03:52:02.918Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"language":"json","code":"{\n  \"ecosystemId\": \"C573b86eeee43dd7ba0244f8a\",\n  \"name\": \"BinarySwitch\",\n  \"service\": {\n    \"name\": \"BinarySwitch\",\n    \"properties\": {\n      \"switch\": {\n        \"values\": [ \"on\", \"off\" ]\n      }\n    }\n  },\n  \"type\": \"custom\",\n  \"createdAt\": \"2016-05-18T02:14:34.266Z\"\n}","name":"","status":200},{"name":"","status":401,"language":"text","code":""},{"language":"text","code":"","status":403},{"status":404,"language":"text","code":"Ecosystem with id C573b86eeee43dd7ba0244f8b does not exist."}]},"settings":"572c39957c8eff0e00aaa18b","examples":{"codes":[{"code":"GET https://ioe.droplit.io/api/serviceclasses/C573b86eeee43dd7ba0244f8a;BinarySwitch HTTP/1.1\nauthorization: AUTH_TOKEN","language":"http"}]},"method":"get","auth":"required","params":[{"_id":"573bf580f09c292200b3977b","ref":"","in":"path","required":true,"desc":"parent [ecosystem](doc:ecosystems) id","default":"","type":"string","name":"ecosystemId"},{"_id":"573bf580f09c292200b3977a","ref":"","in":"path","required":true,"desc":"name of the [service class](doc:services)","default":"","type":"string","name":"name"}],"url":"/serviceclasses/:ecosystemId;:name"},"isReference":true,"order":2,"body":"This endpoint returns information about a service class and its definition.","excerpt":"Get the service class definition","slug":"read-serviceclasses","type":"endpoint","title":"Read"}

getRead

Get the service class definition

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ecosystemId:
required
string
parent [ecosystem](doc:ecosystems) id
name:
required
string
name of the [service class](doc:services)

Examples


Result Format


Documentation

This endpoint returns information about a service class and its definition.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}