FullSchema-ImageUploadServiceInputVO

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/fedex/json-schema/fedex-full-schema-image-upload-service-input-vo-schema.json",
  "title": "FullSchema-ImageUploadServiceInputVO",
  "description": "The request elements to upload image files.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/fedex-upload-documents-api-openapi.yml#/components/schemas/FullSchema-ImageUploadServiceInputVO",
  "required": [
    "document",
    "rules",
    "attachment"
  ],
  "type": "object",
  "properties": {
    "document": {
      "$ref": "#/$defs/Document"
    },
    "rules": {
      "$ref": "#/$defs/Document_rules"
    },
    "attachment": {
      "type": "string",
      "description": "Input the actual image file to be uploaded. Pass this as second data element in the request object.<br> Example:file.PNG",
      "format": "file.PNG"
    }
  },
  "$defs": {
    "Document": {
      "required": [
        "contentType",
        "meta",
        "name",
        "referenceId"
      ],
      "type": "object",
      "properties": {
        "referenceId": {
          "type": "string",
          "description": "Specify reference ID for the image to be uploaded. <br> <br> Example: 1234"
        },
        "name": {
          "type": "string",
          "description": "Specify file name to be uploaded.<br><br>Example: LH2.PNG"
        },
        "contentType": {
          "type": "string",
          "description": "Specify the file type or image type of the to be uploaded. <br> Example: image/png. <br><br>Valid Values are: <ul><li>image/png</li><li>image/gif</li></ul>"
        },
        "meta": {
          "$ref": "#/$defs/Document_meta"
        }
      },
      "description": "Indicate the image reference metadata details. Pass this as first data element in the request object."
    },
    "Document_meta": {
      "required": [
        "imageIndex",
        "imageType"
      ],
      "type": "object",
      "properties": {
        "imageType": {
          "type": "string",
          "description": "Specify the type of image to be uploaded.<br> Example:SIGNATURE <br><br>Valid Values are: <ul><li>SIGNATURE</li><li>LETTERHEAD</li></ul>"
        },
        "imageIndex": {
          "type": "string",
          "description": "Specify the index for the uploaded image.<br> Example: IMAGE_1 <br><br>Valid Values are:<ul><li>IMAGE_1</li><li>IMAGE_2</li><li>IMAGE_3</li><li>IMAGE_4</li><li>IMAGE_5</li></ul>"
        }
      },
      "description": "Use this object to specify image meta data such as image type, path and index for the file to be uploaded."
    },
    "Document_rules": {
      "required": [
        "workflowName"
      ],
      "type": "object",
      "properties": {
        "workflowName": {
          "type": "string",
          "description": "Specify workflow name. To upload custom signature and letterhead images/company logo use value <br><br>Example:LetterheadSignature"
        }
      },
      "description": "Specify the rules."
    }
  }
}