GOBI® (Global Online Bibliographic Information) Integration version v1

HTTP status code 200

Returns a list of fields

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of pairs field name and path in the JSON",
  "type": "object",
  "properties": {
    "fields": {
      "description": "An array of pairs field name and path in the JSON",
      "id": "fields",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Field description",
        "properties": {
          "name": {
            "description": "Name of the field",
            "type": "string"
          },
          "path": {
            "description": "Path to field",
            "type": "string"
          },
          "description": {
            "description": "Description of the field",
            "type": "string"
          }
        }
      }
    },
    "totalRecords": {
      "description": "total number of records in the array",
      "type": "integer"
    }
  },
  "required": [
    "fields",
    "totalRecords"
  ]
}

Example:

{
  "fields": [
    {
      "name": "PREFIX",
      "path": "po.poNumberPrefix",
      "description": "Purchase order prefix"
    },
    {
      "name": "QUANTITY_ELECTRONIC",
      "path": "poLine.cost.quantityElectronic",
      "description": "Purchase order line electronic quantity"
    }
  ],
  "totalRecords": 2
}

HTTP status code 200

Returns a list of translators

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of pairs translator Java method name and name of translator",
  "type": "object",
  "properties": {
    "translators": {
      "description": "An array of pairs translator Java method name and name of translator",
      "id": "translators",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Translator description",
        "properties": {
          "name": {
            "description": "Name of the translator",
            "type": "string"
          },
          "translator": {
            "description": "Path to java method to process",
            "type": "string"
          },
          "description": {
            "description": "Description of the translator",
            "type": "string"
          }
        }
      }
    },
    "totalRecords": {
      "description": "total number of records in the array",
      "type": "integer"
    }
  },
  "required": [
    "translators",
    "totalRecords"
  ]
}

Example:

{
  "translators": [
    {
      "name": "LOOKUP_LINKED_PACKAGE",
      "translator": "lookupLinkedPackage",
      "description": "Lookup purchase order line UUID by order line number"
    },
    {
      "name": "LOOKUP_SUFFIX",
      "translator": "lookupSuffix",
      "description": "Lookup suffix UUID for purchase order number"
    }
  ],
  "totalRecords": 2
}

HTTP status code 200

Returns a list of types

Body

Media type: application/json

Type: string