Requirement

Requirement is a validation applied on asset during creation. The most common ones are validating file type (for example only jpg and gif) or file size (max size of 10mb). More specialized can check image dimensions or ensuring picture contains face.

Obtaining requirements

Information about requirements are public and available upon http OPTIONS request against collection.

Through HTTP

OPTIONS /image

{
  "collection": "image",
  "requirementList": [
    {
      "type": "mimeType",
      "entryList": [
        {
          "mimeType": "image/jpeg",
          "extension": "jpg"
        },
        {
          "mimeType": "image/gif",
          "extension": "gif"
        },
        {
          "mimeType": "image/jpeg",
          "extension": "jpeg"
        },
        {
          "mimeType": "image/bmp",
          "extension": "bmp"
        },
        {
          "mimeType": "image/webp",
          "extension": "webp"
        },
        {
          "mimeType": "image/jp2",
          "extension": "jp2"
        },
        {
          "mimeType": "image/png",
          "extension": "png"
        },
        {
          "mimeType": "image/svg+xml",
          "extension": "svg"
        }
      ]
    },
    {
      "type": "dimension",
      "width": {
        "start": 100
      },
      "height": {
        "start": 100
      }
    },
    {
      "type": "fileSize",
      "fileSize": {
        "end": {
          "inBytes": 104857600,
          "value": 100,
          "unit": "MB",
          "asString": "100 MB"
        }
      }
    }
  ],
  "visibilityOptions": {
    "default": "public",
    "allowed": [
      "public",
      "private"
    ]
  }
}