Deprecated
| Alternative | /api/v2/node/:nodeid |
|---|
Request
| Uri | /api/v2/page/:pagekey |
|---|---|
| Method | OPTIONS |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
Options
Notes
- PageHighlightImage is deprecated, use HighlightImage instead
Methods
OPTIONS
| Permissions |
|
|---|
GET
| Permissions |
|
|---|
PATCH
| Permissions |
|
|---|
DELETE
| Permissions |
|
|---|
Output Fields
| DateAdded | datetimeiso8601 | |
|---|---|---|
| DateModified | datetimeiso8601 | |
| HighlightImageUri | uri | |
| Name | text | |
| PasswordHint | text | |
| Privacy |
select
|
|
| SecurityType |
select
|
|
| UrlName | text | |
| UrlPath | text |
JSON
{
"Request": {
"Version": "v2",
"Method": "OPTIONS",
"Uri": "/api/v2/page/:pagekey"
},
"Options": {
"MethodDetails": {
"OPTIONS": {
"Permissions": [
"Read"
]
},
"GET": {
"Permissions": [
"Read"
]
},
"PATCH": {
"Permissions": [
"Modify"
]
},
"DELETE": {
"Permissions": [
"Modify"
]
}
},
"Methods": [
"OPTIONS",
"GET",
"PATCH",
"DELETE"
],
"ParameterDescription": {
"Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)",
"Boolean": "For true return type true or 1, for false type false or 0",
"Select": "Select one option. Options should pass only the \"Value\".",
"Uri": "Absolute or relative URL, restricted to Locator(s) of the supplied URL if not null. Up to a MAX_LENGTH in length."
},
"Parameters": {
"PATCH": [
{
"Name": "Name",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Varchar",
"MIN_CHARS": 1,
"MAX_CHARS": 254
},
{
"Name": "UrlName",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Varchar",
"MIN_CHARS": 1,
"MAX_CHARS": 32
},
{
"Name": "AutoRename",
"Required": false,
"ReadOnly": false,
"Default": false,
"Description": "Auto-rename conflicting album NiceNames?",
"Type": "Boolean"
},
{
"Name": "Password",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 50
},
{
"Name": "PasswordHint",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 255
},
{
"Name": "Privacy",
"Required": false,
"ReadOnly": false,
"Default": "Public",
"Type": "Select",
"OPTIONS": [
"Public",
"Unlisted",
"Private"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "SecurityType",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Select",
"OPTIONS": [
"None",
"Password",
"GrantAccess"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "HighlightImageUri",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": [
"Image"
]
}
],
"DELETE": []
},
"MediaTypes": [
"application/json",
"application/vnd.php.serialized",
"application/x-msgpack",
"text/html",
"text/csv"
],
"Output": [
{
"Name": "Name",
"Type": "Varchar",
"MIN_CHARS": 1,
"MAX_CHARS": 254
},
{
"Name": "UrlName",
"Type": "Varchar",
"MIN_CHARS": 1,
"MAX_CHARS": 32
},
{
"Name": "PasswordHint",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 255
},
{
"Name": "Privacy",
"Type": "Select",
"OPTIONS": [
"Public",
"Unlisted",
"Private"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "SecurityType",
"Type": "Select",
"OPTIONS": [
"None",
"Password",
"GrantAccess"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "HighlightImageUri",
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": [
"Image"
]
},
{
"Name": "DateAdded",
"Type": "DateTimeISO8601"
},
{
"Name": "DateModified",
"Type": "DateTimeISO8601"
},
{
"Name": "UrlPath",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
}
],
"Notes": [
"PageHighlightImage is deprecated, use HighlightImage instead"
],
"ResponseLevels": [
"Full",
"Public",
"Password",
"GrantAccess"
],
"Path": [
{
"type": "path",
"text": "api"
},
{
"type": "path",
"text": "v2"
},
{
"type": "path",
"text": "page"
},
{
"type": "singleparam",
"param_name": "pagekey",
"param_value": null
}
],
"Deprecated": {
"Alternative": "/api/v2/node/:nodeid"
}
},
"Code": 200,
"Message": "Ok",
"Response": {
"Timing": {
"Total": {
"time": 0.01164,
"cycles": 1,
"objects": 0
}
}
}
}