activity.schema.json

{
    "meta:license": [
        "Copyright 2017 Adobe Systems Incorporated. All rights reserved.",
        "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
        "you may not use this file except in compliance with the License. You may obtain a copy",
        "of the License at https://creativecommons.org/licenses/by/4.0/"
    ],
    "$schema": "http://json-schema.org/draft-06/schema#",
    "$id": "https://ns.adobe.com/xdm/external/activity-streams-2/activity",
    "meta:extensible": true,
    "definitions": {
        "single-object-or-link": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uri"
                },
                {
                    "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/object"
                },
                {
                    "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/link"
                }
            ]
        },
        "multiple-objects-or-links": {
            "items": {
                "$ref": "#/definitions/single-object-or-link"
            },
            "type": "array"
        },
        "object-or-link-or-array-of-object-or-link": {
            "oneOf": [
                {
                    "$ref": "#/definitions/single-object-or-link"
                },
                {
                    "$ref": "#/definitions/multiple-objects-or-links"
                }
            ]
        },
        "extra-properties": {
            "properties": {
                "activitystreams:actor": {
                    "description": "Describes one or more entities that either performed or are expected to perform the activity. Any single activity can have multiple actors. The actor MAY be specified using an indirect Link. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-actor) document for a complete description.",
                    "$ref": "#/definitions/object-or-link-or-array-of-object-or-link"
                },
                "activitystreams:object": {
                    "description": "When used within an Activity, describes the direct object of the activity. For instance, in the activity 'John added a movie to his wishlist', the object of the activity is the movie added. When used within a Relationship describes the entity to which the subject is related. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object) document for a complete description.",
                    "$ref": "#/definitions/object-or-link-or-array-of-object-or-link"
                },
                "activitystreams:target": {
                    "description": "Describes the indirect object, or target, of the activity. The precise meaning of the target is largely dependent on the type of action being described but will often be the object of the English preposition 'to'. For instance, in the activity 'John added a movie to his wishlist', the target of the activity is John's wishlist. An activity can have more than one target. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-target) document for a complete description.",
                    "$ref": "#/definitions/object-or-link-or-array-of-object-or-link"
                },
                "activitystreams:result": {
                    "description": "Describes the result of the activity. For instance, if a particular action results in the creation of a new resource, the result property can be used to describe that new resource. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-result) document for a complete description.",
                    "$ref": "#/definitions/object-or-link-or-array-of-object-or-link"
                },
                "activitystreams:origin": {
                    "description": "Describes an indirect object of the activity from which the activity is directed. The precise meaning of the origin is the object of the English preposition 'from'. For instance, in the activity 'John moved an item to List B from List A', the origin of the activity is 'List A'. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-origin) document for a complete description.",
                    "$ref": "#/definitions/object-or-link-or-array-of-object-or-link"
                },
                "activitystreams:instrument": {
                    "description": "Identifies one or more objects used (or to be used) in the completion of an Activity. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-instrument) document for a complete description.",
                    "$ref": "#/definitions/object-or-link-or-array-of-object-or-link"
                }
            }
        }
    },
    "description": "An [Activity](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-activity) is a subtype of `[Object](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object)` that describes some form of action that may happen, is currently happening, or has already happened. The `Activity` type itself serves as an abstract base type for all types of activities. It is important to note that the `Activity` type itself does not carry any specific semantics about the kind of action being taken.",
    "type": "object",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/object"
        },
        {
            "$ref": "#/definitions/extra-properties"
        }
    ],
    "title": "Activity",
    "meta:status": "experimental",
    "examples": [
        {
            "@context": {
                "activitystreams": "http://www.w3.org/ns/activitystreams#",
                "xdm": "https://ns.adobe.com/xdm/"
            },
            "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b",
            "@type": "https://ns.adobe.com/xdm/common/event/created",
            "activitystreams:published": "2016-07-16T19:20:30+01:00",
            "activitystreams:to": {
                "https://ns.adobe.com/adobecloudplatform/ims/user#id": "D13A1E7053E46A220A4C86E1@AdobeID",
                "@type": "https://ns.adobe.com/adobecloudplatform/ims/user"
            },
            "activitystreams:generator": {
                "xdm:root": "https://cc-api-storage.adobe.io/",
                "@type": "https://ns.adobe.com/xdm/content/repository"
            },
            "activitystreams:actor": {
                "https://ns.adobe.com/adobecloudplatform/ims/user#id": "D13A1E7053E46A220A4C86E1@AdobeID",
                "@type": "https://ns.adobe.com/adobecloudplatform/ims/user"
            },
            "activitystreams:object": {
                "@type": "https://ns.adobe.com/xdm/assets/asset",
                "xdm:asset_id": "urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185",
                "xdm:asset_name": "example.jpg",
                "repo:etag": "6fc55d0389d856ae7deccebba54f110e",
                "xdm:path": "/MyFolder/example.jpg",
                "xdm:format": "image/jpeg"
            }
        }
    ]
}