JSON Schema: Event

URI Template

/repositories/:repo_id/events

Properties

- (string) uri

- (string) refid

- (array (JSONModel(:external_id) object)) external_ids

- (array (JSONModel(:external_document) object)) external_documents

- (string) event_type

- (JSONModel(:date) object) date

- (string) timestamp

- (string) outcome

- (string (max length: 16384)) outcome_note

- (boolean) suppressed

- (array (Object (role, ref, _resolved))) linked_agents

- (array (Object (role, ref, _resolved))) linked_records

View Source 


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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'common/schemas/event.rb', line 1

{
  :schema => {
    "$schema" => "http://www.archivesspace.org/archivesspace.json",
    "version" => 1,
    "type" => "object",
    "uri" => "/repositories/:repo_id/events",
    "properties" => {
      "uri" => {"type" => "string", "required" => false},

      "refid" => {"type" => "string"},
      "external_ids" => {"type" => "array", "items" => {"type" => "JSONModel(:external_id) object"}},
      "external_documents" => {"type" => "array", "items" => {"type" => "JSONModel(:external_document) object"}},

      "event_type" => {
        "type" => "string",
        "ifmissing" => "error",
        "dynamic_enum" => "event_event_type"
      },

      "date" => {"type" => "JSONModel(:date) object"},
      "timestamp" => {"type" => "string"},
      "outcome" => {"type" => "string", "dynamic_enum" => "event_outcome"},
      "outcome_note" => {"type" => "string", "maxLength" => 16384},

      "suppressed" => {"type" => "boolean"},

      "linked_agents" => {
        "type" => "array",
        "ifmissing" => "error",
        "minItems" => 1,
        "items" => {
          "type" => "object",
          "subtype" => "ref",
          "properties" => {
            "role" => {
              "type" => "string",
              "dynamic_enum" => "linked_agent_event_roles",
              "ifmissing" => "error",
            },
            "ref" => {"type" => [
                                 {"type" => "JSONModel(:agent_corporate_entity) uri"},
                                 {"type" => "JSONModel(:agent_family) uri"},
                                 {"type" => "JSONModel(:agent_person) uri"},
                                 {"type" => "JSONModel(:agent_software) uri"}],
              "ifmissing" => "error"},
            "_resolved" => {
              "type" => "object",
              "readonly" => "true"
            }
          }
        }
      },

      "linked_records" => {
        "type" => "array",
        "ifmissing" => "error",
        "minItems" => 1,
        "items" => {
          "type" => "object",
          "subtype" => "ref",
          "properties" => {
            "role" => {
              "type" => "string",
              "dynamic_enum" => "linked_event_archival_record_roles",
              "ifmissing" => "error",
            },
            "ref" => {
              "type" => [{"type" => "JSONModel(:agent_person) uri"},
                         {"type" => "JSONModel(:agent_family) uri"},
                         {"type" => "JSONModel(:agent_corporate_entity) uri"},
                         {"type" => "JSONModel(:agent_software) uri"},
                         {"type" => "JSONModel(:accession) uri"},
                         {"type" => "JSONModel(:resource) uri"},
                         {"type" => "JSONModel(:digital_object) uri"},
                         {"type" => "JSONModel(:archival_object) uri"},
                         {"type" => "JSONModel(:digital_object_component) uri"},
                         {"type" => "JSONModel(:top_container) uri"}],
              "ifmissing" => "error"
            },
            "_resolved" => {
              "type" => "object",
              "readonly" => "true"
            }
          }
        }
      },

      "suppressed" => {"type" => "boolean", "readonly" => "true"},
    },
  }
}

Plain Text Version