Request
| Uri | /api/v2/printmark/:printmarkid |
|---|---|
| Method | OPTIONS |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
Options
Methods
OPTIONS
| Permissions |
|
|---|
GET
| Permissions |
|
|---|
PATCH
| Permissions |
|
|---|
DELETE
| Permissions |
|
|---|
Output Fields
| Dissolve | integer | |
|---|---|---|
| Gap | integer | |
| ImageID | integer | |
| ImageKey | text | |
| ImageUri | uri | |
| Location | text | |
| Name | text | |
| PreviewOverlayURL | fullurl | |
| PrintmarkID | integer | |
| Scale | integer |
JSON
{
"Request": {
"Version": "v2",
"Method": "OPTIONS",
"Uri": "/api/v2/printmark/:printmarkid"
},
"Options": {
"MethodDetails": {
"OPTIONS": {
"Permissions": [
"Read"
]
},
"GET": {
"Permissions": [
"Read"
]
},
"PATCH": {
"Permissions": [
"Modify"
]
},
"DELETE": {
"Permissions": [
"Modify"
]
}
},
"Methods": [
"OPTIONS",
"GET",
"PATCH",
"DELETE"
],
"ParameterDescription": {
"Integer": "Integer value in the range MIN_VALUE to MAX_VALUE, inclusive",
"Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)"
},
"Parameters": {
"PATCH": [
{
"Name": "PrintmarkID",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "ImageID",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "ImageKey",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 254
},
{
"Name": "Name",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 254
},
{
"Name": "Dissolve",
"Required": false,
"ReadOnly": false,
"Default": 0,
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "Gap",
"Required": false,
"ReadOnly": false,
"Default": 60,
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "Location",
"Required": false,
"ReadOnly": false,
"Default": "BottomRight",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 254
},
{
"Name": "Scale",
"Required": false,
"ReadOnly": false,
"Default": 100,
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
}
],
"DELETE": []
},
"MediaTypes": [
"application/json",
"application/vnd.php.serialized",
"application/x-msgpack",
"text/html",
"text/csv"
],
"Output": [
{
"Name": "ImageUri",
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": [
"Image"
]
},
{
"Name": "PrintmarkID",
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "ImageID",
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "ImageKey",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 254
},
{
"Name": "Name",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 254
},
{
"Name": "Dissolve",
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "Gap",
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "Location",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 254
},
{
"Name": "Scale",
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "PreviewOverlayURL",
"Type": "FullUrl",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
}
],
"Path": [
{
"type": "path",
"text": "api"
},
{
"type": "path",
"text": "v2"
},
{
"type": "path",
"text": "printmark"
},
{
"type": "singleparam",
"param_name": "printmarkid",
"param_value": null
}
]
},
"Code": 200,
"Message": "Ok",
"Response": {
"Timing": {
"Total": {
"time": 0.01852,
"cycles": 1,
"objects": 0
}
}
}
}