Assets

This section provides an overview of all available APIs that adhere to the OpenAPI specification. All APIs are loaded from the OpenAPI specification file: Link. Please note that the API base-paths may differ depending on the connector, the specific API base-path can be seen in the UI dashboard.

---

---

---

---

---

---

---

---

Updates an asset with the given ID if it exists. If the asset is not found, no further action is taken. DANGER ZONE: Note that updating assets can have unexpected results, especially for contract offers that have been sent out or are ongoing in contract negotiations.

put

/v3/assets

Body

@contextobjectrequired

@idstring

@typestring

Example: https://w3id.org/edc/v0.0.1/ns/Asset

dataAddressobjectrequired

privatePropertiesobject

propertiesobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '//v3/assets' \
  --header 'Content-Type: application/json' \
  --data '{
    "@context": {
      "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
    },
    "@id": "asset-id",
    "properties": {
      "key": "value"
    },
    "privateProperties": {
      "privateKey": "privateValue"
    },
    "dataAddress": {
      "type": "HttpData",
      "baseUrl": "https://jsonplaceholder.typicode.com/todos"
    }
  }'

204

400

404

204

No body

Asset was updated successfully

---

Creates a new asset together with a data address

post

/v3/assets

Body

@contextobjectrequired

@idstring

@typestring

Example: https://w3id.org/edc/v0.0.1/ns/Asset

dataAddressobjectrequired

privatePropertiesobject

propertiesobjectrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//v3/assets' \
  --header 'Content-Type: application/json' \
  --data '{
    "@context": {
      "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
    },
    "@id": "asset-id",
    "properties": {
      "key": "value"
    },
    "privateProperties": {
      "privateKey": "privateValue"
    },
    "dataAddress": {
      "type": "HttpData",
      "baseUrl": "https://jsonplaceholder.typicode.com/todos"
    }
  }'

200

400

409

200

{
  "@context": {
    "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
  },
  "@id": "id-value",
  "createdAt": 1688465655
}

Asset was created successfully. Returns the asset Id and created timestamp

---

Request all assets according to a particular query

post

/v3/assets/request

Body

@typestring

Example: https://w3id.org/edc/v0.0.1/ns/QuerySpec

filterExpressionobject[]

Example: {"@context":{"@vocab":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"Criterion","operandLeft":"fieldName","operator":"=","operandRight":"some value"}

limitinteger · int32

offsetinteger · int32

sortFieldstring

sortOrderstring · enum

Options: ASC, DESC

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//v3/assets/request' \
  --header 'Content-Type: application/json' \
  --data '{
    "@context": {
      "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
    },
    "@type": "QuerySpec",
    "offset": 5,
    "limit": 10,
    "sortOrder": "DESC",
    "sortField": "fieldName",
    "filterExpression": []
  }'

200

400

200

No body

The assets matching the query

---

Gets an asset with the given ID

get

/v3/assets/{id}

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//v3/assets/{id}'

200

400

404

200

{
  "@context": {
    "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
  },
  "@id": "asset-id",
  "properties": {
    "key": "value"
  },
  "privateProperties": {
    "privateKey": "privateValue"
  },
  "dataAddress": {
    "type": "HttpData",
    "baseUrl": "https://jsonplaceholder.typicode.com/todos"
  },
  "createdAt": 1688465655
}

The asset

---

Removes an asset with the given ID if possible. Deleting an asset is only possible if that asset is not yet referenced by a contract agreement, in which case an error is returned. DANGER ZONE: Note that deleting assets can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations.

delete

/v3/assets/{id}

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '//v3/assets/{id}'

204

400

404

409

204

No body

Asset was deleted successfully