Fetch file metadata

GET the metadata for a file whose upload has started

get/files/{path}

Request

Base URL
http://localhost:26900
Auth
API key in header Authorization

Path parameters

pathstring required

path of required file

Response

File metadata

pathstring

Path to file

is_publishableboolean

Is the file publishable

collection_idstring

The collection ID to which the file is attached

bundle_idstring

The bundle ID to which the file is attached

titlestring

The title given to the file

size_in_bytesinteger

Size of the file in bytes

typestring

The file type

licencestring

The type of licence the file has

licence_urlstring

Licence URL

etagstring

File etag

statestring

File state

Example response

{
  "path": "images/meme.jpg",
  "is_publishable": true,
  "collection_id": "1234-asdfg-54321-qwerty",
  "bundle_id": "bundle-789-xyz",
  "title": "The latest Meme",
  "size_in_bytes": 14794,
  "type": "image/jpeg",
  "licence": "OGL v3",
  "licence_url": "http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
  "etag": "1234567890asdfghjk",
  "state": "UPLOADED",
  "content_item": {
    "dataset_id": "cpih01",
    "edition": "time-series",
    "version": "1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.