See these use-cases to understand this scenario in context: Peer-review, Endorsement
The corresponding author submits a paper to an overlay journal. The journal deposits the paper in a repository and arranges reviews. The reviews are deposited in the repository
The overlay journal requests that a repository ingest an author's submitted manuscript
@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 Offer & coar-notify:IngestAction
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
object
The object
describes the resource which is the main focus of this notification.
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.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://overlay-journal.com",
"name": "Overlay Journal",
"type": "Service"
},
"id": "urn:uuid:0370c0fb-bb78-4a9b-87f5-bed307a509dd",
"object": {
"id": "https://overlay-journal.com/submissions/00001/",
"type": "sorg:AboutPage",
"url": {
"id": "https://overlay-journal.com/submissions/00001/files/content.pdf",
"mediaType": "application/pdf",
"type": [
"Article",
"sorg:ScholarlyArticle"
]
}
},
"origin": {
"id": "https://overlay-journal.com/system",
"inbox": "https://overlay-journal.com/inbox/",
"type": "Service"
},
"target": {
"id": "https://research-organisation.org/repository",
"inbox": "https://research-organisation.org/inbox/",
"type": "Service"
},
"type": [
"Offer",
"coar-notify:IngestAction"
]
}
The repository notifies the overlay journal that it has ingested the resource
@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:IngestAction
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
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.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://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",
"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://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"
]
}
},
"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"
]
}
The repository notifies the overlay journal of a new review
@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://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",
"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://research-organisation.org/repository/review/00001",
"ietf:cite-as": "https://doi.org/10.3214/000001",
"type": [
"Document",
"sorg:Review"
]
},
"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:ReviewAction"
]
}
The overlay journal notifies the repository of its endorsement
@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:EndorsementAction
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
which identifies the resource representing the endorsement.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 representing the endorsement.type
describing the content file.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://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",
"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://overlay-journal.com/articles/00001/",
"ietf:cite-as": "https://overlay-journal.com/articles/00001/",
"type": [
"Page",
"sorg:WebPage"
]
},
"origin": {
"id": "https://overlay-journal.com/system",
"inbox": "https://overlay-journal.com/inbox/",
"type": "Service"
},
"target": {
"id": "https://research-organisation.org/repository",
"inbox": "https://research-organisation.org/inbox/",
"type": "Service"
},
"type": [
"Announce",
"coar-notify:EndorsementAction"
]
}