Response [200 Ok]
| Uri | /api/v2/image!removekeywords |
|---|---|
| UriDescription | Removes keywords from images |
| EndpointType | RemoveKeywords |
Request
| Uri | /api/v2/image!removekeywords?_accept=text%2Fhtml |
|---|---|
| Method | GET |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
Options
Notes
- The provided keywords are removed from each image for the given image URIs.
- When Async is true this endpoint will return an /api/v2/task/:taskid entity that can be polled for status.
Methods
OPTIONS
| Permissions |
|
|---|
GET
| Permissions |
|
|---|
POST
| Permissions |
|
|---|
JSON
{
"Request": {
"Version": "v2",
"Method": "GET",
"Uri": "/api/v2/image!removekeywords?_accept=text%2Fhtml"
},
"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": [
"The provided keywords are removed from each image for the given image URIs.",
"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!removekeywords",
"UriDescription": "Removes keywords from images",
"EndpointType": "RemoveKeywords",
"Timing": {
"Total": {
"time": 0.02111,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}