Plugin item

Read-only

This resource type refers to a plugin item.

In other Collection+JSON resource representations this resource type is linked by any link relation with attribute:

"rel": "plugin"

GET /api/v1/plugins/(int: plugin_id)/

Synopsis:Gets a system plugin.

Example request:

GET /api/v1/plugins/12/ 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/12/",
        "items": [
            {
                "data": [
                    {
                        "name": "name",
                        "value": "simplefsapp"
                    },
                    {
                        "name": "type",
                        "value": "fs"
                    }
                ],
                "href": "https://localhost:8000/api/v1/plugins/12/",
                "links": [
                    {
                        "href": "https://localhost:8000/api/v1/plugins/12/parameters/",
                        "rel": "parameters"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/plugins/12/instances/",
                        "rel": "instances"
                    }
                ]
            }
        ],
        "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):

• name (string) – plugin’s name
• type (string) – plugin’s type. Can only be the strings ‘fs’ (filesystem plugin) or ‘ds’ (data plugin)

Link Relations:

• parameters – links to the plugin’s collection of parameters
• instances – links to the plugin’s collection of instances