API docs by Redocly

LCA Collaboration Server Webservice (2.0.2)

Download OpenAPI specification:Download

E-mail: greve@greendelta.com

Webservice documentation for the LCA Collaboration Server

Session

Login

Logs in with the given credentials

Request Body schema: application/json

Login credentails

username
required
string

The username of the user to login with

password
required
string

The password of the user to login with

token
string

If two factor authentication is enabled, a token has to be provided

Responses

Request samples

Content type
application/json
{
  • "username": "john.doe",
  • "password": "passw0rd",
  • "token": "435163"
}

Dataset

Download a data set

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

type
required
string
Enum: "ACTOR" "CATEGORY" "CURRENCY" "DQ_SYSTEM" "EPD" "FLOW" "FLOW_PROPERTY" "IMPACT_CATEGORY" "IMPACT_METHOD" "LOCATION" "PARAMETER" "PROCESS" "PRODUCT_SYSTEM" "PROJECT" "RESULT" "SOURCE" "SOCIAL_INDICATOR" "UNIT_GROUP"

The model type of the data set

refId
required
string

The reference id of the data set

query Parameters
commitId
string

The commit id for the data set (or latest before)

Responses

Group

List accessible groups

Loads a list of groups that are accessible for the client

query Parameters
page
integer <int32>
Default: 1

page value for pagination, if the value is 0, no paging is applied and all values will be returned

pageSize
integer <int32>
Default: 10

Defines the page size for pagination if page is not 0

filter
string

Filters results that contain the phrase in their name

onlyIfCanWrite
boolean
Default: false

If true only groups the client has permission to WRITE to are returned

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "aggregations": [
    ],
  • "resultInfo": {
    }
}

Get group settings

Loads settings and permissions of {group}. For this operation the client needs permission to READ in {group}

path Parameters
group
required
string

The name for the group

Responses

Response samples

Content type
application/json
{
  • "name": "examples",
  • "userCanDelete": false,
  • "userCanWrite": false,
  • "userCanCreate": false,
  • "userCanEditMembers": false
}

Create a new group

Creates a new group with {name}. For this operation the client needs general permission to create groups

path Parameters
group
required
string

The name for the group

Responses

Response samples

Content type
application/json
{
  • "name": "examples"
}

Delete a group

Deletes {group} and all containing repositories. For this operation the client needs permission to DELETE {group}

path Parameters
group
required
string

The name for the group

Responses

Get group avatar

Loads the avatar for {group}. For this operation the client needs permission to READ in {group}

path Parameters
group
required
string

The name for the group

Responses

Set group avatar

Set the avatar for {group}. For this operation the client needs permission to WRITE in {group}

path Parameters
group
required
string

The name for the group

Responses

Set group setting

Set the setting {setting} in group {group}. For this operation the client needs permission to SET_SETTING in {group}

path Parameters
group
required
string

The name of the group

setting
required
string

The name of the group setting

Responses

Repository

List public repositories

Lists all public repositories inlcuding basic settings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get public repository settings

Loads settings of {group}/{repo}. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

Responses

Response samples

Content type
application/json
{
  • "group": "examples",
  • "name": "reference_data",
  • "label": "string",
  • "groupIsUserNamespace": false,
  • "settings": {
    },
  • "groupSettings": {
    }
}

Get repository avatar

Loads the avatar for {group}/{repo}. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

Responses

Get repository file

Loads file with name {path} of data set {type}/{refId} from {group}/{repo}. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

type
required
string
Enum: "ACTOR" "CATEGORY" "CURRENCY" "DQ_SYSTEM" "EPD" "FLOW" "FLOW_PROPERTY" "IMPACT_CATEGORY" "IMPACT_METHOD" "LOCATION" "PARAMETER" "PROCESS" "PRODUCT_SYSTEM" "PROJECT" "RESULT" "SOURCE" "SOCIAL_INDICATOR" "UNIT_GROUP"

The model type of the data set

refId
required
string

The reference id of the data set

path
required
string

The path/filename of the file to obtain

query Parameters
commitId
string

The commit id for the data set (or latest before)

Responses

List accessible repositories

Loads a list of repositories that are accessible for the client

query Parameters
page
integer <int32>
Default: 1

page value for pagination, if the value is 0, no paging is applied and all values will be returned

pageSize
integer <int32>
Default: 10

Defines the page size for pagination if page is not 0

filter
string

Filters results that contain the phrase in their name

group
string

Filters repositories by group (exact match)

module
string
Value: "REVIEW"

Module specific filter. If value is "REVIEW", the list of accessible repositories is filtered for those the user can manage tasks in

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "aggregations": [
    ],
  • "resultInfo": {
    }
}

Get repository settings

Loads settings and permissions of {group}/{repo}. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

Responses

Response samples

Content type
application/json
{
  • "group": "examples",
  • "name": "reference_data",
  • "label": "string",
  • "groupIsUserNamespace": false,
  • "settings": {
    },
  • "groupSettings": {
    },
  • "userCanDelete": false,
  • "userCanWrite": false,
  • "userCanMove": false,
  • "userCanClone": false,
  • "userCanEditMembers": false,
  • "userCanSetSettings": false,
  • "size": 0
}

Create a new repository

Creates a new repository in {group} with name {repo}. For this operation the client needs permission to WRITE to {group} and general permission to create repositories

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

Responses

Response samples

Content type
application/json
{
  • "group": "examples",
  • "name": "reference_data",
  • "label": "string",
  • "groupIsUserNamespace": false,
  • "settings": {
    },
  • "groupSettings": {
    }
}

Delete a repository

Deletes {group}/{repo}. For this operation the client needs permission to DELETE {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

Responses

Get repository avatar

Loads the avatar for {group}/{repo}. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

Responses

Set repository avatar

Set the avatar for {group}/{repo}. For this operation the client needs permission to WRITE in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

Responses

Get repository meta information

Loads meta information for {group}/{repo}. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

Responses

Response samples

Content type
application/json
{}

Export a repository (migrate)

Exports {group}/{repo} for migration to another collaboration server (only data and repo info is exported, comments and membership information are dropped). For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

Responses

Import data into an empty repository

Imports either an exported repository from another collaboration server or a JSON-LD zip file exported from openLCA. If {group}/{repo} is not empty, existing data will be overwritten. For this operation the client needs permission to WRITE in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

query Parameters
format
string

Either json-ld or empty (empty=import exported repository)

Request Body schema: multipart/form-data
commitMessage
string

The commit message in case of format=json-ld

file
string

The file to be imported

Responses

Move an existing repository

Move {group}/{repo} to {newGroup}/{newRepo} or rename it within the same group if {group}={newGroup}. For this operation the client needs permission to WRITE in {newGroup} and permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

newGroup
required
string

The name of the group to move {group}/{repo} to (if it equals the existing group, the repository is renamed)

newRepo
required
string

The new name of the repo

Responses

Clone an existing repository

Clone an existing repository to {newGroup}. For this operation the client needs permission to WRITE in {newGroup} and permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

commitId
required
string

If specified only data until {commitId} are cloned

newGroup
required
string

The name of the group to move the repository to (if it equals the existing group, the repository is renamed

newRepo
required
string

The new name of the repo

Responses

Change a setting of the repository

Change the value of {setting} to {value}. For this operation the client needs permission to WRITE in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

setting
required
string
Enum: "publicAccess" "prohibitCommits" "commentApproval" "maxSize"

The name of the setting to change

value
required
string

The new value for {setting}, a long value for maxSize or true/false for the other settings

Responses

Membership (Group)

Get memberships for a group

Get all memberships for {group}. For this operation the client needs permission to READ in {group}

path Parameters
group
required
string

The group of the repository

Responses

Add a user to a group

Add {username} to {group} with {role}. For this operation the client needs permission to CHANGE_ROLE in {group}

path Parameters
group
required
string

The group of the repository

username
required
string

The username of the user

role
required
string

The role of the user in the repository

Responses

Update a users role in a group

Update the role of {username} in {group} to {role}. For this operation the client needs permission to CHANGE_ROLE in {group}

path Parameters
group
required
string

The group of the repository

username
required
string

The username of the user

role
required
string

The role of the user in the repository

Responses

Delete a user from a group

Deletes {username} from {group}. For this operation the client needs permission to CHANGE_ROLE in {group}

path Parameters
group
required
string

The group of the repository

username
required
string

The username of the user

Responses

Add a team to a group

Add {teamname} to {group} with {role}. For this operation the client needs permission to CHANGE_ROLE in {group}

path Parameters
group
required
string

The group of the repository

teamname
required
string

The teamname of the team

role
required
string

The role of the user in the repository

Responses

Update a teams role in a group

Update the role of {teamname} in {group} to {role}. For this operation the client needs permission to CHANGE_ROLE in {group}

path Parameters
group
required
string

The group of the repository

teamname
required
string

The teamname of the team

role
required
string

The role of the user in the repository

Responses

Delete a team from a group

Deletes {teamname} from {group}. For this operation the client needs permission to CHANGE_ROLE in {group}

path Parameters
group
required
string

The group of the repository

teamname
required
string

The teamname of the team

Responses

Membership (Repository)

Get memberships for a repository

Get all memberships for {group}/{repo}. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

Responses

Add a user to a repository

Add {username} to {group}/{repo} with {role}. For this operation the client needs permission to CHANGE_ROLE in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

username
required
string

The username of the user

role
required
string

The role of the user in the repository

Responses

Update a users role in a repository

Update the role of {username} in {group}/{repo} to {role}. For this operation the client needs permission to CHANGE_ROLE in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

username
required
string

The username of the user

role
required
string

The role of the user in the repository

Responses

Delete a user from a repository

Deletes {username} from {group}/{repo}. For this operation the client needs permission to CHANGE_ROLE in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

username
required
string

The username of the user

Responses

Add a team to a repository

Add {teamname} to {group}/{repo} with {role}. For this operation the client needs permission to CHANGE_ROLE in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

teamname
required
string

The teamname of the team

role
required
string

The role of the user in the repository

Responses

Update a teams role in a repository

Update the role of {teamname} in {group}/{repo} to {role}. For this operation the client needs permission to CHANGE_ROLE in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

teamname
required
string

The teamname of the team

role
required
string

The role of the user in the repository

Responses

Delete a team from a repository

Deletes {teamname} from {group}/{repo}. For this operation the client needs permission to CHANGE_ROLE in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

teamname
required
string

The teamname of the team

Responses

History

Get commit history for a repository

Loads the commit history for {group}/{repo}. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

query Parameters
lastCommitId
string

If specified, only commits after the specified commit are returned

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get commit history for a data set

Loads the commit history for data set {refId} of {type} from {group}/{repo}. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

type
required
string
Enum: "ACTOR" "CATEGORY" "CURRENCY" "DQ_SYSTEM" "EPD" "FLOW" "FLOW_PROPERTY" "IMPACT_CATEGORY" "IMPACT_METHOD" "LOCATION" "PARAMETER" "PROCESS" "PRODUCT_SYSTEM" "PROJECT" "RESULT" "SOURCE" "SOCIAL_INDICATOR" "UNIT_GROUP"

The model type of the data set

refId
required
string

The reference id of the data set

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get paginated and filtered commit history

Loads the commit history for {group}/{repo}, filtered by {filter} and paged. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

query Parameters
page
integer <int32>
Default: 1

page value for pagination, if the value is 0, no paging is applied and all values will be returned

pageSize
integer <int32>
Default: 10

Defines the page size for pagination if page is not 0

filter
string

Filters results that contain the phrase in their name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "aggregations": [
    ],
  • "resultInfo": {
    }
}

Search references of a commit

Loads the data sets that were {commitId} in {group}/{repo}, paged and filtered by {filter} and {type}. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

commitId
required
string

The commit id of the commit to get

query Parameters
type
string

If set only get references of type {type}

page
integer <int32>
Default: 1

page value for pagination, if the value is 0, no paging is applied and all values will be returned

pageSize
integer <int32>
Default: 10

Defines the page size for pagination if page is not 0

filter
string

Filters results that contain the phrase in their name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "aggregations": [
    ],
  • "resultInfo": {
    }
}

Get a commit

Loads {commitId} from {group}/{repo}. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

commitId
required
string

The commit id of the commit to get

Responses

Response samples

Content type
application/json
{
  • "id": "b16964d2-a5a0-7d05-4c69-782d87904ed2",
  • "message": "Changed some data sets",
  • "user": "johndoe",
  • "timestamp": 1552993526562,
  • "userDisplayName": "John Doe"
}

Get previous commit id

Looks up the id of the commit on {group}/{repo}, prior to {commitId}. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

type
required
string
Enum: "ACTOR" "CATEGORY" "CURRENCY" "DQ_SYSTEM" "EPD" "FLOW" "FLOW_PROPERTY" "IMPACT_CATEGORY" "IMPACT_METHOD" "LOCATION" "PARAMETER" "PROCESS" "PRODUCT_SYSTEM" "PROJECT" "RESULT" "SOURCE" "SOCIAL_INDICATOR" "UNIT_GROUP"

The model type of the data set

refId
required
string

The reference id of the data set

commitId
required
string

The id of the commit to get the predecessor for

Responses

Search

Search data sets

Searches for data sets across the collaboration server

query Parameters
query
string

Filter results by text

group
string

Filter by group name (exact matches)

repositoryId
string

Filter by repositoryId (group/repo) (exact matches)

type
string
Enum: "ACTOR" "CATEGORY" "CURRENCY" "DQ_SYSTEM" "EPD" "FLOW" "FLOW_PROPERTY" "IMPACT_CATEGORY" "IMPACT_METHOD" "LOCATION" "PARAMETER" "PROCESS" "PRODUCT_SYSTEM" "PROJECT" "RESULT" "SOURCE" "SOCIAL_INDICATOR" "UNIT_GROUP"

Filter by model type (exact matches)

categoryPaths
string

Filter by category path (exact matches, only applies if type is set)

flowType
string
Enum: "ELEMENTARY_FLOW" "PRODUCT_FLOW" "WASTE_FLOW"

Filter by flow type (exact matches, only applies if type=FLOW)

processType
string
Enum: "UNIT_PROCESS" "LCI_RESULT"

Filter by process type (exact matches, only applies if type=PROCESS)

modellingApproach
string
Enum: "PHYSICAL" "ECONOMIC" "CAUSAL" "NONE" "UNKNOWN"

Filter by modellingApproach (exact matches, only applies if type=PROCESS)

validFromYear
integer <int64>

Filter by validFromYear (exact matches, only applies if type=PROCESS)

validUntilYear
integer <int64>

Filter by validUntilYear (exact matches, only applies if type=PROCESS)

location
string

Filter by location (exact matches, only applies if type=PROCESS)

contact
string

Filter by contact (exact matches, only applies if type=PROCESS)

page
integer <int32>
Default: 1

page value for pagination, if the value is 0, no paging is applied and all values will be returned

pageSize
integer <int32>
Default: 10

Defines the page size for pagination if page is not 0

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download (JSON-LD 2.0)

Prepare download of a repository

Collects and compresses data sets in {group}/{repo} into a JSON-LD zip-archive, which can be downloaded by using the returned download token. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

query Parameters
commitId
string

The commit id for the data set (or latest before)

path
string

A category path to filter the data sets to export

Responses

Prepare download of a repository (direct selection with category children)

Collects and compresses data sets in {group}/{repo} into a JSON-LD zip-archive, which can be downloaded by using the returned download token. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

query Parameters
commitId
string

The commit id for the data set (or latest before)

Request Body schema: application/json

The elements to export, if this element is a category, all children will be collected and exported

Array
id
required
string

The id of the reference

type
required
string
Enum: "ACTOR" "CATEGORY" "CURRENCY" "DQ_SYSTEM" "EPD" "FLOW" "FLOW_PROPERTY" "IMPACT_CATEGORY" "IMPACT_METHOD" "LOCATION" "PARAMETER" "PROCESS" "PRODUCT_SYSTEM" "PROJECT" "RESULT" "SOURCE" "SOCIAL_INDICATOR" "UNIT_GROUP"

The model type of the reference

name
required
string

The name of the reference

commitId
required
string

The commit id of the reference

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Prepare download of a repository (direct selection without category children)

Collects and compresses data sets in {group}/{repo} into a JSON-LD zip-archive, which can be downloaded by using the returned download token. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

query Parameters
commitId
string

The commit id for the data set (or latest before)

Request Body schema: application/json

The elements to export

Array
type
required
string
Enum: "ACTOR" "CATEGORY" "CURRENCY" "DQ_SYSTEM" "EPD" "FLOW" "FLOW_PROPERTY" "IMPACT_CATEGORY" "IMPACT_METHOD" "LOCATION" "PARAMETER" "PROCESS" "PRODUCT_SYSTEM" "PROJECT" "RESULT" "SOURCE" "SOCIAL_INDICATOR" "UNIT_GROUP"

The model type of the data set

refId
required
string

The reference id of the data set

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Prepare download of a data set (single data set, with references)

Collects and compresses data set {type} {refId} and its references from {group}/{repo} into a JSON-LD zip-archive, which can be downloaded by using the returned download token. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

type
required
string
Enum: "ACTOR" "CATEGORY" "CURRENCY" "DQ_SYSTEM" "EPD" "FLOW" "FLOW_PROPERTY" "IMPACT_CATEGORY" "IMPACT_METHOD" "LOCATION" "PARAMETER" "PROCESS" "PRODUCT_SYSTEM" "PROJECT" "RESULT" "SOURCE" "SOCIAL_INDICATOR" "UNIT_GROUP"

The model type of the data set

refId
required
string

The reference id of the data set

query Parameters
commitId
string

The commit id for the data set (or latest before)

Responses

Download a prepared JSON-LD zip-archive

Looks up the token in the temporary filestorage and returns the prepared JSON-LD zip-archive

path Parameters
token
required
string

The token returned by any of the prepare calls

Responses

Download (JSON-LD 1.0)

Prepare download of a repository

Collects and compresses data sets in {group}/{repo} into a JSON-LD zip-archive, which can be downloaded by using the returned download token. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

query Parameters
commitId
string

The commit id for the data set (or latest before)

path
string

A category path to filter the data sets to export

Responses

Prepare download of a repository (direct selection with category children)

Collects and compresses data sets in {group}/{repo} into a JSON-LD zip-archive, which can be downloaded by using the returned download token. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

query Parameters
commitId
string

The commit id for the data set (or latest before)

Request Body schema: application/json

The elements to export, if this element is a category, all children will be collected and exported

Array
id
required
string

The id of the reference

type
required
string
Enum: "ACTOR" "CATEGORY" "CURRENCY" "DQ_SYSTEM" "EPD" "FLOW" "FLOW_PROPERTY" "IMPACT_CATEGORY" "IMPACT_METHOD" "LOCATION" "PARAMETER" "PROCESS" "PRODUCT_SYSTEM" "PROJECT" "RESULT" "SOURCE" "SOCIAL_INDICATOR" "UNIT_GROUP"

The model type of the reference

name
required
string

The name of the reference

commitId
required
string

The commit id of the reference

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Prepare download of a repository (direct selection without category children)

Collects and compresses data sets in {group}/{repo} into a JSON-LD zip-archive, which can be downloaded by using the returned download token. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

query Parameters
commitId
string

The commit id for the data set (or latest before)

Request Body schema: application/json

The elements to export

Array
type
required
string
Enum: "ACTOR" "CATEGORY" "CURRENCY" "DQ_SYSTEM" "EPD" "FLOW" "FLOW_PROPERTY" "IMPACT_CATEGORY" "IMPACT_METHOD" "LOCATION" "PARAMETER" "PROCESS" "PRODUCT_SYSTEM" "PROJECT" "RESULT" "SOURCE" "SOCIAL_INDICATOR" "UNIT_GROUP"

The model type of the data set

refId
required
string

The reference id of the data set

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Prepare download of a data set (single data set, with references)

Collects and compresses data set {type} {refId} and its references from {group}/{repo} into a JSON-LD zip-archive, which can be downloaded by using the returned download token. For this operation the client needs permission to READ in {group}/{repo}

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

type
required
string
Enum: "ACTOR" "CATEGORY" "CURRENCY" "DQ_SYSTEM" "EPD" "FLOW" "FLOW_PROPERTY" "IMPACT_CATEGORY" "IMPACT_METHOD" "LOCATION" "PARAMETER" "PROCESS" "PRODUCT_SYSTEM" "PROJECT" "RESULT" "SOURCE" "SOCIAL_INDICATOR" "UNIT_GROUP"

The model type of the data set

refId
required
string

The reference id of the data set

query Parameters
commitId
string

The commit id for the data set (or latest before)

Responses

Download a prepared JSON-LD zip-archive

Looks up the token in the temporary filestorage and returns the prepared JSON-LD zip-archive

path Parameters
token
required
string

The token returned by any of the prepare calls

Responses

GLAD

Push repository data sets to GLAD

Pushes the selected data sets to the preconfigured GLAD node. For this operation the client needs special permission to manage data

path Parameters
group
required
string

The group of the repository

repo
required
string

The name of the repository

Request Body schema: application/json

The elements to export, if an element is a category, all children will be collected and exported

dataprovider
string

The name of the data provider of the selected data sets (will be used in GLAD)

paths
Array of strings

Full dataset or category paths, e.g. "ACTORS" or "FLOWS/Elementary flows" or "PROCESS/example category/0fff6db0-464b-44f3-81af-381d88e7a1c3.json

Responses

Request samples

Content type
application/json
{
  • "dataprovider": "GreenDelta GmbH",
  • "paths": [
    ]
}