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, 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

]

maxSizeInBytesinteger

required

maxSizeInKBinteger

required

deprecated, see maxSizeInBytes

maxSizeInKbinteger

required

deprecated, see maxSizeInBytes

mimeTypesarray of string

required

• Array[
• *string
]

propertiesobject

• imageDimensionsobject
  • maxobject
    • heightinteger
    • widthinteger
  • minobject
    • heightinteger
    • widthinteger

Example

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

JSON Schema

{
  "properties": {
    "extensions": {
      "items": {
        "example": [
          ".png",
          ".jpeg",
          ".jpg"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "fileTypes": {
      "items": {
        "properties": {
          "extensions": {
            "items": {
              "example": [
                ".jpe",
                ".jpeg",
                ".jpg"
              ],
              "type": "string"
            },
            "type": "array"
          },
          "mimeType": {
            "example": "image/jpeg",
            "type": "string"
          }
        },
        "required": [
          "mimeType",
          "extensions"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "maxSizeInBytes": {
      "example": 1000000,
      "type": "integer"
    },
    "maxSizeInKB": {
      "deprecated": true,
      "description": "deprecated, see maxSizeInBytes",
      "example": 1000,
      "type": "integer"
    },
    "maxSizeInKb": {
      "deprecated": true,
      "description": "deprecated, see maxSizeInBytes",
      "example": 1000,
      "type": "integer"
    },
    "mimeTypes": {
      "items": {
        "example": [
          "image/png",
          "image/jpeg"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "properties": {
      "properties": {
        "imageDimensions": {
          "properties": {
            "max": {
              "properties": {
                "height": {
                  "type": "integer"
                },
                "width": {
                  "type": "integer"
                }
              },
              "type": "object"
            },
            "min": {
              "properties": {
                "height": {
                  "type": "integer"
                },
                "width": {
                  "type": "integer"
                }
              },
              "type": "object"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    }
  },
  "required": [
    "maxSizeInBytes",
    "maxSizeInKB",
    "maxSizeInKb",
    "mimeTypes",
    "fileTypes",
    "extensions"
  ],
  "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();