GET /images

bbc.com

Summary: Find metadata for images
Operation ID: listImages
Auth: unknown
Description

Find metadata for images, particularly those in galleries

Parameters (13)

embargoed (string, query, optional)

Control return of embargoed items (undocumented)

Constraints: {'enum': ['include', 'exclude', 'only']}

group (string, query, optional)

filter for images belonging to the given group (i.e. Gallery)

Constraints: {'minLength': 8, 'pattern': '^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$'}

image_type (array, query, optional)

filter for images by type

is_alternate_image_for (string, query, optional)

filter for alternate images by entity PID

Constraints: {'minLength': 8, 'pattern': '^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$'}

is_image_for (string, query, optional)

filter for images by entity PID

Constraints: {'minLength': 8, 'pattern': '^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$'}

page (integer, query, optional, default: 1)

which page of results to return

Constraints: {'minimum': 1}

page_size (integer, query, optional, default: 10)

number of results in each page

Constraints: {'maximum': 300}

partner_id (array, query, optional)

filter for images by partner ID

partner_pid (array, query, optional)

filter for images by partner PID

pid (array, query, optional)

filter for subset of images having given PID

q (string, query, optional)

filter for subset of images matching supplied keyword/phrase (boolean operators permitted)

sort (string, query, optional)

Sorts: * group_position: sort numerically by position, ascending only * pid: sort alphabetically by PID

Constraints: {'enum': ['group_position', 'pid']}

sort_direction (string, query, optional)

Sort direction

Constraints: {'enum': ['ascending', 'descending']}

No probe data for this endpoint yet.