Plugin Parameter item

Read-only

This resource type refers to a plugin parameter item.

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

"rel": "plugin_param"

GET /api/v1/parameters/(int: parameter_id)/

Synopsis:Gets a plugin parameter.

Example request:

GET /api/v1/parameters/1/ HTTP/1.1
Host: localhost:8010
Accept: application/vnd.collection+json

Example response:

HTTP/1.1 200 OK
Allow: GET
Content-Type: application/vnd.collection+json

{
    "collection": {
        "href": "https://localhost:8010/api/v1/parameters/1/",
        "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:8010/api/v1/parameters/1/",
                "links": [
                    {
                        "href": "https://localhost:8000/api/v1/1/",
                        "rel": "plugin"
                    }
                ]
            }
        ],
        "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) – parameter’s name
• type (string) – paremeter’s type. Any of the strings ‘string’, ‘integer’, ‘float’ or ‘boolean’
• optional (boolean) – indicates whether the parameter has a default value and is not required in requests
• default (string) – a string representation of the parameter’s default value Only available if the value of the “optional” property is True
• help (string) – a description of the parameter

Link Relations:

• plugin – links to the corresponding plugin