Description: | This pattern is used to announce the existence of a review, referencing (in context ) the resource that has been reviewed |
Event Notification Pattern(s): | OneWayPatternSNSN, OneWayPatternSNDN |
Pattern Categories: | Announcements |
@context
The @context
must include:
id
Notify payloads must describe an AS 2.0 activity
. The activity
has an id
which must be a URI, and the use of URN:UUID is recommended. An HTTP URI may be used instead, but in such cases the URI should resolve to a useful resource.
type
The activity
has a type
which should include Announce & coar-notify:ReviewAction
actor
The actor
describes the party responsible for this activity.
The actor
has:
id
which must be a URI identifying the actor
(HTTP URIs are preferred, but any valid URI is permitted)type
which should be one of: Application, Group, Organization, Person or Service from AS 2.0.actor
may also have a name
origin
The origin
describes the system which has sent the notification.
The origin
has:
id
which is an HTTP URI identifying the sending systemtype
which should include the value Service from AS 2.0.inbox
which is the HTTP URI of the LDN inbox for the origin
inReplyTo
This particular example has the following properties:
inReplyTo
may be specified if this is a response to a previous notification. inReplyTo
takes the URI (URN:UUID or HTTP URI) which identifies the activity
for which this is a response.
context
When the object
describes the result of some service acting on a resource, the context
may be used to refer to that second resource.
This particular example has the following properties:
id
which is the HTTP URI of the "landing page" for the resource.type
which should include the value AboutPage from schema.org.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.url
containing the details of the actual content resource. The url
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.object
The object
describes the resource which is the main focus of this notification.
This particular example has the following properties:
id
is the HTTP URI of the "landing page" for the resource.type
should include the value Document from AS 2.0, and sorg:Reviewietf:cite-as
contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.target
The target
describes the system which is intended to receive the notification.
The target
has:
id
which is an HTTP URI identifying the receiving systemtype
which should include the value Service from AS 2.0.inbox
which is the HTTP URI of the LDN inbox for the target
{
"@context": [
"https://www.w3.org/ns/activitystreams",
"https://purl.org/coar/notify"
],
"actor": {
"id": "https://review-service.com",
"name": "Review Service",
"type": "Service"
},
"context": {
"id": "https://research-organisation.org/repository/preprint/201203/421/",
"ietf:cite-as": "https://doi.org/10.5555/12345680",
"type": "sorg:AboutPage",
"url": {
"id": "https://research-organisation.org/repository/preprint/201203/421/content.pdf",
"mediaType": "application/pdf",
"type": [
"Article",
"sorg:ScholarlyArticle"
]
}
},
"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": [
"Document",
"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"
]
}
ID | Scenario | Participating Systems |
---|---|---|
1 | Author requests review with possible endorsement (via overlay journal) | Overlay Journal <-> Repository |
2 | Author requests review with possible endorsement (via repository) | Repository <-> Overlay Journal |
3 | Overlay Journal Announces Review and Endorsement of Pre-print to Aggregator | Overlay Journal <-> Aggregator |
5 | Repository requests review (on behalf of corresponding author) | Repository <-> Review Service |
6 | Author submits to overlay journal using repository to host resource and reviews | Overlay Journal <-> Repository |
7 | Review Service Announces Review of Pre-print to Aggregator | Review Service <-> Aggregator |
8 | Review Service Announces Review of Pre-print to Repository | Review Service <-> Repository |
9 | Author requests reviews from review service, via repository | Repository <-> Review Service |
9 | Author requests reviews from review service, via repository | Repository <-> Review Service |