Inventory API (v0.1)

http://localhost

Table of contents

Inventory configuration API

API for interacting with configuration for Instances, Items, Holdings

/inventory/config

GET /inventory/config/instances/blocked-fields

Provides configuration with blocked fields of instance

GET /inventory/config/instances/blocked-fields

Response 200

Array of blocked fields of instance

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Blocked fields of instance",
  "type": "object",
  "properties": {
    "blockedFields": {
      "description": "Array of blocked fields",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "blockedFields"
  ]
}

Example:

{
  "blockedFields": [
    "hrid",
    "source",
    "discoverySuppress"
  ]
}

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /inventory/config/holdings/blocked-fields

Provides configuration with blocked fields of holdings

GET /inventory/config/holdings/blocked-fields

Response 200

Array of blocked fields of holdings

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Blocked fields of instance",
  "type": "object",
  "properties": {
    "blockedFields": {
      "description": "Array of blocked fields",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "blockedFields"
  ]
}

Example:

{
  "blockedFields": [
    "hrid",
    "source",
    "discoverySuppress"
  ]
}

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator