Collection

get

https://content.api.pressassociation.io/v1/item

Item: Collection

Query Params

offset

int32

Offset to start from.

limit

int32

Number of items to return.

string

Defaults to json

The format to render the response. Possible values (json, atom, rss).

uri

string

uri value to query.

pubstatus

string

The published status to query. Possible values (usable, withheld, canceled).

type

string

The kind of content type to query. Possible values (text, audio, video, picture, graphic, composite, social, quiz).

event

string

Event path to include, either matching all associations to an Event (e.g. paevent:b47ddf45-6e26-4d9d-86ac-9e62459fda6f.*) or a specific association (e.g. paevent:b47ddf45-6e26-4d9d-86ac-9e62459fda6f.partOf) . Any may match in a single document.

notEvent

string

Event path to exclude, either matching all associations to an Event (e.g. paevent:b47ddf45-6e26-4d9d-86ac-9e62459fda6f.*) or a specific association (e.g. paevent:b47ddf45-6e26-4d9d-86ac-9e62459fda6f.partOf).

andEvent

string

parentEvent

string

Return all items that contain an event that is a child of the provided event.

subject

string

Subject identifier to include (for a list of available subjects please refer to the subject resource). Any may match in a single document.

notSubject

string

Subject to exclude (for a list of available subjects please refer to the subject resource).

andSubject

string

Subject identifier to include (for a list of available subjects please refer to the subject resource). All must match in a single document.

place

string

Place identifier to include. Any may match in a single document.

notPlace

string

Place to exclude.

andPlace

string

Place identifier to include. All must match in a single document.

service

string

Service identifier to include (for a list of available service please refer to the service resource). Any may match in a single document.

object

string

Object identifier to include. Any may match in a single document.

notObject

string

Object to exclude.

andObject

string

Object identifier to include. All must match in a single document.

product

string

Only return items included within this product. Possible values (paproduct:now, paproduct:ready, paproduct:create, paproduct:radar).

entitlement

string

Entitlement identifier to include.

profile

string

The kind of content item to query. Possible values (asset, alert, advisory, insight, statement, story, story-enriched).

start

date

Start date time either as an ISO datetime or Date Math expression.

end

date

End date time either as an ISO datetime or Date Math expression.

query

string

String to query.

string

Experimental String to query.

qDefaultOperator

string

Defaults to OR

Sets whether the q param should AND or OR the search terms given.

minScore

float

Defaults to 0

Value that the ElasticSearch score must meet for an item to be included.

geoLat

float

Latitude for a geo-spatial query against places in an item.

geoLong

float

Longitude for a geo-spatial query against places in an item.

geoRadius

string

Radius of the circle for geo-spatial queries, combined with geoLat and geoLong. Defaults to metres (m), a unit can be provided e.g. 10km.

geoRelation

string

Defaults to intersects

The required geo-spatial relation to use for circle and other shape queries, defaulting to 'intersects'. Use 'within' to find items with a place within the submitted shape, 'contains' to find items with places containing the shape, and 'disjoint' to find items with places that have nothing in common with the shape.

fieldExist

string

Only return items where this field exists.

sort

string

Defaults to versioncreated:desc:min

Sort uri (e.g. :<desc || asc>:<min || max || avg || sum>).

sortType

string

Allows special sortTypes to be set.

includeEventStats

boolean

Defaults to false

include event statistic details. To enable, include this parameter with any value.

includeGeometry

boolean

Defaults to false

include geometry objects of embedded places. Warning - increases response time and size.

excludeEmbedType

string

Exclude a specific embed type from the content (e.g. YouTube, Image, Twitter).

Response

200200