copycat version v0.0

HTTP status code 200

Imported OK

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "tags",
  "description": "copycat import request/response",
  "type": "object",
  "properties": {
    "externalIdentifier": {
      "description": "external identifier for the record (for Z39.50 retrieval)",
      "type": "string"
    },
    "internalIdentifier": {
      "description": "FOLIO instance identifier for the record; specify when a record should be updated",
      "type": "string"
    },
    "profileId": {
      "description": "profile to be used for importing",
      "type": "string"
    },
    "selectedJobProfileId": {
      "description": "Job profile to be used for importing",
      "type": "string",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "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}$"
    },
    "record": {
      "description": "local record",
      "type": "object",
      "properties": {
        "json": {
          "description": "JSON MARC record object within json property",
          "type": "string"
        },
        "marc": {
          "description": "base64 encoded ISO2709 MARC",
          "type": "string"
        }
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "profileId"
  ]
}

HTTP status code 400

Import error

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

HTTP status code 500

Internal error

Body

Media type: text/plain

Type: any

HTTP status code 201

Created OK

Headers

• Location: required(string)

  URI of profile

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "copycat profile",
  "description": "copycat import profile",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique identifier and primary key"
    },
    "name": {
      "type": "string",
      "description": "Human-readable name"
    },
    "url": {
      "type": "string",
      "description": "Location of remote service to obtain records from"
    },
    "authentication": {
      "type": "string",
      "description": "Authentication credentials to use for the remote service"
    },
    "externalIdQueryMap": {
      "type": "string",
      "description": "Specifies which field at the remote service should be searched with the value of `externalIdentifier` when an import request is POSTed. Could be specified as a YAZ prefix-query string, e.g. '@attr 1=12 $identifier'"
    },
    "internalIdEmbedPath": {
      "type": "string",
      "description": "Specifies where the internalIdentifier is to be embedded in the MARC record, e.g. '999__$i' to place it in field 999, indicator double space (absent) and subfield i; this field only has effect when internalIdentifier is present"
    },
    "createJobProfileId": {
      "type": "string",
      "description": "Default job profile to use for create",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "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}$"
    },
    "updateJobProfileId": {
      "type": "string",
      "description": "Default job profile to use for update",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "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}$"
    },
    "allowedCreateJobProfileIds": {
      "type": "array",
      "description": "Job profiles to use for create",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "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}$"
      }
    },
    "allowedUpdateJobProfileIds": {
      "type": "array",
      "description": "Job profiles to use for update",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "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}$"
      }
    },
    "targetOptions": {
      "type": "object",
      "description": "A 1-level Json Object containing ZOOM options. The most important ones being preferredRecordSyntax, charset, marcencoding (encoding for retrieved MARC records - default is marc-8). See https://software.indexdata.com/yaz/doc/zoom.html#zoom-connections and https://software.indexdata.com/yaz/doc/zoom.resultsets.html#zoom.resultset.options"
    },
    "externalIdentifierType": {
      "type": "string",
      "description": "UUID of an identifier-type defined by the inventory module",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "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}$"
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether this profile should be presented to users importing records"
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "createJobProfileId",
    "updateJobProfileId"
  ]
}

HTTP status code 400

Error in usage

Body

Media type: text/plain

Type: any

HTTP status code 500

Internal error

Body

Media type: text/plain

Type: any

HTTP status code 200

Get collection OK

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CopyCat Profiles Response",
  "description": "CopyCat Profiles",
  "type": "object",
  "properties": {
    "profiles": {
      "description": "List of CopyCat profiles",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "copycat profile",
        "description": "copycat import profile",
        "properties": {
          "id": {
            "type": "string",
            "description": "unique identifier and primary key"
          },
          "name": {
            "type": "string",
            "description": "Human-readable name"
          },
          "url": {
            "type": "string",
            "description": "Location of remote service to obtain records from"
          },
          "authentication": {
            "type": "string",
            "description": "Authentication credentials to use for the remote service"
          },
          "externalIdQueryMap": {
            "type": "string",
            "description": "Specifies which field at the remote service should be searched with the value of `externalIdentifier` when an import request is POSTed. Could be specified as a YAZ prefix-query string, e.g. '@attr 1=12 $identifier'"
          },
          "internalIdEmbedPath": {
            "type": "string",
            "description": "Specifies where the internalIdentifier is to be embedded in the MARC record, e.g. '999__$i' to place it in field 999, indicator double space (absent) and subfield i; this field only has effect when internalIdentifier is present"
          },
          "createJobProfileId": {
            "type": "string",
            "description": "Default job profile to use for create",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "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}$"
          },
          "updateJobProfileId": {
            "type": "string",
            "description": "Default job profile to use for update",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "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}$"
          },
          "allowedCreateJobProfileIds": {
            "type": "array",
            "description": "Job profiles to use for create",
            "items": {
              "type": "string",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "id": "uuid.schema",
              "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
              "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}$"
            }
          },
          "allowedUpdateJobProfileIds": {
            "type": "array",
            "description": "Job profiles to use for update",
            "items": {
              "type": "string",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "id": "uuid.schema",
              "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
              "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}$"
            }
          },
          "targetOptions": {
            "type": "object",
            "description": "A 1-level Json Object containing ZOOM options. The most important ones being preferredRecordSyntax, charset, marcencoding (encoding for retrieved MARC records - default is marc-8). See https://software.indexdata.com/yaz/doc/zoom.html#zoom-connections and https://software.indexdata.com/yaz/doc/zoom.resultsets.html#zoom.resultset.options"
          },
          "externalIdentifierType": {
            "type": "string",
            "description": "UUID of an identifier-type defined by the inventory module",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "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}$"
          },
          "enabled": {
            "type": "boolean",
            "description": "Whether this profile should be presented to users importing records"
          }
        },
        "additionalProperties": false,
        "required": [
          "name",
          "createJobProfileId",
          "updateJobProfileId"
        ]
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "profiles",
    "totalRecords"
  ]
}

HTTP status code 400

Error in usage

Body

Media type: text/plain

Type: any

HTTP status code 500

Internal error

Body

Media type: text/plain

Type: any

HTTP status code 200

retrieved OK

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "copycat profile",
  "description": "copycat import profile",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique identifier and primary key"
    },
    "name": {
      "type": "string",
      "description": "Human-readable name"
    },
    "url": {
      "type": "string",
      "description": "Location of remote service to obtain records from"
    },
    "authentication": {
      "type": "string",
      "description": "Authentication credentials to use for the remote service"
    },
    "externalIdQueryMap": {
      "type": "string",
      "description": "Specifies which field at the remote service should be searched with the value of `externalIdentifier` when an import request is POSTed. Could be specified as a YAZ prefix-query string, e.g. '@attr 1=12 $identifier'"
    },
    "internalIdEmbedPath": {
      "type": "string",
      "description": "Specifies where the internalIdentifier is to be embedded in the MARC record, e.g. '999__$i' to place it in field 999, indicator double space (absent) and subfield i; this field only has effect when internalIdentifier is present"
    },
    "createJobProfileId": {
      "type": "string",
      "description": "Default job profile to use for create",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "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}$"
    },
    "updateJobProfileId": {
      "type": "string",
      "description": "Default job profile to use for update",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "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}$"
    },
    "allowedCreateJobProfileIds": {
      "type": "array",
      "description": "Job profiles to use for create",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "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}$"
      }
    },
    "allowedUpdateJobProfileIds": {
      "type": "array",
      "description": "Job profiles to use for update",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "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}$"
      }
    },
    "targetOptions": {
      "type": "object",
      "description": "A 1-level Json Object containing ZOOM options. The most important ones being preferredRecordSyntax, charset, marcencoding (encoding for retrieved MARC records - default is marc-8). See https://software.indexdata.com/yaz/doc/zoom.html#zoom-connections and https://software.indexdata.com/yaz/doc/zoom.resultsets.html#zoom.resultset.options"
    },
    "externalIdentifierType": {
      "type": "string",
      "description": "UUID of an identifier-type defined by the inventory module",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "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}$"
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether this profile should be presented to users importing records"
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "createJobProfileId",
    "updateJobProfileId"
  ]
}

HTTP status code 400

User error

Body

Media type: text/plain

Type: any

HTTP status code 404

Not found

Body

Media type: text/plain

Type: any

HTTP status code 500

Internal error

Body

Media type: text/plain

Type: any

HTTP status code 204

updated OK

HTTP status code 400

User error

Body

Media type: text/plain

Type: any

HTTP status code 404

Not found

Body

Media type: text/plain

Type: any

HTTP status code 500

Internal error

Body

Media type: text/plain

Type: any

HTTP status code 204

deleted OK

HTTP status code 400

User error

Body

Media type: text/plain

Type: any

HTTP status code 404

Not found

Body

Media type: text/plain

Type: any

HTTP status code 500

Internal error

Body

Media type: text/plain

Type: any