Skip to main content
In retrieving an image, the primary element required is:
  • File id or fid;
 

Query string

Using the element outlined above the query string becomes:

{domain}/file/{fid}/?_format=hal_json

Replacing the following variables:

  • {domain} ~ your-site.com
  • {fid} ~ 3214
Becomes:
your-site.com/file/3214?_format=hal_json
Generates the following output:
{
    "_links":
    {
        "self":
        {
            "href": "https://your-site.com/file/3214?_format=hal_json"
        },
        "type":
        {
            "href": "https://your-site.com/rest/type/file/image"
        },
        "https://your-site.com/rest/relation/file/image/uid": [
        {
            "href": "https://your-site.com/user/5?_format=hal_json"
        }]
    },
    "fid": [
    {
        "value": 3214
    }],
    "uuid": [
    {
        "value": "ea63b5e8-3f47-4320-aad9-bfe835d4f8ab"
    }],
    "langcode": [
    {
        "value": "en"
    }],
    "type": [
    {
        "target_id": "image"
    }],
    "_embedded":
    {
        "https://your-site.com/rest/relation/file/image/uid": [
            {
                "_links":
                {
                    "self":
                    {
                        "href": "https://your-site.com/user/5?_format=hal_json"…
                    },
                    "uuid": [
                    {
                        "value": "6c2be4c0-3bdb-4c0e-aec8-5836348cd4db"
                    }]
                }
            ]
        },
        "filename": [
        {
            "value": "sarah7.jpg"
        }],
        "uri": [
        {
            "value": "public://pictures/2017-08/sarah7_0.jpg"
        }],
        "filemime": [
        {
            "value": "image/jpeg"
        }],
        "filesize": [
        {
            "value": 35291
        }],
        "status": [
        {
            "value": false
        }],
        "created": [
        {
            "value": 1502676875
        }],
        "changed": [
        {
            "value": 1502764775
        }],
        "data": [
        {
            "value": "/9j/4QA2RXhpZgAASUkqAAgAAAABAJiCAgARAAAAGg....."
        }]
    }

Related articles