Get a FileUploadType's rules

GET/file-upload-types/{fileUploadType}/rules/

API version

v2

Request method

GET

Operation ID

file-get-file-upload-type-rules

---

Request

• fileUploadTypestring (one of: avatar, extensionAssetImage, extensionAssetVideo, anchorIcon, conversation)

  required

  FileUploadType to retrieve rules for.

Responses

Format

application/json

Description

OK

Schema documentation

• extensionsarray of string

  required
  • Array[
  • *string
  ]

fileTypesarray of object

required

• Array[
• *object
  • extensionsarray of string

    required
    • Array[
    • *string
    ]
• mimeTypestring

  required

]

maxNameLengthinteger

required

maxSizeInBytesinteger (int64)

required

maxSizeInKBinteger (int64)

deprecated

required

deprecated, see maxSizeInBytes

maxSizeInKbinteger (int64)

deprecated

required

deprecated, see maxSizeInBytes

mimeTypesarray of string

required

• Array[
• *string
]

propertiesobject

• imageDimensionsobject
  • maxobject
    • heightinteger (int64)
    • widthinteger (int64)
  • minobject
    • heightinteger (int64)
    • widthinteger (int64)

Example

Content-Type: application/json

{
  "extensions": [
    ".png",
    ".jpeg",
    ".jpg"
  ],
  "fileTypes": [
    {
      "extensions": [
        ".jpe",
        ".jpeg",
        ".jpg"
      ],
      "mimeType": "image/jpeg"
    }
  ],
  "maxNameLength": 80,
  "maxSizeInBytes": 1000000,
  "mimeTypes": [
    "image/png",
    "image/jpeg"
  ],
  "properties": {
    "imageDimensions": {
      "max": {
        "height": 123,
        "width": 123
      },
      "min": {
        "height": 123,
        "width": 123
      }
    }
  }
}

JSON Schema

{
  "properties": {
    "extensions": {
      "example": [
        ".png",
        ".jpeg",
        ".jpg"
      ],
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "fileTypes": {
      "items": {
        "properties": {
          "extensions": {
            "example": [
              ".jpe",
              ".jpeg",
              ".jpg"
            ],
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "mimeType": {
            "example": "image/jpeg",
            "type": "string"
          }
        },
        "required": [
          "mimeType",
          "extensions"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "maxNameLength": {
      "example": 80,
      "type": "integer"
    },
    "maxSizeInBytes": {
      "example": 1000000,
      "format": "int64",
      "type": "integer"
    },
    "maxSizeInKB": {
      "deprecated": true,
      "description": "deprecated, see maxSizeInBytes",
      "example": 1000,
      "format": "int64",
      "type": "integer"
    },
    "maxSizeInKb": {
      "deprecated": true,
      "description": "deprecated, see maxSizeInBytes",
      "example": 1000,
      "format": "int64",
      "type": "integer"
    },
    "mimeTypes": {
      "example": [
        "image/png",
        "image/jpeg"
      ],
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "properties": {
      "properties": {
        "imageDimensions": {
          "properties": {
            "max": {
              "properties": {
                "height": {
                  "format": "int64",
                  "type": "integer"
                },
                "width": {
                  "format": "int64",
                  "type": "integer"
                }
              },
              "type": "object"
            },
            "min": {
              "properties": {
                "height": {
                  "format": "int64",
                  "type": "integer"
                },
                "width": {
                  "format": "int64",
                  "type": "integer"
                }
              },
              "type": "object"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    }
  },
  "required": [
    "maxSizeInBytes",
    "maxSizeInKB",
    "maxSizeInKb",
    "mimeTypes",
    "fileTypes",
    "extensions",
    "maxNameLength"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/file-upload-types/avatar/rules

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.file.getFileUploadTypeRules({
  "fileUploadType": "avatar"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\File\GetFileUploadTypeRules\GetFileUploadTypeRulesRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new GetFileUploadTypeRulesRequest(
  fileUploadType: "avatar"
));
$response = $client->file()->getFileUploadTypeRules($request);

var_dump($response->getBody();