Feed collection

Read-only

This resource type refers to a collection of user-specific feed items.

A Collection+JSON representation is served at the root of the API: /api/v1/.

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

"rel": "feeds"

GET /api/v1/

Synopsis:Gets the list of feeds for the authenticated user.

Example request:

GET /api/v1/ 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/",
        "items": [
            {
                "data": [
                    {
                        "name": "name",
                        "value": ""
                    }
                ],
                "href": "https://localhost:8000/api/v1/33/",
                "links": [
                    {
                        "href": "https://localhost:8000/api/v1/users/2/",
                        "rel": "owner"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/note33/",
                        "rel": "note"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/33/tags/",
                        "rel": "tags"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/33/comments/",
                        "rel": "comments"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/33/files/",
                        "rel": "files"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/plugins/instances/58/",
                        "rel": "plugin_inst"
                    }
                ]
            },
            {
                "data": [
                    {
                        "name": "name",
                        "value": ""
                    }
                ],
                "href": "https://localhost:8000/api/v1/34/",
                "links": [
                    {
                        "href": "https://localhost:8000/api/v1/users/2/",
                        "rel": "owner"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/note34/",
                        "rel": "note"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/34/tags/",
                        "rel": "tags"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/34/comments/",
                        "rel": "comments"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/34/files/",
                        "rel": "files"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/plugins/instances/59/",
                        "rel": "plugin_inst"
                    }
                ]
            }
        ],
        "links": [
            {
                "href": "https://localhost:8000/api/v1/plugins/",
                "rel": "plugins"
            }
        ],
        "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

Properties (API semantic descriptors):

• feed item properties

Link Relations:

• feed item link relations
• plugins – links to the collection of plugins in the system