Response [200 Ok]

Uri /api/v2/image!crop
UriDescription Crop a set of images
EndpointType CropImages

Timing

Total

cycles 1
objects 0
time 0.02555

Config

{
    "expand_method": "ref",
    "shorturis": false
}

Options

Notes

  • Crop Image Uris (CropUris) is a comma-separated list
  • This endpoint will modify the original image and is not reversible

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

POST

Permissions
  • Modify

Parameters

POST

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/image!crop?_accept=text%2Fhtml"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "POST": {
                "Permissions": [
                    "Modify"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET",
            "POST"
        ],
        "ParameterDescription": {
            "Integer": "Integer value in the range MIN_VALUE to MAX_VALUE, inclusive",
            "Boolean": "For true return type true or 1, for false type false or 0",
            "Text": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)"
        },
        "Parameters": {
            "POST": [
                {
                    "Name": "TopLeftX",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Integer",
                    "MIN_VALUE": "NEGATIVE_INFINITY",
                    "MAX_VALUE": "POSITIVE_INFINITY"
                },
                {
                    "Name": "TopLeftY",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Integer",
                    "MIN_VALUE": "NEGATIVE_INFINITY",
                    "MAX_VALUE": "POSITIVE_INFINITY"
                },
                {
                    "Name": "Height",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Integer",
                    "MIN_VALUE": "NEGATIVE_INFINITY",
                    "MAX_VALUE": "POSITIVE_INFINITY"
                },
                {
                    "Name": "Width",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Integer",
                    "MIN_VALUE": "NEGATIVE_INFINITY",
                    "MAX_VALUE": "POSITIVE_INFINITY"
                },
                {
                    "Name": "ThumbOnly",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Boolean"
                },
                {
                    "Name": "CropUris",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Text",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": "INFINITY"
                }
            ]
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Notes": [
            "Crop Image Uris (CropUris) is a comma-separated list",
            "This endpoint will modify the original image and is not reversible"
        ]
    },
    "Response": {
        "Uri": "/api/v2/image!crop",
        "UriDescription": "Crop a set of images",
        "EndpointType": "CropImages",
        "Timing": {
            "Total": {
                "time": 0.02555,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}