Skip to content

Latest commit

 

History

History
216 lines (137 loc) · 5.34 KB

resource-event.schema.md

File metadata and controls

216 lines (137 loc) · 5.34 KB

Resource Event Schema

https://ns.adobe.com/xdm/assets/resource-event

A Resource Event is a high-level event that occurred in the processing, editing, or creation of an asset.

Resource Events are typically attached directly to an asset.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Experimental No Forbidden Permitted assets/resource-event.schema.json

Resource Event Example

{
  "stEvt:action": "created",
  "stEvt:when": "2017-09-26T15:52:25+00:00",
  "stEvt:instanceID": "00112233-4455-6677-8899-AABBCCDDEEFF"
}

Resource Event Properties

Property Type Required Defined by
stEvt:action complex Optional Resource Event (this schema)
stEvt:changed string Optional Resource Event (this schema)
stEvt:instanceID string Optional Resource Event (this schema)
stEvt:parameters string Optional Resource Event (this schema)
stEvt:softwareAgent string Optional Resource Event (this schema)
stEvt:when string Optional Resource Event (this schema)
* any Additional this schema allows additional properties

stEvt:action

Action

The action that occurred. Defined values are: converted, copied, created, cropped, edited, filtered, formatted, version_updated, printed, published, managed, produced, resized, and saved. New values should be verbs in the past tense.

stEvt:action

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

stEvt:action Type

Unknown type ``.

{
  "title": "Action",
  "description": "The action that occurred. Defined values are: converted, copied, created, cropped, edited, filtered, formatted, version_updated, printed, published, managed, produced, resized, and saved. New values should be verbs in the past tense.",
  "meta:enum": [
    "converted",
    "copied",
    "created",
    "cropped",
    "edited",
    "filtered",
    "formatted",
    "version_updated",
    "printed",
    "published",
    "managed",
    "produced",
    "resized",
    "saved"
  ],
  "simpletype": "complex"
}

stEvt:action Known Values

Value Description
0 converted
1 copied
2 created
3 cropped
4 edited
5 filtered
6 formatted
7 version_updated
8 printed
9 published
10 managed
11 produced
12 resized
13 saved

stEvt:changed

Changed

A semicolon-delimited list of the parts of the resource that were changed since the previous event history. If not present, presumed to be undefined. When tracking changes and the scope of the changed components is unknown, it should be assumed that anything might have changed.

stEvt:changed

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

stEvt:changed Type

string

stEvt:instanceID

Instance ID

The value of the instanceID property for the modified (output) resource. The value is a GUID, capital A-F, 8-4-4-12

stEvt:instanceID

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

stEvt:instanceID Type

string

All instances must conform to this regular expression

^[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$

stEvt:instanceID Example

"00112233-4455-6677-8899-AABBCCDDEEFF"

stEvt:parameters

Parameters

Additional description of the action.

stEvt:parameters

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

stEvt:parameters Type

string

stEvt:softwareAgent

Software Agent

The software agent (program) that performed the action. It is recommended that the value use this format convention: Organization Software_name Version (token;token;...)

  • Organization: The name of the company or organization providing the software, no SPACEs.
  • Software_name: The full name of the software, SPACEs allowed.
  • version: The version of the software, no SPACEs.
  • tokens: Can be used to identify an operating system, plug-in, or more detailed version information.

stEvt:softwareAgent

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

stEvt:softwareAgent Type

string

stEvt:when

When

Timestamp of when the action occurred. For events that create or write to a file, this should be the approximate modification time of the file.

stEvt:when

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

stEvt:when Type

string