Boolean Parameter instance¶
Read-only
This resource type refers to a boolean plugin parameter’s instance.
In other Collection+JSON resource representations this resource type is linked by any link relation with attribute:
"rel": "bool_inst"
-
GET
/api/v1/plugins/bool-parameter/
(int: parameterinstance_id)/
¶ Synopsis: Gets a boolean plugin parameter’s instance. Example request:
GET /api/v1/plugins/bool-parameter/30/ HTTP/1.1 Host: localhost:8000 Accept: application/vnd.collection+json
Example response:
HTTP/1.1 200 OK Allow: GET Content-Type: application/vnd.collection+json { "collection": { "href": "https://localhost:8000/api/v1/plugins/bool-parameter/30/", "items": [ { "data": [ { "name": "param_name", "value": "local" }, { "name": "value", "value": "True" } ], "href": "https://localhost:8000/api/v1/plugins/bool-parameter/30/", "links": [ { "href": "https://localhost:8000/api/v1/plugins/instances/40/", "rel": "plugin_inst" }, { "href": "https://localhost:8000/api/v1/plugins/parameters/8/", "rel": "plugin_param" } ] } ], "links": [], "version": "1.0" } }
Request Headers: - Accept – application/vnd.collection+json
Response Headers: - Content-Type – application/vnd.collection+json
Status Codes: - 200 OK – no error
- 401 Unauthorized – authentication credentials were not provided
- 404 Not Found – not found
Properties (API semantic descriptors):
- param_name (string) – name of the corresponding plugin parameter
- value (boolean) – parameter instance’s value
- plugin_inst – links to the corresponding plugin instance
- plugin_param – links to the corresponding plugin parameter