@itentialopensource/adapter-eai/entities/card/schema.json

Itential Ericsson Adaptive Inventory Adapter

{
  "$id": "card_schema.json",
  "type": "object",
  "schema": "http://json-schema.org/draft-07/schema#",
  "translate": true,
  "dynamicfields": true,
  "properties": {
    "ph_request_type": {
      "type": "string",
      "description": "type of request (internal to adapter)",
      "default": "getCards",
      "enum": [
        "getCards",
        "createCard",
        "updateCard",
        "deleteCard"
      ],
      "external_name": "ph_request_type"
    },
    "id": {
      "type": "integer",
      "description": "the card unique identifier",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "id"
    },
    "name": {
      "type": "string",
      "description": "the name of card",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "name"
    },
    "type": {
      "type": "string",
      "description": "the entity",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "type"
    },
    "cardtype": {
      "type": "string",
      "description": "the type of card",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "_type"
    },
    "serialNumber": {
      "type": "string",
      "description": "the serial number for the card",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "serialNumber"
    },
    "slotOccupancy": {
      "type": "integer",
      "description": "the slot the card is in",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "slotOccupancy"
    },
    "role": {
      "type": "string",
      "description": "the role of the card",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "role"
    },
    "description": {
      "type": "string",
      "description": "the description for the card",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "description"
    },
    "status": {
      "type": "string",
      "description": "the status of the card",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "status"
    },
    "inServiceDate": {
      "type": "string",
      "description": "the date the card was placed in service",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "inServiceDate"
    },
    "parentSlots": {
      "type": "array",
      "items": {
        "translate": false,
        "type": "object"
      },
      "description": "",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "parentSlots"
    }
  },
  "allOf": [
    {
      "if": {
        "properties": {
          "ph_request_type": {
            "enum": [
              "createCard"
            ]
          }
        }
      },
      "then": {
        "required": [
          "name",
          "type",
          "cardtype",
          "status",
          "slotOccupancy",
          "parentSlots"
        ]
      }
    },
    {
      "if": {
        "properties": {
          "ph_request_type": {
            "enum": [
              "updateCard"
            ]
          }
        }
      },
      "then": {
        "required": [
          "type"
        ]
      }
    }
  ],
  "definitions": {}
}