swagger: "2.0"
info:
title: The ReliefWeb API
description: Interactive API documentation for the data API of Reliefweb.int. ReliefWeb is a leading source of information on global crises and disasters.
Our continuous coverage and archive going back to the 1970s makes ReliefWeb an unparalleled resource for both current and historical data on humanitarian response.
The vast majority of content on ReliefWeb has been contributed by humanitarian partners. We owe it to the community to make data more accessible and reusable, so that developers can build tools that increase exposure for valuable content and facilitate analysis for better decisions.
termsOfService: https://apidoc.rwlabs.org/#tos
version: v1
contact:
url: https://reliefweb.int/contact
email: api@reliefweb.int
license:
name: Creative Commons Zero - Public Domain
url: http://creativecommons.org/about/cc0
host: api.reliefweb.int
basePath: /v2
schemes:
- http
- https
consumes:
- text/plain; charset=utf-8
- application/json
produces:
- application/json
tags:
-
name: Discovery
description: Versions and main endpoints.
externalDocs:
description: RWApi docs.
url: https://apidoc.rwlabs.org
-
name: Reports
description: Gateway to updates and analysis from more than 4,000 global information sources.
externalDocs:
description: RWApi docs.
url: https://apidoc.rwlabs.org
-
name: Jobs
description: Humanitarian job listings.
externalDocs:
description: RWApi docs.
url: https://apidoc.rwlabs.org
-
name: Training
description: Humanitarian training opportunities and courses.
externalDocs:
description: RWApi docs.
url: https://apidoc.rwlabs.org
-
name: Countries
description: Countries covered by ReliefWeb.
externalDocs:
description: RWApi docs.
url: https://apidoc.rwlabs.org
-
name: Disasters
description: Disasters covered by ReliefWeb.
externalDocs:
description: RWApi docs.
url: https://apidoc.rwlabs.org
-
name: Sources
description: Organizations providing content to ReliefWeb.
externalDocs:
description: RWApi docs.
url: https://apidoc.rwlabs.org
paths:
/../:
get:
tags:
- Discovery
description: Review location and status of all versions.
operationId: discoveryVersions
consumes:
- text/plain; charset=utf-8
produces:
- application/json
responses:
200:
description: Success.
/:
get:
tags:
- Discovery
description: Review list of main entrypoints and top-level resources.
operationId: discoveryResources
consumes:
- text/plain; charset=utf-8
produces:
- application/json
responses:
200:
description: Success.
/reports:
get:
tags:
- Reports
summary: |
List or search updates, headlines or maps.
description: |
operationId: getReports
consumes:
- text/plain; charset=utf-8
produces:
- application/json
parameters:
-
$ref: '#/parameters/query[value]'
-
$ref: '#/parameters/query[operator]'
-
$ref: '#/parameters/query[fields][]'
-
$ref: '#/parameters/filter[field]'
-
$ref: '#/parameters/filter[value][]'
-
$ref: '#/parameters/filter[operator]'
-
$ref: '#/parameters/filter[negate]'
-
$ref: '#/parameters/filter[conditions][]'
-
$ref: '#/parameters/facets[field]'
-
$ref: '#/parameters/facets[name]'
-
$ref: '#/parameters/facets[limit]'
-
$ref: '#/parameters/facets[sort]'
-
$ref: '#/parameters/facets[filter][]'
-
$ref: '#/parameters/facets[interval]'
-
$ref: '#/parameters/fields[include][]'
-
$ref: '#/parameters/fields[exclude][]'
-
$ref: '#/parameters/limit'
-
$ref: '#/parameters/offset'
-
$ref: '#/parameters/sort[]'
-
$ref: '#/parameters/profile'
-
$ref: '#/parameters/preset'
responses:
200:
description: Success
schema:
$ref: '#/definitions/Report'
400:
description: Unexpected value
schema:
$ref: '#/definitions/error'
post:
tags:
- Reports
summary: |
List or search updates, headlines or maps.
description: |
operationId: searchReports
consumes:
- "application/json"
produces:
- "application/json"
parameters:
-
description: Returned fields
in: body
name: fields
required: false
schema:
$ref: '#/definitions/post-params'
responses:
200:
description: Success
schema:
$ref: '#/definitions/Report'
400:
description: Unexpected value
schema:
$ref: '#/definitions/error'
/reports/{reportId}:
get:
tags:
- Reports
summary: Find report by its unique ID
description: |
Individual reports.
operationId: getReportById
parameters:
-
description: The identifier of the report.
in: path
name: reportId
required: true
type: string
-
$ref: '#/parameters/profile'
-
$ref: '#/parameters/fields[include][]'
-
$ref: '#/parameters/fields[exclude][]'
produces:
- application/json
responses:
200:
description: Report fields
schema:
$ref: '#/definitions/Report'
404:
description: Not found
schema:
$ref: '#/definitions/error'
/jobs:
get:
tags:
- Jobs
summary: |
List or search humanitarian job offers.
description: |
operationId: getJobs
consumes:
- text/plain; charset=utf-8
produces:
- application/json
parameters:
-
$ref: '#/parameters/query[value]'
-
$ref: '#/parameters/query[operator]'
-
$ref: '#/parameters/query[fields][]'
-
$ref: '#/parameters/filter[field]'
-
$ref: '#/parameters/filter[value][]'
-
$ref: '#/parameters/filter[operator]'
-
$ref: '#/parameters/filter[negate]'
-
$ref: '#/parameters/filter[conditions][]'
-
$ref: '#/parameters/facets[field]'
-
$ref: '#/parameters/facets[name]'
-
$ref: '#/parameters/facets[limit]'
-
$ref: '#/parameters/facets[sort]'
-
$ref: '#/parameters/facets[filter][]'
-
$ref: '#/parameters/facets[interval]'
-
$ref: '#/parameters/fields[include][]'
-
$ref: '#/parameters/fields[exclude][]'
-
$ref: '#/parameters/limit'
-
$ref: '#/parameters/offset'
-
$ref: '#/parameters/sort[]'
-
$ref: '#/parameters/profile'
-
$ref: '#/parameters/preset'
responses:
200:
description: Success
schema:
$ref: '#/definitions/Job'
400:
description: Unexpected value
schema:
$ref: '#/definitions/error'
post:
tags:
- Jobs
summary: |
List or search humanitarian job offers.
description: |
operationId: "searchJobs"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
-
description: Returned fields
in: body
name: fields
required: false
schema:
$ref: '#/definitions/post-params'
responses:
200:
description: Success
schema:
$ref: '#/definitions/Job'
400:
description: Unexpected value
schema:
$ref: '#/definitions/error'
/jobs/{jobId}:
get:
tags:
- Jobs
summary: Find job by its unique ID
description: |
Individual jobs.
operationId: getJobById
parameters:
-
description: The identifier of the job.
in: path
name: jobId
required: true
type: string
-
$ref: '#/parameters/profile'
-
$ref: '#/parameters/fields[include][]'
-
$ref: '#/parameters/fields[exclude][]'
produces:
- application/json
responses:
200:
description: Job fields
schema:
$ref: '#/definitions/Job'
404:
description: Not found
schema:
$ref: '#/definitions/error'
/training:
get:
tags:
- Training
summary: |
List or search humanitarian learning opportunities.
description: |
operationId: getTraining
consumes:
- text/plain; charset=utf-8
produces:
- application/json
parameters:
-
$ref: '#/parameters/query[value]'
-
$ref: '#/parameters/query[operator]'
-
$ref: '#/parameters/query[fields][]'
-
$ref: '#/parameters/filter[field]'
-
$ref: '#/parameters/filter[value][]'
-
$ref: '#/parameters/filter[operator]'
-
$ref: '#/parameters/filter[negate]'
-
$ref: '#/parameters/filter[conditions][]'
-
$ref: '#/parameters/facets[field]'
-
$ref: '#/parameters/facets[name]'
-
$ref: '#/parameters/facets[limit]'
-
$ref: '#/parameters/facets[sort]'
-
$ref: '#/parameters/facets[filter][]'
-
$ref: '#/parameters/facets[interval]'
-
$ref: '#/parameters/fields[include][]'
-
$ref: '#/parameters/fields[exclude][]'
-
$ref: '#/parameters/limit'
-
$ref: '#/parameters/offset'
-
$ref: '#/parameters/sort[]'
-
$ref: '#/parameters/profile'
-
$ref: '#/parameters/preset'
responses:
200:
description: Success
schema:
$ref: '#/definitions/Training'
400:
description: Unexpected value
schema:
$ref: '#/definitions/error'
post:
tags:
- Training
summary: |
List or search humanitarian learning opportunities.
description: |
operationId: searchTraining
consumes:
- application/json
produces:
- application/json
parameters:
-
description: Returned fields
in: body
name: fields
required: false
schema:
$ref: '#/definitions/post-params'
responses:
200:
description: Success
schema:
$ref: '#/definitions/Training'
400:
description: Unexpected value
schema:
$ref: '#/definitions/error'
/training/{trainingId}:
get:
tags:
- Training
summary: Find training by its unique ID
description: |
Individual training opportunities.
operationId: getTrainingById
parameters:
-
description: The identifier of the training opportunity.
in: path
name: trainingId
required: true
type: string
-
$ref: '#/parameters/profile'
-
$ref: '#/parameters/fields[include][]'
-
$ref: '#/parameters/fields[exclude][]'
produces:
- application/json
responses:
200:
description: Training fields
schema:
$ref: '#/definitions/Training'
404:
description: Not found
schema:
$ref: '#/definitions/error'
/countries:
get:
tags:
- Countries
summary: |
List or search countries covered by ReliefWeb.
description: |
operationId: getCountries
consumes:
- text/plain; charset=utf-8
produces:
- application/json
parameters:
-
$ref: '#/parameters/query[value]'
-
$ref: '#/parameters/query[operator]'
-
$ref: '#/parameters/query[fields][]'
-
$ref: '#/parameters/filter[field]'
-
$ref: '#/parameters/filter[value][]'
-
$ref: '#/parameters/filter[operator]'
-
$ref: '#/parameters/filter[negate]'
-
$ref: '#/parameters/filter[conditions][]'
-
$ref: '#/parameters/facets[field]'
-
$ref: '#/parameters/facets[name]'
-
$ref: '#/parameters/facets[limit]'
-
$ref: '#/parameters/facets[sort]'
-
$ref: '#/parameters/facets[filter][]'
-
$ref: '#/parameters/facets[interval]'
-
$ref: '#/parameters/fields[include][]'
-
$ref: '#/parameters/fields[exclude][]'
-
$ref: '#/parameters/limit'
-
$ref: '#/parameters/offset'
-
$ref: '#/parameters/sort[]'
-
$ref: '#/parameters/profile'
-
$ref: '#/parameters/preset'
responses:
200:
description: Success
schema:
$ref: '#/definitions/Country'
400:
description: Unexpected value
schema:
$ref: '#/definitions/error'
post:
tags:
- Countries
summary: |
List or search countries covered by ReliefWeb.
description: |
operationId: searchCountries
consumes:
- application/json
produces:
- application/json
parameters:
-
description: Returned fields
in: body
name: fields
required: false
schema:
$ref: '#/definitions/post-params'
responses:
200:
description: Success
schema:
$ref: '#/definitions/Country'
400:
description: Unexpected value
schema:
$ref: '#/definitions/error'
/countries/{countryId}:
get:
tags:
- Countries
summary: Find country by its unique ID
description: |
Individual countries
operationId: getCountryById
parameters:
-
description: The identifier of the country
in: path
name: countryId
required: true
type: string
-
$ref: '#/parameters/profile'
-
$ref: '#/parameters/fields[include][]'
-
$ref: '#/parameters/fields[exclude][]'
produces:
- application/json
responses:
200:
description: Country fields
schema:
$ref: '#/definitions/Country'
404:
description: Not found
schema:
$ref: '#/definitions/error'
/disasters:
get:
tags:
- Disasters
summary: |
List or search disasters covered by ReliefWeb.
description: |
operationId: getDisasters
consumes:
- text/plain; charset=utf-8
produces:
- application/json
parameters:
-
$ref: '#/parameters/query[value]'
-
$ref: '#/parameters/query[operator]'
-
$ref: '#/parameters/query[fields][]'
-
$ref: '#/parameters/filter[field]'
-
$ref: '#/parameters/filter[value][]'
-
$ref: '#/parameters/filter[operator]'
-
$ref: '#/parameters/filter[negate]'
-
$ref: '#/parameters/filter[conditions][]'
-
$ref: '#/parameters/facets[field]'
-
$ref: '#/parameters/facets[name]'
-
$ref: '#/parameters/facets[limit]'
-
$ref: '#/parameters/facets[sort]'
-
$ref: '#/parameters/facets[filter][]'
-
$ref: '#/parameters/facets[interval]'
-
$ref: '#/parameters/fields[include][]'
-
$ref: '#/parameters/fields[exclude][]'
-
$ref: '#/parameters/limit'
-
$ref: '#/parameters/offset'
-
$ref: '#/parameters/sort[]'
-
$ref: '#/parameters/profile'
-
$ref: '#/parameters/preset'
responses:
200:
description: Success
schema:
$ref: '#/definitions/Disaster'
400:
description: Unexpected value
schema:
$ref: '#/definitions/error'
post:
tags:
- Disasters
summary: |
List or search disasters covered by ReliefWeb.
description: |
operationId: searchDisasters
consumes:
- application/json
produces:
- application/json
parameters:
-
description: Returned fields
in: body
name: fields
required: false
schema:
$ref: '#/definitions/post-params'
responses:
200:
description: Success
schema:
$ref: '#/definitions/Disaster'
400:
description: Unexpected value
schema:
$ref: '#/definitions/error'
/disasters/{disasterId}:
get:
tags:
- Disasters
summary: Find disaster by its unique ID
description: |
Individual disasters
operationId: getDisasterById
parameters:
-
description: The identifier of the disaster
in: path
name: disasterId
required: true
type: string
-
$ref: '#/parameters/profile'
-
$ref: '#/parameters/fields[include][]'
-
$ref: '#/parameters/fields[exclude][]'
produces:
- application/json
responses:
200:
description: Disaster fields
schema:
$ref: '#/definitions/Disaster'
404:
description: Not found
schema:
$ref: '#/definitions/error'
/sources:
get:
tags:
- Sources
summary: |
List or search organizations providing content to ReliefWeb.
description: |
operationId: getSources
consumes:
- text/plain; charset=utf-8
produces:
- application/json
parameters:
-
$ref: '#/parameters/query[value]'
-
$ref: '#/parameters/query[operator]'
-
$ref: '#/parameters/query[fields][]'
-
$ref: '#/parameters/filter[field]'
-
$ref: '#/parameters/filter[value][]'
-
$ref: '#/parameters/filter[operator]'
-
$ref: '#/parameters/filter[negate]'
-
$ref: '#/parameters/filter[conditions][]'
-
$ref: '#/parameters/facets[field]'
-
$ref: '#/parameters/facets[name]'
-
$ref: '#/parameters/facets[limit]'
-
$ref: '#/parameters/facets[sort]'
-
$ref: '#/parameters/facets[filter][]'
-
$ref: '#/parameters/facets[interval]'
-
$ref: '#/parameters/fields[include][]'
-
$ref: '#/parameters/fields[exclude][]'
-
$ref: '#/parameters/limit'
-
$ref: '#/parameters/offset'
-
$ref: '#/parameters/sort[]'
-
$ref: '#/parameters/profile'
-
$ref: '#/parameters/preset'
responses:
200:
description: Success
schema:
$ref: '#/definitions/Source'
400:
description: Unexpected value
schema:
$ref: '#/definitions/error'
post:
tags:
- Sources
summary: |
List or search organizations providing content to ReliefWeb.
description: |
operationId: searchSources
consumes:
- application/json
produces:
- application/json
parameters:
-
description: Returned fields
in: body
name: fields
required: false
schema:
$ref: '#/definitions/post-params'
responses:
200:
description: Success
schema:
$ref: '#/definitions/Source'
400:
description: Unexpected value
schema:
$ref: '#/definitions/error'
/sources/{sourceId}:
get:
tags:
- Sources
summary: Find source by its unique ID
description: |
Individual sources.
operationId: getSourceById
parameters:
-
description: The identifier of the source
in: path
name: sourceId
required: true
type: string
-
$ref: '#/parameters/profile'
-
$ref: '#/parameters/fields[include][]'
-
$ref: '#/parameters/fields[exclude][]'
produces:
- application/json
responses:
200:
description: Source fields
schema:
$ref: '#/definitions/Source'
404:
description: Not found
schema:
$ref: '#/definitions/error'
definitions:
Report:
properties:
body:
type: string
country:
items:
$ref: '#/definitions/country'
type: array
date:
$ref: '#/definitions/date'
format:
description: Format of report.
items:
$ref: '#/definitions/category'
type: array
id:
format: int64
type: integer
language:
$ref: '#/definitions/language'
primary_country:
$ref: '#/definitions/country'
source:
description: Report production and coordination bodies.
items:
$ref: '#/definitions/source'
type: array
status:
type: boolean
theme:
description: Category of information contained in the report.
items:
$ref: '#/definitions/category'
type: array
title:
type: string
type:
type: string
Job:
properties:
category:
items:
$ref: '#/definitions/category'
type: array
city:
items:
$ref: '#/definitions/location'
type: array
country:
items:
$ref: '#/definitions/country'
type: array
date:
$ref: '#/definitions/date'
description:
type: string
description-html:
type: string
experience:
items:
$ref: '#/definitions/category'
type: array
file:
items:
$ref: '#/definitions/file'
type: array
how-to-apply-html:
type: string
how_to_apply:
type: string
id:
type: string
language:
$ref: '#/definitions/language'
link:
type: string
theme:
items:
$ref: '#/definitions/category'
type: array
title:
type: string
url:
type: string
Training:
properties:
category:
items:
$ref: '#/definitions/category'
type: array
city:
items:
$ref: '#/definitions/location'
type: array
country:
items:
$ref: '#/definitions/country'
type: array
date:
$ref: '#/definitions/date'
description:
type: string
description-html:
type: string
file:
items:
$ref: '#/definitions/file'
type: array
format:
items:
$ref: '#/definitions/category'
type: array
how-to-apply-html:
type: string
how_to_apply:
type: string
id:
type: string
language:
$ref: '#/definitions/language'
link:
type: string
theme:
items:
$ref: '#/definitions/category'
type: array
title:
type: string
url:
type: string
Country:
properties:
current:
type: boolean
description:
type: string
description-html:
type: string
featured:
type: boolean
id:
type: integer
iso3:
type: string
name:
type: string
shortname:
type: string
type:
type: string
url:
type: string
Disaster:
properties:
category:
items:
$ref: '#/definitions/category'
type: array
category_primary:
$ref: '#/definitions/category'
country:
description: Countries impacted by this disaster.
items:
$ref: '#/definitions/country'
type: array
current:
description: Ongoing disaster
type: boolean
description:
type: string
description-html:
type: string
featured:
description: Receiving special attention.
type: boolean
glide:
description: |
[Glide number](http://glidenumber.net)
type: string
id:
type: integer
link:
type: string
name:
type: string
primary_country:
$ref: '#/definitions/country'
type:
type: string
Source:
properties:
description:
type: string
description-html:
type: string
id:
type: integer
longname:
type: string
name:
type: string
shortname:
type: string
type:
items:
$ref: '#/definitions/country'
type: array
url:
type: string
category:
properties:
id:
format: integer
type: integer
name:
type: string
country:
description: Country object.
properties:
id:
type: integer
iso3:
type: string
name:
type: string
primary:
type: boolean
shortname:
type: string
date:
description: Date object
properties:
changed:
format: string
type: string
created:
format: string
type: string
original:
format: string
type: string
file:
properties:
description:
type: string
filename:
type: string
id:
type: integer
mimetype:
type: string
url:
type: string
language:
properties:
code:
type: string
id:
format: int64
type: integer
name:
type: string
location:
properties:
name:
type: string
source:
properties:
homepage:
type: string
id:
format: integer
type: integer
link:
type: string
longname:
type: string
name:
type: string
shortname:
type: string
type:
$ref: '#/definitions/category'
error:
properties:
status:
type: integer
error:
$ref: '#/definitions/error-definition'
error-definition:
type: string
post-params:
properties:
query[value]:
$ref: '#/definitions/query[value]-post'
query[operator]-post:
$ref: '#/definitions/query[operator]-post'
query[fields][]-post:
$ref: '#/definitions/query[fields][]-post'
filter[field]-post:
$ref: '#/definitions/filter[field]-post'
filter[value][]-post:
$ref: '#/definitions/filter[value][]-post'
filter[operator]-post:
$ref: '#/definitions/filter[operator]-post'
filter[negate]-post:
$ref: '#/definitions/filter[negate]-post'
filter[conditions][]-post:
$ref: '#/definitions/filter[conditions][]-post'
facets[field]-post:
$ref: '#/definitions/facets[field]-post'
facets[name]-post:
$ref: '#/definitions/facets[name]-post'
facets[limit]-post:
$ref: '#/definitions/facets[limit]-post'
facets[sort]-post:
$ref: '#/definitions/facets[sort]-post'
facets[filter][]-post:
$ref: '#/definitions/facets[filter][]-post'
facets[interval]-post:
$ref: '#/definitions/facets[interval]-post'
fields[include][]:
$ref: '#/definitions/fields[include][]-post'
fields[exclude][]:
$ref: '#/definitions/fields[exclude][]-post'
sort[]-post:
$ref: '#/definitions/sort[]-post'
limit-post:
$ref: '#/definitions/limit-post'
offset-post:
$ref: '#/definitions/offset-post'
profile:
$ref: '#/definitions/profile-post'
preset-post:
$ref: '#/definitions/preset-post'
limit-post:
description: |
The maximum number of items to return for a list query. The default is 10 and the maximum 1000.
default: 10
format: int64
maximum: 1000
minimum: 1
type: integer
offset-post:
default: 0
description: |
The offset from which to return the items in a list query. Allows paging through all results. The default is 0.
format: int64
minimum: 0
type: integer
preset-post:
description: |
Pre-built standard configurations of queries, filters and sorts for common use cases.
enum:
- analysis
- latest
- minimal
type: string
query[value]-post:
description: |
Specify the terms of your fuzzy search. The default is no query.
type: string
query[operator]-post:
description: |
Specify the operator by which your search query words will be combined.
enum:
- AND
- OR
type: string
query[fields][]-post:
description: |
Specify which fields to target with your search. You may use boost syntax here, see the Advanced API Usage documentation.
type: array
items:
type: string
profile-post:
enum:
- full
- list
- minimal
type: string
fields[include][]-post:
description: |
Fields to include for each item.
items:
type: string
type: array
fields[exclude][]-post:
description: |
Sub-fields to exclude from results. For example, if you include date you may exclude date.changed.
items:
type: string
type: array
filter[field]-post:
description: |
Field to filter by. Every condition must contain either a field or conditions property.
type: string
filter[value][]-post:
description: |
Value for the field being filtered. Leave blank to require existence of the field, must be present for range and value conditions.
items:
type: string
type: array
filter[operator]-post:
description: |
Operator by which filters will be combined.
enum:
- AND
- OR
type: string
filter[negate]-post:
description: |
Reverse the filter to include those items that do not match.
type: boolean
filter[conditions][]-post:
description: |
This property is used to combine conditions with a logical connector (the operator property). Every condition must contain one of the field or conditions properties.
items:
type: string
type: array
facets[field]-post:
description: |
Field to facet by. May include dates, references or the status field.
type: string
facets[name]-post:
description: |
Identifier for resulting facet data. Useful when faceting multiple ways on the same field.
type: string
facets[limit]-post:
description: |
Limit the number of facets returned for non-date based facets.
type: integer
format: int64
facets[sort]-post:
description: |
The sort order of non-date facets. Sorting may be by value or count of terms, and ascending or descending. count defaults to desc, value defaults to asc.
type: string
facets[filter][]-post:
description: |
Apply all the same capabilities of the filter parameter to the specific results of this facet request.
items:
type: string
type: array
facets[interval]-post:
description: |
Round date information to the nearest interval unit.
Apply all the same capabilities of the filter parameter to the specific results of this facet request.
enum:
- year
- month
- week
- day
type: string
sort[]-post:
description: |
Sort the list results. Defaults to search relevance. Values in the form of fieldname:(asc|desc).
items:
type: string
type: array
parameters:
limit:
description: |
The maximum number of items to return for a list query. The default is 10 and the maximum 1000.
in: query
name: limit
required: false
default: 10
format: int64
maximum: 1000
minimum: 1
type: integer
offset:
default: 0
description: |
The offset from which to return the items in a list query. Allows paging through all results. The default is 0.
format: int64
in: query
minimum: 0
name: offset
required: false
type: integer
profile:
description: |
Pre-built standard selections of fields to return for ease of displaying lists or items.
enum:
- full
- list
- minimal
in: query
name: profile
type: string
preset:
description: |
Pre-built standard configurations of queries, filters and sorts for common use cases.
enum:
- analysis
- latest
- minimal
in: query
name: preset
type: string
fields[include][]:
description: |
Specify which fields to include for each item. Defaults to an item label.
in: query
items:
type: string
name: fields[include][]
required: false
type: array
fields[exclude][]:
description: |
Specify sub-fields to exclude from overall results. For example, if you include date you may exclude date.changed.
in: query
items:
type: string
name: fields[exclude][]
required: false
type: array
query[value]:
description: |
Specify the terms of your fuzzy search. The default is no query.
in: query
name: query[value]
required: false
type: string
query[operator]:
description: |
Specify the operator by which your search query words will be combined.
enum:
- AND
- OR
in: query
name: query[operator]
required: false
type: string
query[fields][]:
description: |
Specify which fields to target with your search. You may use boost syntax here, see the Advanced API Usage documentation.
in: query
items:
type: string
name: query[fields][]
required: false
type: array
filter[field]:
description: |
Field to filter by. Every condition must contain either a field or conditions property.
in: query
name: filter[field]
required: false
type: string
filter[value][]:
description: |
Value for the field being filtered. Leave blank to require existence of the field, must be present for range and value conditions.
in: query
items:
type: string
name: filter[value][]
required: false
type: array
filter[operator]:
description: |
Operator by which filters will be combined.
enum:
- AND
- OR
in: query
name: filter[operator]
required: false
type: string
filter[negate]:
description: |
Reverse the filter to include those items that do not match.
in: query
name: filter[negate]
required: false
type: boolean
filter[conditions][]:
description: |
This property is used to combine conditions with a logical connector (the operator property). Every condition must contain one of the field or conditions properties.
in: query
items:
type: string
name: filter[conditions][]
required: false
type: array
facets[field]:
description: |
Field to facet by. May include dates, references or the status field.
in: query
name: facets[field]
required: false
type: string
facets[name]:
description: |
Identifier for resulting facet data. Useful when faceting multiple ways on the same field.
in: query
name: facets[name]
required: false
type: string
facets[limit]:
description: |
Limit the number of facets returned for non-date based facets.
in: query
name: facets[limit]
required: false
type: integer
facets[sort]:
description: |
The sort order of non-date facets. Sorting may be by value or count of terms, and ascending or descending. count defaults to desc, value defaults to asc.
in: query
name: facets[sort]
required: false
type: string
facets[filter][]:
description: |
Apply all the same capabilities of the filter parameter to the specific results of this facet request.
in: query
items:
type: string
name: facets[filter][]
required: false
type: array
facets[interval]:
description: |
Round date information to the nearest interval unit.
Apply all the same capabilities of the filter parameter to the specific results of this facet request.
enum:
- year
- month
- week
- day
in: query
name: facets[interval]
required: false
type: string
sort[]:
description: |
Sort the list results. Defaults to search relevance. Values in the form of fieldname:(asc|desc).
in: query
items:
type: string
name: sort[]
required: false
type: array