This pattern is used to announce the existence of a "service result", referencing (in context
) the resource to which the service result pertains
@context
is REQUIRED.
This is the JSON-LD 'context' for the activity.
actor
is RECOMMENDED.
It describes the party responsible for this activity. It:
id
which MUST be a URI identifying the actor
(HTTP URIs are RECOMMENDED, but any valid URI is permitted)type
which MUST be one of: Application, Group, Organization, Person or Service from Activity Streams 2.0.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
is OPTIONAL.
id
which is the HTTP URI of the "landing page" for the resource.type
which should include the value sorg:AboutPage.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.ietf:item
containing the details of the actual content resource. The ietf:item
has:
id
containing the HTTP URI of the content file for the resource.type
describing the content file.mediaType
which contains the MIME Type of the content file.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
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
is REQUIRED.
id
which identifies the resource representing the service result.type
describing the content file.origin
is REQUIRED.
The originator of the activity, typically the service responsible for sending the notification.
target
is REQUIRED.
The intended destination of the activity, typically the service which consumes the notification.
type
is REQUIRED.
The type
of this activity MUST include the value Announce
{
"@context": [
"https://www.w3.org/ns/activitystreams",
"https://purl.org/coar/notify"
],
"actor": {
"id": "https://overlay-journal.com",
"name": "Overlay Journal",
"type": "Service"
},
"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://overlay-journal.com/information-page",
"type": [
"Page",
"sorg:WebPage"
]
},
"origin": {
"id": "https://overlay-journal.com/system",
"inbox": "https://overlay-journal.com/inbox/",
"type": "Service"
},
"target": {
"id": "https://generic-service.com/system",
"inbox": "https://generic-service.com/system/inbox/",
"type": "Service"
},
"type": [
"Announce"
]
}