Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Settings application UI preview:

localauthoritydefinition.PNGNew mod-inventory-storage API to store local authority files:

 /local-authority-file (GET/POST/PUT)


Code Block
themeDJango
borderStyledashed
titleLocal Authority Source File Example (hridSettings)
collapsetrue
{
 
  "id": "cb58492d-018e-442d-9ce3-35aabfc524aa",

   "name": "Test",
    "type": "Subjects",
  "codes": [
    "loc"
  ],
  "hridSetting": {
    "prefix": "localloc",
    "startWithstartNumber": "000000001"
  },
  "source": "local"
}


Code Block
themeDJango
borderStyledashed
titleLocal Authority Source File Schema (hridSetting)
collapsetrue
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "An Authority localsource file",
  "type": "object",
  "properties": {
    "id": {
      "description": "unique ID of the Authority localsource file; a UUID",
      "$ref": "uuid.json"
    },
    "name": {
      "type": "string",
      "description": "Authority localsource file name"
    },
    "typecodes": {
      "type" : "stringarray",
      "description": "TypeList of authority records stored in local file"
    },identifying prefix",
      "prefixitems": {
        "type": "string",
        "description": "Assign local file prefix"identifying prefix, i.e. 'n', 'D', 'fst'"
      }
    },
    "startWithtype": {
      "type": "string",
      "description": "Assign local file start with valueType of authority records stored in source file"
    },
    "metadatabaseUrl": {
      "type": "objectstring",
      "$refdescription": "raml-util/schemas/metadata.schema",
      "readonly": trueBase URL of the source file origin"
    }
,
 },   "additionalPropertieshridSetting": false,{
  "required": [     "namedescription",
:    "type",
    "prefix",
    "startWith""The HRID settings for source file",
  ] }
Code Block
themeDJango
borderStyledashed
titleLocal Authority Files Schema
collapsetrue
{   "$schematype": "http://json-schema.org/draft-04/schema#object",
  "description": "A collection of Authority local files",
  "type"$ref": "objecthridsetting.json",
   "properties": { },
    "authorityLocalFilessource": {
      "descriptiontype": "List of Authority local filesstring",
      "iddescription": "authorityLocalFile",
      "type": "arraylabel indicating where the authority source file entry originates from, i.e. 'folio' or 'local'",
      "itemsenum": {[
        "type": "objectfolio",
        "$reflocal":
"authoritylocalfile.json"       }]
    },
    "totalRecordsmetadata": {
      "descriptiontype": "object"Estimated,
  or exact total number of records"$ref": "raml-util/schemas/metadata.schema",
      "typereadonly": "integer"true
    }
  },
  "additionalProperties": false,
  "required": [
    "authorityLocalFiles"name",
    "codes",
    "type",
    "totalRecordssource"
  ]
} 


Link authority local file to the authority (data-import-processing-core)

...