Update a dataplane

PUT 
/api/management/dataplanes/:id

Updates an existing dataplane.

Request

Path Parameters

id stringrequired

application/json

Bodyrequired

datasets object[]
Array [
@idstringrequired
Example: 3f2592da-ffc9-40cb-a336-a9daa9343ce8
dcat:contactPointstring
Example: contactPointExample
dcat:keywordstring[]
Example: ["keyword1","keyword2"]
dcat:landingPagestring
Example: landingPageExample
dcat:themestring[]
Example: ["theme1","theme2"]
dcat:conformsTostring
Example: conformsToExample
dct:creatorstring
Example: creatorExample
dct:descriptionstring[]
Example: ["description1","description2"]
dct:identifierstring
Example: identifierExample
dct:isReferencedBystring
Example: isReferencedByExample
dct:issuedstring
Example: 2020-01-01
dct:languagestring
Example: en
dct:licensestring
Example: licenseExample
dct:modifiedstring
Example: 2020-01-02
dct:publisherstring
Example: publisherExample
dct:relationstring
Example: relationExample
dct:titlestring
Example: titleExample
dct:typestring
Example: typeExample
odrl:hasPolicy object[]
Array [
@idstringrequired
Example: 3f2592da-ffc9-40cb-a336-a9daa9343ce8
@typestringrequired
Example: odrl:Offer
odrl:assignerstring
Example: assignerExample
odrl:assigneestring
Example: assigneeExample
odrl:profilestring
Example: profileExample
odrl:permission object[]
Array [
@typestringrequired
Example: odrl:Permission
odrl:assignerstring
Example: assignerExample
odrl:assigneestring
Example: assigneeExample
odrl:actionstringrequired
Example: odrl:actionExample
odrl:targetstring
Example: targetExample
odrl:constraint object[]
Array [
@typestringrequired
Example: odrl:Constraint
odrl:leftOperandstringrequired
Example: odrl:leftOperandExample
odrl:operatorstringrequired
Example: odrl:operatorExample
odrl:rightOperandobject
Example: {"value":"rightOperandExample"}
odrl:rightOperandReferencestring
Example: rightOperandReferenceExample
]
odrl:Dutystring[]
Example: []
]
odrl:prohibition object[]
Array [
@typestringrequired
Example: odrl:Prohibition
odrl:assignerstring
Example: assignerExample
odrl:assigneestring
Example: assigneeExample
odrl:actionstringrequired
Example: odrl:actionExample
odrl:targetstring
Example: targetExample
odrl:constraint object[]
Array [
@typestringrequired
Example: odrl:Constraint
odrl:leftOperandstringrequired
Example: odrl:leftOperandExample
odrl:operatorstringrequired
Example: odrl:operatorExample
odrl:rightOperandobject
Example: {"value":"rightOperandExample"}
odrl:rightOperandReferencestring
Example: rightOperandReferenceExample
]
]
odrl:obligation object[]
Array [
@typestringrequired
Example: odrl:Duty
odrl:assignerstring
Example: assignerExample
odrl:assigneestring
Example: assigneeExample
odrl:actionstringrequired
Example: odrl:actionExample
odrl:targetstring
Example: targetExample
odrl:constraint object[]
Array [
@typestringrequired
Example: odrl:Constraint
odrl:leftOperandstringrequired
Example: odrl:leftOperandExample
odrl:operatorstringrequired
Example: odrl:operatorExample
odrl:rightOperandobject
Example: {"value":"rightOperandExample"}
odrl:rightOperandReferencestring
Example: rightOperandReferenceExample
]
]
odrl:targetstring
Example: targetExample
]
dcat:hasVersionstring[]
Example: ["version1","version2"]
dcat:isVersionOfstring
Example: isVersionOfExample
dcat:versionstring
Example: versionExample
dcat:hasCurrentVersionstring
Example: hasCurrentVersionExample
dcat:previousVersionstring
Example: previousVersionExample
@typestringrequired
Example: dcat:Dataset
dcat:distributionstring[]
dcat:spatialResolutionInMetersstring
Example: 100
dcat:temporalResolution object
@valuestringrequired
Example: P3Y6M4DT12H30M5S
@typestringrequired
Example: xsd:duration
dct:accrualPeriodicitystring
Example: accrualPeriodicityExample
dct:spatialstring
Example: spatialExample
dct:temporalstring
Example: temporalExample
prov:wasGeneratedBystring
Example: wasGeneratedByExample
]
dataplaneTypestringrequired
Example: exampleType
endpointPrefixstringrequired
Example: /api/v1/dataplane
callbackAddressstringrequired
Example: http://localhost/callback
managementAddressstringrequired
Example: http://localhost/manage
managementTokenstringrequired
Example: token123
catalogSynchronizationstringrequired
Possible values: [push, pull]
Example: push
rolestringrequired
Possible values: [consumer, provider, both]
Example: consumer
identifierstringrequired
Example: dp-12345

Responses

200

application/json

Schema

Schema

datasets object[]
Array [
@idstringrequired
Example: 3f2592da-ffc9-40cb-a336-a9daa9343ce8
dcat:contactPointstring
Example: contactPointExample
dcat:keywordstring[]
Example: ["keyword1","keyword2"]
dcat:landingPagestring
Example: landingPageExample
dcat:themestring[]
Example: ["theme1","theme2"]
dcat:conformsTostring
Example: conformsToExample
dct:creatorstring
Example: creatorExample
dct:descriptionstring[]
Example: ["description1","description2"]
dct:identifierstring
Example: identifierExample
dct:isReferencedBystring
Example: isReferencedByExample
dct:issuedstring
Example: 2020-01-01
dct:languagestring
Example: en
dct:licensestring
Example: licenseExample
dct:modifiedstring
Example: 2020-01-02
dct:publisherstring
Example: publisherExample
dct:relationstring
Example: relationExample
dct:titlestring
Example: titleExample
dct:typestring
Example: typeExample
odrl:hasPolicy object[]
Array [
@idstringrequired
Example: 3f2592da-ffc9-40cb-a336-a9daa9343ce8
@typestringrequired
Example: odrl:Offer
odrl:assignerstring
Example: assignerExample
odrl:assigneestring
Example: assigneeExample
odrl:profilestring
Example: profileExample
odrl:permission object[]
Array [
@typestringrequired
Example: odrl:Permission
odrl:assignerstring
Example: assignerExample
odrl:assigneestring
Example: assigneeExample
odrl:actionstringrequired
Example: odrl:actionExample
odrl:targetstring
Example: targetExample
odrl:constraint object[]
Array [
@typestringrequired
Example: odrl:Constraint
odrl:leftOperandstringrequired
Example: odrl:leftOperandExample
odrl:operatorstringrequired
Example: odrl:operatorExample
odrl:rightOperandobject
Example: {"value":"rightOperandExample"}
odrl:rightOperandReferencestring
Example: rightOperandReferenceExample
]
odrl:Dutystring[]
Example: []
]
odrl:prohibition object[]
Array [
@typestringrequired
Example: odrl:Prohibition
odrl:assignerstring
Example: assignerExample
odrl:assigneestring
Example: assigneeExample
odrl:actionstringrequired
Example: odrl:actionExample
odrl:targetstring
Example: targetExample
odrl:constraint object[]
Array [
@typestringrequired
Example: odrl:Constraint
odrl:leftOperandstringrequired
Example: odrl:leftOperandExample
odrl:operatorstringrequired
Example: odrl:operatorExample
odrl:rightOperandobject
Example: {"value":"rightOperandExample"}
odrl:rightOperandReferencestring
Example: rightOperandReferenceExample
]
]
odrl:obligation object[]
Array [
@typestringrequired
Example: odrl:Duty
odrl:assignerstring
Example: assignerExample
odrl:assigneestring
Example: assigneeExample
odrl:actionstringrequired
Example: odrl:actionExample
odrl:targetstring
Example: targetExample
odrl:constraint object[]
Array [
@typestringrequired
Example: odrl:Constraint
odrl:leftOperandstringrequired
Example: odrl:leftOperandExample
odrl:operatorstringrequired
Example: odrl:operatorExample
odrl:rightOperandobject
Example: {"value":"rightOperandExample"}
odrl:rightOperandReferencestring
Example: rightOperandReferenceExample
]
]
odrl:targetstring
Example: targetExample
]
dcat:hasVersionstring[]
Example: ["version1","version2"]
dcat:isVersionOfstring
Example: isVersionOfExample
dcat:versionstring
Example: versionExample
dcat:hasCurrentVersionstring
Example: hasCurrentVersionExample
dcat:previousVersionstring
Example: previousVersionExample
@typestringrequired
Example: dcat:Dataset
dcat:distributionstring[]
dcat:spatialResolutionInMetersstring
Example: 100
dcat:temporalResolution object
@valuestringrequired
Example: P3Y6M4DT12H30M5S
@typestringrequired
Example: xsd:duration
dct:accrualPeriodicitystring
Example: accrualPeriodicityExample
dct:spatialstring
Example: spatialExample
dct:temporalstring
Example: temporalExample
prov:wasGeneratedBystring
Example: wasGeneratedByExample
]
dataplaneTypestringrequired
Example: exampleType
endpointPrefixstringrequired
Example: /api/v1/dataplane
callbackAddressstringrequired
Example: http://localhost/callback
managementAddressstringrequired
Example: http://localhost/manage
managementTokenstringrequired
Example: token123
catalogSynchronizationstringrequired
Possible values: [push, pull]
Example: push
rolestringrequired
Possible values: [consumer, provider, both]
Example: consumer
identifierstringrequired
Example: dp-12345

Example (auto)

{
  "datasets": [
    {
      "id": "dataset-123",
      "name": "Example Dataset"
    }
  ],
  "dataplaneType": "exampleType",
  "endpointPrefix": "/api/v1/dataplane",
  "callbackAddress": "http://localhost/callback",
  "managementAddress": "http://localhost/manage",
  "managementToken": "token123",
  "catalogSynchronization": "push",
  "role": "consumer",
  "identifier": "dp-12345"
}

400

Invalid dataplane data

403

Forbidden

application/json

Schema

Schema

namestringrequired
Example: ResourceNotFound
statusstringrequired
Example: 404 Not Found
codenumberrequired
Example: 404
messageobject
Example: The requested resource does not exist.
errorstring
Example: Not Found

Example (auto)

{
  "name": "ResourceNotFound",
  "status": "404 Not Found",
  "code": 404,
  "message": "The requested resource does not exist.",
  "error": "Not Found"
}

Authorization: oauth2

name: oauth2type: oauth2scopes: controlplane_admin,controlplane_dataplaneflows: {
  "password": {
    "scopes": {
      "controlplane_admin": "controlplane_admin",
      "controlplane_dataplane": "controlplane_dataplane"
    }
  }
}

• curl
• http

• CURL

curl -L -X PUT 'https://tsg.dataspac.es/api/management/dataplanes/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
  "datasets": [
    {
      "id": "dataset-123",
      "name": "Example Dataset"
    }
  ],
  "dataplaneType": "exampleType",
  "endpointPrefix": "/api/v1/dataplane",
  "callbackAddress": "http://localhost/callback",
  "managementAddress": "http://localhost/manage",
  "managementToken": "token123",
  "catalogSynchronization": "push",
  "role": "consumer",
  "identifier": "dp-12345"
}'

Request Collapse all

Auth

Bearer Token

Parameters

id — pathrequired

Body required

{
  "datasets": [
    {
      "id": "dataset-123",
      "name": "Example Dataset"
    }
  ],
  "dataplaneType": "exampleType",
  "endpointPrefix": "/api/v1/dataplane",
  "callbackAddress": "http://localhost/callback",
  "managementAddress": "http://localhost/manage",
  "managementToken": "token123",
  "catalogSynchronization": "push",
  "role": "consumer",
  "identifier": "dp-12345"
}