Skip to content

auditable.schema.md

Latest commit

 

History

History
173 lines (96 loc) · 4.76 KB

auditable.schema.md

File metadata and controls

173 lines (96 loc) · 4.76 KB

Audit trail Schema

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

The audit trail schema indicates a data record is auditable. For example, who and when the record was last modified.

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

Schema Hierarchy

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

Audit trail Example

{
  "repo:createDate": "2018-01-12T15:52:25+00:00",
  "repo:modifyDate": "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:modifyDate 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: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"

xdm:createdByBatchID

Created by batch identifier

The dataset files in Catalog which has been originating the creation of the record.

xdm:createdByBatchID

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

xdm:createdByBatchID Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

xdm:modifiedByBatchID

Modified by batch identifier

The last dataset files in Catalog which has modified the record. At creation time, modifiedByBatchID is set as createdByBatchID.

xdm:modifiedByBatchID

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

xdm:modifiedByBatchID Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

xdm:repositoryCreatedBy

Created by user identifier

User ID of who created the record.

xdm:repositoryCreatedBy

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

xdm:repositoryCreatedBy Type

string

xdm:repositoryLastModifiedBy

Modified by user identifier

User ID of who last modified the record. At creation time, modifiedByUser is set as createdByUser.

xdm:repositoryLastModifiedBy

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

xdm:repositoryLastModifiedBy Type

string