Skip to content

Latest commit

 

History

History
179 lines (98 loc) · 4.91 KB

auditable.schema.md

File metadata and controls

179 lines (98 loc) · 4.91 KB

Audit Trail Schema

https://ns.adobe.com/xdm/common/auditable

Inheriting this schema using allOf indicates that the data record is auditable, i.e. it can be determined when the record has last been modified and by whom.

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

Schema Hierarchy

  • Audit Trail https://ns.adobe.com/xdm/common/auditable

Audit Trail Example

{
  "repo:createdDate": "2018-01-12T15:52:25+00:00",
  "repo:lastModifiedDate": "2018-01-12T15:52:25+00:00",
  "xdm:repositoryCreatedBy": "jsmith",
  "xdm:repositoryLastModifiedBy": "jsmith",
  "xdm:createdByBatchID": "https://data.adobe.io/batchid-123",
  "xdm:modifiedByBatchID": "https://data.adobe.io/batchid-456"
}

Audit Trail Properties

Property Type Required Defined by
repo:createDate string Optional Common Properties
repo:lastModifiedDate string Optional Common Properties
xdm:createdByBatchID string Optional Audit Trail (this schema)
xdm:modifiedByBatchID string Optional Audit Trail (this schema)
xdm:repositoryCreatedBy string Optional Audit Trail (this schema)
xdm:repositoryLastModifiedBy string Optional Audit Trail (this schema)
* any Additional this schema allows additional properties

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: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

repo:lastModifiedDate Type

string

repo:lastModifiedDate Example

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

xdm:createdByBatchID

Created by Batch Identifier

The Data Set Files in Catalog Services which has been originating the creation of the entity.

xdm:createdByBatchID

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

xdm:createdByBatchID Type

string

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

xdm:modifiedByBatchID

Modified by Batch Identifier

The last Data Set Files in Catalog Services which has modified the entity. At creation time, modifiedByBatchID is set as createdByBatchID.

xdm:modifiedByBatchID

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

xdm:modifiedByBatchID Type

string

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

xdm:repositoryCreatedBy

Created by User Identifier

User id who has created the entity.

xdm:repositoryCreatedBy

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

xdm:repositoryCreatedBy Type

string

xdm:repositoryLastModifiedBy

Modified by User Identifier

User id who last modified the entity. At creation time, modifiedByUser is set as createdByUser.

xdm:repositoryLastModifiedBy

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

xdm:repositoryLastModifiedBy Type

string