Plugin Parameter collection

Read-only

This resource type refers to the collection of a plugin’s plugin parameter items.

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

"rel": "parameters"

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

Synopsis:Gets the list of parameters for the plugin (plugin_id).

Example request:

GET /api/v1/plugins/12/parameters/ 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/parameters/",
        "items": [
            {
                "data": [
                    {
                        "name": "name",
                        "value": "dir"
                    },
                    {
                        "name": "type",
                        "value": "string"
                    },
                    {
                        "name": "optional",
                        "value": true
                    },
                    {
                        "name": "default",
                        "value": "./"
                    },
                    {
                        "name": "help",
                        "value": "look up directory"
                    }
                ],
                "href": "https://localhost:8000/api/v1/plugins/parameters/12/",
                "links": [
                    {
                        "href": "https://localhost:8000/api/v1/plugins/12/",
                        "rel": "plugin"
                    }
                ]
            }
        ],
        "links": [
            {
                "href": "https://localhost:8000/api/v1/plugins/12/",
                "rel": "plugin"
            }
        ],
        "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):

• plugin parameter item properties

Link Relations:

• plugin parameter item link relations
• plugin – links to the corresponding plugin