Get an agreement by agreement ID

GET 
/api/management/agreements/:agreementId

Get an agreement by agreement ID

Request

Path Parameters

agreementId stringrequired

Agreement ID

Responses

200

application/json

Schema

Schema

@typestringrequired
dspace:consumerPidstringrequired
dspace:providerPidstringrequired

dspace:agreement

object

required

@idstringrequired

@typestringrequired

odrl:assignerstring

odrl:assigneestring

odrl:profile

object

@idstringrequired

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

Example (from schema)

{
  "@type": "string",
  "dspace:consumerPid": "string",
  "dspace:providerPid": "string",
  "dspace:agreement": {
    "@id": "string",
    "@type": "string",
    "odrl:assigner": "string",
    "odrl:assignee": "string",
    "odrl:profile": {
      "@id": "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"
  }
}