File collection

Read-only

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

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

"rel": "files"

GET /api/v1/(int: feed_id)/files/

Synopsis:Gets the list of files for the feed (feed_id).

Example request:

GET /api/v1/35/files/ 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/35/files/",
        "items": [
            {
                "data": [
                    {
                        "name": "fname",
                        "value": "~/users/jbernal/feed_35/simplefsapp_60/data/out.txt"
                    }
                ],
                "href": "https://localhost:8000/api/v1/files/28/",
                "links": [
                    {
                        "href": "https://localhost:8000/api/v1/files/28/out.txt",
                        "rel": "file_resource"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/35/",
                        "rel": "feed"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/plugins/instances/60/",
                        "rel": "plugin_inst"
                    }
                ]
            },
            {
                "data": [
                    {
                        "name": "fname",
                        "value": "~/users/jbernal/feed_35/simplefsapp_60/simpledsapp_62/data/new_out.txt"
                    }
                ],
                "href": "https://localhost:8000/api/v1/files/30/",
                "links": [
                    {
                        "href": "https://localhost:8000/api/v1/files/30/new_out.txt",
                        "rel": "file_resource"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/35/",
                        "rel": "feed"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/plugins/instances/62/",
                        "rel": "plugin_inst"
                    }
                ]
            }
        ],
        "links": [
            {
                "href": "https://localhost:8000/api/v1/35/",
                "rel": "feed"
            }
        ],
        "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
• 403 Forbidden – you do not have permission to perform this action
• 404 Not Found – not found

Properties (API semantic descriptors):

• file item properties

Link Relations:

• file item link relations