Skip to main content
Version: Next

ContractAgreementMessageSchema

@typestringrequired
Example: ContractAgreementMessage
consumerPidstringrequired
Example: urn:example:consumerPid
providerPidstringrequired
Example: urn:example:providerPid
agreement object
@idstringrequired
Example: 3f2592da-ffc9-40cb-a336-a9daa9343ce8
@typestringrequired
Example: Agreement
assignerstring
Example: did:example:assigner
assigneestring
Example: did:example:assignee
profilestring
Example: profileExample
permission object[]
  • Array [
  • @typestringrequired
    Example: Permission
    assignerstring
    Example: assignerExample
    assigneestring
    Example: assigneeExample
    actionstringrequired
    Example: actionExample
    targetstring
    Example: targetExample
    constraint object[]
  • Array [
  • @typestringrequired
    Example: Constraint
    leftOperandstringrequired
    Example: leftOperandExample
    operatorstringrequired
    Example: operatorExample
    rightOperandobject
    Example: {"value":"rightOperandExample"}
    rightOperandReferencestring
    Example: rightOperandReferenceExample
  • ]
  • Dutystring[]
    Example: []
  • ]
  • prohibition object[]
  • Array [
  • @typestringrequired
    Example: Prohibition
    assignerstring
    Example: assignerExample
    assigneestring
    Example: assigneeExample
    actionstringrequired
    Example: actionExample
    targetstring
    Example: targetExample
    constraint object[]
  • Array [
  • @typestringrequired
    Example: Constraint
    leftOperandstringrequired
    Example: leftOperandExample
    operatorstringrequired
    Example: operatorExample
    rightOperandobject
    Example: {"value":"rightOperandExample"}
    rightOperandReferencestring
    Example: rightOperandReferenceExample
  • ]
  • ]
  • obligation object[]
  • Array [
  • @typestringrequired
    Example: Duty
    assignerstring
    Example: assignerExample
    assigneestring
    Example: assigneeExample
    actionstringrequired
    Example: actionExample
    targetstring
    Example: targetExample
    constraint object[]
  • Array [
  • @typestringrequired
    Example: Constraint
    leftOperandstringrequired
    Example: leftOperandExample
    operatorstringrequired
    Example: operatorExample
    rightOperandobject
    Example: {"value":"rightOperandExample"}
    rightOperandReferencestring
    Example: rightOperandReferenceExample
  • ]
  • ]
  • targetstring
    Example: urn:example:target
    timestampstringrequired
    Example: 2023-10-01T12:34:56Z
    callbackAddressstringrequired
    Example: http://example.com/agreement-callback
    ContractAgreementMessageSchema
    {
    "@type": "ContractAgreementMessage",
    "consumerPid": "urn:example:consumerPid",
    "providerPid": "urn:example:providerPid",
    "agreement": {
    "@type": "Agreement",
    "assigner": "urn:example:assigner",
    "assignee": "urn:example:assignee",
    "timestamp": "2023-10-01T12:34:56Z",
    "target": "urn:example:target"
    },
    "callbackAddress": "http://example.com/agreement-callback"
    }