Field Protection Settings (v1.0)

http://localhost

Table of contents

Field Protection Settings API

API for managing field protection settings

/field-protection-settings

GET /field-protection-settings/marc

Retrieve a list of marc items.

GET /field-protection-settings/marc
Query Parameters
  • query: (string)

    A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

    with valid searchable fields: for example source=SYSTEM

    Example:

    (username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
    
    source=SYSTEM
    
  • 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
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns a list of marc items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of MARC field protection settings",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "marcFieldProtectionSettings": {
      "description": "List of MARC field protection settings",
      "type": "array",
      "id": "marcFieldProtectionSettingsList",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "MARC field protection setting schema",
        "javaType": "org.folio.rest.jaxrs.model.MarcFieldProtectionSetting",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "MARC field protection setting id",
            "$schema": "http://json-schema.org/draft-04/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}$"
          },
          "field": {
            "description": "Field",
            "type": "string"
          },
          "indicator1": {
            "description": "Indicator 1",
            "type": "string"
          },
          "indicator2": {
            "description": "Indicator 2",
            "type": "string"
          },
          "subfield": {
            "description": "Subfield",
            "type": "string"
          },
          "data": {
            "description": "Data",
            "type": "string"
          },
          "source": {
            "description": "Source",
            "type": "string",
            "enum": [
              "SYSTEM",
              "USER"
            ]
          },
          "override": {
            "description": "Indicates whether field can be overridden or not, always false for SYSTEM protection settings",
            "type": "boolean",
            "default": false
          },
          "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": [
          "field"
        ]
      }
    },
    "totalRecords": {
      "description": "Total number of MARC field protection settings",
      "type": "integer"
    }
  },
  "excludedFromEqualsAndHashCode": [
    "totalRecords"
  ],
  "required": [
    "marcFieldProtectionSettings",
    "totalRecords"
  ]
}

Example:

{
  "marcFieldProtectionSettings": [
    {
      "id": "2d706874-8a10-4d3e-a190-33c301d157e3",
      "field": "001",
      "indicator1": "",
      "indicator2": "",
      "subfield": "",
      "data": "*",
      "source": "SYSTEM",
      "override": false,
      "metadata":{
        "createdDate":"2020-08-13T14:44:07Z",
        "createdByUserId":"00000000-0000-0000-0000-000000000000",
        "createdByUsername":"System",
        "updatedDate":"2020-08-13T14:44:07Z",
        "updatedByUserId":"00000000-0000-0000-0000-000000000000",
        "updatedByUsername":"System"
      }
    },
    {
      "id": "82d0b904-f8b0-4cc2-b238-7d8cddef7b7e",
      "field": "999",
      "indicator1": "f",
      "indicator2": "f",
      "subfield": "*",
      "data": "*",
      "source": "SYSTEM",
      "override": false,
      "metadata":{
        "createdDate":"2020-08-13T14:44:07Z",
        "createdByUserId":"00000000-0000-0000-0000-000000000000",
        "createdByUsername":"System",
        "updatedDate":"2020-08-13T14:44:07Z",
        "updatedByUserId":"00000000-0000-0000-0000-000000000000",
        "updatedByUsername":"System"
      }
    }
  ],
  "totalRecords": 2
}

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 marc -- 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 marc -- 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 /field-protection-settings/marc

Create a new marc item.

POST /field-protection-settings/marc
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "MARC field protection setting schema",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.MarcFieldProtectionSetting",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "MARC field protection setting id",
      "$schema": "http://json-schema.org/draft-04/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}$"
    },
    "field": {
      "description": "Field",
      "type": "string"
    },
    "indicator1": {
      "description": "Indicator 1",
      "type": "string"
    },
    "indicator2": {
      "description": "Indicator 2",
      "type": "string"
    },
    "subfield": {
      "description": "Subfield",
      "type": "string"
    },
    "data": {
      "description": "Data",
      "type": "string"
    },
    "source": {
      "description": "Source",
      "type": "string",
      "enum": [
        "SYSTEM",
        "USER"
      ]
    },
    "override": {
      "description": "Indicates whether field can be overridden or not, always false for SYSTEM protection settings",
      "type": "boolean",
      "default": false
    },
    "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": [
    "field"
  ]
}

Example:

{
  "id": "2d706874-8a10-4d3e-a190-33c301d157e3",
  "field": "001",
  "indicator1": "",
  "indicator2": "",
  "subfield": "",
  "data": "*",
  "source": "SYSTEM",
  "override": false,
  "metadata":{
    "createdDate":"2020-08-13T14:44:07Z",
    "createdByUserId":"00000000-0000-0000-0000-000000000000",
    "createdByUsername":"System",
    "updatedDate":"2020-08-13T14:44:07Z",
    "updatedByUserId":"00000000-0000-0000-0000-000000000000",
    "updatedByUsername":"System"
  }
}

Response 201

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

Headers
  • Location: required (string)

    URI to the created marc item

Body

Media type: application/json

Type: any

Example:

{
  "id": "2d706874-8a10-4d3e-a190-33c301d157e3",
  "field": "001",
  "indicator1": "",
  "indicator2": "",
  "subfield": "",
  "data": "*",
  "source": "SYSTEM",
  "override": false,
  "metadata":{
    "createdDate":"2020-08-13T14:44:07Z",
    "createdByUserId":"00000000-0000-0000-0000-000000000000",
    "createdByUsername":"System",
    "updatedDate":"2020-08-13T14:44:07Z",
    "updatedByUserId":"00000000-0000-0000-0000-000000000000",
    "updatedByUsername":"System"
  }
}

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 marc -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create marc -- 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

PUT /field-protection-settings/marc/{id}

Update marc item with given {marcId}

PUT /field-protection-settings/marc/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "MARC field protection setting schema",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.MarcFieldProtectionSetting",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "MARC field protection setting id",
      "$schema": "http://json-schema.org/draft-04/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}$"
    },
    "field": {
      "description": "Field",
      "type": "string"
    },
    "indicator1": {
      "description": "Indicator 1",
      "type": "string"
    },
    "indicator2": {
      "description": "Indicator 2",
      "type": "string"
    },
    "subfield": {
      "description": "Subfield",
      "type": "string"
    },
    "data": {
      "description": "Data",
      "type": "string"
    },
    "source": {
      "description": "Source",
      "type": "string",
      "enum": [
        "SYSTEM",
        "USER"
      ]
    },
    "override": {
      "description": "Indicates whether field can be overridden or not, always false for SYSTEM protection settings",
      "type": "boolean",
      "default": false
    },
    "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": [
    "field"
  ]
}

Example:

{
  "id": "2d706874-8a10-4d3e-a190-33c301d157e3",
  "field": "001",
  "indicator1": "",
  "indicator2": "",
  "subfield": "",
  "data": "*",
  "source": "SYSTEM",
  "override": false,
  "metadata":{
    "createdDate":"2020-08-13T14:44:07Z",
    "createdByUserId":"00000000-0000-0000-0000-000000000000",
    "createdByUsername":"System",
    "updatedDate":"2020-08-13T14:44:07Z",
    "updatedByUserId":"00000000-0000-0000-0000-000000000000",
    "updatedByUsername":"System"
  }
}

Response 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "MARC field protection setting schema",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.MarcFieldProtectionSetting",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "MARC field protection setting id",
      "$schema": "http://json-schema.org/draft-04/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}$"
    },
    "field": {
      "description": "Field",
      "type": "string"
    },
    "indicator1": {
      "description": "Indicator 1",
      "type": "string"
    },
    "indicator2": {
      "description": "Indicator 2",
      "type": "string"
    },
    "subfield": {
      "description": "Subfield",
      "type": "string"
    },
    "data": {
      "description": "Data",
      "type": "string"
    },
    "source": {
      "description": "Source",
      "type": "string",
      "enum": [
        "SYSTEM",
        "USER"
      ]
    },
    "override": {
      "description": "Indicates whether field can be overridden or not, always false for SYSTEM protection settings",
      "type": "boolean",
      "default": false
    },
    "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": [
    "field"
  ]
}

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 marc -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"marc not found"

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 /field-protection-settings/marc/{id}

Delete marc item with given {marcId}

DELETE /field-protection-settings/marc/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

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 marc -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"marc 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 /field-protection-settings/marc/{id}

Retrieve marc item with given {marcId}

GET /field-protection-settings/marc/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

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": "MARC field protection setting schema",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.MarcFieldProtectionSetting",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "MARC field protection setting id",
      "$schema": "http://json-schema.org/draft-04/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}$"
    },
    "field": {
      "description": "Field",
      "type": "string"
    },
    "indicator1": {
      "description": "Indicator 1",
      "type": "string"
    },
    "indicator2": {
      "description": "Indicator 2",
      "type": "string"
    },
    "subfield": {
      "description": "Subfield",
      "type": "string"
    },
    "data": {
      "description": "Data",
      "type": "string"
    },
    "source": {
      "description": "Source",
      "type": "string",
      "enum": [
        "SYSTEM",
        "USER"
      ]
    },
    "override": {
      "description": "Indicates whether field can be overridden or not, always false for SYSTEM protection settings",
      "type": "boolean",
      "default": false
    },
    "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": [
    "field"
  ]
}

Example:

{
  "id": "2d706874-8a10-4d3e-a190-33c301d157e3",
  "field": "001",
  "indicator1": "",
  "indicator2": "",
  "subfield": "",
  "data": "*",
  "source": "SYSTEM",
  "override": false,
  "metadata":{
    "createdDate":"2020-08-13T14:44:07Z",
    "createdByUserId":"00000000-0000-0000-0000-000000000000",
    "createdByUsername":"System",
    "updatedDate":"2020-08-13T14:44:07Z",
    "updatedByUserId":"00000000-0000-0000-0000-000000000000",
    "updatedByUsername":"System"
  }
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"marc 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