Request a new negotiation

POST 
/api/negotiations/request

Request a new negotiation

Request

application/json

Bodyrequired

@typestringrequired
Example: dspace:ContractRequestMessage
dspace:consumerPidstringrequired
Example: urn:example:consumerPid
dspace:providerPidstring
Example: urn:example:providerPid
dspace:callbackAddressstringrequired
Example: http://example.com/callback
dspace:offer object
@idstringrequired
Example: 3f2592da-ffc9-40cb-a336-a9daa9343ce8
@typestringrequired
Example: odrl:Offer
odrl:assignerstring
Example: did:example:assigner
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

Responses

201

application/json

Schema

Schema

@idstringrequired
Example: 3f2592da-ffc9-40cb-a336-a9daa9343ce8
@typestringrequired
Example: dspace:ContractNegotiation
dspace:consumerPidstringrequired
Example: urn:example:consumerPid
dspace:providerPidstringrequired
Example: urn:example:providerPid
dspace:statestringrequired
Example: REQUESTED

Example (auto)

{
  "@id": "3f2592da-ffc9-40cb-a336-a9daa9343ce8",
  "@type": "dspace:ContractNegotiation",
  "dspace:consumerPid": "urn:example:consumerPid",
  "dspace:providerPid": "urn:example:providerPid",
  "dspace:state": "REQUESTED"
}

Authorization: http

name: bearertype: httpscheme: bearerbearerFormat: VPdescription: Verifiable Presentation needed to communicate between two instances of the control plane.

• curl
• http

• CURL

curl -L 'https://tsg.dataspac.es/api/negotiations/request' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
--data-raw '{
  "@type": "dspace:ContractRequestMessage",
  "dspace:consumerPid": "urn:example:consumerPid",
  "dspace:providerPid": "urn:example:providerPid",
  "dspace:callbackAddress": "http://example.com/callback",
  "dspace:offer": {
    "@type": "odrl:Offer",
    "odrl:assigner": "urn:example:assigner"
  }
}'

Request Collapse all

Auth

Bearer Token

Body required

{
  "@type": "dspace:ContractRequestMessage",
  "dspace:consumerPid": "urn:example:consumerPid",
  "dspace:providerPid": "urn:example:providerPid",
  "dspace:callbackAddress": "http://example.com/callback",
  "dspace:offer": {
    "@type": "odrl:Offer",
    "odrl:assigner": "urn:example:assigner"
  }
}