Plugin Instance item

Read-only

This resource type refers to a plugin instance item.

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

"rel": "plugin_inst"

GET /api/v1/instances/(int: instance_id)/

Synopsis:Gets a plugin instance.

Example request:

GET /api/v1/instances/16/ 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": "http://localhost:8000/api/v1/plugins/instances/16/",
        "items": [
            {
                "data": [
                    {
                        "name": "id",
                        "value": 16
                    },
                    {
                        "name": "previous_id",
                        "value": 6
                    },
                    {
                        "name": "plugin_name",
                        "value": "simpledsapp"
                    },
                    {
                        "name": "start_date",
                        "value": "2016-11-17T21:33:22.281362Z"
                    },
                    {
                        "name": "end_date",
                        "value": "2016-11-17T21:34:13.860258Z"
                    },
                    {
                        "name": "status",
                        "value": "finishedSuccessfully"
                    },
                    {
                        "name": "owner",
                        "value": "jbernal"
                    }
                ],
                "href": "http://localhost:8000/api/v1/plugins/instances/16/",
                "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/14/",
                        "rel": "string_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):

• id (int) – instance’s id
• previous_id (int) – previous instance’s id
• plugin_name (string) – corresponding plugin’s name
• start_date (string) – starting date of the associated plugin process
• end_date (boolean) – end date of the associated plugin process
• status (string) – status of the associated plugin process
• owner (string) – the plugin instance’s owner’s username

Link Relations:

• plugin – links to the corresponding plugin
• previous – links to the previous plugin instance
• feed – links to the corresponding feed (only for plugins of type ‘fs’)
• string_param – links to a string parameter instance
• int_param – links to an integer parameter instance
• float_param – links to a float parameter instance
• bool_param – links to a boolean parameter instance