Plugin Instance collection

Read/write

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

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

"rel": "instances"

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

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

Example request:

GET /api/v1/plugins/4/instances/ HTTP/1.1
Host: localhost:8000
Accept: application/vnd.collection+json

Example response:

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

{
    "collection": {
        "href": "http://localhost:8000/api/v1/plugins/4/instances/",
        "items": [
            {
                "data": [
                    {
                        "name": "id",
                        "value": 8
                    },
                    {
                        "name": "previous_id",
                        "value": 5
                    },
                    {
                        "name": "plugin_name",
                        "value": "simpledsapp"
                    },
                    {
                        "name": "start_date",
                        "value": "2016-11-16T17:27:19.192067Z"
                    },
                    {
                        "name": "end_date",
                        "value": "2016-11-16T17:27:19.192118Z"
                    },
                    {
                        "name": "status",
                        "value": "started"
                    },
                    {
                        "name": "owner",
                        "value": "jbernal"
                    }
                ],
                "href": "http://localhost:8000/api/v1/plugins/instances/8/",
                "links": [
                    {
                        "href": "http://localhost:8000/api/v1/plugins/instances/5/",
                        "rel": "previous"
                    },
                    {
                        "href": "http://localhost:8000/api/v1/plugins/4/",
                        "rel": "plugin"
                    },
                    {
                        "href": "http://localhost:8000/api/v1/plugins/string-parameter/6/",
                        "rel": "string_param"
                    }
                ]
            },
            {
                "data": [
                    {
                        "name": "id",
                        "value": 9
                    },
                    {
                        "name": "previous_id",
                        "value": 6
                    },
                    {
                        "name": "plugin_name",
                        "value": "simpledsapp"
                    },
                    {
                        "name": "start_date",
                        "value": "2016-11-16T17:27:39.508197Z"
                    },
                    {
                        "name": "end_date",
                        "value": "2016-11-16T17:27:39.508248Z"
                    },
                    {
                        "name": "status",
                        "value": "started"
                    },
                    {
                        "name": "owner",
                        "value": "jbernal"
                    }
                ],
                "href": "http://localhost:8000/api/v1/plugins/instances/9/",
                "links": [
                    {
                        "href": "http://localhost:8000/api/v1/plugins/instances/6/",
                        "rel": "previous"
                    },
                    {
                        "href": "http://localhost:8000/api/v1/plugins/4/",
                        "rel": "plugin"
                    },
                    {
                        "href": "http://localhost:8000/api/v1/plugins/string-parameter/7/",
                        "rel": "string_param"
                    }
                ]
            },
        ],
        "links": [
            {
                "href": "http://localhost:8000/api/v1/plugins/4/",
                "rel": "plugin"
            }
        ],
        "queries": [
            {
                "data": [
                    {
                        "name": "root_id",
                        "value": ""
                    },
                    {
                        "name": "status",
                        "value": ""
                    },
                    {
                        "name": "previous_id",
                        "value": ""
                    },
                    {
                        "name": "min_start_date",
                        "value": ""
                    },
                    {
                        "name": "max_start_date",
                        "value": ""
                    },
                    {
                        "name": "min_end_date",
                        "value": ""
                    },
                    {
                        "name": "max_end_date",
                        "value": ""
                    }
                ],
                "href": "http://localhost:8000/api/v1/plugins/instances/search/",
                "rel": "search"
            }
        ],
        "template": {
            "data": [
                {
                    "name": "prefix",
                    "value": ""
                },
                {
                    "name": "sleepLength",
                    "value": ""
                },
                {
                    "name": "previous_id",
                    "value": ""
                }
            ]
        },
        "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 instance item properties

Link Relations:

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