Skip to content

Latest commit

 

History

History
113 lines (71 loc) · 3.64 KB

deleted.schema.md

File metadata and controls

113 lines (71 loc) · 3.64 KB
Raw

Deleted Event Schema

https://ns.adobe.com/xdm/common/event/deleted

A deleted event follows semantics that are exactly equivalent to the semantics described by the delete activity, except for one difference. The delete activity can be used in imperative contexts, however, the deleted event can only be used in passive contexts.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated No Experimental No Forbidden Permitted common/event/deleted.schema.json

Schema Hierarchy

  • Deleted Event https://ns.adobe.com/xdm/common/event/deleted

Deleted Event Example

{
  "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b",
  "@type": "https://ns.adobe.com/xdm/common/event/deleted",
  "xdm:objectType": "https://ns.adobe.com/xdm/assets/asset",
  "activitystreams:actor": {
    "@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:object": {
    "@type": "https://ns.adobe.com/xdm/assets/asset",
    "repo:id": "urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185",
    "xdm:name": "example.jpg",
    "repo:etag": "6fc55d0389d856ae7deccebba54f110e",
    "xdm:path": "/MyFolder/example.jpg",
    "dc:format": "image/jpeg"
  },
  "activitystreams:published": "2016-07-16T19:20:30+01:00",
  "activitystreams:to": {
    "@id": "D13A1E7053E46A220A4C86E1@AdobeID",
    "@type": "https://ns.adobe.com/adobecloudplatform/ims/user"
  }
}

Deleted Event Properties

Property Type Required Defined by
@type const Optional Deleted Event (this schema)
xdm:objectType complex Optional EventEnvelope
* any Additional this schema allows additional properties

@type

@type

  • is optional
  • type: const
  • defined in this schema

The value of this property must be equal to:

"https://ns.adobe.com/xdm/common/event/deleted"

xdm:objectType

This is the type of the object that has been emitting this event. The value of this field MUST be exactly same as the value of the object.type field. Making the type available in the event envelope allows routing systems to dispatch events based on the object type without inspecting the object itself.

xdm:objectType

xdm:objectType Type

One of the following conditions need to be fulfilled.

Condition 1

Array type:

All items must be of the type: string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)

Condition 2

string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)