auditable.schema.json

{
  "meta:license": [
    "Copyright 2017 Adobe Systems Incorporated. All rights reserved.",
    "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
    "you may not use this file except in compliance with the License. You may obtain a copy",
    "of the License at https://creativecommons.org/licenses/by/4.0/"
  ],
  "$id": "https://ns.adobe.com/xdm/common/auditable",
  "$schema": "http://json-schema.org/draft-06/schema#",
  "title": "Audit Trail",
  "type": "object",
  "meta:extends": ["http://ns.adobe.com/adobecloud/core/1.0"],
  "meta:abstract": true,
  "description":
    "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.",
  "definitions": {
    "auditlog": {
      "properties": {
        "xdm:repositoryCreatedBy": {
          "title": "Created by User Identifier",
          "type": "string",
          "description": "User id who has created the entity.\n"
        },
        "xdm:repositoryLastModifiedBy": {
          "title": "Modified by User Identifier",
          "type": "string",
          "description":
            "User id who last modified the entity.\nAt creation time, `modifiedByUser` is set as `createdByUser`.\n"
        },
        "xdm:createdByBatchID": {
          "title": "Created by Batch Identifier",
          "type": "string",
          "format": "uri",
          "description":
            "The Data Set Files in Catalog Services which has been originating the creation of the entity.\n"
        },
        "xdm:modifiedByBatchID": {
          "title": "Modified by Batch Identifier",
          "type": "string",
          "format": "uri",
          "description":
            "The last Data Set Files in Catalog Services which has modified the entity.\nAt creation time, `modifiedByBatchID` is set as `createdByBatchID`.\n"
        }
      }
    }
  },
  "allOf": [
    {
      "$ref": "#/definitions/auditlog"
    },
    {
      "$ref":
        "http://ns.adobe.com/adobecloud/core/1.0#/definitions/date-properties"
    }
  ],
  "meta:status": "experimental"
}