Source Record Storage Record API (v2.0)

http://localhost

Table of contents

Source Record Storage Record API

API for managing records

Records

API for managing Records

POST /source-storage/records

Create a new record item.

POST /source-storage/records
Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Record DTO Schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "UUID",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "snapshotId": {
      "description": "Corresponding snapshot id, which is the same as jobExecutionId",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "matchedId": {
      "description": "Represents relations with another matched records, necessary for saving the history of applying changes for inventory/holding/etc records",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "generation": {
      "description": "Generation from the last record with the same matchedId incremented by 1. Starts from 0.",
      "type": "integer"
    },
    "recordType": {
      "description": "Type of record, e.g. MARC",
      "type": "string",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "enum": [
        "MARC_BIB",
        "MARC_AUTHORITY",
        "MARC_HOLDING",
        "EDIFACT"
      ]
    },
    "rawRecord": {
      "description": "Raw record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "content": {
          "description": "Raw data",
          "type": "string"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content"
      ],
      "required": [
        "content"
      ]
    },
    "parsedRecord": {
      "description": "Parsed record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "content": {
          "description": "Parsed record content, e.g. MARC record"
        },
        "formattedContent": {
          "description": "Parsed content represented in human readable form",
          "type": "string"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content",
        "formattedContent"
      ],
      "required": [
        "content"
      ]
    },
    "errorRecord": {
      "description": "Error record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "description": {
          "description": "Error description",
          "type": "string"
        },
        "content": {
          "description": "Record content"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content"
      ],
      "required": [
        "description",
        "content"
      ]
    },
    "deleted": {
      "description": "Flag indicates that the record marked as deleted",
      "type": "boolean",
      "default": false
    },
    "order": {
      "description": "Order of the record in imported file",
      "type": "integer",
      "minimum": 0
    },
    "externalIdsHolder": {
      "description": "Container for identifiers of external entities",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "instanceId": {
          "description": "instance id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "instanceHrid": {
          "description": "instance hrid",
          "type": "string"
        },
        "holdingsId": {
          "description": "holdings id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "holdingsHrid": {
          "description": "holdings hrid",
          "type": "string"
        },
        "authorityId": {
          "description": "authority id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "authorityHrid": {
          "description": "authority hrid",
          "type": "string"
        }
      }
    },
    "additionalInfo": {
      "description": "Auxiliary data which is not related to MARC type record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "suppressDiscovery": {
          "description": "Flag indicates if the record is displayed during a search",
          "type": "boolean",
          "default": false
        }
      }
    },
    "state": {
      "description": "This field represents the actual state of a particular SRS record. Can be: ACTUAL, OLD, DRAFT, DELETED. ",
      "type": "string",
      "enum": [
        "ACTUAL",
        "OLD",
        "DRAFT",
        "DELETED"
      ],
      "default": "ACTUAL"
    },
    "leaderRecordStatus": {
      "description": "Single character representing MARC leader 05",
      "type": "string",
      "pattern": "^[a|c|d|n|p|o|s|x]{1}$"
    },
    "metadata": {
      "description": "Metadata provided by the server",
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "required": [
    "snapshotId",
    "matchedId",
    "recordType",
    "rawRecord"
  ]
}

Example:

{
  "id": "67dfac11-1caf-4470-9ad1-d533f6360bdd",
  "snapshotId": "11dfac11-1caf-4470-9ad1-d533f6360bdd",
  "matchedId": "c9db5b04-e1d4-11e8-9f32-f2801f1b9fd1",
  "generation": 1,
  "recordType": "MARC",
  "state": "ACTUAL",
  "leaderRecordStatus": "c",
  "rawRecord": {
    "id": "67dfac11-1caf-4470-9ad1-d533f6360bdd",
    "content": "01542ccm a2200361   4500001000700000005001700007008004100024010001900065035002000084035001100104040002300115041001900138045000900157047007500166050001400241100004200255240001000297245016700307246002400474260003600498300002500534505031400559650001600873650002300889650004900912650004200961902002301003905002101026948004201047948002701089948002701116948003701143\u001e393893\u001e20141107001016.0\u001e830419m19559999gw mua   hiz   n    lat  \u001e  \u001fa   55001156/M \u001e  \u001fa(OCoLC)63611770\u001e  \u001fa393893\u001e  \u001fcUPB\u001fdUPB\u001fdNIC\u001fdNIC\u001e0 \u001falatitager\u001fgger\u001e  \u001fav6v9\u001e  \u001facn\u001fact\u001faco\u001fadf\u001fadv\u001faft\u001fafg\u001fams\u001fami\u001fanc\u001faop\u001faov\u001farq\u001fasn\u001fasu\u001fasy\u001favr\u001fazz\u001e0 \u001faM3\u001fb.M896\u001e1 \u001faMozart, Wolfgang Amadeus,\u001fd1756-1791.\u001e10\u001faWorks\u001e10\u001faNeue Ausgabe sämtlicher Werke,\u001fbin Verbindung mit den Mozartstädten, Augsburg, Salzburg und Wien.\u001fcHrsg. von der Internationalen Stiftung Mozarteum, Salzburg.\u001e33\u001faNeue Mozart-Ausgabe\u001e  \u001faKassel,\u001fbBärenreiter,\u001fcc1955-\u001e  \u001fav.\u001fbfacsims.\u001fc33 cm.\u001e0 \u001faSer. I. Geistliche Gesangswerke -- Ser. II. Opern -- Ser. III. Lieder, mehrstimmige Gesänge, Kanons -- Ser. IV. Orchesterwerke -- Ser. V. Konzerte -- Ser. VI. Kirchensonaten -- Ser. VII. Ensemblemusik für grössere Solobesetzungen -- Ser. VIII. Kammermusik -- Ser. IX. Klaviermusik -- Ser. X. Supplement.\u001e 0\u001faVocal music\u001e 0\u001faInstrumental music\u001e 7\u001faInstrumental music\u001f2fast\u001f0(OCoLC)fst00974414\u001e 7\u001faVocal music\u001f2fast\u001f0(OCoLC)fst01168379\u001e  \u001fapfnd\u001fbAustin Music\u001e  \u001fa19980728120000.0\u001e1 \u001fa20100622\u001fbs\u001fdlap11\u001felts\u001fxToAddCatStat\u001e0 \u001fa20110818\u001fbr\u001fdnp55\u001felts\u001e2 \u001fa20130128\u001fbm\u001fdbmt1\u001felts\u001e2 \u001fa20141106\u001fbm\u001fdbatch\u001felts\u001fxaddfast\u001e\u001d"
  },
  "parsedRecord": {
    "id": "67dfac11-1caf-4470-9ad1-d533f6360bdd",
    "content": {
      "leader": "01542ccm a2200361   4500",
      "fields": [
        {
          "001": "393893"
        },
        {
          "005": "20141107001016.0"
        },
        {
          "008": "830419m19559999gw mua   hiz   n    lat  "
        },
        {
          "010": {
            "subfields": [
              {
                "a": "   55001156/M "
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "035": {
            "subfields": [
              {
                "a": "(OCoLC)63611770"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "035": {
            "subfields": [
              {
                "a": "393893"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "040": {
            "subfields": [
              {
                "c": "UPB"
              },
              {
                "d": "UPB"
              },
              {
                "d": "NIC"
              },
              {
                "d": "NIC"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "041": {
            "subfields": [
              {
                "a": "latitager"
              },
              {
                "g": "ger"
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "045": {
            "subfields": [
              {
                "a": "v6v9"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "047": {
            "subfields": [
              {
                "a": "cn"
              },
              {
                "a": "ct"
              },
              {
                "a": "co"
              },
              {
                "a": "df"
              },
              {
                "a": "dv"
              },
              {
                "a": "ft"
              },
              {
                "a": "fg"
              },
              {
                "a": "ms"
              },
              {
                "a": "mi"
              },
              {
                "a": "nc"
              },
              {
                "a": "op"
              },
              {
                "a": "ov"
              },
              {
                "a": "rq"
              },
              {
                "a": "sn"
              },
              {
                "a": "su"
              },
              {
                "a": "sy"
              },
              {
                "a": "vr"
              },
              {
                "a": "zz"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "050": {
            "subfields": [
              {
                "a": "M3"
              },
              {
                "b": ".M896"
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "100": {
            "subfields": [
              {
                "a": "Mozart, Wolfgang Amadeus,"
              },
              {
                "d": "1756-1791."
              }
            ],
            "ind1": "1",
            "ind2": " "
          }
        },
        {
          "240": {
            "subfields": [
              {
                "a": "Works"
              }
            ],
            "ind1": "1",
            "ind2": "0"
          }
        },
        {
          "245": {
            "subfields": [
              {
                "a": "Neue Ausgabe sa\\u0308mtlicher Werke, "
              },
              {
                "b": "in Verbindung mit den Mozartsta\\u0308dten, Augsburg, Salzburg und Wien."
              },
              {
                "c": "Hrsg. von der Internationalen Stiftung Mozarteum, Salzburg."
              }
            ],
            "ind1": "1",
            "ind2": "0"
          }
        },
        {
          "246": {
            "subfields": [
              {
                "a": "Neue Mozart-Ausgabe"
              }
            ],
            "ind1": "3",
            "ind2": "3"
          }
        },
        {
          "260": {
            "subfields": [
              {
                "a": "Kassel,"
              },
              {
                "b": "Ba\\u0308renreiter,"
              },
              {
                "c": "c1955-"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "300": {
            "subfields": [
              {
                "a": "v."
              },
              {
                "b": "facsims."
              },
              {
                "c": "33 cm."
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "505": {
            "subfields": [
              {
                "a": "Ser. I. Geistliche Gesangswerke -- Ser. II. Opern -- Ser. III. Lieder, mehrstimmige Gesa\\u0308nge, Kanons -- Ser. IV. Orchesterwerke -- Ser. V. Konzerte -- Ser. VI. Kirchensonaten -- Ser. VII. Ensemblemusik fu\\u0308r gro\\u0308ssere Solobesetzungen -- Ser. VIII. Kammermusik -- Ser. IX. Klaviermusik -- Ser. X. Supplement."
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Vocal music"
              }
            ],
            "ind1": " ",
            "ind2": "0"
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Instrumental music"
              }
            ],
            "ind1": " ",
            "ind2": "0"
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Instrumental music"
              },
              {
                "2": "fast"
              },
              {
                "0": "(OCoLC)fst00974414"
              }
            ],
            "ind1": " ",
            "ind2": "7"
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Vocal music"
              },
              {
                "2": "fast"
              },
              {
                "0": "(OCoLC)fst01168379"
              }
            ],
            "ind1": " ",
            "ind2": "7"
          }
        },
        {
          "902": {
            "subfields": [
              {
                "a":"pfnd"
              },
              {
                "b":"Austin Music"
              }
            ],
            "ind1":" ",
            "ind2":" "
          }
        },
        {
          "905": {
            "subfields": [
              {
                "a":"19980728120000.0"
              }
            ],
            "ind1":" ",
            "ind2":" "
          }
        },
        {
          "948": {
            "subfields": [
              {
                "a": "20100622"
              },
              {
                "b": "s"
              },
              {
                "d": "lap11"
              },
              {
                "e": "lts"
              },
              {
                "x": "ToAddCatStat"
              }
            ],
            "ind1": "1",
            "ind2": " "
          }
        },
        {
          "948": {
            "subfields": [
              {
                "a": "20110818"
              },
              {
                "b": "r"
              },
              {
                "d": "np55"
              },
              {
                "e": "lts"
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "948": {
            "subfields": [
              {
                 "a": "20130128"
              },
              {
                 "b": "m"
              },
              {
                 "d": "bmt1"
              },
              {
                 "e": "lts"
              }
            ],
            "ind1": "2",
            "ind2": " "
          }
        },
        {
          "948": {
            "subfields": [
              {
                 "a": "20141106"
              },
              {
                 "b": "m"
              },
              {
                 "d": "batch"
              },
              {
                 "e": "lts"
              },
              {
                 "x": "addfast"
              }
            ],
            "ind1": "2",
            "ind2": " "
          }
        }
      ],
      "formattedContent": "LEADER 01542ccm a2200361   4500\u000a001 393893\u000a005 20141107001016.0\u000a008 830419m19559999gw mua   hiz   n    lat  \u000a010   \u0024a   55001156/M \u000a035   \u0024a(OCoLC)63611770\u000a035   \u0024a393893\u000a040   \u0024cUPB\u0024dUPB\u0024dNIC\u0024dNIC\u000a041 0 \u0024alatitager\u0024gger\u000a045   \u0024av6v9\u000a047   \u0024acn\u0024act\u0024aco\u0024adf\u0024adv\u0024aft\u0024afg\u0024ams\u0024ami\u0024anc\u0024aop\u0024aov\u0024arq\u0024asn\u0024asu\u0024asy\u0024avr\u0024azz\u000a050 0 \u0024aM3\u0024b.M896\u000a100 1 \u0024aMozart, Wolfgang Amadeus,\u0024d1756-1791.\u000a240 10\u0024aWorks\u000a245 10\u0024aNeue Ausgabe sämtlicher Werke,\u0024bin Verbindung mit den Mozartstädten, Augsburg, Salzburg und Wien.\u0024cHrsg. von der Internationalen Stiftung Mozarteum, Salzburg.\u000a246 33\u0024aNeue Mozart-Ausgabe\u000a260   \u0024aKassel,\u0024bBärenreiter,\u0024cc1955-\u000a300   \u0024av.\u0024bfacsims.\u0024c33 cm.\u000a505 0 \u0024aSer. I. Geistliche Gesangswerke -- Ser. II. Opern -- Ser. III. Lieder, mehrstimmige Gesänge, Kanons -- Ser. IV. Orchesterwerke -- Ser. V. Konzerte -- Ser. VI. Kirchensonaten -- Ser. VII. Ensemblemusik für grössere Solobesetzungen -- Ser. VIII. Kammermusik -- Ser. IX. Klaviermusik -- Ser. X. Supplement.\u000a650  0\u0024aVocal music\u000a650  0\u0024aInstrumental music\u000a650  7\u0024aInstrumental music\u00242fast\u00240(OCoLC)fst00974414\u000a650  7\u0024aVocal music\u00242fast\u00240(OCoLC)fst01168379\u000a902   \u0024apfnd\u0024bAustin Music\u000a905   \u0024a19980728120000.0\u000a948 1 \u0024a20100622\u0024bs\u0024dlap11\u0024elts\u0024xToAddCatStat\u000a948 0 \u0024a20110818\u0024br\u0024dnp55\u0024elts\u000a948 2 \u0024a20130128\u0024bm\u0024dbmt1\u0024elts\u000a948 2 \u0024a20141106\u0024bm\u0024dbatch\u0024elts\u0024xaddfas"
    }
  },
  "externalIdsHolder": {
      "instanceId": "54cc0262-76df-4cac-acca-b10e9bc5c79a"
  },
  "deleted": false,
  "order": 0,
  "additionalInfo": {
    "suppressDiscovery": false
  }
}

Response 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers
  • Location: required (string)

    URI to the created record item

Body

Media type: application/json

Type: any

Example:

{
  "id": "67dfac11-1caf-4470-9ad1-d533f6360bdd",
  "snapshotId": "11dfac11-1caf-4470-9ad1-d533f6360bdd",
  "matchedId": "c9db5b04-e1d4-11e8-9f32-f2801f1b9fd1",
  "generation": 1,
  "recordType": "MARC",
  "state": "ACTUAL",
  "leaderRecordStatus": "c",
  "rawRecord": {
    "id": "67dfac11-1caf-4470-9ad1-d533f6360bdd",
    "content": "01542ccm a2200361   4500001000700000005001700007008004100024010001900065035002000084035001100104040002300115041001900138045000900157047007500166050001400241100004200255240001000297245016700307246002400474260003600498300002500534505031400559650001600873650002300889650004900912650004200961902002301003905002101026948004201047948002701089948002701116948003701143\u001e393893\u001e20141107001016.0\u001e830419m19559999gw mua   hiz   n    lat  \u001e  \u001fa   55001156/M \u001e  \u001fa(OCoLC)63611770\u001e  \u001fa393893\u001e  \u001fcUPB\u001fdUPB\u001fdNIC\u001fdNIC\u001e0 \u001falatitager\u001fgger\u001e  \u001fav6v9\u001e  \u001facn\u001fact\u001faco\u001fadf\u001fadv\u001faft\u001fafg\u001fams\u001fami\u001fanc\u001faop\u001faov\u001farq\u001fasn\u001fasu\u001fasy\u001favr\u001fazz\u001e0 \u001faM3\u001fb.M896\u001e1 \u001faMozart, Wolfgang Amadeus,\u001fd1756-1791.\u001e10\u001faWorks\u001e10\u001faNeue Ausgabe sämtlicher Werke,\u001fbin Verbindung mit den Mozartstädten, Augsburg, Salzburg und Wien.\u001fcHrsg. von der Internationalen Stiftung Mozarteum, Salzburg.\u001e33\u001faNeue Mozart-Ausgabe\u001e  \u001faKassel,\u001fbBärenreiter,\u001fcc1955-\u001e  \u001fav.\u001fbfacsims.\u001fc33 cm.\u001e0 \u001faSer. I. Geistliche Gesangswerke -- Ser. II. Opern -- Ser. III. Lieder, mehrstimmige Gesänge, Kanons -- Ser. IV. Orchesterwerke -- Ser. V. Konzerte -- Ser. VI. Kirchensonaten -- Ser. VII. Ensemblemusik für grössere Solobesetzungen -- Ser. VIII. Kammermusik -- Ser. IX. Klaviermusik -- Ser. X. Supplement.\u001e 0\u001faVocal music\u001e 0\u001faInstrumental music\u001e 7\u001faInstrumental music\u001f2fast\u001f0(OCoLC)fst00974414\u001e 7\u001faVocal music\u001f2fast\u001f0(OCoLC)fst01168379\u001e  \u001fapfnd\u001fbAustin Music\u001e  \u001fa19980728120000.0\u001e1 \u001fa20100622\u001fbs\u001fdlap11\u001felts\u001fxToAddCatStat\u001e0 \u001fa20110818\u001fbr\u001fdnp55\u001felts\u001e2 \u001fa20130128\u001fbm\u001fdbmt1\u001felts\u001e2 \u001fa20141106\u001fbm\u001fdbatch\u001felts\u001fxaddfast\u001e\u001d"
  },
  "parsedRecord": {
    "id": "67dfac11-1caf-4470-9ad1-d533f6360bdd",
    "content": {
      "leader": "01542ccm a2200361   4500",
      "fields": [
        {
          "001": "393893"
        },
        {
          "005": "20141107001016.0"
        },
        {
          "008": "830419m19559999gw mua   hiz   n    lat  "
        },
        {
          "010": {
            "subfields": [
              {
                "a": "   55001156/M "
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "035": {
            "subfields": [
              {
                "a": "(OCoLC)63611770"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "035": {
            "subfields": [
              {
                "a": "393893"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "040": {
            "subfields": [
              {
                "c": "UPB"
              },
              {
                "d": "UPB"
              },
              {
                "d": "NIC"
              },
              {
                "d": "NIC"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "041": {
            "subfields": [
              {
                "a": "latitager"
              },
              {
                "g": "ger"
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "045": {
            "subfields": [
              {
                "a": "v6v9"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "047": {
            "subfields": [
              {
                "a": "cn"
              },
              {
                "a": "ct"
              },
              {
                "a": "co"
              },
              {
                "a": "df"
              },
              {
                "a": "dv"
              },
              {
                "a": "ft"
              },
              {
                "a": "fg"
              },
              {
                "a": "ms"
              },
              {
                "a": "mi"
              },
              {
                "a": "nc"
              },
              {
                "a": "op"
              },
              {
                "a": "ov"
              },
              {
                "a": "rq"
              },
              {
                "a": "sn"
              },
              {
                "a": "su"
              },
              {
                "a": "sy"
              },
              {
                "a": "vr"
              },
              {
                "a": "zz"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "050": {
            "subfields": [
              {
                "a": "M3"
              },
              {
                "b": ".M896"
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "100": {
            "subfields": [
              {
                "a": "Mozart, Wolfgang Amadeus,"
              },
              {
                "d": "1756-1791."
              }
            ],
            "ind1": "1",
            "ind2": " "
          }
        },
        {
          "240": {
            "subfields": [
              {
                "a": "Works"
              }
            ],
            "ind1": "1",
            "ind2": "0"
          }
        },
        {
          "245": {
            "subfields": [
              {
                "a": "Neue Ausgabe sa\\u0308mtlicher Werke, "
              },
              {
                "b": "in Verbindung mit den Mozartsta\\u0308dten, Augsburg, Salzburg und Wien."
              },
              {
                "c": "Hrsg. von der Internationalen Stiftung Mozarteum, Salzburg."
              }
            ],
            "ind1": "1",
            "ind2": "0"
          }
        },
        {
          "246": {
            "subfields": [
              {
                "a": "Neue Mozart-Ausgabe"
              }
            ],
            "ind1": "3",
            "ind2": "3"
          }
        },
        {
          "260": {
            "subfields": [
              {
                "a": "Kassel,"
              },
              {
                "b": "Ba\\u0308renreiter,"
              },
              {
                "c": "c1955-"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "300": {
            "subfields": [
              {
                "a": "v."
              },
              {
                "b": "facsims."
              },
              {
                "c": "33 cm."
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "505": {
            "subfields": [
              {
                "a": "Ser. I. Geistliche Gesangswerke -- Ser. II. Opern -- Ser. III. Lieder, mehrstimmige Gesa\\u0308nge, Kanons -- Ser. IV. Orchesterwerke -- Ser. V. Konzerte -- Ser. VI. Kirchensonaten -- Ser. VII. Ensemblemusik fu\\u0308r gro\\u0308ssere Solobesetzungen -- Ser. VIII. Kammermusik -- Ser. IX. Klaviermusik -- Ser. X. Supplement."
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Vocal music"
              }
            ],
            "ind1": " ",
            "ind2": "0"
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Instrumental music"
              }
            ],
            "ind1": " ",
            "ind2": "0"
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Instrumental music"
              },
              {
                "2": "fast"
              },
              {
                "0": "(OCoLC)fst00974414"
              }
            ],
            "ind1": " ",
            "ind2": "7"
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Vocal music"
              },
              {
                "2": "fast"
              },
              {
                "0": "(OCoLC)fst01168379"
              }
            ],
            "ind1": " ",
            "ind2": "7"
          }
        },
        {
          "902": {
            "subfields": [
              {
                "a":"pfnd"
              },
              {
                "b":"Austin Music"
              }
            ],
            "ind1":" ",
            "ind2":" "
          }
        },
        {
          "905": {
            "subfields": [
              {
                "a":"19980728120000.0"
              }
            ],
            "ind1":" ",
            "ind2":" "
          }
        },
        {
          "948": {
            "subfields": [
              {
                "a": "20100622"
              },
              {
                "b": "s"
              },
              {
                "d": "lap11"
              },
              {
                "e": "lts"
              },
              {
                "x": "ToAddCatStat"
              }
            ],
            "ind1": "1",
            "ind2": " "
          }
        },
        {
          "948": {
            "subfields": [
              {
                "a": "20110818"
              },
              {
                "b": "r"
              },
              {
                "d": "np55"
              },
              {
                "e": "lts"
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "948": {
            "subfields": [
              {
                 "a": "20130128"
              },
              {
                 "b": "m"
              },
              {
                 "d": "bmt1"
              },
              {
                 "e": "lts"
              }
            ],
            "ind1": "2",
            "ind2": " "
          }
        },
        {
          "948": {
            "subfields": [
              {
                 "a": "20141106"
              },
              {
                 "b": "m"
              },
              {
                 "d": "batch"
              },
              {
                 "e": "lts"
              },
              {
                 "x": "addfast"
              }
            ],
            "ind1": "2",
            "ind2": " "
          }
        }
      ],
      "formattedContent": "LEADER 01542ccm a2200361   4500\u000a001 393893\u000a005 20141107001016.0\u000a008 830419m19559999gw mua   hiz   n    lat  \u000a010   \u0024a   55001156/M \u000a035   \u0024a(OCoLC)63611770\u000a035   \u0024a393893\u000a040   \u0024cUPB\u0024dUPB\u0024dNIC\u0024dNIC\u000a041 0 \u0024alatitager\u0024gger\u000a045   \u0024av6v9\u000a047   \u0024acn\u0024act\u0024aco\u0024adf\u0024adv\u0024aft\u0024afg\u0024ams\u0024ami\u0024anc\u0024aop\u0024aov\u0024arq\u0024asn\u0024asu\u0024asy\u0024avr\u0024azz\u000a050 0 \u0024aM3\u0024b.M896\u000a100 1 \u0024aMozart, Wolfgang Amadeus,\u0024d1756-1791.\u000a240 10\u0024aWorks\u000a245 10\u0024aNeue Ausgabe sämtlicher Werke,\u0024bin Verbindung mit den Mozartstädten, Augsburg, Salzburg und Wien.\u0024cHrsg. von der Internationalen Stiftung Mozarteum, Salzburg.\u000a246 33\u0024aNeue Mozart-Ausgabe\u000a260   \u0024aKassel,\u0024bBärenreiter,\u0024cc1955-\u000a300   \u0024av.\u0024bfacsims.\u0024c33 cm.\u000a505 0 \u0024aSer. I. Geistliche Gesangswerke -- Ser. II. Opern -- Ser. III. Lieder, mehrstimmige Gesänge, Kanons -- Ser. IV. Orchesterwerke -- Ser. V. Konzerte -- Ser. VI. Kirchensonaten -- Ser. VII. Ensemblemusik für grössere Solobesetzungen -- Ser. VIII. Kammermusik -- Ser. IX. Klaviermusik -- Ser. X. Supplement.\u000a650  0\u0024aVocal music\u000a650  0\u0024aInstrumental music\u000a650  7\u0024aInstrumental music\u00242fast\u00240(OCoLC)fst00974414\u000a650  7\u0024aVocal music\u00242fast\u00240(OCoLC)fst01168379\u000a902   \u0024apfnd\u0024bAustin Music\u000a905   \u0024a19980728120000.0\u000a948 1 \u0024a20100622\u0024bs\u0024dlap11\u0024elts\u0024xToAddCatStat\u000a948 0 \u0024a20110818\u0024br\u0024dnp55\u0024elts\u000a948 2 \u0024a20130128\u0024bm\u0024dbmt1\u0024elts\u000a948 2 \u0024a20141106\u0024bm\u0024dbatch\u0024elts\u0024xaddfas"
    }
  },
  "externalIdsHolder": {
      "instanceId": "54cc0262-76df-4cac-acca-b10e9bc5c79a"
  },
  "deleted": false,
  "order": 0,
  "additionalInfo": {
    "suppressDiscovery": false
  }
}

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to add record -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create records -- unauthorized

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /source-storage/records

Retrieve a list of record items.

GET /source-storage/records
Query Parameters
  • snapshotId: (string)

    Filter by Snapshot Id

    Example:

    e5ddbbdc-90b3-498f-bb8f-49367ca4c142
  • recordType: required (string - default: MARC_BIB)

    Filter by Record Type

    Example:

    MARC_BIB
  • state: (string)

    Filter by State

    Example:

    ACTUAL
  • orderBy: (array of string)

    Sort Records

    Example:

    [
      "order,ASC"
    ]
  • totalRecords: (string - default: auto - pattern: exact|estimated|none|auto)

    How to calculate the totalRecords property. "exact" for the correct number, "estimated" for an estimation, "auto" to automatically select "exact" or "estimated", "none" for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords

    Example:

    none
  • offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)

    Skip over a number of elements by specifying an offset value for the query

    Example:

    0
  • limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)

    Limit the number of elements returned in the response

    Example:

    10

Response 200

Returns a list of record items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of record DTO",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "records": {
      "description": "List of records",
      "type": "array",
      "id": "recordList",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Record DTO Schema",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "UUID",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "snapshotId": {
            "description": "Corresponding snapshot id, which is the same as jobExecutionId",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "matchedId": {
            "description": "Represents relations with another matched records, necessary for saving the history of applying changes for inventory/holding/etc records",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "generation": {
            "description": "Generation from the last record with the same matchedId incremented by 1. Starts from 0.",
            "type": "integer"
          },
          "recordType": {
            "description": "Type of record, e.g. MARC",
            "type": "string",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "additionalProperties": false,
            "enum": [
              "MARC_BIB",
              "MARC_AUTHORITY",
              "MARC_HOLDING",
              "EDIFACT"
            ]
          },
          "rawRecord": {
            "description": "Raw record",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "additionalProperties": false,
            "properties": {
              "id": {
                "description": "UUID",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "id": "uuid.schema",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
              },
              "content": {
                "description": "Raw data",
                "type": "string"
              }
            },
            "excludedFromEqualsAndHashCode": [
              "content"
            ],
            "required": [
              "content"
            ]
          },
          "parsedRecord": {
            "description": "Parsed record",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "additionalProperties": false,
            "properties": {
              "id": {
                "description": "UUID",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "id": "uuid.schema",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
              },
              "content": {
                "description": "Parsed record content, e.g. MARC record"
              },
              "formattedContent": {
                "description": "Parsed content represented in human readable form",
                "type": "string"
              }
            },
            "excludedFromEqualsAndHashCode": [
              "content",
              "formattedContent"
            ],
            "required": [
              "content"
            ]
          },
          "errorRecord": {
            "description": "Error record",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "additionalProperties": false,
            "properties": {
              "id": {
                "description": "UUID",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "id": "uuid.schema",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
              },
              "description": {
                "description": "Error description",
                "type": "string"
              },
              "content": {
                "description": "Record content"
              }
            },
            "excludedFromEqualsAndHashCode": [
              "content"
            ],
            "required": [
              "description",
              "content"
            ]
          },
          "deleted": {
            "description": "Flag indicates that the record marked as deleted",
            "type": "boolean",
            "default": false
          },
          "order": {
            "description": "Order of the record in imported file",
            "type": "integer",
            "minimum": 0
          },
          "externalIdsHolder": {
            "description": "Container for identifiers of external entities",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "additionalProperties": false,
            "properties": {
              "instanceId": {
                "description": "instance id",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "id": "uuid.schema",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
              },
              "instanceHrid": {
                "description": "instance hrid",
                "type": "string"
              },
              "holdingsId": {
                "description": "holdings id",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "id": "uuid.schema",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
              },
              "holdingsHrid": {
                "description": "holdings hrid",
                "type": "string"
              },
              "authorityId": {
                "description": "authority id",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "id": "uuid.schema",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
              },
              "authorityHrid": {
                "description": "authority hrid",
                "type": "string"
              }
            }
          },
          "additionalInfo": {
            "description": "Auxiliary data which is not related to MARC type record",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "properties": {
              "suppressDiscovery": {
                "description": "Flag indicates if the record is displayed during a search",
                "type": "boolean",
                "default": false
              }
            }
          },
          "state": {
            "description": "This field represents the actual state of a particular SRS record. Can be: ACTUAL, OLD, DRAFT, DELETED. ",
            "type": "string",
            "enum": [
              "ACTUAL",
              "OLD",
              "DRAFT",
              "DELETED"
            ],
            "default": "ACTUAL"
          },
          "leaderRecordStatus": {
            "description": "Single character representing MARC leader 05",
            "type": "string",
            "pattern": "^[a|c|d|n|p|o|s|x]{1}$"
          },
          "metadata": {
            "description": "Metadata provided by the server",
            "type": "object",
            "readonly": true,
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "metadata.schema",
            "title": "Metadata Schema",
            "properties": {
              "createdDate": {
                "description": "Date and time when the record was created",
                "type": "string",
                "format": "date-time"
              },
              "createdByUserId": {
                "description": "ID of the user who created the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "createdByUsername": {
                "description": "Username of the user who created the record (when available)",
                "type": "string"
              },
              "updatedDate": {
                "description": "Date and time when the record was last updated",
                "type": "string",
                "format": "date-time"
              },
              "updatedByUserId": {
                "description": "ID of the user who last updated the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "updatedByUsername": {
                "description": "Username of the user who last updated the record (when available)",
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "createdDate"
            ]
          }
        },
        "required": [
          "snapshotId",
          "matchedId",
          "recordType",
          "rawRecord"
        ]
      }
    },
    "totalRecords": {
      "description": "Total number of records",
      "type": "integer"
    }
  },
  "excludedFromEqualsAndHashCode": [
    "totalRecords"
  ],
  "required": [
    "records",
    "totalRecords"
  ]
}

Example:

{
  "records": [
    {
      "id": "67dfac11-1caf-4470-9ad1-d533f6360bdd",
      "snapshotId": "11dfac11-1caf-4470-9ad1-d533f6360bdd",
      "matchedId": "c9db5b04-e1d4-11e8-9f32-f2801f1b9fd1",
      "generation": 1,
      "state": "ACTUAL",
      "recordType": "MARC",
      "rawRecord": {
        "id": "67dfac11-1caf-4470-9ad1-d533f6360bdd",
        "content": "01542ccm a2200361   4500001000700000005001700007008004100024010001900065035002000084035001100104040002300115041001900138045000900157047007500166050001400241100004200255240001000297245016700307246002400474260003600498300002500534505031400559650001600873650002300889650004900912650004200961902002301003905002101026948004201047948002701089948002701116948003701143\u001e393893\u001e20141107001016.0\u001e830419m19559999gw mua   hiz   n    lat  \u001e  \u001fa   55001156/M \u001e  \u001fa(OCoLC)63611770\u001e  \u001fa393893\u001e  \u001fcUPB\u001fdUPB\u001fdNIC\u001fdNIC\u001e0 \u001falatitager\u001fgger\u001e  \u001fav6v9\u001e  \u001facn\u001fact\u001faco\u001fadf\u001fadv\u001faft\u001fafg\u001fams\u001fami\u001fanc\u001faop\u001faov\u001farq\u001fasn\u001fasu\u001fasy\u001favr\u001fazz\u001e0 \u001faM3\u001fb.M896\u001e1 \u001faMozart, Wolfgang Amadeus,\u001fd1756-1791.\u001e10\u001faWorks\u001e10\u001faNeue Ausgabe sämtlicher Werke,\u001fbin Verbindung mit den Mozartstädten, Augsburg, Salzburg und Wien.\u001fcHrsg. von der Internationalen Stiftung Mozarteum, Salzburg.\u001e33\u001faNeue Mozart-Ausgabe\u001e  \u001faKassel,\u001fbBärenreiter,\u001fcc1955-\u001e  \u001fav.\u001fbfacsims.\u001fc33 cm.\u001e0 \u001faSer. I. Geistliche Gesangswerke -- Ser. II. Opern -- Ser. III. Lieder, mehrstimmige Gesänge, Kanons -- Ser. IV. Orchesterwerke -- Ser. V. Konzerte -- Ser. VI. Kirchensonaten -- Ser. VII. Ensemblemusik für grössere Solobesetzungen -- Ser. VIII. Kammermusik -- Ser. IX. Klaviermusik -- Ser. X. Supplement.\u001e 0\u001faVocal music\u001e 0\u001faInstrumental music\u001e 7\u001faInstrumental music\u001f2fast\u001f0(OCoLC)fst00974414\u001e 7\u001faVocal music\u001f2fast\u001f0(OCoLC)fst01168379\u001e  \u001fapfnd\u001fbAustin Music\u001e  \u001fa19980728120000.0\u001e1 \u001fa20100622\u001fbs\u001fdlap11\u001felts\u001fxToAddCatStat\u001e0 \u001fa20110818\u001fbr\u001fdnp55\u001felts\u001e2 \u001fa20130128\u001fbm\u001fdbmt1\u001felts\u001e2 \u001fa20141106\u001fbm\u001fdbatch\u001felts\u001fxaddfast\u001e\u001d"
      },
      "parsedRecord": {
        "id": "67dfac11-1caf-4470-9ad1-d533f6360bdd",
        "content": {
          "leader": "01542ccm a2200361   4500",
          "fields": [
            {
              "001": "393893"
            },
            {
              "005": "20141107001016.0"
            },
            {
              "008": "830419m19559999gw mua   hiz   n    lat  "
            },
            {
              "010": {
                "subfields": [
                  {
                    "a": "   55001156/M "
                  }
                ],
                "ind1": " ",
                "ind2": " "
              }
            },
            {
              "035": {
                "subfields": [
                  {
                    "a": "(OCoLC)63611770"
                  }
                ],
                "ind1": " ",
                "ind2": " "
              }
            },
            {
              "035": {
                "subfields": [
                  {
                    "a": "393893"
                  }
                ],
                "ind1": " ",
                "ind2": " "
              }
            },
            {
              "040": {
                "subfields": [
                  {
                    "c": "UPB"
                  },
                  {
                    "d": "UPB"
                  },
                  {
                    "d": "NIC"
                  },
                  {
                    "d": "NIC"
                  }
                ],
                "ind1": " ",
                "ind2": " "
              }
            },
            {
              "041": {
                "subfields": [
                  {
                    "a": "latitager"
                  },
                  {
                    "g": "ger"
                  }
                ],
                "ind1": "0",
                "ind2": " "
              }
            },
            {
              "045": {
                "subfields": [
                  {
                    "a": "v6v9"
                  }
                ],
                "ind1": " ",
                "ind2": " "
              }
            },
            {
              "047": {
                "subfields": [
                  {
                    "a": "cn"
                  },
                  {
                    "a": "ct"
                  },
                  {
                    "a": "co"
                  },
                  {
                    "a": "df"
                  },
                  {
                    "a": "dv"
                  },
                  {
                    "a": "ft"
                  },
                  {
                    "a": "fg"
                  },
                  {
                    "a": "ms"
                  },
                  {
                    "a": "mi"
                  },
                  {
                    "a": "nc"
                  },
                  {
                    "a": "op"
                  },
                  {
                    "a": "ov"
                  },
                  {
                    "a": "rq"
                  },
                  {
                    "a": "sn"
                  },
                  {
                    "a": "su"
                  },
                  {
                    "a": "sy"
                  },
                  {
                    "a": "vr"
                  },
                  {
                    "a": "zz"
                  }
                ],
                "ind1": " ",
                "ind2": " "
              }
            },
            {
              "050": {
                "subfields": [
                  {
                    "a": "M3"
                  },
                  {
                    "b": ".M896"
                  }
                ],
                "ind1": "0",
                "ind2": " "
              }
            },
            {
              "100": {
                "subfields": [
                  {
                    "a": "Mozart, Wolfgang Amadeus,"
                  },
                  {
                    "d": "1756-1791."
                  }
                ],
                "ind1": "1",
                "ind2": " "
              }
            },
            {
              "240": {
                "subfields": [
                  {
                    "a": "Works"
                  }
                ],
                "ind1": "1",
                "ind2": "0"
              }
            },
            {
              "245": {
                "subfields": [
                  {
                    "a": "Neue Ausgabe sa\\u0308mtlicher Werke, "
                  },
                  {
                    "b": "in Verbindung mit den Mozartsta\\u0308dten, Augsburg, Salzburg und Wien."
                  },
                  {
                    "c": "Hrsg. von der Internationalen Stiftung Mozarteum, Salzburg."
                  }
                ],
                "ind1": "1",
                "ind2": "0"
              }
            },
            {
              "246": {
                "subfields": [
                  {
                    "a": "Neue Mozart-Ausgabe"
                  }
                ],
                "ind1": "3",
                "ind2": "3"
              }
            },
            {
              "260": {
                "subfields": [
                  {
                    "a": "Kassel,"
                  },
                  {
                    "b": "Ba\\u0308renreiter,"
                  },
                  {
                    "c": "c1955-"
                  }
                ],
                "ind1": " ",
                "ind2": " "
              }
            },
            {
              "300": {
                "subfields": [
                  {
                    "a": "v."
                  },
                  {
                    "b": "facsims."
                  },
                  {
                    "c": "33 cm."
                  }
                ],
                "ind1": " ",
                "ind2": " "
              }
            },
            {
              "505": {
                "subfields": [
                  {
                    "a": "Ser. I. Geistliche Gesangswerke -- Ser. II. Opern -- Ser. III. Lieder, mehrstimmige Gesa\\u0308nge, Kanons -- Ser. IV. Orchesterwerke -- Ser. V. Konzerte -- Ser. VI. Kirchensonaten -- Ser. VII. Ensemblemusik fu\\u0308r gro\\u0308ssere Solobesetzungen -- Ser. VIII. Kammermusik -- Ser. IX. Klaviermusik -- Ser. X. Supplement."
                  }
                ],
                "ind1": "0",
                "ind2": " "
              }
            },
            {
              "650": {
                "subfields": [
                  {
                    "a": "Vocal music"
                  }
                ],
                "ind1": " ",
                "ind2": "0"
              }
            },
            {
              "650": {
                "subfields": [
                  {
                    "a": "Instrumental music"
                  }
                ],
                "ind1": " ",
                "ind2": "0"
              }
            },
            {
              "650": {
                "subfields": [
                  {
                    "a": "Instrumental music"
                  },
                  {
                    "2": "fast"
                  },
                  {
                    "0": "(OCoLC)fst00974414"
                  }
                ],
                "ind1": " ",
                "ind2": "7"
              }
            },
            {
              "650": {
                "subfields": [
                  {
                    "a": "Vocal music"
                  },
                  {
                    "2": "fast"
                  },
                  {
                    "0": "(OCoLC)fst01168379"
                  }
                ],
                "ind1": " ",
                "ind2": "7"
              }
            },
            {
              "902": {
                "subfields": [
                  {
                    "a": "pfnd"
                  },
                  {
                    "b": "Austin Music"
                  }
                ],
                "ind1": " ",
                "ind2": " "
              }
            },
            {
              "905": {
                "subfields": [
                  {
                    "a": "19980728120000.0"
                  }
                ],
                "ind1": " ",
                "ind2": " "
              }
            },
            {
              "948": {
                "subfields": [
                  {
                    "a": "20100622"
                  },
                  {
                    "b": "s"
                  },
                  {
                    "d": "lap11"
                  },
                  {
                    "e": "lts"
                  },
                  {
                    "x": "ToAddCatStat"
                  }
                ],
                "ind1": "1",
                "ind2": " "
              }
            },
            {
              "948": {
                "subfields": [
                  {
                    "a": "20110818"
                  },
                  {
                    "b": "r"
                  },
                  {
                    "d": "np55"
                  },
                  {
                    "e": "lts"
                  }
                ],
                "ind1": "0",
                "ind2": " "
              }
            },
            {
              "948": {
                "subfields": [
                  {
                    "a": "20130128"
                  },
                  {
                    "b": "m"
                  },
                  {
                    "d": "bmt1"
                  },
                  {
                    "e": "lts"
                  }
                ],
                "ind1": "2",
                "ind2": " "
              }
            },
            {
              "948": {
                "subfields": [
                  {
                    "a": "20141106"
                  },
                  {
                    "b": "m"
                  },
                  {
                    "d": "batch"
                  },
                  {
                    "e": "lts"
                  },
                  {
                    "x": "addfast"
                  }
                ],
                "ind1": "2",
                "ind2": " "
              }
            }
          ]
        }
      },
      "externalIdsHolder": {
        "instanceId": "54cc0262-76df-4cac-acca-b10e9bc5c79a"
      },
      "deleted": false,
      "order": 0,
      "additionalInfo": {
        "suppressDiscovery": false
      }
    }
  ],
  "totalRecords": 1
}

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

unable to list records -- malformed parameter 'query', syntax error at column 6

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to list records -- unauthorized

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

POST /source-storage/records/matching

Collection of pairs of marc record ID to external entity ID (instance, holdings, authority)

POST /source-storage/records/matching
Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Schema for records matching request",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "logicalOperator": {
      "description": "Logical operator that will be used to combine defined filters",
      "type": "string",
      "enum": [
        "AND",
        "OR"
      ],
      "default": "AND"
    },
    "filters": {
      "description": "Collection of conditions for records matching",
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "values": {
            "description": "Collection of values to match for equality",
            "type": "array",
            "minItems": 1,
            "items": {
              "type": "string"
            }
          },
          "field": {
            "description": "MARC field tag to match",
            "type": "string",
            "pattern": "^[0-9]{3}$"
          },
          "indicator1": {
            "description": "MARC field indicator1 to match. Value can be a lowercase alphabetic, numeric, blank, or * meaning a wildcard",
            "type": "string",
            "pattern": "^[a-z0-9\\s*]?$"
          },
          "indicator2": {
            "description": "MARC field indicator2 to match. Value can be a lowercase alphabetic, numeric, blank, or * meaning a wildcard",
            "type": "string",
            "pattern": "^[a-z0-9\\s*]?$"
          },
          "subfield": {
            "description": "MARC subfield to match, allowed value can be ASCII lowercase alphabetic or numeric character",
            "type": "string",
            "pattern": "^[a-z0-9]?$"
          },
          "matchType": {
            "description": "Match type to consider for the query",
            "type": "string",
            "enum": [
              "EXACTLY_MATCHES",
              "EXISTING_VALUE_CONTAINS_INCOMING_VALUE",
              "INCOMING_VALUE_CONTAINS_EXISTING_VALUE",
              "EXISTING_VALUE_BEGINS_WITH_INCOMING_VALUE",
              "INCOMING_VALUE_BEGINS_WITH_EXISTING_VALUE",
              "EXISTING_VALUE_ENDS_WITH_INCOMING_VALUE",
              "INCOMING_VALUE_ENDS_WITH_EXISTING_VALUE"
            ],
            "default": "EXACTLY_MATCHES"
          },
          "qualifier": {
            "description": "Qualifier for match criteria",
            "type": "string",
            "enum": [
              "BEGINS_WITH",
              "ENDS_WITH",
              "CONTAINS"
            ]
          },
          "qualifierValue": {
            "description": "Value for the qualifier",
            "type": "string"
          },
          "comparisonPartType": {
            "description": "Part of a value to compare",
            "type": "string",
            "enum": [
              "NUMERICS_ONLY",
              "ALPHANUMERICS_ONLY"
            ]
          }
        },
        "required": [
          "field",
          "values"
        ]
      }
    },
    "recordType": {
      "description": "Type of MARC record",
      "type": "string",
      "enum": [
        "MARC_BIB",
        "MARC_AUTHORITY",
        "MARC_HOLDING"
      ]
    },
    "limit": {
      "description": "Limitation of the number of elements returned in the response",
      "type": "integer",
      "minimum": 1,
      "default": 1000
    },
    "offset": {
      "description": "Offset to skip over a number of elements",
      "type": "integer",
      "minimum": 0,
      "default": 0
    },
    "returnTotalRecordsCount": {
      "description": "Indicates whether it is needed to return total count of records matching the specified filters",
      "type": "boolean",
      "default": true
    }
  },
  "required": [
    "filters",
    "recordType"
  ]
}

Response 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of pairs of MARC record id and external entity id",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "identifiers": {
      "description": "List of pairs of records identifiers",
      "type": "array",
      "items": {
        "additionalProperties": false,
        "type": "object",
        "javaType": "org.folio.rest.jaxrs.model.RecordIdentifiersDto",
        "properties": {
          "recordId": {
            "description": "MARC record UUID",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "externalId": {
            "description": "UUID of external entity (instance, holdings, authority)",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          }
        }
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "identifiersPairs",
    "totalRecords"
  ]
}

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

PUT /source-storage/records/{id}

Update record item with given {recordId}

PUT /source-storage/records/{id}
URI Parameters
  • id: required (string)
Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Record DTO Schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "UUID",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "snapshotId": {
      "description": "Corresponding snapshot id, which is the same as jobExecutionId",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "matchedId": {
      "description": "Represents relations with another matched records, necessary for saving the history of applying changes for inventory/holding/etc records",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "generation": {
      "description": "Generation from the last record with the same matchedId incremented by 1. Starts from 0.",
      "type": "integer"
    },
    "recordType": {
      "description": "Type of record, e.g. MARC",
      "type": "string",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "enum": [
        "MARC_BIB",
        "MARC_AUTHORITY",
        "MARC_HOLDING",
        "EDIFACT"
      ]
    },
    "rawRecord": {
      "description": "Raw record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "content": {
          "description": "Raw data",
          "type": "string"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content"
      ],
      "required": [
        "content"
      ]
    },
    "parsedRecord": {
      "description": "Parsed record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "content": {
          "description": "Parsed record content, e.g. MARC record"
        },
        "formattedContent": {
          "description": "Parsed content represented in human readable form",
          "type": "string"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content",
        "formattedContent"
      ],
      "required": [
        "content"
      ]
    },
    "errorRecord": {
      "description": "Error record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "description": {
          "description": "Error description",
          "type": "string"
        },
        "content": {
          "description": "Record content"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content"
      ],
      "required": [
        "description",
        "content"
      ]
    },
    "deleted": {
      "description": "Flag indicates that the record marked as deleted",
      "type": "boolean",
      "default": false
    },
    "order": {
      "description": "Order of the record in imported file",
      "type": "integer",
      "minimum": 0
    },
    "externalIdsHolder": {
      "description": "Container for identifiers of external entities",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "instanceId": {
          "description": "instance id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "instanceHrid": {
          "description": "instance hrid",
          "type": "string"
        },
        "holdingsId": {
          "description": "holdings id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "holdingsHrid": {
          "description": "holdings hrid",
          "type": "string"
        },
        "authorityId": {
          "description": "authority id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "authorityHrid": {
          "description": "authority hrid",
          "type": "string"
        }
      }
    },
    "additionalInfo": {
      "description": "Auxiliary data which is not related to MARC type record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "suppressDiscovery": {
          "description": "Flag indicates if the record is displayed during a search",
          "type": "boolean",
          "default": false
        }
      }
    },
    "state": {
      "description": "This field represents the actual state of a particular SRS record. Can be: ACTUAL, OLD, DRAFT, DELETED. ",
      "type": "string",
      "enum": [
        "ACTUAL",
        "OLD",
        "DRAFT",
        "DELETED"
      ],
      "default": "ACTUAL"
    },
    "leaderRecordStatus": {
      "description": "Single character representing MARC leader 05",
      "type": "string",
      "pattern": "^[a|c|d|n|p|o|s|x]{1}$"
    },
    "metadata": {
      "description": "Metadata provided by the server",
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "required": [
    "snapshotId",
    "matchedId",
    "recordType",
    "rawRecord"
  ]
}

Example:

{
  "id": "67dfac11-1caf-4470-9ad1-d533f6360bdd",
  "snapshotId": "11dfac11-1caf-4470-9ad1-d533f6360bdd",
  "matchedId": "c9db5b04-e1d4-11e8-9f32-f2801f1b9fd1",
  "generation": 1,
  "recordType": "MARC",
  "state": "ACTUAL",
  "leaderRecordStatus": "c",
  "rawRecord": {
    "id": "67dfac11-1caf-4470-9ad1-d533f6360bdd",
    "content": "01542ccm a2200361   4500001000700000005001700007008004100024010001900065035002000084035001100104040002300115041001900138045000900157047007500166050001400241100004200255240001000297245016700307246002400474260003600498300002500534505031400559650001600873650002300889650004900912650004200961902002301003905002101026948004201047948002701089948002701116948003701143\u001e393893\u001e20141107001016.0\u001e830419m19559999gw mua   hiz   n    lat  \u001e  \u001fa   55001156/M \u001e  \u001fa(OCoLC)63611770\u001e  \u001fa393893\u001e  \u001fcUPB\u001fdUPB\u001fdNIC\u001fdNIC\u001e0 \u001falatitager\u001fgger\u001e  \u001fav6v9\u001e  \u001facn\u001fact\u001faco\u001fadf\u001fadv\u001faft\u001fafg\u001fams\u001fami\u001fanc\u001faop\u001faov\u001farq\u001fasn\u001fasu\u001fasy\u001favr\u001fazz\u001e0 \u001faM3\u001fb.M896\u001e1 \u001faMozart, Wolfgang Amadeus,\u001fd1756-1791.\u001e10\u001faWorks\u001e10\u001faNeue Ausgabe sämtlicher Werke,\u001fbin Verbindung mit den Mozartstädten, Augsburg, Salzburg und Wien.\u001fcHrsg. von der Internationalen Stiftung Mozarteum, Salzburg.\u001e33\u001faNeue Mozart-Ausgabe\u001e  \u001faKassel,\u001fbBärenreiter,\u001fcc1955-\u001e  \u001fav.\u001fbfacsims.\u001fc33 cm.\u001e0 \u001faSer. I. Geistliche Gesangswerke -- Ser. II. Opern -- Ser. III. Lieder, mehrstimmige Gesänge, Kanons -- Ser. IV. Orchesterwerke -- Ser. V. Konzerte -- Ser. VI. Kirchensonaten -- Ser. VII. Ensemblemusik für grössere Solobesetzungen -- Ser. VIII. Kammermusik -- Ser. IX. Klaviermusik -- Ser. X. Supplement.\u001e 0\u001faVocal music\u001e 0\u001faInstrumental music\u001e 7\u001faInstrumental music\u001f2fast\u001f0(OCoLC)fst00974414\u001e 7\u001faVocal music\u001f2fast\u001f0(OCoLC)fst01168379\u001e  \u001fapfnd\u001fbAustin Music\u001e  \u001fa19980728120000.0\u001e1 \u001fa20100622\u001fbs\u001fdlap11\u001felts\u001fxToAddCatStat\u001e0 \u001fa20110818\u001fbr\u001fdnp55\u001felts\u001e2 \u001fa20130128\u001fbm\u001fdbmt1\u001felts\u001e2 \u001fa20141106\u001fbm\u001fdbatch\u001felts\u001fxaddfast\u001e\u001d"
  },
  "parsedRecord": {
    "id": "67dfac11-1caf-4470-9ad1-d533f6360bdd",
    "content": {
      "leader": "01542ccm a2200361   4500",
      "fields": [
        {
          "001": "393893"
        },
        {
          "005": "20141107001016.0"
        },
        {
          "008": "830419m19559999gw mua   hiz   n    lat  "
        },
        {
          "010": {
            "subfields": [
              {
                "a": "   55001156/M "
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "035": {
            "subfields": [
              {
                "a": "(OCoLC)63611770"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "035": {
            "subfields": [
              {
                "a": "393893"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "040": {
            "subfields": [
              {
                "c": "UPB"
              },
              {
                "d": "UPB"
              },
              {
                "d": "NIC"
              },
              {
                "d": "NIC"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "041": {
            "subfields": [
              {
                "a": "latitager"
              },
              {
                "g": "ger"
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "045": {
            "subfields": [
              {
                "a": "v6v9"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "047": {
            "subfields": [
              {
                "a": "cn"
              },
              {
                "a": "ct"
              },
              {
                "a": "co"
              },
              {
                "a": "df"
              },
              {
                "a": "dv"
              },
              {
                "a": "ft"
              },
              {
                "a": "fg"
              },
              {
                "a": "ms"
              },
              {
                "a": "mi"
              },
              {
                "a": "nc"
              },
              {
                "a": "op"
              },
              {
                "a": "ov"
              },
              {
                "a": "rq"
              },
              {
                "a": "sn"
              },
              {
                "a": "su"
              },
              {
                "a": "sy"
              },
              {
                "a": "vr"
              },
              {
                "a": "zz"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "050": {
            "subfields": [
              {
                "a": "M3"
              },
              {
                "b": ".M896"
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "100": {
            "subfields": [
              {
                "a": "Mozart, Wolfgang Amadeus,"
              },
              {
                "d": "1756-1791."
              }
            ],
            "ind1": "1",
            "ind2": " "
          }
        },
        {
          "240": {
            "subfields": [
              {
                "a": "Works"
              }
            ],
            "ind1": "1",
            "ind2": "0"
          }
        },
        {
          "245": {
            "subfields": [
              {
                "a": "Neue Ausgabe sa\\u0308mtlicher Werke, "
              },
              {
                "b": "in Verbindung mit den Mozartsta\\u0308dten, Augsburg, Salzburg und Wien."
              },
              {
                "c": "Hrsg. von der Internationalen Stiftung Mozarteum, Salzburg."
              }
            ],
            "ind1": "1",
            "ind2": "0"
          }
        },
        {
          "246": {
            "subfields": [
              {
                "a": "Neue Mozart-Ausgabe"
              }
            ],
            "ind1": "3",
            "ind2": "3"
          }
        },
        {
          "260": {
            "subfields": [
              {
                "a": "Kassel,"
              },
              {
                "b": "Ba\\u0308renreiter,"
              },
              {
                "c": "c1955-"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "300": {
            "subfields": [
              {
                "a": "v."
              },
              {
                "b": "facsims."
              },
              {
                "c": "33 cm."
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "505": {
            "subfields": [
              {
                "a": "Ser. I. Geistliche Gesangswerke -- Ser. II. Opern -- Ser. III. Lieder, mehrstimmige Gesa\\u0308nge, Kanons -- Ser. IV. Orchesterwerke -- Ser. V. Konzerte -- Ser. VI. Kirchensonaten -- Ser. VII. Ensemblemusik fu\\u0308r gro\\u0308ssere Solobesetzungen -- Ser. VIII. Kammermusik -- Ser. IX. Klaviermusik -- Ser. X. Supplement."
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Vocal music"
              }
            ],
            "ind1": " ",
            "ind2": "0"
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Instrumental music"
              }
            ],
            "ind1": " ",
            "ind2": "0"
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Instrumental music"
              },
              {
                "2": "fast"
              },
              {
                "0": "(OCoLC)fst00974414"
              }
            ],
            "ind1": " ",
            "ind2": "7"
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Vocal music"
              },
              {
                "2": "fast"
              },
              {
                "0": "(OCoLC)fst01168379"
              }
            ],
            "ind1": " ",
            "ind2": "7"
          }
        },
        {
          "902": {
            "subfields": [
              {
                "a":"pfnd"
              },
              {
                "b":"Austin Music"
              }
            ],
            "ind1":" ",
            "ind2":" "
          }
        },
        {
          "905": {
            "subfields": [
              {
                "a":"19980728120000.0"
              }
            ],
            "ind1":" ",
            "ind2":" "
          }
        },
        {
          "948": {
            "subfields": [
              {
                "a": "20100622"
              },
              {
                "b": "s"
              },
              {
                "d": "lap11"
              },
              {
                "e": "lts"
              },
              {
                "x": "ToAddCatStat"
              }
            ],
            "ind1": "1",
            "ind2": " "
          }
        },
        {
          "948": {
            "subfields": [
              {
                "a": "20110818"
              },
              {
                "b": "r"
              },
              {
                "d": "np55"
              },
              {
                "e": "lts"
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "948": {
            "subfields": [
              {
                 "a": "20130128"
              },
              {
                 "b": "m"
              },
              {
                 "d": "bmt1"
              },
              {
                 "e": "lts"
              }
            ],
            "ind1": "2",
            "ind2": " "
          }
        },
        {
          "948": {
            "subfields": [
              {
                 "a": "20141106"
              },
              {
                 "b": "m"
              },
              {
                 "d": "batch"
              },
              {
                 "e": "lts"
              },
              {
                 "x": "addfast"
              }
            ],
            "ind1": "2",
            "ind2": " "
          }
        }
      ],
      "formattedContent": "LEADER 01542ccm a2200361   4500\u000a001 393893\u000a005 20141107001016.0\u000a008 830419m19559999gw mua   hiz   n    lat  \u000a010   \u0024a   55001156/M \u000a035   \u0024a(OCoLC)63611770\u000a035   \u0024a393893\u000a040   \u0024cUPB\u0024dUPB\u0024dNIC\u0024dNIC\u000a041 0 \u0024alatitager\u0024gger\u000a045   \u0024av6v9\u000a047   \u0024acn\u0024act\u0024aco\u0024adf\u0024adv\u0024aft\u0024afg\u0024ams\u0024ami\u0024anc\u0024aop\u0024aov\u0024arq\u0024asn\u0024asu\u0024asy\u0024avr\u0024azz\u000a050 0 \u0024aM3\u0024b.M896\u000a100 1 \u0024aMozart, Wolfgang Amadeus,\u0024d1756-1791.\u000a240 10\u0024aWorks\u000a245 10\u0024aNeue Ausgabe sämtlicher Werke,\u0024bin Verbindung mit den Mozartstädten, Augsburg, Salzburg und Wien.\u0024cHrsg. von der Internationalen Stiftung Mozarteum, Salzburg.\u000a246 33\u0024aNeue Mozart-Ausgabe\u000a260   \u0024aKassel,\u0024bBärenreiter,\u0024cc1955-\u000a300   \u0024av.\u0024bfacsims.\u0024c33 cm.\u000a505 0 \u0024aSer. I. Geistliche Gesangswerke -- Ser. II. Opern -- Ser. III. Lieder, mehrstimmige Gesänge, Kanons -- Ser. IV. Orchesterwerke -- Ser. V. Konzerte -- Ser. VI. Kirchensonaten -- Ser. VII. Ensemblemusik für grössere Solobesetzungen -- Ser. VIII. Kammermusik -- Ser. IX. Klaviermusik -- Ser. X. Supplement.\u000a650  0\u0024aVocal music\u000a650  0\u0024aInstrumental music\u000a650  7\u0024aInstrumental music\u00242fast\u00240(OCoLC)fst00974414\u000a650  7\u0024aVocal music\u00242fast\u00240(OCoLC)fst01168379\u000a902   \u0024apfnd\u0024bAustin Music\u000a905   \u0024a19980728120000.0\u000a948 1 \u0024a20100622\u0024bs\u0024dlap11\u0024elts\u0024xToAddCatStat\u000a948 0 \u0024a20110818\u0024br\u0024dnp55\u0024elts\u000a948 2 \u0024a20130128\u0024bm\u0024dbmt1\u0024elts\u000a948 2 \u0024a20141106\u0024bm\u0024dbatch\u0024elts\u0024xaddfas"
    }
  },
  "externalIdsHolder": {
      "instanceId": "54cc0262-76df-4cac-acca-b10e9bc5c79a"
  },
  "deleted": false,
  "order": 0,
  "additionalInfo": {
    "suppressDiscovery": false
  }
}

Response 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Record DTO Schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "UUID",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "snapshotId": {
      "description": "Corresponding snapshot id, which is the same as jobExecutionId",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "matchedId": {
      "description": "Represents relations with another matched records, necessary for saving the history of applying changes for inventory/holding/etc records",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "generation": {
      "description": "Generation from the last record with the same matchedId incremented by 1. Starts from 0.",
      "type": "integer"
    },
    "recordType": {
      "description": "Type of record, e.g. MARC",
      "type": "string",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "enum": [
        "MARC_BIB",
        "MARC_AUTHORITY",
        "MARC_HOLDING",
        "EDIFACT"
      ]
    },
    "rawRecord": {
      "description": "Raw record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "content": {
          "description": "Raw data",
          "type": "string"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content"
      ],
      "required": [
        "content"
      ]
    },
    "parsedRecord": {
      "description": "Parsed record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "content": {
          "description": "Parsed record content, e.g. MARC record"
        },
        "formattedContent": {
          "description": "Parsed content represented in human readable form",
          "type": "string"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content",
        "formattedContent"
      ],
      "required": [
        "content"
      ]
    },
    "errorRecord": {
      "description": "Error record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "description": {
          "description": "Error description",
          "type": "string"
        },
        "content": {
          "description": "Record content"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content"
      ],
      "required": [
        "description",
        "content"
      ]
    },
    "deleted": {
      "description": "Flag indicates that the record marked as deleted",
      "type": "boolean",
      "default": false
    },
    "order": {
      "description": "Order of the record in imported file",
      "type": "integer",
      "minimum": 0
    },
    "externalIdsHolder": {
      "description": "Container for identifiers of external entities",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "instanceId": {
          "description": "instance id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "instanceHrid": {
          "description": "instance hrid",
          "type": "string"
        },
        "holdingsId": {
          "description": "holdings id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "holdingsHrid": {
          "description": "holdings hrid",
          "type": "string"
        },
        "authorityId": {
          "description": "authority id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "authorityHrid": {
          "description": "authority hrid",
          "type": "string"
        }
      }
    },
    "additionalInfo": {
      "description": "Auxiliary data which is not related to MARC type record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "suppressDiscovery": {
          "description": "Flag indicates if the record is displayed during a search",
          "type": "boolean",
          "default": false
        }
      }
    },
    "state": {
      "description": "This field represents the actual state of a particular SRS record. Can be: ACTUAL, OLD, DRAFT, DELETED. ",
      "type": "string",
      "enum": [
        "ACTUAL",
        "OLD",
        "DRAFT",
        "DELETED"
      ],
      "default": "ACTUAL"
    },
    "leaderRecordStatus": {
      "description": "Single character representing MARC leader 05",
      "type": "string",
      "pattern": "^[a|c|d|n|p|o|s|x]{1}$"
    },
    "metadata": {
      "description": "Metadata provided by the server",
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "required": [
    "snapshotId",
    "matchedId",
    "recordType",
    "rawRecord"
  ]
}

Response 204

Item successfully updated

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to update record -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"record not found"

Response 409

Optimistic locking version conflict

Body

Media type: text/plain

Type: any

Example:

version conflict

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

DELETE /source-storage/records/{id}

Delete record item with given {recordId}

DELETE /source-storage/records/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • idType: required (string - default: SRS_RECORD)

    Type of Id for Record lookup

    Example:

    INSTANCE

Response 204

Item deleted successfully

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to delete record -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"record not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /source-storage/records/{id}

Retrieve record item with given {recordId}

GET /source-storage/records/{id}
URI Parameters
  • id: required (string)

Response 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Record DTO Schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "UUID",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "snapshotId": {
      "description": "Corresponding snapshot id, which is the same as jobExecutionId",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "matchedId": {
      "description": "Represents relations with another matched records, necessary for saving the history of applying changes for inventory/holding/etc records",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "generation": {
      "description": "Generation from the last record with the same matchedId incremented by 1. Starts from 0.",
      "type": "integer"
    },
    "recordType": {
      "description": "Type of record, e.g. MARC",
      "type": "string",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "enum": [
        "MARC_BIB",
        "MARC_AUTHORITY",
        "MARC_HOLDING",
        "EDIFACT"
      ]
    },
    "rawRecord": {
      "description": "Raw record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "content": {
          "description": "Raw data",
          "type": "string"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content"
      ],
      "required": [
        "content"
      ]
    },
    "parsedRecord": {
      "description": "Parsed record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "content": {
          "description": "Parsed record content, e.g. MARC record"
        },
        "formattedContent": {
          "description": "Parsed content represented in human readable form",
          "type": "string"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content",
        "formattedContent"
      ],
      "required": [
        "content"
      ]
    },
    "errorRecord": {
      "description": "Error record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "description": {
          "description": "Error description",
          "type": "string"
        },
        "content": {
          "description": "Record content"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content"
      ],
      "required": [
        "description",
        "content"
      ]
    },
    "deleted": {
      "description": "Flag indicates that the record marked as deleted",
      "type": "boolean",
      "default": false
    },
    "order": {
      "description": "Order of the record in imported file",
      "type": "integer",
      "minimum": 0
    },
    "externalIdsHolder": {
      "description": "Container for identifiers of external entities",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "instanceId": {
          "description": "instance id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "instanceHrid": {
          "description": "instance hrid",
          "type": "string"
        },
        "holdingsId": {
          "description": "holdings id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "holdingsHrid": {
          "description": "holdings hrid",
          "type": "string"
        },
        "authorityId": {
          "description": "authority id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "authorityHrid": {
          "description": "authority hrid",
          "type": "string"
        }
      }
    },
    "additionalInfo": {
      "description": "Auxiliary data which is not related to MARC type record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "suppressDiscovery": {
          "description": "Flag indicates if the record is displayed during a search",
          "type": "boolean",
          "default": false
        }
      }
    },
    "state": {
      "description": "This field represents the actual state of a particular SRS record. Can be: ACTUAL, OLD, DRAFT, DELETED. ",
      "type": "string",
      "enum": [
        "ACTUAL",
        "OLD",
        "DRAFT",
        "DELETED"
      ],
      "default": "ACTUAL"
    },
    "leaderRecordStatus": {
      "description": "Single character representing MARC leader 05",
      "type": "string",
      "pattern": "^[a|c|d|n|p|o|s|x]{1}$"
    },
    "metadata": {
      "description": "Metadata provided by the server",
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "required": [
    "snapshotId",
    "matchedId",
    "recordType",
    "rawRecord"
  ]
}

Example:

{
  "id": "67dfac11-1caf-4470-9ad1-d533f6360bdd",
  "snapshotId": "11dfac11-1caf-4470-9ad1-d533f6360bdd",
  "matchedId": "c9db5b04-e1d4-11e8-9f32-f2801f1b9fd1",
  "generation": 1,
  "recordType": "MARC",
  "state": "ACTUAL",
  "leaderRecordStatus": "c",
  "rawRecord": {
    "id": "67dfac11-1caf-4470-9ad1-d533f6360bdd",
    "content": "01542ccm a2200361   4500001000700000005001700007008004100024010001900065035002000084035001100104040002300115041001900138045000900157047007500166050001400241100004200255240001000297245016700307246002400474260003600498300002500534505031400559650001600873650002300889650004900912650004200961902002301003905002101026948004201047948002701089948002701116948003701143\u001e393893\u001e20141107001016.0\u001e830419m19559999gw mua   hiz   n    lat  \u001e  \u001fa   55001156/M \u001e  \u001fa(OCoLC)63611770\u001e  \u001fa393893\u001e  \u001fcUPB\u001fdUPB\u001fdNIC\u001fdNIC\u001e0 \u001falatitager\u001fgger\u001e  \u001fav6v9\u001e  \u001facn\u001fact\u001faco\u001fadf\u001fadv\u001faft\u001fafg\u001fams\u001fami\u001fanc\u001faop\u001faov\u001farq\u001fasn\u001fasu\u001fasy\u001favr\u001fazz\u001e0 \u001faM3\u001fb.M896\u001e1 \u001faMozart, Wolfgang Amadeus,\u001fd1756-1791.\u001e10\u001faWorks\u001e10\u001faNeue Ausgabe sämtlicher Werke,\u001fbin Verbindung mit den Mozartstädten, Augsburg, Salzburg und Wien.\u001fcHrsg. von der Internationalen Stiftung Mozarteum, Salzburg.\u001e33\u001faNeue Mozart-Ausgabe\u001e  \u001faKassel,\u001fbBärenreiter,\u001fcc1955-\u001e  \u001fav.\u001fbfacsims.\u001fc33 cm.\u001e0 \u001faSer. I. Geistliche Gesangswerke -- Ser. II. Opern -- Ser. III. Lieder, mehrstimmige Gesänge, Kanons -- Ser. IV. Orchesterwerke -- Ser. V. Konzerte -- Ser. VI. Kirchensonaten -- Ser. VII. Ensemblemusik für grössere Solobesetzungen -- Ser. VIII. Kammermusik -- Ser. IX. Klaviermusik -- Ser. X. Supplement.\u001e 0\u001faVocal music\u001e 0\u001faInstrumental music\u001e 7\u001faInstrumental music\u001f2fast\u001f0(OCoLC)fst00974414\u001e 7\u001faVocal music\u001f2fast\u001f0(OCoLC)fst01168379\u001e  \u001fapfnd\u001fbAustin Music\u001e  \u001fa19980728120000.0\u001e1 \u001fa20100622\u001fbs\u001fdlap11\u001felts\u001fxToAddCatStat\u001e0 \u001fa20110818\u001fbr\u001fdnp55\u001felts\u001e2 \u001fa20130128\u001fbm\u001fdbmt1\u001felts\u001e2 \u001fa20141106\u001fbm\u001fdbatch\u001felts\u001fxaddfast\u001e\u001d"
  },
  "parsedRecord": {
    "id": "67dfac11-1caf-4470-9ad1-d533f6360bdd",
    "content": {
      "leader": "01542ccm a2200361   4500",
      "fields": [
        {
          "001": "393893"
        },
        {
          "005": "20141107001016.0"
        },
        {
          "008": "830419m19559999gw mua   hiz   n    lat  "
        },
        {
          "010": {
            "subfields": [
              {
                "a": "   55001156/M "
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "035": {
            "subfields": [
              {
                "a": "(OCoLC)63611770"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "035": {
            "subfields": [
              {
                "a": "393893"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "040": {
            "subfields": [
              {
                "c": "UPB"
              },
              {
                "d": "UPB"
              },
              {
                "d": "NIC"
              },
              {
                "d": "NIC"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "041": {
            "subfields": [
              {
                "a": "latitager"
              },
              {
                "g": "ger"
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "045": {
            "subfields": [
              {
                "a": "v6v9"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "047": {
            "subfields": [
              {
                "a": "cn"
              },
              {
                "a": "ct"
              },
              {
                "a": "co"
              },
              {
                "a": "df"
              },
              {
                "a": "dv"
              },
              {
                "a": "ft"
              },
              {
                "a": "fg"
              },
              {
                "a": "ms"
              },
              {
                "a": "mi"
              },
              {
                "a": "nc"
              },
              {
                "a": "op"
              },
              {
                "a": "ov"
              },
              {
                "a": "rq"
              },
              {
                "a": "sn"
              },
              {
                "a": "su"
              },
              {
                "a": "sy"
              },
              {
                "a": "vr"
              },
              {
                "a": "zz"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "050": {
            "subfields": [
              {
                "a": "M3"
              },
              {
                "b": ".M896"
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "100": {
            "subfields": [
              {
                "a": "Mozart, Wolfgang Amadeus,"
              },
              {
                "d": "1756-1791."
              }
            ],
            "ind1": "1",
            "ind2": " "
          }
        },
        {
          "240": {
            "subfields": [
              {
                "a": "Works"
              }
            ],
            "ind1": "1",
            "ind2": "0"
          }
        },
        {
          "245": {
            "subfields": [
              {
                "a": "Neue Ausgabe sa\\u0308mtlicher Werke, "
              },
              {
                "b": "in Verbindung mit den Mozartsta\\u0308dten, Augsburg, Salzburg und Wien."
              },
              {
                "c": "Hrsg. von der Internationalen Stiftung Mozarteum, Salzburg."
              }
            ],
            "ind1": "1",
            "ind2": "0"
          }
        },
        {
          "246": {
            "subfields": [
              {
                "a": "Neue Mozart-Ausgabe"
              }
            ],
            "ind1": "3",
            "ind2": "3"
          }
        },
        {
          "260": {
            "subfields": [
              {
                "a": "Kassel,"
              },
              {
                "b": "Ba\\u0308renreiter,"
              },
              {
                "c": "c1955-"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "300": {
            "subfields": [
              {
                "a": "v."
              },
              {
                "b": "facsims."
              },
              {
                "c": "33 cm."
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "505": {
            "subfields": [
              {
                "a": "Ser. I. Geistliche Gesangswerke -- Ser. II. Opern -- Ser. III. Lieder, mehrstimmige Gesa\\u0308nge, Kanons -- Ser. IV. Orchesterwerke -- Ser. V. Konzerte -- Ser. VI. Kirchensonaten -- Ser. VII. Ensemblemusik fu\\u0308r gro\\u0308ssere Solobesetzungen -- Ser. VIII. Kammermusik -- Ser. IX. Klaviermusik -- Ser. X. Supplement."
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Vocal music"
              }
            ],
            "ind1": " ",
            "ind2": "0"
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Instrumental music"
              }
            ],
            "ind1": " ",
            "ind2": "0"
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Instrumental music"
              },
              {
                "2": "fast"
              },
              {
                "0": "(OCoLC)fst00974414"
              }
            ],
            "ind1": " ",
            "ind2": "7"
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Vocal music"
              },
              {
                "2": "fast"
              },
              {
                "0": "(OCoLC)fst01168379"
              }
            ],
            "ind1": " ",
            "ind2": "7"
          }
        },
        {
          "902": {
            "subfields": [
              {
                "a":"pfnd"
              },
              {
                "b":"Austin Music"
              }
            ],
            "ind1":" ",
            "ind2":" "
          }
        },
        {
          "905": {
            "subfields": [
              {
                "a":"19980728120000.0"
              }
            ],
            "ind1":" ",
            "ind2":" "
          }
        },
        {
          "948": {
            "subfields": [
              {
                "a": "20100622"
              },
              {
                "b": "s"
              },
              {
                "d": "lap11"
              },
              {
                "e": "lts"
              },
              {
                "x": "ToAddCatStat"
              }
            ],
            "ind1": "1",
            "ind2": " "
          }
        },
        {
          "948": {
            "subfields": [
              {
                "a": "20110818"
              },
              {
                "b": "r"
              },
              {
                "d": "np55"
              },
              {
                "e": "lts"
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "948": {
            "subfields": [
              {
                 "a": "20130128"
              },
              {
                 "b": "m"
              },
              {
                 "d": "bmt1"
              },
              {
                 "e": "lts"
              }
            ],
            "ind1": "2",
            "ind2": " "
          }
        },
        {
          "948": {
            "subfields": [
              {
                 "a": "20141106"
              },
              {
                 "b": "m"
              },
              {
                 "d": "batch"
              },
              {
                 "e": "lts"
              },
              {
                 "x": "addfast"
              }
            ],
            "ind1": "2",
            "ind2": " "
          }
        }
      ],
      "formattedContent": "LEADER 01542ccm a2200361   4500\u000a001 393893\u000a005 20141107001016.0\u000a008 830419m19559999gw mua   hiz   n    lat  \u000a010   \u0024a   55001156/M \u000a035   \u0024a(OCoLC)63611770\u000a035   \u0024a393893\u000a040   \u0024cUPB\u0024dUPB\u0024dNIC\u0024dNIC\u000a041 0 \u0024alatitager\u0024gger\u000a045   \u0024av6v9\u000a047   \u0024acn\u0024act\u0024aco\u0024adf\u0024adv\u0024aft\u0024afg\u0024ams\u0024ami\u0024anc\u0024aop\u0024aov\u0024arq\u0024asn\u0024asu\u0024asy\u0024avr\u0024azz\u000a050 0 \u0024aM3\u0024b.M896\u000a100 1 \u0024aMozart, Wolfgang Amadeus,\u0024d1756-1791.\u000a240 10\u0024aWorks\u000a245 10\u0024aNeue Ausgabe sämtlicher Werke,\u0024bin Verbindung mit den Mozartstädten, Augsburg, Salzburg und Wien.\u0024cHrsg. von der Internationalen Stiftung Mozarteum, Salzburg.\u000a246 33\u0024aNeue Mozart-Ausgabe\u000a260   \u0024aKassel,\u0024bBärenreiter,\u0024cc1955-\u000a300   \u0024av.\u0024bfacsims.\u0024c33 cm.\u000a505 0 \u0024aSer. I. Geistliche Gesangswerke -- Ser. II. Opern -- Ser. III. Lieder, mehrstimmige Gesänge, Kanons -- Ser. IV. Orchesterwerke -- Ser. V. Konzerte -- Ser. VI. Kirchensonaten -- Ser. VII. Ensemblemusik für grössere Solobesetzungen -- Ser. VIII. Kammermusik -- Ser. IX. Klaviermusik -- Ser. X. Supplement.\u000a650  0\u0024aVocal music\u000a650  0\u0024aInstrumental music\u000a650  7\u0024aInstrumental music\u00242fast\u00240(OCoLC)fst00974414\u000a650  7\u0024aVocal music\u00242fast\u00240(OCoLC)fst01168379\u000a902   \u0024apfnd\u0024bAustin Music\u000a905   \u0024a19980728120000.0\u000a948 1 \u0024a20100622\u0024bs\u0024dlap11\u0024elts\u0024xToAddCatStat\u000a948 0 \u0024a20110818\u0024br\u0024dnp55\u0024elts\u000a948 2 \u0024a20130128\u0024bm\u0024dbmt1\u0024elts\u000a948 2 \u0024a20141106\u0024bm\u0024dbatch\u0024elts\u0024xaddfas"
    }
  },
  "externalIdsHolder": {
      "instanceId": "54cc0262-76df-4cac-acca-b10e9bc5c79a"
  },
  "deleted": false,
  "order": 0,
  "additionalInfo": {
    "suppressDiscovery": false
  }
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"record not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

GET /source-storage/records/{id}/formatted

Get Record with formatted content

GET /source-storage/records/{id}/formatted
URI Parameters
  • id: required (string)
Query Parameters
  • idType: required (string - default: RECORD)

    Type of Id for Record lookup

    Example:

    INSTANCE

Response 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Record DTO Schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "UUID",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "snapshotId": {
      "description": "Corresponding snapshot id, which is the same as jobExecutionId",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "matchedId": {
      "description": "Represents relations with another matched records, necessary for saving the history of applying changes for inventory/holding/etc records",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "generation": {
      "description": "Generation from the last record with the same matchedId incremented by 1. Starts from 0.",
      "type": "integer"
    },
    "recordType": {
      "description": "Type of record, e.g. MARC",
      "type": "string",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "enum": [
        "MARC_BIB",
        "MARC_AUTHORITY",
        "MARC_HOLDING",
        "EDIFACT"
      ]
    },
    "rawRecord": {
      "description": "Raw record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "content": {
          "description": "Raw data",
          "type": "string"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content"
      ],
      "required": [
        "content"
      ]
    },
    "parsedRecord": {
      "description": "Parsed record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "content": {
          "description": "Parsed record content, e.g. MARC record"
        },
        "formattedContent": {
          "description": "Parsed content represented in human readable form",
          "type": "string"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content",
        "formattedContent"
      ],
      "required": [
        "content"
      ]
    },
    "errorRecord": {
      "description": "Error record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "description": {
          "description": "Error description",
          "type": "string"
        },
        "content": {
          "description": "Record content"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content"
      ],
      "required": [
        "description",
        "content"
      ]
    },
    "deleted": {
      "description": "Flag indicates that the record marked as deleted",
      "type": "boolean",
      "default": false
    },
    "order": {
      "description": "Order of the record in imported file",
      "type": "integer",
      "minimum": 0
    },
    "externalIdsHolder": {
      "description": "Container for identifiers of external entities",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "instanceId": {
          "description": "instance id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "instanceHrid": {
          "description": "instance hrid",
          "type": "string"
        },
        "holdingsId": {
          "description": "holdings id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "holdingsHrid": {
          "description": "holdings hrid",
          "type": "string"
        },
        "authorityId": {
          "description": "authority id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "authorityHrid": {
          "description": "authority hrid",
          "type": "string"
        }
      }
    },
    "additionalInfo": {
      "description": "Auxiliary data which is not related to MARC type record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "suppressDiscovery": {
          "description": "Flag indicates if the record is displayed during a search",
          "type": "boolean",
          "default": false
        }
      }
    },
    "state": {
      "description": "This field represents the actual state of a particular SRS record. Can be: ACTUAL, OLD, DRAFT, DELETED. ",
      "type": "string",
      "enum": [
        "ACTUAL",
        "OLD",
        "DRAFT",
        "DELETED"
      ],
      "default": "ACTUAL"
    },
    "leaderRecordStatus": {
      "description": "Single character representing MARC leader 05",
      "type": "string",
      "pattern": "^[a|c|d|n|p|o|s|x]{1}$"
    },
    "metadata": {
      "description": "Metadata provided by the server",
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "required": [
    "snapshotId",
    "matchedId",
    "recordType",
    "rawRecord"
  ]
}

Response 400

Bad request

Body

Media type: text/plain

Type: any

Example:

Bad request

Response 404

Not found

Body

Media type: text/plain

Type: any

Example:

Not found

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

PUT /source-storage/records/{id}/suppress-from-discovery

Update Record suppress from discovery additional information

PUT /source-storage/records/{id}/suppress-from-discovery
URI Parameters
  • id: required (string)
Query Parameters
  • idType: required (string - default: RECORD)

    Type of Id for Record lookup

    Example:

    INSTANCE
  • suppress: required (boolean - default: true)

    Whether to suppress or unsuppress from discovery

    Example:

    false

Response 200

Body

Media type: text/plain

Type: any

Response 400

Bad request

Body

Media type: text/plain

Type: any

Example:

Bad request

Response 422

Unprocessable Entity

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

PUT /source-storage/records/{id}/generation

Updates a specific Record with incremented generation and state ACTUAL by matched id

PUT /source-storage/records/{id}/generation
URI Parameters
  • id: required (string)
Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Record DTO Schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "UUID",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "snapshotId": {
      "description": "Corresponding snapshot id, which is the same as jobExecutionId",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "matchedId": {
      "description": "Represents relations with another matched records, necessary for saving the history of applying changes for inventory/holding/etc records",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "generation": {
      "description": "Generation from the last record with the same matchedId incremented by 1. Starts from 0.",
      "type": "integer"
    },
    "recordType": {
      "description": "Type of record, e.g. MARC",
      "type": "string",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "enum": [
        "MARC_BIB",
        "MARC_AUTHORITY",
        "MARC_HOLDING",
        "EDIFACT"
      ]
    },
    "rawRecord": {
      "description": "Raw record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "content": {
          "description": "Raw data",
          "type": "string"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content"
      ],
      "required": [
        "content"
      ]
    },
    "parsedRecord": {
      "description": "Parsed record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "content": {
          "description": "Parsed record content, e.g. MARC record"
        },
        "formattedContent": {
          "description": "Parsed content represented in human readable form",
          "type": "string"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content",
        "formattedContent"
      ],
      "required": [
        "content"
      ]
    },
    "errorRecord": {
      "description": "Error record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "description": {
          "description": "Error description",
          "type": "string"
        },
        "content": {
          "description": "Record content"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content"
      ],
      "required": [
        "description",
        "content"
      ]
    },
    "deleted": {
      "description": "Flag indicates that the record marked as deleted",
      "type": "boolean",
      "default": false
    },
    "order": {
      "description": "Order of the record in imported file",
      "type": "integer",
      "minimum": 0
    },
    "externalIdsHolder": {
      "description": "Container for identifiers of external entities",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "instanceId": {
          "description": "instance id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "instanceHrid": {
          "description": "instance hrid",
          "type": "string"
        },
        "holdingsId": {
          "description": "holdings id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "holdingsHrid": {
          "description": "holdings hrid",
          "type": "string"
        },
        "authorityId": {
          "description": "authority id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "authorityHrid": {
          "description": "authority hrid",
          "type": "string"
        }
      }
    },
    "additionalInfo": {
      "description": "Auxiliary data which is not related to MARC type record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "suppressDiscovery": {
          "description": "Flag indicates if the record is displayed during a search",
          "type": "boolean",
          "default": false
        }
      }
    },
    "state": {
      "description": "This field represents the actual state of a particular SRS record. Can be: ACTUAL, OLD, DRAFT, DELETED. ",
      "type": "string",
      "enum": [
        "ACTUAL",
        "OLD",
        "DRAFT",
        "DELETED"
      ],
      "default": "ACTUAL"
    },
    "leaderRecordStatus": {
      "description": "Single character representing MARC leader 05",
      "type": "string",
      "pattern": "^[a|c|d|n|p|o|s|x]{1}$"
    },
    "metadata": {
      "description": "Metadata provided by the server",
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "required": [
    "snapshotId",
    "matchedId",
    "recordType",
    "rawRecord"
  ]
}

Example:

{
  "id": "67dfac11-1caf-4470-9ad1-d533f6360bdd",
  "snapshotId": "11dfac11-1caf-4470-9ad1-d533f6360bdd",
  "matchedId": "c9db5b04-e1d4-11e8-9f32-f2801f1b9fd1",
  "generation": 1,
  "recordType": "MARC",
  "state": "ACTUAL",
  "leaderRecordStatus": "c",
  "rawRecord": {
    "id": "67dfac11-1caf-4470-9ad1-d533f6360bdd",
    "content": "01542ccm a2200361   4500001000700000005001700007008004100024010001900065035002000084035001100104040002300115041001900138045000900157047007500166050001400241100004200255240001000297245016700307246002400474260003600498300002500534505031400559650001600873650002300889650004900912650004200961902002301003905002101026948004201047948002701089948002701116948003701143\u001e393893\u001e20141107001016.0\u001e830419m19559999gw mua   hiz   n    lat  \u001e  \u001fa   55001156/M \u001e  \u001fa(OCoLC)63611770\u001e  \u001fa393893\u001e  \u001fcUPB\u001fdUPB\u001fdNIC\u001fdNIC\u001e0 \u001falatitager\u001fgger\u001e  \u001fav6v9\u001e  \u001facn\u001fact\u001faco\u001fadf\u001fadv\u001faft\u001fafg\u001fams\u001fami\u001fanc\u001faop\u001faov\u001farq\u001fasn\u001fasu\u001fasy\u001favr\u001fazz\u001e0 \u001faM3\u001fb.M896\u001e1 \u001faMozart, Wolfgang Amadeus,\u001fd1756-1791.\u001e10\u001faWorks\u001e10\u001faNeue Ausgabe sämtlicher Werke,\u001fbin Verbindung mit den Mozartstädten, Augsburg, Salzburg und Wien.\u001fcHrsg. von der Internationalen Stiftung Mozarteum, Salzburg.\u001e33\u001faNeue Mozart-Ausgabe\u001e  \u001faKassel,\u001fbBärenreiter,\u001fcc1955-\u001e  \u001fav.\u001fbfacsims.\u001fc33 cm.\u001e0 \u001faSer. I. Geistliche Gesangswerke -- Ser. II. Opern -- Ser. III. Lieder, mehrstimmige Gesänge, Kanons -- Ser. IV. Orchesterwerke -- Ser. V. Konzerte -- Ser. VI. Kirchensonaten -- Ser. VII. Ensemblemusik für grössere Solobesetzungen -- Ser. VIII. Kammermusik -- Ser. IX. Klaviermusik -- Ser. X. Supplement.\u001e 0\u001faVocal music\u001e 0\u001faInstrumental music\u001e 7\u001faInstrumental music\u001f2fast\u001f0(OCoLC)fst00974414\u001e 7\u001faVocal music\u001f2fast\u001f0(OCoLC)fst01168379\u001e  \u001fapfnd\u001fbAustin Music\u001e  \u001fa19980728120000.0\u001e1 \u001fa20100622\u001fbs\u001fdlap11\u001felts\u001fxToAddCatStat\u001e0 \u001fa20110818\u001fbr\u001fdnp55\u001felts\u001e2 \u001fa20130128\u001fbm\u001fdbmt1\u001felts\u001e2 \u001fa20141106\u001fbm\u001fdbatch\u001felts\u001fxaddfast\u001e\u001d"
  },
  "parsedRecord": {
    "id": "67dfac11-1caf-4470-9ad1-d533f6360bdd",
    "content": {
      "leader": "01542ccm a2200361   4500",
      "fields": [
        {
          "001": "393893"
        },
        {
          "005": "20141107001016.0"
        },
        {
          "008": "830419m19559999gw mua   hiz   n    lat  "
        },
        {
          "010": {
            "subfields": [
              {
                "a": "   55001156/M "
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "035": {
            "subfields": [
              {
                "a": "(OCoLC)63611770"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "035": {
            "subfields": [
              {
                "a": "393893"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "040": {
            "subfields": [
              {
                "c": "UPB"
              },
              {
                "d": "UPB"
              },
              {
                "d": "NIC"
              },
              {
                "d": "NIC"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "041": {
            "subfields": [
              {
                "a": "latitager"
              },
              {
                "g": "ger"
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "045": {
            "subfields": [
              {
                "a": "v6v9"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "047": {
            "subfields": [
              {
                "a": "cn"
              },
              {
                "a": "ct"
              },
              {
                "a": "co"
              },
              {
                "a": "df"
              },
              {
                "a": "dv"
              },
              {
                "a": "ft"
              },
              {
                "a": "fg"
              },
              {
                "a": "ms"
              },
              {
                "a": "mi"
              },
              {
                "a": "nc"
              },
              {
                "a": "op"
              },
              {
                "a": "ov"
              },
              {
                "a": "rq"
              },
              {
                "a": "sn"
              },
              {
                "a": "su"
              },
              {
                "a": "sy"
              },
              {
                "a": "vr"
              },
              {
                "a": "zz"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "050": {
            "subfields": [
              {
                "a": "M3"
              },
              {
                "b": ".M896"
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "100": {
            "subfields": [
              {
                "a": "Mozart, Wolfgang Amadeus,"
              },
              {
                "d": "1756-1791."
              }
            ],
            "ind1": "1",
            "ind2": " "
          }
        },
        {
          "240": {
            "subfields": [
              {
                "a": "Works"
              }
            ],
            "ind1": "1",
            "ind2": "0"
          }
        },
        {
          "245": {
            "subfields": [
              {
                "a": "Neue Ausgabe sa\\u0308mtlicher Werke, "
              },
              {
                "b": "in Verbindung mit den Mozartsta\\u0308dten, Augsburg, Salzburg und Wien."
              },
              {
                "c": "Hrsg. von der Internationalen Stiftung Mozarteum, Salzburg."
              }
            ],
            "ind1": "1",
            "ind2": "0"
          }
        },
        {
          "246": {
            "subfields": [
              {
                "a": "Neue Mozart-Ausgabe"
              }
            ],
            "ind1": "3",
            "ind2": "3"
          }
        },
        {
          "260": {
            "subfields": [
              {
                "a": "Kassel,"
              },
              {
                "b": "Ba\\u0308renreiter,"
              },
              {
                "c": "c1955-"
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "300": {
            "subfields": [
              {
                "a": "v."
              },
              {
                "b": "facsims."
              },
              {
                "c": "33 cm."
              }
            ],
            "ind1": " ",
            "ind2": " "
          }
        },
        {
          "505": {
            "subfields": [
              {
                "a": "Ser. I. Geistliche Gesangswerke -- Ser. II. Opern -- Ser. III. Lieder, mehrstimmige Gesa\\u0308nge, Kanons -- Ser. IV. Orchesterwerke -- Ser. V. Konzerte -- Ser. VI. Kirchensonaten -- Ser. VII. Ensemblemusik fu\\u0308r gro\\u0308ssere Solobesetzungen -- Ser. VIII. Kammermusik -- Ser. IX. Klaviermusik -- Ser. X. Supplement."
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Vocal music"
              }
            ],
            "ind1": " ",
            "ind2": "0"
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Instrumental music"
              }
            ],
            "ind1": " ",
            "ind2": "0"
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Instrumental music"
              },
              {
                "2": "fast"
              },
              {
                "0": "(OCoLC)fst00974414"
              }
            ],
            "ind1": " ",
            "ind2": "7"
          }
        },
        {
          "650": {
            "subfields": [
              {
                "a": "Vocal music"
              },
              {
                "2": "fast"
              },
              {
                "0": "(OCoLC)fst01168379"
              }
            ],
            "ind1": " ",
            "ind2": "7"
          }
        },
        {
          "902": {
            "subfields": [
              {
                "a":"pfnd"
              },
              {
                "b":"Austin Music"
              }
            ],
            "ind1":" ",
            "ind2":" "
          }
        },
        {
          "905": {
            "subfields": [
              {
                "a":"19980728120000.0"
              }
            ],
            "ind1":" ",
            "ind2":" "
          }
        },
        {
          "948": {
            "subfields": [
              {
                "a": "20100622"
              },
              {
                "b": "s"
              },
              {
                "d": "lap11"
              },
              {
                "e": "lts"
              },
              {
                "x": "ToAddCatStat"
              }
            ],
            "ind1": "1",
            "ind2": " "
          }
        },
        {
          "948": {
            "subfields": [
              {
                "a": "20110818"
              },
              {
                "b": "r"
              },
              {
                "d": "np55"
              },
              {
                "e": "lts"
              }
            ],
            "ind1": "0",
            "ind2": " "
          }
        },
        {
          "948": {
            "subfields": [
              {
                 "a": "20130128"
              },
              {
                 "b": "m"
              },
              {
                 "d": "bmt1"
              },
              {
                 "e": "lts"
              }
            ],
            "ind1": "2",
            "ind2": " "
          }
        },
        {
          "948": {
            "subfields": [
              {
                 "a": "20141106"
              },
              {
                 "b": "m"
              },
              {
                 "d": "batch"
              },
              {
                 "e": "lts"
              },
              {
                 "x": "addfast"
              }
            ],
            "ind1": "2",
            "ind2": " "
          }
        }
      ],
      "formattedContent": "LEADER 01542ccm a2200361   4500\u000a001 393893\u000a005 20141107001016.0\u000a008 830419m19559999gw mua   hiz   n    lat  \u000a010   \u0024a   55001156/M \u000a035   \u0024a(OCoLC)63611770\u000a035   \u0024a393893\u000a040   \u0024cUPB\u0024dUPB\u0024dNIC\u0024dNIC\u000a041 0 \u0024alatitager\u0024gger\u000a045   \u0024av6v9\u000a047   \u0024acn\u0024act\u0024aco\u0024adf\u0024adv\u0024aft\u0024afg\u0024ams\u0024ami\u0024anc\u0024aop\u0024aov\u0024arq\u0024asn\u0024asu\u0024asy\u0024avr\u0024azz\u000a050 0 \u0024aM3\u0024b.M896\u000a100 1 \u0024aMozart, Wolfgang Amadeus,\u0024d1756-1791.\u000a240 10\u0024aWorks\u000a245 10\u0024aNeue Ausgabe sämtlicher Werke,\u0024bin Verbindung mit den Mozartstädten, Augsburg, Salzburg und Wien.\u0024cHrsg. von der Internationalen Stiftung Mozarteum, Salzburg.\u000a246 33\u0024aNeue Mozart-Ausgabe\u000a260   \u0024aKassel,\u0024bBärenreiter,\u0024cc1955-\u000a300   \u0024av.\u0024bfacsims.\u0024c33 cm.\u000a505 0 \u0024aSer. I. Geistliche Gesangswerke -- Ser. II. Opern -- Ser. III. Lieder, mehrstimmige Gesänge, Kanons -- Ser. IV. Orchesterwerke -- Ser. V. Konzerte -- Ser. VI. Kirchensonaten -- Ser. VII. Ensemblemusik für grössere Solobesetzungen -- Ser. VIII. Kammermusik -- Ser. IX. Klaviermusik -- Ser. X. Supplement.\u000a650  0\u0024aVocal music\u000a650  0\u0024aInstrumental music\u000a650  7\u0024aInstrumental music\u00242fast\u00240(OCoLC)fst00974414\u000a650  7\u0024aVocal music\u00242fast\u00240(OCoLC)fst01168379\u000a902   \u0024apfnd\u0024bAustin Music\u000a905   \u0024a19980728120000.0\u000a948 1 \u0024a20100622\u0024bs\u0024dlap11\u0024elts\u0024xToAddCatStat\u000a948 0 \u0024a20110818\u0024br\u0024dnp55\u0024elts\u000a948 2 \u0024a20130128\u0024bm\u0024dbmt1\u0024elts\u000a948 2 \u0024a20141106\u0024bm\u0024dbatch\u0024elts\u0024xaddfas"
    }
  },
  "externalIdsHolder": {
      "instanceId": "54cc0262-76df-4cac-acca-b10e9bc5c79a"
  },
  "deleted": false,
  "order": 0,
  "additionalInfo": {
    "suppressDiscovery": false
  }
}

Response 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Record DTO Schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "UUID",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "snapshotId": {
      "description": "Corresponding snapshot id, which is the same as jobExecutionId",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "matchedId": {
      "description": "Represents relations with another matched records, necessary for saving the history of applying changes for inventory/holding/etc records",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "generation": {
      "description": "Generation from the last record with the same matchedId incremented by 1. Starts from 0.",
      "type": "integer"
    },
    "recordType": {
      "description": "Type of record, e.g. MARC",
      "type": "string",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "enum": [
        "MARC_BIB",
        "MARC_AUTHORITY",
        "MARC_HOLDING",
        "EDIFACT"
      ]
    },
    "rawRecord": {
      "description": "Raw record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "content": {
          "description": "Raw data",
          "type": "string"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content"
      ],
      "required": [
        "content"
      ]
    },
    "parsedRecord": {
      "description": "Parsed record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "content": {
          "description": "Parsed record content, e.g. MARC record"
        },
        "formattedContent": {
          "description": "Parsed content represented in human readable form",
          "type": "string"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content",
        "formattedContent"
      ],
      "required": [
        "content"
      ]
    },
    "errorRecord": {
      "description": "Error record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "UUID",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "description": {
          "description": "Error description",
          "type": "string"
        },
        "content": {
          "description": "Record content"
        }
      },
      "excludedFromEqualsAndHashCode": [
        "content"
      ],
      "required": [
        "description",
        "content"
      ]
    },
    "deleted": {
      "description": "Flag indicates that the record marked as deleted",
      "type": "boolean",
      "default": false
    },
    "order": {
      "description": "Order of the record in imported file",
      "type": "integer",
      "minimum": 0
    },
    "externalIdsHolder": {
      "description": "Container for identifiers of external entities",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "additionalProperties": false,
      "properties": {
        "instanceId": {
          "description": "instance id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "instanceHrid": {
          "description": "instance hrid",
          "type": "string"
        },
        "holdingsId": {
          "description": "holdings id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "holdingsHrid": {
          "description": "holdings hrid",
          "type": "string"
        },
        "authorityId": {
          "description": "authority id",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "uuid.schema",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        },
        "authorityHrid": {
          "description": "authority hrid",
          "type": "string"
        }
      }
    },
    "additionalInfo": {
      "description": "Auxiliary data which is not related to MARC type record",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "suppressDiscovery": {
          "description": "Flag indicates if the record is displayed during a search",
          "type": "boolean",
          "default": false
        }
      }
    },
    "state": {
      "description": "This field represents the actual state of a particular SRS record. Can be: ACTUAL, OLD, DRAFT, DELETED. ",
      "type": "string",
      "enum": [
        "ACTUAL",
        "OLD",
        "DRAFT",
        "DELETED"
      ],
      "default": "ACTUAL"
    },
    "leaderRecordStatus": {
      "description": "Single character representing MARC leader 05",
      "type": "string",
      "pattern": "^[a|c|d|n|p|o|s|x]{1}$"
    },
    "metadata": {
      "description": "Metadata provided by the server",
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "required": [
    "snapshotId",
    "matchedId",
    "recordType",
    "rawRecord"
  ]
}

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

POST /source-storage/records/{id}/un-delete

Undelete specific record

POST /source-storage/records/{id}/un-delete
URI Parameters
  • id: required (string)
Query Parameters
  • idType: required (string - default: RECORD)

    Type of Id for Record lookup

    Example:

    INSTANCE

Response 204