Skip to content

Latest commit

 

History

History
698 lines (389 loc) · 17.3 KB

aggregated-asset.schema.md

File metadata and controls

698 lines (389 loc) · 17.3 KB

Aggregated Asset Schema

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

This schema aggregates all asset sub-schemas that are supported by XDM.

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

Schema Hierarchy

  • Aggregated Asset https://ns.adobe.com/xdm/assets/aggregated-asset

Aggregated Asset Example

{
  "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab",
  "xmp:createDate": "2017-09-26T15:52:25+00:00",
  "repo:createDate": "2017-09-26T15:52:25+00:00",
  "xdm:repositoryCreatedBy": "lars",
  "xmp:modifyDate": "2017-09-26T15:52:25+00:00",
  "repo:modifyDate": "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"
}

Aggregated Asset Properties

Property Type Required Defined by
_embedded object Optional HAL Resource
_links object Optional HAL Resource
dc:format string Optional Common Properties
photoshop:ICCProfile string Optional Image
photoshop:colorMode enum Optional Image
plus:copyrightOwnerID string Optional Copyright Owner
plus:copyrightOwnerName string Optional Copyright Owner
repo:createDate string Optional Common Properties
repo:createdBy string Optional Asset
repo:etag string Optional Asset
repo:id string Optional Asset
repo:modifiedBy string Optional Asset
repo:modifyDate string Optional Common Properties
repo:name string Optional Common Properties
repo:path string Optional Common Properties
repo:size integer Optional Asset
repo:version string Optional Asset
tiff:XResolution object Optional Image
tiff:YResolution object Optional Image
tiff:imageLength integer Optional Simple Rectangular Area
tiff:imageWidth integer Optional Simple Rectangular Area
tiff:orientation integer Optional Image
tiff:resolutionUnit enum Optional Image
xdm:aspectRatio number Optional Simple Rectangular Area
xdm:extent integer Optional Video
xmpDM:videoFrameRate string Optional Video
* any Additional this schema allows additional properties

_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

_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

_links Type

object with following properties:

Property Type Required

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

dc:format Type

string

All instances must conform to this regular expression

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

dc:format Example

"application/vnd.adobe.photoshop"

photoshop:ICCProfile

ICC Profile

The ICC color profile, such as AppleRGB, AdobeRGB1998.

photoshop:ICCProfile

  • is optional
  • type: string
  • defined in Image

photoshop:ICCProfile Type

string

photoshop:ICCProfile Known Values

Value Description
0 ColorMatchRGB
1 AppleRGB
2 AdobeRGB1998
3 JapanColor2002Newspaper
4 USSheetfedUncoated
5 JapanColor2001Uncoated
6 CoatedFOGRA27
7 UncoatedFOGRA29
8 USWebCoatedSWOP
9 JapanColor2001Coated
10 JapanWebCoated
11 WebCoatedFOGRA28
12 USWebUncoated
13 CoatedFOGRA39
14 USSheetfedCoated

photoshop:colorMode

Color Mode

The color mode or image mode determines how colors combine based on the number of channels in a color model. Different color modes result in different levels of color detail and file size. For instance, use CMYK color mode for images in a full-color print brochure, and use RGB color mode for images in web or e-mail to reduce file size while maintaining color integrity.

photoshop:colorMode

  • is optional
  • type: enum
  • defined in Image

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

photoshop:colorMode Known Values

Value Description
0 Bitmap
1 Gray scale
2 Indexed color
3 RGB color
4 CMYK color
7 Multi-channel
8 Duotone
9 LAB color

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

plus:copyrightOwnerID Type

string

plus:copyrightOwnerName

Copyright Owner Name

Name of Copyright Owner.

plus:copyrightOwnerName

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

repo:createDate Type

string

repo:createDate Example

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

repo:createdBy

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

repo:createdBy

  • is optional
  • type: string
  • defined in Asset

repo:createdBy Type

string

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 optional
  • 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 optional
  • type: string
  • defined in Asset

repo:id Type

string

repo:id Example

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

repo:modifiedBy

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

repo:modifiedBy

  • is optional
  • type: string
  • defined in Asset

repo:modifiedBy Type

string

repo:modifyDate

The server date and time when the resource was last 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:modifyDate

repo:modifyDate Type

string

repo:modifyDate Example

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

repo:name

repo:name

repo:name Type

string

repo:path

repo:path

repo:path Type

string

repo:size

Size

Size of the asset in bytes.

repo:size

  • is optional
  • type: integer
  • defined in Asset

repo:size Type

integer

  • minimum value: 0

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 optional
  • type: string
  • defined in Asset

repo:version Type

string

tiff:XResolution

X-Resolution

Horizontal resolution in pixels per resolutionUnit.

tiff:XResolution

  • is optional
  • type: object
  • defined in Image

tiff:XResolution Type

object with following properties:

Property Type Required

tiff:YResolution

Y-Resolution

Vertical resolution in pixels per resolutionUnit.

tiff:YResolution

  • is optional
  • type: object
  • defined in Image

tiff:YResolution Type

object with following properties:

Property Type Required

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

tiff:imageLength Type

integer

  • minimum value: 0

tiff:imageWidth

Width

Width in pixels.

tiff:imageWidth

tiff:imageWidth Type

integer

  • minimum value: 0

tiff:orientation

Orientation

The orientation of the image. Following values are permitted:

  • 1 = Horizontal (normal)
  • 2 = Mirror horizontal
  • 3 = Rotate 180 degrees
  • 4 = Mirror vertical
  • 5 = Mirror horizontal and rotate 270 degrees clockwise
  • 6 = Rotate 90 degrees clockwise
  • 7 = Mirror horizontal and rotate 90 degrees clockwise
  • 8 = Rotate 270 degrees clockwise.

tiff:orientation

  • is optional
  • type: integer
  • defined in Image

tiff:orientation Type

integer

  • minimum value: 1
  • maximum value: 8

tiff:orientation Known Values

Value Description
1 Horizontal (normal)
2 Mirror horizontal
3 Rotate 180 degrees
4 Mirror vertical
5 Mirror horizontal and rotate 270 degrees clockwise
6 Rotate 90 degrees clockwise
7 Mirror horizontal and rotate 90 degrees clockwise
8 Rotate 270 degrees clockwise

tiff:resolutionUnit

Resolution Unit

Unit used for XResolution and YRresolution. Possible values are 2 (inches) and 3 (centimeters).

tiff:resolutionUnit

  • is optional
  • type: enum
  • defined in Image

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

tiff:resolutionUnit Known Values

Value Description
2 inches
3 centimeters

xdm:aspectRatio

Aspect Ratio

Describes the proportional relationship between the width and the height. To determine the aspect ratio, divide width by height. Media that have an aspect ratio smaller than one are in landscape format, media that have an aspect ratio greater than one are in portrait format.

xdm:aspectRatio

xdm:aspectRatio Type

number

  • minimum value: 0

xdm:extent

Duration

The duration of the video in milliseconds. This property is inspired by dc:extent. However, dc:extent does not specify units. core:extent is always an integer and describes the duration in milliseconds.

xdm:extent

  • is optional
  • type: integer
  • defined in Video

xdm:extent Type

integer

xmpDM:videoFrameRate

Frame Rate

The video frame rate in frames per second (FPS). Predefined values include: -24 -NTSC -PAL Other values must include f and the integer value of the frame rate. Optionally, s and the integer value of the rate basis may be included.

These examples show common video and audio frame rates:

  • Film at 24 fps (frame rate = 24, rate basis = 1): f24
  • Speech-to-text in milliseconds (frame rate = 1000, rate basis = 1): f1000
  • NTSC at 29.97 fps (frame rate = 30000, rate basis = 1001): f30000s1001.

xmpDM:videoFrameRate

  • is optional
  • type: string
  • defined in Video

xmpDM:videoFrameRate Type

string

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

((f\d+(s\d+)?)|PAL|NTSC|24)