Asset Schema

https://ns.adobe.com/xdm/assets/asset

A digital asset, is anything that exists in a binary format and comes with the right to use. Content that does not possess that right is not considered an asset. Digital assets include but are not exclusive to: digital documents, audible content, motion picture, and other relevant digital content that is currently in circulation or production.

As described in What is a digital asset, the definition of a digital asset can be put like this:

In theory, a digital asset is something represented in a digital form that has an intrinsic or acquired value. This initial definition is intentionally general. It could correspond to almost anything or any piece of media in a digital form, such as a photo, website, or email message. As a practical matter, however, DAM [Digital Asset Management] has evolved to support the management of digital media assets almost exclusively. This includes images, video, audio, and related artifacts (such as brochures and compound publications). You would typically use different types of technology to manage email, Word documents, relational data records, and web pages. Even some image “assets” don’t fall under the domain of DAM technology as it is known today. Scanned paper or forms that end up as TIFF or PDF files do not constitute media assets that originate through some creative process.

All digital assets are content, and some content can include, link to, or refer digital assets. Content can furthermore be transformed (rendered) into digital assets, such as when exporting a PDF.

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

Schema Hierarchy

Asset https://ns.adobe.com/xdm/assets/asset
- Asset http://ns.adobe.com/adobecloud/core/1.0/asset
- Common Properties http://ns.adobe.com/adobecloud/core/1.0
- HAL Resource https://ns.adobe.com/xdm/external/hal/resource
- Content https://ns.adobe.com/xdm/content/content
- Copyright Owner https://ns.adobe.com/xdm/assets/copyright-owner
- Layer Group https://ns.adobe.com/xdm/assets/layer-group

Asset Example

{
  "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab",
  "xmp:createDate": "2017-09-26T15:52:25+00:00",
  "repo:createdDate": "2017-09-26T15:52:25+00:00",
  "xdm:repositoryCreatedBy": "lars",
  "xmp:modifyDate": "2017-09-26T15:52:25+00:00",
  "repo:lastModifiedDate": "2017-09-26T15:52:25+00:00",
  "xdm:repositoryLastModifiedBy": "lars",
  "repo:version": "15",
  "repo:size": 1632418,
  "repo:path": "here",
  "repo:etag": "15",
  "repo:name": "example.pdf",
  "dc:format": "application/pdf"
}

Asset Properties

Property	Type	Required	Defined by
@id	`string`	Optional	Content
_embedded	`object`	Optional	HAL Resource
_links	`object`	Optional	HAL Resource
cc:attributionName	`string`	Optional	Asset (this schema)
cc:attributionUrl	`string`	Optional	Asset (this schema)
cc:license	`string`	Optional	Asset (this schema)
dc:creator	`string[]`	Optional	Asset (this schema)
dc:description	reference	Optional	Asset (this schema)
dc:format	`string`	Required	Common Properties
dc:language	`string[]`	Optional	Asset (this schema)
dc:rights	reference	Optional	Asset (this schema)
dc:subject	`string[]`	Optional	Asset (this schema)
dc:title	reference	Optional	Asset (this schema)
exif:gpsAltitude	`number`	Optional	Asset (this schema)
exif:gpsAltitudeRef	`enum`	Optional	Asset (this schema)
exif:gpsLatitude	`string`	Optional	Asset (this schema)
exif:gpsLongitude	`string`	Optional	Asset (this schema)
photoshop:credit	`string`	Optional	Asset (this schema)
plus:copyrightOwner	reference	Optional	Asset (this schema)
plus:copyrightOwnerID	`string`	Optional	Copyright Owner
plus:copyrightOwnerName	`string`	Optional	Copyright Owner
repo:createDate	`string`	Optional	Common Properties
repo:etag	`string`	Required	Asset
repo:id	`string`	Required	Asset
repo:lastModifiedDate	`string`	Required	Common Properties
repo:name	`string`	Required	Common Properties
repo:path	`string`	Required	Common Properties
repo:size	`integer`	Required	Asset
repo:version	`string`	Required	Asset
tiff:imageLength	`integer`	Optional	Asset
tiff:imageWidth	`integer`	Optional	Asset
xdm:aliasIDs	`array`	Optional	Asset (this schema)
xdm:documentID	`string`	Optional	Asset (this schema)
xdm:milestone	`object`	Optional	Asset (this schema)
xdm:notSafe	`enum`	Optional	Asset (this schema)
xdm:repositoryCreatedBy	`string`	Optional	Content
xdm:repositoryLastModifiedBy	`string`	Optional	Content
xmp:artboards	Artboard	Optional	Asset (this schema)
xmp:createDate	`string`	Optional	Asset (this schema)
xmp:creatorTool	`string`	Optional	Asset (this schema)
xmp:fonts	reference	Optional	Asset (this schema)
xmp:keywords	`array`	Optional	Asset (this schema)
xmp:layers	complex	Optional	Asset (this schema)
xmp:machineKeywords	`object[]`	Optional	Asset (this schema)
xmp:modifyDate	`string`	Optional	Asset (this schema)
xmp:rating	`enum`	Optional	Asset (this schema)
xmpMM:history	reference	Optional	Asset (this schema)
xmpMM:manageTo	`string`	Optional	Asset (this schema)
xmpMM:manageUI	`string`	Optional	Asset (this schema)
xmpRights:marked	`boolean`	Optional	Asset (this schema)
xmpRights:usageTerms	reference	Optional	Asset (this schema)
xmpRights:webStatement	`string`	Optional	Asset (this schema)
xmpTPg:NPages	`integer`	Optional	Asset (this schema)
`*`	any	Additional	this schema allows additional properties

@id

A unique identifier given to every addressable piece of content in a given repository.

@id

is optional
type: string
defined in Content

@id Type

string

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

_embedded

It is an object whose property names are link relation types (as defined by RFC5988) and values are either a Resource Object or an array of Resource Objects.\n\nEmbedded Resources MAY be a full, partial, or inconsistent version of the representation served from the target URI.

_embedded

is optional
type: object
defined in HAL Resource

_embedded Type

object with following properties:

Property	Type	Required

_links

It is an object whose property names are link relation types (as defined by RFC5988 and values are either a Link Object or an array of Link Objects. The subject resource of these links is the Resource Object of which the containing _links object is a property.

_links

is optional
type: object
defined in HAL Resource

_links Type

object with following properties:

Property	Type	Required

cc:attributionName

Attribution Name

For licenses that require attribution, such as some Creative Commons licenses, the user to which a work is attributed. When publishing to Behance, this is taken from the user's Behance profile information.

cc:attributionName

is optional
type: string
defined in this schema

cc:attributionName Type

string

cc:attributionUrl

Attribution URL

For licenses that require attribution, such as some Creative Commons licenses, a URL that identifies the user to which a work should be attributed. When publishing to Behance, we link to the user's profile page.

cc:attributionUrl

is optional
type: string
defined in this schema

cc:attributionUrl Type

string

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

cc:license

License

A license is a set of requests/permissions to users of a Work, e.g. a copyright license, the public domain, information for distributors.

cc:license

is optional
type: string
defined in this schema

cc:license Type

string

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

dc:creator

Creator

An entity primarily responsible for making the resource. Examples of a creator include a person, an organization, or a service. Typically, the name of a creator should be used to indicate the entity.

XMP usage is a list of creators. Entities should be listed in order of decreasing precedence, if such order is significant.

dc:creator

is optional
type: string[]
defined in this schema

dc:creator Type

Array type: string[]

All items must be of the type: string

dc:description

Description

An account of the content of the resource. Description may include but is not limited to: an abstract, table of contents, reference to a graphical representation of content or a free-text account of the content.

dc:description

is optional
type: reference
defined in this schema

dc:description Type

Array type: reference

All items must be of the type:

– https://ns.adobe.com/xdm/assets/language-alternative#/definitions/language-alternative

dc:format

Format

The physical or digital manifestation of the resource. Typically, Format should include the media-type of the resource. Format may be used to determine the software, hardware or other equipment needed to display or operate the resource. Recommended best practice is to select a value from a controlled vocabulary (for example, the list of [Internet Media Types](http://www.iana.org/ assignments/media-types/) defining computer media formats).

dc:format

is required
type: string
defined in Common Properties

dc:format Type

string

All instances must conform to this regular expression

\w+\/[-.\w]+(?:\+[-.\w]+)?

test example: application/vnd.adobe.photoshop

dc:format Example

"application/vnd.adobe.photoshop"

dc:language

Language

The language or languages of the resource. Languages are specified in language code as defined in IETF RFC 3066, which is part of BCP 47, which is used elsewhere in XDM.

dc:language

is optional
type: string[]
defined in this schema

dc:language Type

Array type: string[]

All items must be of the type: string

All instances must conform to this regular expression (test examples here):

^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

dc:language Examples

"\n"

"pt-BR"

"es-ES"

dc:rights

Rights

Information about rights held in and over the resource. We can live without mentioning locale if only one entry is there. Default locale is en_us. Locale codes should follow IETF BCP 47 standard.

dc:rights

is optional
type: reference
defined in this schema

dc:rights Type

Array type: reference

All items must be of the type:

– https://ns.adobe.com/xdm/assets/language-alternative#/definitions/language-alternative

dc:subject

Subject

Set of descriptive phrases or keywords that describe the content of the resource. These keywords are part of the XMP metadata of the asset. Compare this with the keyword and machineKeywords properties, which provide more structure and context.

dc:subject

is optional
type: string[]
defined in this schema

dc:subject Type

Array type: string[]

All items must be of the type: string

dc:title

Title

A name given to the resource. Typically, a Title will be a name by which the resource is formally known.

dc:title

is optional
type: reference
defined in this schema

dc:title Type

Array type: reference

All items must be of the type:

– https://ns.adobe.com/xdm/assets/language-alternative#/definitions/language-alternative

exif:gpsAltitude

GPS Altitude

GPS tag 6, 0x06. Indicates altitude in meters.

exif:gpsAltitude

is optional
type: number
defined in this schema

exif:gpsAltitude Type

number

exif:gpsAltitudeRef

GPS Altitude Reference

GPS tag 5, 0x5. Indicates whether the altitude is above or below sea level.

exif:gpsAltitudeRef

is optional
type: enum
defined in this schema

The value of this property must be equal to one of the known values below.

exif:gpsAltitudeRef Known Values

Value	Description
`0`	The `exif:gpsAltitude` specifies a value above sea level
`1`	The `exif:gpsAltitude` specifies a value below sea level

exif:gpsLatitude

GPS Latitude

GPS tag 2, 0x02 (position) and 1, 0x01 (North/South). Indicates latitude. A Text value in the form “DDD,MM,SSk” or “DDD,MM.mmk”, where:

DDD is a number of degrees
MM is a number of minutes
SS is a number of seconds
mm is a fraction of minutes
k is a single character N or S, indicating a direction (north, south) Leading zeros are not necessary for the for DDD, MM, and SS values. The DDD,MM.mmk form should be used when any of the native Exif component rational values has a denominator other than 1. There can be any number of fractional digits.

exif:gpsLatitude

is optional
type: string
defined in this schema

exif:gpsLatitude Type

string

All instances must conform to this regular expression (test examples here):

^[\d]{1,3},[\d]{1,2}(,[\d]{1,2}|.[\d]+)[NS]$

exif:gpsLongitude

GPS Longitude

GPS tag 4, 0x04 (position) and 3, 0x03 (East/West). Indicates longitude. A Text value in the form “DDD,MM,SSk” or “DDD,MM.mmk”, where:

DDD is a number of degrees
MM is a number of minutes
SS is a number of seconds
mm is a fraction of minutes
k is a single character E or W, indicating a direction (east, west) Leading zeros are not necessary for the for DDD, MM, and SS values. The DDD,MM.mmk form should be used when any of the native Exif component rational values has a denominator other than 1. There can be any number of fractional digits.

exif:gpsLongitude

is optional
type: string
defined in this schema

exif:gpsLongitude Type

string

All instances must conform to this regular expression (test examples here):

^[\d]{1,3},[\d]{1,2}(,[\d]{1,2}|.[\d]+)[EW]$

photoshop:credit

Credit

Who should be credited when the asset is published.

photoshop:credit

is optional
type: string
defined in this schema

photoshop:credit Type

string

plus:copyrightOwner

Copyright Owners

Owner or owners of the copyright in the licensed asset.

plus:copyrightOwner

is optional
type: reference
defined in this schema

plus:copyrightOwner Type

Array type: reference

All items must be of the type:

– https://ns.adobe.com/xdm/assets/copyright-owner#/definitions/copyright

plus:copyrightOwnerID

Copyright Owner ID

ID of the copyright owner. If the PLUS-ID being stored in this property is registered with the PLUS Coalition, it should be expressed as a URL. For example: http://plus-id.org/PLUS-ID

plus:copyrightOwnerID

is optional
type: string
defined in Copyright Owner

plus:copyrightOwnerID Type

string

plus:copyrightOwnerName

Copyright Owner Name

Name of Copyright Owner.

plus:copyrightOwnerName

is optional
type: string
defined in Copyright Owner

plus:copyrightOwnerName Type

string

repo:createDate

The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The Date Time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".

repo:createDate

is optional
type: string
defined in Common Properties

repo:createDate Type

string

format: date-time – date and time (according to RFC 3339, section 5.6)

repo:createDate Example

"2004-10-23T12:00:00-06:00"

repo:etag

ETag

An ETag is an HTTP response header returned by an HTTP/1.1 compliant web server used to determine change in content of a resource at a given URL.

repo:etag

is required
type: string
defined in Asset

repo:etag Type

string

repo:id

A unique identifier given to every addressable asset in a given repository.

repo:id

is required
type: string
defined in Asset

repo:id Type

string

repo:id Example

"urn:aaid:sc:US:6dc33479-13ca-4b19-b25d-c805eff8a69e"

repo:lastModifiedDate

The server date and time when the resource was most recently modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The Date Time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".

repo:lastModifiedDate

is required
type: string
defined in Common Properties

repo:lastModifiedDate Type

string

format: date-time – date and time (according to RFC 3339, section 5.6)

repo:lastModifiedDate Example

"2004-10-23T12:00:00-06:00"

repo:name

repo:name

is required
type: string
defined in Common Properties

repo:name Type

string

repo:path

repo:path

is required
type: string
defined in Common Properties

repo:path Type

string

repo:size

Size

Size of the asset in bytes.

repo:size

is required
type: integer
defined in Asset

repo:size Type

integer

repo:version

The version ID of the piece of content. It will be generated both on explicit and implicit save or upload.

repo:version

is required
type: string
defined in Asset

repo:version Type

string

tiff:imageLength

Length

Height in pixels. To maintain continuity with the XMP and TIFF standards, the height of an image or video is specified in the property imageLength. The duration of the video (also commonly called length) is specified in the property extent

tiff:imageLength

is optional
type: integer
defined in Asset

tiff:imageLength Type

integer

minimum value: 0

tiff:imageWidth

Width

Width in pixels

tiff:imageWidth

is optional
type: integer
defined in Asset

tiff:imageWidth Type

integer

minimum value: 0

xdm:aliasIDs

Alias IDs

List of IDs under which external systems track the asset. Example of external systems : google, facebook etc.

xdm:aliasIDs

is optional
type: array
defined in this schema

xdm:aliasIDs Type

Array type: array

All items must be of the type: Unknown type ``.

{
  "type": "array",
  "meta:usereditable": false,
  "title": "Alias IDs",
  "items": {
    "properties": {
      "system": {
        "title": "External System",
        "type": "string",
        "description": "A string used to identify the external systems like google, facebook etc."
      },
      "id": {
        "type": "string",
        "title": "External ID",
        "description": "An ID under which external systems track the asset."
      }
    },
    "simpletype": "complex"
  },
  "description": "List of IDs under which external systems track the asset. Example of external systems : google, facebook etc.",
  "simpletype": "`array`"
}

xdm:documentID

Document ID

It takes the value of xmpMM:DocumentID present in the XMP packet of the asset. For the assets having no XMP packet this property won't be populated.

The value is a GUID, capital A-F, 8-4-4-12, preceded by the string uuid:

xdm:documentID

is optional
type: string
defined in this schema

xdm:documentID Type

string

All instances must conform to this regular expression

^uuid:[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}$

test example: uuid:00112233-4455-6677-8899-AABBCCDDEEFF

xdm:documentID Example

"uuid:00112233-4455-6677-8899-AABBCCDDEEFF"

xdm:milestone

Milestone

A label given to a version of the asset.

xdm:milestone

is optional
type: object
defined in this schema

xdm:milestone Type

object with following properties:

Property	Type	Required
`description`	string	Optional
`label`	string	Optional

description

Milestone Description

Description for the version of an asset

description

is optional
type: string

description Type

string

label

Milestone Label

Label for the version of an asset

label

is optional
type: string

label Type

string

xdm:notSafe

NSFW State

Indicates if the content is SFW (safe for work). Safe is value 0 or missing value. NSFW is value 1.

xdm:notSafe

is optional
type: enum
defined in this schema

The value of this property must be equal to one of the known values below.

xdm:notSafe Known Values

Value	Description
`0`	The content is safe for work
`1`	The content is not safe for work

xdm:repositoryCreatedBy

ID of the user who initiated the action that caused the resource to be created in the repository.

xdm:repositoryCreatedBy

is optional
type: string
defined in Content

xdm:repositoryCreatedBy Type

string

xdm:repositoryLastModifiedBy

ID of the user who initiated the action that most recently caused the resource to be modified in the repository.

xdm:repositoryLastModifiedBy

is optional
type: string
defined in Content

xdm:repositoryLastModifiedBy Type

string

xmp:artboards

Artboards

Contains the artboards that are being used in the document. A document can have multiple artboards.

xmp:artboards

is optional
type: Artboard
defined in this schema

xmp:artboards Type

Array type: Artboard

All items must be of the type:

Artboard – https://ns.adobe.com/xdm/assets/artboard

xmp:createDate

Date Created

The date and time the resource was created. It will be taken from within the asset.

xmp:createDate

is optional
type: string
defined in this schema

xmp:createDate Type

string

format: date-time – date and time (according to RFC 3339, section 5.6)

xmp:creatorTool

Creator Tool

Name of the application which authored the asset. It takes the value present in xmp:CreatorTool property in XMP. 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.

xmp:creatorTool

is optional
type: string
defined in this schema

xmp:creatorTool Type

string

xmp:fonts

Fonts

This is a list of fonts and typefaces that are used in the document. The order of fonts does not matter.

xmp:fonts

is optional
type: reference
defined in this schema

xmp:fonts Type

Array type: reference

All items must be of the type:

– https://ns.adobe.com/xdm/assets/font#/definitions/font

xmp:keywords

Keywords

The keywords property is used to track human-assigned descriptive phrases like keywords or tags of an asset. Rather than a plan list of tags, it is a structured set of keywords, where keywords can have an explicit importance ranking and a locale. This allows the management of multi-lingual keywords for a given asset. For machine-generated keywords, use the machineKeywords property.

xmp:keywords

is optional
type: array
defined in this schema

xmp:keywords Type

Array type: array

All items must be of the type: Unknown type ``.

{
  "type": "array",
  "title": "Keywords",
  "items": {
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Keyword",
    "description": "The `Keyword` schema describes a keyword in a list of keywords, with specific locale and importance relative to other keywords in the same list.",
    "properties": {
      "value": {
        "title": "Value",
        "description": "The keyword itself. A keyword can be considered like a tag, i.e. a short description of the content of the asset.",
        "type": "string"
      },
      "localeCode": {
        "type": "string",
        "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$",
        "description": "Language of the keyword. The locale code should follow [RFC BCP 47](https://tools.ietf.org/html/bcp47)",
        "examples": [
          "en-US",
          "de-CH"
        ]
      },
      "importance": {
        "type": "number",
        "title": "Importance",
        "minimum": 0,
        "maximum": 1,
        "description": "The importance of the keyword on a scale from zero to one. If required repository will infer it as per its policies and add it for the keywords"
      }
    },
    "required": [
      "value"
    ],
    "simpletype": "complex"
  },
  "description": "The `keywords` property is used to track human-assigned descriptive phrases like keywords or tags of an asset. Rather than a plan list of tags, it is a structured set of keywords, where keywords can have an explicit importance ranking and a locale. This allows the management of multi-lingual keywords for a given asset. For machine-generated keywords, use the `machineKeywords` property. ",
  "simpletype": "`array`"
}

The Keyword schema describes a keyword in a list of keywords, with specific locale and importance relative to other keywords in the same list.

xmp:layers

xmp:layers

is optional
type: complex
defined in this schema

xmp:layers Type

Unknown type ``.

{
  "properties": {
    "xdm:name": {
      "type": "string",
      "title": "Name",
      "description": "Name of the Layer Group. This will be visible to the user and users can specify names that can help them to identify different Layer Groups"
    },
    "xdm:layers": {
      "name": "Layers",
      "description": "The layers or layer groups contained in this layer group.",
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "#/definitions/layer-group"
          },
          {
            "$ref": "https://ns.adobe.com/xdm/assets/layer#/definitions/layer"
          }
        ]
      }
    }
  },
  "simpletype": "complex"
}

xmp:machineKeywords

The machineKeywords property is used to track machine-assigned descriptive phrases like keywords or tags of an asset. Rather than a plan list of tags, it is a structured set of keywords, where keywords can have an explicit confidence ranking and a locale. For human-defined keywords, use the keywords property.

xmp:machineKeywords

is optional
type: object[]
defined in this schema

xmp:machineKeywords Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
`algorithm`	string	Optional
`confidence`	number	Optional
`localeCode`	string	Optional
`value`	string	Optional

algorithm

Name of the algorithm which generated the keyword.

algorithm

is optional
type: string

algorithm Type

string

confidence

Confidence of the algorithm that this keyword is applicable to the asset. Confidence values are numbers between zero and one. A value of .95 indicates that the algorithm expects less than 5% of all tags with the same confidence value to be mis-applied, i.e. not to be a proper description of the asset.

confidence

is optional
type: number

confidence Type

number

minimum value: 0
maximum value: 1

localeCode

Language of the keyword. The locale code should follow RFC BCP47

localeCode

is optional
type: string

localeCode Type

string

All instances must conform to this regular expression (test examples here):

^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

value

The keyword itself. A keyword can be considered like a tag, i.e. a short description of the content of the asset.

value

is optional
type: string

value Type

string

xmp:modifyDate

Mofification Date

The date and time when asset was last modified. The Date Time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". Opposed to repositoryLastModifiedDate, this is the time when the asset was last modified locally, with or without knowledge of the repository.

xmp:modifyDate

is optional
type: string
defined in this schema

xmp:modifyDate Type

string

format: date-time – date and time (according to RFC 3339, section 5.6)

xmp:rating

Rating

A user-assigned editable rating for this file. The value shall be -1 or in the range [0..5], where -1 indicates “rejected” and 0 indicates “unrated”. If xmp:Rating is not present, a value of 0 should be assumed. NOTE: Anticipated usage is for a typical “star rating” UI, with the addition of a notion of rejection.

xmp:rating

is optional
type: enum
defined in this schema

The value of this property must be equal to one of the known values below.

xmp:rating Known Values

Value	Description
`0`
`1`	⭑
`2`	⭑⭑
`3`	⭑⭑⭑
`4`	⭑⭑⭑⭑
`5`	⭑⭑⭑⭑⭑
`-1`	rejected

xmpMM:history

History

High-level actions that resulted in the creation of this asset. It is intended to give human readers a description of the steps taken to make the changes from the previous version to this one. The list should be at an abstract level; it is not intended to be an exhaustive keystroke or other detailed history. The description should be sufficient for metadata management, as well as for workflow enhancement.

xmpMM:history

is optional
type: reference
defined in this schema

xmpMM:history Type

Array type: reference

All items must be of the type:

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

xmpMM:manageTo

Manage To

A URI identifying the managed resource to the asset management system; the presence of this property is the formal indication that this resource is managed. The form and content of this URI is private to the asset management system.

xmpMM:manageTo

is optional
type: string
defined in this schema

xmpMM:manageTo Type

string

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

xmpMM:manageUI

Manage UI

A URI that can be used to access information about the managed resource through a web browser.

xmpMM:manageUI

is optional
type: string
defined in this schema

xmpMM:manageUI Type

string

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

xmpRights:marked

Marked

When true, indicates that this is a rights-managed resource. When false, indicates that this is a public-domain resource. Omit if the state is unknown.

xmpRights:marked

is optional
type: boolean
defined in this schema

xmpRights:marked Type

boolean

xmpRights:usageTerms

Usage Terms

A collection of text instructions on how a resource can be legally used, given in a variety of languages.

xmpRights:usageTerms

is optional
type: reference
defined in this schema

xmpRights:usageTerms Type

Array type: reference

All items must be of the type:

– https://ns.adobe.com/xdm/assets/language-alternative#/definitions/language-alternative

xmpRights:webStatement

A Web URL for a statement of the ownership and usage rights for this resource. This is a normal (non-URI) simple value because of historical usage.

xmpRights:webStatement

is optional
type: string
defined in this schema

xmpRights:webStatement Type

string

xmpRights:webStatement Example

"http://creativecommons.org/licenses/by/4.0/"

xmpTPg:NPages

Number of pages

The number of pages in the document (including any in contained documents).

xmpTPg:NPages

is optional
type: integer
defined in this schema

xmpTPg:NPages Type

integer

minimum value: 0

Files

asset.schema.md

Latest commit

History

asset.schema.md

File metadata and controls

Asset Schema

Schema Hierarchy

Asset Example

Asset Properties

@id

@id Type

_embedded

_embedded Type

_links

_links Type

cc:attributionName

Attribution Name

cc:attributionName Type

cc:attributionUrl

Attribution URL

cc:attributionUrl Type

cc:license

License

cc:license Type

dc:creator

Creator

dc:creator Type

dc:description

Description

dc:description Type

dc:format

Format

dc:format Type

dc:format Example

dc:language

Language

dc:language Type

dc:language Examples

dc:rights

Rights

dc:rights Type

dc:subject

Subject

dc:subject Type

dc:title

Title

dc:title Type

exif:gpsAltitude

GPS Altitude

exif:gpsAltitude Type

exif:gpsAltitudeRef

GPS Altitude Reference

exif:gpsAltitudeRef Known Values

exif:gpsLatitude

GPS Latitude

exif:gpsLatitude Type

exif:gpsLongitude

GPS Longitude

exif:gpsLongitude Type

photoshop:credit

Credit

photoshop:credit Type

plus:copyrightOwner

Copyright Owners

plus:copyrightOwner Type

plus:copyrightOwnerID

Copyright Owner ID

plus:copyrightOwnerID Type

plus:copyrightOwnerName

Copyright Owner Name

plus:copyrightOwnerName Type

repo:createDate

repo:createDate Type

repo:createDate Example

repo:etag

ETag

repo:etag Type

repo:id

repo:id Type