Data Requests

VERA provides access to various Catena-X Ecosystems, to fetch data from other parties in the specific system we use DataRequests which are responsible to manage and hold the requested data from other Catena-X participants.

The data request model

The data request model contains all information for VERA which is necessary to fetch data from other Catena-X participants.

Properties

Name
id
Type
string
Description
Unique identifier for the data request.
Name
provider
Type
string
Description
BPNL number of the providers BPN which gets requested
Name
consumer
Type
string
Description
BPNL number of the current used consumer BPN which requests data
Name
data
Type
string
Description
JSON payload of the requested data
Name
assetId
Type
string
Description
Unique identifier of the requested asset or digital twin
Name
trackingId
Type
string
Description
Internal tracking id which VERA uses to match the EDC requests
Name
state
Type
string
Description
Current state of the request

GET/data-requests?organizationId=:organizationId

List all requests

This endpoint allows you to retrieve a paginated list of all data requests. By default, a maximum of 20 requests are shown per page. Additionally a list of filters can be applied as GET parameters.

Required attributes

Name
organizationId
Type
string
Description
id of the requested organization

Optional attributes

Name
take
Type
integer
Description
Take the number of verification requests returned.
Name
skip
Type
integer
Description
Skip the number of verification requests returned.
Name
state
Type
string
Description
Filter data requests for the specific state
Name
consumer
Type
string
Description
Filter data requests for the specific consumer BPN
Name
provider
Type
string
Description
Filter data requests for the specific provider BPN
Name
assetId
Type
string
Description
Filter data requests for the specific assetId

Response

{
    "meta": {},
    "data": [{
        "id": "41107f0e-46e9-46b6-ae73-275a21b56bcf",
        "createdAt": "2024-03-15T07:01:14.303Z",
        "updatedAt": "2024-03-15T07:01:14.303Z",
        "assetId": "123",
        "trackingId": "5bbaa76f-befb-4063-8c6d-f0320726332c",
        "state": "Created",
        "consumer": "BPNL000000000001",
        "provider": "BPNL000000000002",
        "data": {},
        "organizationId": "468fa2c5-9cd5-4fd6-8f87-e6bebe3e63ea"
    }]
}

GET/data-requests/:uuid?organizationId=:organizationId

Get single request

This endpoint allows you to retrieve a single data request based on his id.

Required attributes

Name
uuid
Type
string
Description
uuid of the requested data request
Name
organizationId
Type
string
Description
id of the requested organization

Response

{
    "meta": {},
    "data": {
        "id": "41107f0e-46e9-46b6-ae73-275a21b56bcf",
        "createdAt": "2024-03-15T07:01:14.303Z",
        "updatedAt": "2024-03-15T07:01:14.303Z",
        "assetId": "123",
        "trackingId": "5bbaa76f-befb-4063-8c6d-f0320726332c",
        "state": "Created",
        "consumer": "BPNL000000000001",
        "provider": "BPNL000000000002",
        "data": {},
        "organizationId": "468fa2c5-9cd5-4fd6-8f87-e6bebe3e63ea"
    }
}

POST/data-requests?organizationId=:organizationId

Create a data-request

This endpoint allows you to create a new data request.

Required URL attributes

Name
organizationId
Type
string
Description
id of the requested organization

Required payload body (application/json)

{
    "assetId": "REQUESTED_ASSETID_OR_DIGITAL_TWIN",
    "consumer": "CONSUMERS_BPN",
    "provider": "PROVIDERS_BPN"
}

Response

{
    "meta": {},
    "data": {
        "id": "41107f0e-46e9-46b6-ae73-275a21b56bcf",
        "createdAt": "2024-03-15T07:01:14.303Z",
        "updatedAt": "2024-03-15T07:01:14.303Z",
        "assetId": "123",
        "trackingId": "5bbaa76f-befb-4063-8c6d-f0320726332c",
        "state": "Created",
        "consumer": "BPNL000000000001",
        "provider": "BPNL000000000002",
        "data": {},
        "organizationId": "468fa2c5-9cd5-4fd6-8f87-e6bebe3e63ea"
    }
}

DELETE/data-requests/:uuid?organizationId=:organizationId

Delete a data-request

This endpoint allows you to delete an existing data request.

Required URL attributes

Name
uuid
Type
string
Description
uuid of the data request
Name
organizationId
Type
string
Description
id of the requested organization

Response

{
    "meta": {},
    "data": {
        "id": "41107f0e-46e9-46b6-ae73-275a21b56bcf",
        "createdAt": "2024-03-15T07:01:14.303Z",
        "updatedAt": "2024-03-15T07:01:14.303Z",
        "assetId": "123",
        "trackingId": "5bbaa76f-befb-4063-8c6d-f0320726332c",
        "state": "Created",
        "consumer": "BPNL000000000001",
        "provider": "BPNL000000000002",
        "data": {},
        "organizationId": "468fa2c5-9cd5-4fd6-8f87-e6bebe3e63ea"
    }
}