JSON Schema: Top_container

URI Template

/repositories/:repo_id/top_containers

Properties

- (string) uri

- (string (max length: 255)) indicator

- (string) type

- (string (max length: 255)) barcode

- (string) display_string

- (string) long_display_string

- (string) subcontainer_barcodes

- (string (max length: 255)) ils_holding_id

- (string (max length: 255)) ils_item_id

- (string) exported_to_ils

- (string) internal_note

- (boolean) restricted

- (string (max length: 255)) created_for_collection

- (boolean) is_linked_to_published_record

- (array (JSONModel(:rights_restriction) object)) active_restrictions

- (array (JSONModel(:container_location) object)) container_locations

- (object) container_profile

- (array (Object (ref, display_string, identifier, level_display_string, publish, _resolved))) series

- (array (Object (ref, display_string, identifier, _resolved))) collection

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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'common/schemas/top_container.rb', line 1

{
  :schema => {
    "$schema" => "http://www.archivesspace.org/archivesspace.json",
    "version" => 1,
    "type" => "object",
    "uri" => "/repositories/:repo_id/top_containers",

    "properties" => {

      "uri" => {"type" => "string", "required" => false},

      "indicator" => {"type" => "string", "maxLength" => 255, "minLength" => 1, "ifmissing" => "error" },
      "type" => {"type" => "string", "dynamic_enum" => "container_type", "required" => false},
      "barcode" => {"type" => "string", "maxLength" => 255},

      "display_string" => {"type" => "string", "readonly" => true},
      "long_display_string" => {"type" => "string", "readonly" => true},

      "subcontainer_barcodes" => {"type" => "string", "required" => false},

      "ils_holding_id" => {"type" => "string", "maxLength" => 255, "required" => false},
      "ils_item_id" => {"type" => "string", "maxLength" => 255, "required" => false},
      "exported_to_ils" => {"type" => "string", "required" => false},
      "internal_note" => {"type" => "string", "required" => false},

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

      "created_for_collection" => {"type" => "string", "maxLength" => 255, "required" => false},

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

      "active_restrictions" => {
        "type" => "array",
        "readonly" => "true",
        "items" => {"type" => "JSONModel(:rights_restriction) object"},
      },


      "container_locations" => {
        "type" => "array",
        "items" => {
          "type" => "JSONModel(:container_location) object",
        }
      },

      "container_profile" => {
        "type" => "object",
        "subtype" => "ref",
        "properties" => {
          "ref" => {"type" => "JSONModel(:container_profile) uri"},
          "_resolved" => {
            "type" => "object",
            "readonly" => "true"
          }
        }
      },

      "series" => {
        "readonly" => "true",
        "type" => "array",
        "items" => {
          "type" => "object",
          "subtype" => "ref",
          "properties" => {
            "ref" => {
              "type" => "JSONModel(:archival_object) uri",
            },
            "display_string" => {"type" => "string"},
            "identifier" => {"type" => "string"},
            "level_display_string" => {"type" => "string"},
            "publish" => {"type" => "boolean"},
            "_resolved" => {
              "type" => "object",
              "readonly" => "true"
            }
          }
        }
      },

      "collection" => {
        "readonly" => "true",
        "type" => "array",
        "items" => {
          "type" => "object",
          "subtype" => "ref",
          "properties" => {
            "ref" => {
              "type" => [
                {"type" => "JSONModel(:resource) uri"},
                {"type" => "JSONModel(:accession) uri"}
              ]
            },
            "display_string" => {"type" => "string"},
            "identifier" => {"type" => "string"},
            "_resolved" => {
              "type" => "object",
              "readonly" => "true"
            }
          }
        }
      }
    }
  }
}

Plain Text Version