Response [200 Ok]

Uri /api/v2/image!addkeywords
UriDescription Add keywords to images
EndpointType AddKeywords

Timing

Total

cycles 1
objects 0
time 0.01183

Request

Uri /api/v2/image!addkeywords
Method GET
Version v2

Config

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

Options

Notes

  • Keywords are added to each image for the given image URIs.
  • Existing keywords on images are unmodified.
  • When Async is true this endpoint will return an /api/v2/task/:taskid entity that can be polled for status.

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

POST

Permissions
  • Modify

Parameters

POST

Whether to process the keyword operation as an asynchronous task
An array of Image URIs
Keywords separated by commas or semicolons

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/image!addkeywords"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "POST": {
                "Permissions": [
                    "Modify"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET",
            "POST"
        ],
        "ParameterDescription": {
            "Boolean": "For true return type true or 1, for false type false or 0",
            "Array": "An indexed array of values with a length in the range MIN_COUNT to MAX_COUNT, inclusive.",
            "Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)"
        },
        "Parameters": {
            "POST": [
                {
                    "Name": "Async",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": false,
                    "Description": "Whether to process the keyword operation as an asynchronous task",
                    "Type": "Boolean"
                },
                {
                    "Name": "ImageUris",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": [],
                    "Description": "An array of Image URIs",
                    "Type": "Array",
                    "ITEM_TYPE": "Uri",
                    "MIN_COUNT": 0,
                    "MAX_COUNT": "INFINITY"
                },
                {
                    "Name": "Keywords",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "Keywords separated by commas or semicolons",
                    "Type": "Varchar",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": "INFINITY"
                }
            ]
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Notes": [
            "Keywords are added to each image for the given image URIs.",
            "Existing keywords on images are unmodified.",
            "When Async is true this endpoint will return an /api/v2/task/:taskid entity that can be polled for status."
        ]
    },
    "Response": {
        "Uri": "/api/v2/image!addkeywords",
        "UriDescription": "Add keywords to images",
        "EndpointType": "AddKeywords",
        "Timing": {
            "Total": {
                "time": 0.01183,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}