Pattern: Announce Review

Properties

@context

@context is REQUIRED. It takes an array of URIs which MUST include:

• https://www.w3.org/ns/activitystreams

and MUST include ONE of the following:

• https://coar-notify.net (preferred)
• https://purl.org/coar/notify instead (deprecated)

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 which is a string containing the name of the party responsible for this activity

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.

context

context is REQUIRED. It:

• MUST have an id which MUST be the HTTP URI of the "landing page" for the resource.
• MAY have a type describing the resource, which MUST include an Activity Streams 2.0 object type, and SHOULD include the value sorg:AboutPage.
• MAY have an ietf:cite-as which contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.
• MAY have an ietf:item containing the details of the actual content resource. When present, the ietf:item:
  • MUST have an id containing the HTTP URI of the content file for the resource.
  • MUST have a type describing the resource, which MUST include an Activity Streams 2.0 object type, and SHOULD include a value from schema.org.
  • MUST have a mediaType which contains the MIME Type of the content file.

id

id is REQUIRED. It MUST identify an Activity Streams 2.0 activity. Its value MUST be a single URI, and the use of URN:UUID is RECOMMENDED. An HTTP URI MAY be used instead, and in such cases the URI SHOULD resolve to a useful resource.

inReplyTo

inReplyTo is OPTIONAL. It SHOULD be specified if this is a response to a previous notification. It takes the URI which identifies the activity for which this is a response.

object

object is REQUIRED. This represents the review. It:

• MUST have an id which identifies the review resource.
• MUST have a type describing the resource, which MUST include an Activity Streams 2.0 object type, and SHOULD include a value from schema.org.
• SHOULD have an ietf:cite-as which contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the review resource.

origin

origin is REQUIRED. It describes the system which has sent the notification. It:

• MUST have an id which MUST be an HTTP URI identifying the sending system
• MUST have a type which SHOULD include the value Service from Activity Streams 2.0
• SHOULD have an inbox which, when present, MUST have the HTTP URI of the LDN inbox for the origin.

target

target is REQUIRED. It describes the system which is intended to receive the notification. It:

• MUST have an id which MUST be an HTTP URI identifying the receiving system
• MUST have a type which SHOULD include the value Service from Activity Streams 2.0
• MUST have an inbox which MUST have the HTTP URI of the LDN inbox for the target.

type

type is REQUIRED. The type of this activity MUST include the values:

• Announce
• coar-notify:ReviewAction

Example JSON-LD Payload

{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://coar-notify.net"
  ],
  "actor": {
    "id": "https://review-service.com",
    "name": "Review Service",
    "type": "Service"
  },
  "context": {
    "id": "https://research-organisation.org/repository/preprint/201203/421/"
  },
  "id": "urn:uuid:94ecae35-dcfd-4182-8550-22c7164fe23f",
  "inReplyTo": "urn:uuid:0370c0fb-bb78-4a9b-87f5-bed307a509dd",
  "object": {
    "id": "https://review-service.com/review/geo/202103/0021",
    "ietf:cite-as": "https://doi.org/10.3214/987654",
    "type": [
      "Page",
      "sorg:Review"
    ]
  },
  "origin": {
    "id": "https://review-service.com/system",
    "inbox": "https://review-service.com/inbox/",
    "type": "Service"
  },
  "target": {
    "id": "https://generic-service.com/system",
    "inbox": "https://generic-service.com/system/inbox/",
    "type": "Service"
  },
  "type": [
    "Announce",
    "coar-notify:ReviewAction"
  ]
}