GET Process Datasets (Query)

Process datasets can be queried for a number of fields that can be specified as request parameters. All of those parameters specified are regarded as AND conjuction.

Some paramters will work in "contains" match mode, that means the given search string may be contained somewhere in the field to be searched. For others, the exact value has to be given (see table below).

Requests

Syntax

GET /processes?search=true[&param=value][&param=value]

Request Parameters

Search

These parameters can be used to search for specific attributes or any combination thereof:

Name Data type Match mode Multiple? Description
name String contains no Matches name and synonyms fields
description String contains no Matches "general comment" and "use advice" field
location String exact yes Matches location field, regional code to be given.
validUntil Year exact no Matches the "valid until" date (year)
referenceYear Year exact no Matches the reference year
classes String contains no Matches any name in the dataset's classification
classId String exact no Matches any class id in the dataset's classification
subType Enum exact yes Matches the subtype (only for ILCD+EPD)
type Enum exact no Matches the dataset type
parameterized Boolean exact no Matches the parameterized property
owner String contains no Matches the owner of the dataset

Parameters indicated as multiple occurrence can be given multiple times (which corresponds to boolean OR).

Sort

For optional sorting of the results, the following parameters can be used:

Name Data type Description
sortBy String Sorts the result by a specific attribute. Value can be the name of any of the parameters from the table above.
sortOrder Boolean If true, sort ascending, otherwise descending. Defaults to true.

Format

Data can either be returned in XML (default) or JSON formats, which can be controlled by using a request parameter:

Name Values Description
format XML,JSON Returns the result in the specified format.

Responses

Response Elements

The response returned is a list of process dataset overview objects, wrapped in a dataSetList object. See the section "DataSetList Response Elements" for a detailed description.

Examples

The following request would yield all datasets that contain the word "foo" in their name and declare a validity until 2020.

Sample Request

GET /processes?search=true&name=foo&validUntil=2020

Sample Response

HTTP/1.1 200 OK
Content-Type: application/xml