Pattern: Announce Ingest

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.

context

context is OPTIONAL.

• An id which is the HTTP URI of the "landing page" for the resource.
• A type which should include the value sorg:AboutPage.
• 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.
• An ietf:item containing the details of the actual content resource. The ietf:item has:
  • An id containing the HTTP URI of the content file for the resource.
  • A type describing the content file.
  • A mediaType which contains the MIME Type of the content file.

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.

inReplyTo

inReplyTo is OPTIONAL. It SHOULD be specified if this is a response to a previous notification. It takes the URI (URN:UUID or HTTP URI) which identifies the activity for which this is a response.

object

object is REQUIRED.

• An id which is the HTTP URI of the "landing page" for the resource.
• A type which should include the value sorg:AboutPage.
• 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.
• An ietf:item containing the details of the actual content resource. The ietf:item has:
  • An id containing the HTTP URI of the content file for the resource.
  • A type describing the content file.
  • A mediaType which contains the MIME Type of the content file.

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 values:

• Announce
• coar-notify:IngestAction

Example JSON-LD Payload

{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://purl.org/coar/notify"
  ],
  "actor": {
    "id": "https://research-organisation.org",
    "name": "Research Organisation",
    "type": "Organization"
  },
  "context": {
    "id": "https://research-organisation.org/repository/preprint/201203/421/",
    "ietf:cite-as": "https://doi.org/10.5555/12345680",
    "ietf:item": {
      "id": "https://research-organisation.org/repository/preprint/201203/421/content.pdf",
      "mediaType": "application/pdf",
      "type": [
        "Article",
        "sorg:ScholarlyArticle"
      ]
    },
    "type": "sorg:AboutPage"
  },
  "id": "urn:uuid:94ecae35-dcfd-4182-8550-22c7164fe23f",
  "inReplyTo": "urn:uuid:0370c0fb-bb78-4a9b-87f5-bed307a509dd",
  "object": {
    "id": "https://research-organisation.org/repository/preprint/201203/421/",
    "ietf:cite-as": "https://doi.org/10.5555/12345680",
    "ietf:item": {
      "id": "https://research-organisation.org/repository/preprint/201203/421/content.pdf",
      "mediaType": "application/pdf",
      "type": [
        "Article",
        "sorg:ScholarlyArticle"
      ]
    },
    "type": "sorg:AboutPage"
  },
  "origin": {
    "id": "https://research-organisation.org/repository",
    "inbox": "https://research-organisation.org/inbox/",
    "type": "Service"
  },
  "target": {
    "id": "https://overlay-journal.com/system",
    "inbox": "https://overlay-journal.com/inbox/",
    "type": "Service"
  },
  "type": [
    "Announce",
    "coar-notify:IngestAction"
  ]
}