xdm/docs/reference/datatypes/auditable.schema.json at master · RussStringham/xdm · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
{
    "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:abstract": true,
    "description": "The audit trail schema indicates a data record is auditable. For example, who and when the record was last modified.",
    "definitions": {
        "auditlog": {
            "properties": {
                "xdm:repositoryCreatedBy": {
                    "title": "Created by user identifier",
                    "type": "string",
                    "description": "User ID of who created the record."
                },
                "xdm:repositoryLastModifiedBy": {
                    "title": "Modified by user identifier",
                    "type": "string",
                    "description": "User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`."
                },
                "xdm:createdByBatchID": {
                    "title": "Created by batch identifier",
                    "type": "string",
                    "format": "uri-reference",
                    "description": "The dataset files in Catalog which has been originating the creation of the record."
                },
                "xdm:modifiedByBatchID": {
                    "title": "Modified by batch identifier",
                    "type": "string",
                    "format": "uri-reference",
                    "description": "The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`."
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/auditlog"
        },
        {
            "$ref": "http://ns.adobe.com/adobecloud/core/1.0#/definitions/date-properties"
        }
    ],
    "meta:status": "stable",
    "examples": [
        {
            "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"
        }
    ]
}