Swagger Documentation
Dataspace OS (DOS) Beta: Swagger UI
Dataspace OS (DOS) Production: Swagger UI
API Requests
For all requests, authenticate with OAuth against Dataspace OS. Use a technical user with permissions on the EDC.
tokenURL is https://users.dataspaceos.{ENV}.cofinity-x.com/realms/{COMPANY-ID}/protocol/openid-connect/token where {ENV} would be preprod or svc
GET Component Details - Step 1
Retrieve information about the EDC component.
GET https://backend.dataspaceos.{ENV}.cofinity-x.com/api/v1/components/{componentId}
PUT Update Component - Step 2
Replace the EDC component values with the ones gotten in the previous call and update the API key "authKey".
PUT https://backend.dataspaceos.{ENV}.cofinity-x.com/api/v1/components/{componentId}
Request Body Template:
{
"type": "EDC",
"description": "use-value-from-get",
"displayName": "use-value-from-get",
"department": "use-value-from-get",
"dataspaceId": "use-value-from-get",
"costCenter": "use-value-from-get",
"componentVersion": "use-value-from-get",
"keepAwake": "use-value-from-get",
"bpn": "use-value-from-get",
"iatp": {
"id": "use-value-from-get",
"oauthClientId": "use-value-from-get",
"oauthClientSecret": "use-value-from-get",
"oauthTokenUrl": "use-value-from-get",
"dimUrl": "use-value-from-get",
"trustedIssuers": [
"use-value-from-get"
]
},
"controlPlane": {
"authKey": "UPDATE-WITH-NEW-KEY",
"bdrs": "use-value-from-get"
}
}