Pattern: Undo Offer

Properties

@context

@context is REQUIRED. This is the JSON-LD 'context' for the activity.

actor

actor is RECOMMENDED. It describes the party responsible for this activity. It:

• MUST have an id which MUST be a URI identifying the actor (HTTP URIs are RECOMMENDED, but any valid URI is permitted)
• MUST have a type which MUST be one of: Application, Group, Organization, Person or Service from Activity Streams 2.0.
• MAY have a name

The inclusion of actor is highly RECOMMENDED in order to facilitate the broadest possible interoperability beyond the immediate COAR Notify context. Some external systems which can usefully consume notifications based on Activity Streams 2.0 may require the presence of an actor to function correctly.

id

id is REQUIRED. This must be a URI, and the use of URN:UUID is recommended. An HTTP URI may be used, but in such cases the URI should resolve to a resource which represents the activity.

object

object is REQUIRED.

• An id which identifies the original offer activity which this notification is acknowledging.
• An object which identifies the resource which was the object of the original offer
• The type which is Offer

origin

origin is REQUIRED. The originator of the activity, typically the service responsible for sending the notification.

target

target is REQUIRED. The intended destination of the activity, typically the service which consumes the notification.

type

type is REQUIRED. The type of this activity MUST include the value Undo

Example JSON-LD Payload

{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://purl.org/coar/notify"
  ],
  "actor": {
    "id": "https://some-organisation.org",
    "name": "Some Organisation",
    "type": "Organization"
  },
  "id": "urn:uuid:46956915-e3fe-4528-8789-1d325a356e4f",
  "object": {
    "id": "urn:uuid:0370c0fb-bb78-4a9b-87f5-bed307a509dd",
    "object": "https://some-organisation.org/resource/0021",
    "type": "Offer"
  },
  "origin": {
    "id": "https://some-organisation.org",
    "inbox": "https://some-organisation.org/inbox/",
    "type": "Service"
  },
  "target": {
    "id": "https://generic-service.com/system",
    "inbox": "https://generic-service.com/system/inbox/",
    "type": "Service"
  },
  "type": "Undo"
}