Get a negotiation by process ID

GET 
/api/management/negotiations/:processId

Get a negotiation by process ID

Request

Path Parameters

processId stringrequired

Process ID of the negotiation

Responses

200

Successfully fetched negotiation

application/json

Schema

Schema

localIdstringrequired
remoteIdstringrequired
remotePartystringrequired
rolestringrequired
remoteAddressstringrequired
statestringrequired
dataSetstringrequired
modifiedDatedate-timerequired

offer

object

required

@idstringrequired

@typestringrequired

odrl:assignerstring

odrl:assigneestring

odrl:profilestring

odrl:permission

object[]

Array [

@typestringrequired

odrl:assignerstring

odrl:assigneestring

odrl:actionstringrequired

odrl:targetstring

odrl:constraint

object[]

Array [

@typestringrequired

odrl:leftOperandstringrequired

odrl:operatorstringrequired

odrl:rightOperandobject

odrl:rightOperandReferencestring

]

odrl:Dutystring[]

]

odrl:prohibition

object[]

Array [

@typestringrequired

odrl:assignerstring

odrl:assigneestring

odrl:actionstringrequired

odrl:targetstring

odrl:constraint

object[]

Array [

@typestringrequired

odrl:leftOperandstringrequired

odrl:operatorstringrequired

odrl:rightOperandobject

odrl:rightOperandReferencestring

]

]

odrl:obligation

object[]

Array [

object

]

odrl:targetstring

agreement

object

required

@idstringrequired

@typestringrequired

odrl:assignerstring

odrl:assigneestring

odrl:profilestring

odrl:permission

object[]

Array [

@typestringrequired

odrl:assignerstring

odrl:assigneestring

odrl:actionstringrequired

odrl:targetstring

odrl:constraint

object[]

Array [

@typestringrequired

odrl:leftOperandstringrequired

odrl:operatorstringrequired

odrl:rightOperandobject

odrl:rightOperandReferencestring

]

odrl:Dutystring[]

]

odrl:prohibition

object[]

Array [

@typestringrequired

odrl:assignerstring

odrl:assigneestring

odrl:actionstringrequired

odrl:targetstring

odrl:constraint

object[]

Array [

@typestringrequired

odrl:leftOperandstringrequired

odrl:operatorstringrequired

odrl:rightOperandobject

odrl:rightOperandReferencestring

]

]

odrl:obligation

object[]

Array [

object

]

odrl:targetstring

dspace:timestampstringrequired

events

object[]

required

Array [

timedate-timerequired

statestringrequired

localMessagestring

codestring

reason

object[]

Array [

@valuestringrequired

@languagestringrequired

]

agreementMessagestring

verification

object

@typestringrequired

dspace:consumerPidstringrequired

dspace:providerPidstringrequired

dspace:hashedMessageobjectrequired

typestringrequired

]

Example (from schema)

{
  "localId": "string",
  "remoteId": "string",
  "remoteParty": "string",
  "role": "string",
  "remoteAddress": "string",
  "state": "string",
  "dataSet": "string",
  "modifiedDate": "2024-07-29T15:51:28.071Z",
  "offer": {
    "@id": "string",
    "@type": "string",
    "odrl:assigner": "string",
    "odrl:assignee": "string",
    "odrl:profile": "string",
    "odrl:permission": [
      {
        "@type": "string",
        "odrl:assigner": "string",
        "odrl:assignee": "string",
        "odrl:action": "string",
        "odrl:target": "string",
        "odrl:constraint": [
          {
            "@type": "string",
            "odrl:leftOperand": "string",
            "odrl:operator": "string",
            "odrl:rightOperand": {},
            "odrl:rightOperandReference": "string"
          }
        ],
        "odrl:Duty": [
          "string"
        ]
      }
    ],
    "odrl:prohibition": [
      {
        "@type": "string",
        "odrl:assigner": "string",
        "odrl:assignee": "string",
        "odrl:action": "string",
        "odrl:target": "string",
        "odrl:constraint": [
          {
            "@type": "string",
            "odrl:leftOperand": "string",
            "odrl:operator": "string",
            "odrl:rightOperand": {},
            "odrl:rightOperandReference": "string"
          }
        ]
      }
    ],
    "odrl:obligation": [
      {}
    ],
    "odrl:target": "string"
  },
  "agreement": {
    "@id": "string",
    "@type": "string",
    "odrl:assigner": "string",
    "odrl:assignee": "string",
    "odrl:profile": "string",
    "odrl:permission": [
      {
        "@type": "string",
        "odrl:assigner": "string",
        "odrl:assignee": "string",
        "odrl:action": "string",
        "odrl:target": "string",
        "odrl:constraint": [
          {
            "@type": "string",
            "odrl:leftOperand": "string",
            "odrl:operator": "string",
            "odrl:rightOperand": {},
            "odrl:rightOperandReference": "string"
          }
        ],
        "odrl:Duty": [
          "string"
        ]
      }
    ],
    "odrl:prohibition": [
      {
        "@type": "string",
        "odrl:assigner": "string",
        "odrl:assignee": "string",
        "odrl:action": "string",
        "odrl:target": "string",
        "odrl:constraint": [
          {
            "@type": "string",
            "odrl:leftOperand": "string",
            "odrl:operator": "string",
            "odrl:rightOperand": {},
            "odrl:rightOperandReference": "string"
          }
        ]
      }
    ],
    "odrl:obligation": [
      {}
    ],
    "odrl:target": "string",
    "dspace:timestamp": "string"
  },
  "events": [
    {
      "time": "2024-07-29T15:51:28.071Z",
      "state": "string",
      "localMessage": "string",
      "code": "string",
      "reason": [
        {
          "@value": "string",
          "@language": "string"
        }
      ],
      "agreementMessage": "string",
      "verification": {
        "@type": "string",
        "dspace:consumerPid": "string",
        "dspace:providerPid": "string",
        "dspace:hashedMessage": {}
      },
      "type": "string"
    }
  ]
}