Path Parameter instance

Read-only

This resource type refers to a path plugin parameter’s instance.

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

"rel": "path_inst"

GET /api/v1/plugins/path-parameter/(int: parameterinstance_id)/

Synopsis:Gets a path plugin parameter’s instance.

Example request:

GET /api/v1/plugins/path-parameter/56/ 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/path-parameter/56/",
        "items": [
            {
                "data": [
                    {
                        "name": "param_name",
                        "value": "dir"
                    },
                    {
                        "name": "value",
                        "value": "~/"
                    }
                ],
                "href": "https://localhost:8000/api/v1/plugins/path-parameter/56/",
                "links": [
                    {
                        "href": "https://localhost:8000/api/v1/plugins/instances/60/",
                        "rel": "plugin_inst"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/plugins/parameters/12/",
                        "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 (string) – a string representing a relative path

Link Relations:

• plugin_inst – links to the corresponding plugin instance
• plugin_param – links to the corresponding plugin parameter