Streams /streams

/streams endpoint provides file upload, CRUD operations on streams and association of media (i.e. image) to a stream.

Main responsabilities of this endpoint are:

• file upload and new stream creation
• get a collection of streams, using usual Filters
• link a stream to a media object
• remove an existing stream

Upload file and create stream

POST /streams/upload/{file_name}

Upload a file, passing it as binary in body.

Example request:

POST /streams/upload/myfile.jpg HTTP/1.1
Host: example.com
Accept: application/vnd.api+json
Content-Type: image/jpeg

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
    "data": {
        "id": "991c27b0-9e3a-43ca-a9dd-6c1f831eca31",
        "type": "streams",
        "attributes": {
            "file_name": "myfile.jpg",
            "mime_type": "image/png"
        },
        "meta": {
        },
        "relationships": {
            "object": {
                "links": {
                    "related": "http://example.com/streams/991c27b0-9e3a-43ca-a9dd-6c1f831eca31/object",
                    "self": "http://example.com/streams/991c27b0-9e3a-43ca-a9dd-6c1f831eca31/relationships/object"
                }
            }
        },
        "links": {
            "self": "http://example.com/streams/upload/myfile.jpg",
            "home": "http://example.com/home"
        },
        "meta": {
            "schema": {
                "streams": {
                    "$id": "http://example.com/model/schema/streams",
                    "revision": "627017864"
                }
            }
        }
    }
}

Get a single stream

GET /streams/(stream_id)

Get data for a stream by id.

Example request:

GET /streams/302f6fdd-bf31-4cd7-91db-baf45fb93de0 HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "id": "302f6fdd-bf31-4cd7-91db-baf45fb93de0",
        "type": "streams",
        "attributes": {
            "file_name": "myfile.jpg",
            "mime_type": "image/png"
        },
        "meta": {
            "...": "..."
        },
        "relationships": {
            "object": {
                "links": {
                    "related": "http://example.com/streams/302f6fdd-bf31-4cd7-91db-baf45fb93de0/object",
                    "self": "http://example.com/streams/302f6fdd-bf31-4cd7-91db-baf45fb93de0/relationships/object"
                }
            }
        }
    },
    "links": {
        "..." : "..."
    },
    "meta": {
        "..." : "..."
    }
}

Get a collection of streams

The /streams endpoint retrieve a collection of streams.

GET /streams

It returns a collection of streams:

• if called with id query string parameter the response will contain a collection of the streams requested
• else it returns a paginated list of streams that are descendants of the related publication configured in app/config/frontend.ini.php.

Example request:

GET /streams HTTP/1.1
Host: example.com

Example response:

For readability the fields of objects are limited to “title” but they are similar to GET /streams/(stream_id) example

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": [
        {
            "id": "0dae7797-5cc8-4d63-8a11-98664dd675b0",
            "type": "streams",
                "attributes": {
                    "file_name": "myfile.png",
                    "mime_type": "image/png"
                },
                "meta": {
                    "..." : "..."
                },
                "links": {
                    "..." : "..."
                },
                "relationships": {
                    "..." : "..."
                }
        }
    ],
    "links": {
        "..." : "..."
    },
    "meta": {
        "..." : "..."
    },
}

Create an image

POST /images provides image creation.

POST /images

Example request:

POST /images HTTP/1.1
Host: example.com
Content-Type:application/vnd.api+json
Accept: application/vnd.api+json

Example body:

{
    "data": {
        "type": "images",
        "attributes": {
            "title": "My media"
        }
    }
}

Example response:

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
    "data": {
        "id": "6",
        "type": "images",
        "attributes": {
                    "..." : "..."
        },
        "meta": {
                    "..." : "..."
        },
        "relationships": {
                    "..." : "..."
        }
    },
    "links": {
        "..." : "..."
    },
    "meta": {
        "..." : "..."
    }
}

Link stream to media

Link a stream to a media using PATCH /streams/{stream_uuid}/relationships/object.

PATCH /streams/{stream_uuid}/relationships/object

Example request:

PATCH /streams/302f6fdd-bf31-4cd7-91db-baf45fb93de0/relationships/object HTTP/1.1
Host: example.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Example body:

{
    "data": {
        "id": "6",
        "type": "images"
    }
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "http://example.com/streams/302f6fdd-bf31-4cd7-91db-baf45fb93de0/relationships/object",
        "home": "http://example.com/home"
    }
}

Get an image

GET /images/{image_id}

Get detailed data for an image by id.

Example request:

GET /images/6 HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "id": "6",
        "type": "images",
        "attributes": {
            "..." : "..."
        },
        "meta": {
            "..." : "..."
        },
        "relationships": {
            "streams": {
                "data": [
                    {
                        "id": "302f6fdd-bf31-4cd7-91db-baf45fb93de0",
                        "type": "streams"
                    }
                ],
                "links": {
                    "related": "http://example.com/images/6/streams",
                    "self": "http://example.com/images/6/relationships/streams"
                }
            }
        }
    },
    "links": {
        "..." : "..."
    },
    "meta": {
        "..." : "..."
    },
    "included": [
        {
            "id": "302f6fdd-bf31-4cd7-91db-baf45fb93de0",
            "type": "streams",
            "attributes": {
                "..." : "..."
            },
            "meta": {
                "..." : "..."
            },
            "links": {
                "..." : "..."
            },
            "relationships": {
                "..." : "..."
            }
        }
    ]
}