Response [200 Ok]

Uri /api/v2/page/Kg2M9H?_responseLevel=Public
UriDescription Page by ID
EndpointType Page
Locator Page
LocatorType Object

Page [1 of 1] - Pahang small heads issue
/api/v2/page/Kg2M9H

Uri /api/v2/page/Kg2M9H
UriDescription Page by ID
ResponseLevel Public
DateModified 2017-02-20T02:54:39+00:00
Name Pahang small heads issue
PasswordHint empty string
SecurityType None
UrlName Pahang-small-heads-issue
UrlPath /Pahang-small-heads-issue
WebUri https://www.linyangchen.com/Pahang-small-heads-issue

Uris

Folder
/api/v2/folder/user/yangchen

Uri /api/v2/folder/user/yangchen
UriDescription A folder or legacy (sub)category by UrlPath
EndpointType Folder
Locator Folder
LocatorType Object

HighlightImage
/api/v2/highlight/node/Kg2M9H

Uri /api/v2/highlight/node/Kg2M9H
UriDescription Highlight image for a folder, album, or page
EndpointType HighlightImage
Locator Image
LocatorType Object

Node
/api/v2/node/Kg2M9H

Uri /api/v2/node/Kg2M9H
UriDescription Node with the given id.
EndpointType Node
Locator Node
LocatorType Object

PageHighlightImage
/api/v2/page/Kg2M9H!highlightimage

Uri /api/v2/page/Kg2M9H!highlightimage
UriDescription Highlight image for page
EndpointType PageHighlightImage
Locator Image
LocatorType Object

ParentFolders
/api/v2/folder/user/yangchen!parents

Uri /api/v2/folder/user/yangchen!parents
UriDescription The sequence of parent folders, from the given folder to the root
EndpointType ParentFolders
Locator Folder
LocatorType Objects

User
/api/v2/user/yangchen

Uri /api/v2/user/yangchen
UriDescription User By Nickname
EndpointType User
Locator User
LocatorType Object

Timing

Total

cycles 1
objects 0
time 0.03983

Config

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

Options

Path

  • /api
  • /v2
  • /page
  • /

Notes

  • PageHighlightImage is deprecated, use HighlightImage instead

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

PATCH

Permissions
  • Modify

DELETE

Permissions
  • Modify

Output Fields

DateAdded datetimeiso8601
DateModified datetimeiso8601
HighlightImageUri uri
Name text
PasswordHint text
Privacy select
  • Public
  • Unlisted
  • Private
SecurityType select
  • None
  • Password
  • GrantAccess
UrlName text
UrlPath text

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/page/Kg2M9H?_responseLevel=Public"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "PATCH": {
                "Permissions": [
                    "Modify"
                ]
            },
            "DELETE": {
                "Permissions": [
                    "Modify"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "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": "Kg2M9H",
                "param_validator": {}
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node/:nodeid"
        }
    },
    "Response": {
        "Uri": "/api/v2/page/Kg2M9H?_responseLevel=Public",
        "Locator": "Page",
        "LocatorType": "Object",
        "Page": {
            "Name": "Pahang small heads issue",
            "UrlName": "Pahang-small-heads-issue",
            "PasswordHint": "",
            "SecurityType": "None",
            "DateModified": "2017-02-20T02:54:39+00:00",
            "UrlPath": "/Pahang-small-heads-issue",
            "Uri": "/api/v2/page/Kg2M9H",
            "WebUri": "https://www.linyangchen.com/Pahang-small-heads-issue",
            "UriDescription": "Page by ID",
            "Uris": {
                "User": {
                    "Uri": "/api/v2/user/yangchen",
                    "Locator": "User",
                    "LocatorType": "Object",
                    "UriDescription": "User By Nickname",
                    "EndpointType": "User"
                },
                "Folder": {
                    "Uri": "/api/v2/folder/user/yangchen",
                    "Locator": "Folder",
                    "LocatorType": "Object",
                    "UriDescription": "A folder or legacy (sub)category by UrlPath",
                    "EndpointType": "Folder"
                },
                "ParentFolders": {
                    "Uri": "/api/v2/folder/user/yangchen!parents",
                    "Locator": "Folder",
                    "LocatorType": "Objects",
                    "UriDescription": "The sequence of parent folders, from the given folder to the root",
                    "EndpointType": "ParentFolders"
                },
                "Node": {
                    "Uri": "/api/v2/node/Kg2M9H",
                    "Locator": "Node",
                    "LocatorType": "Object",
                    "UriDescription": "Node with the given id.",
                    "EndpointType": "Node"
                },
                "HighlightImage": {
                    "Uri": "/api/v2/highlight/node/Kg2M9H",
                    "Locator": "Image",
                    "LocatorType": "Object",
                    "UriDescription": "Highlight image for a folder, album, or page",
                    "EndpointType": "HighlightImage"
                },
                "PageHighlightImage": {
                    "Uri": "/api/v2/page/Kg2M9H!highlightimage",
                    "Locator": "Image",
                    "LocatorType": "Object",
                    "UriDescription": "Highlight image for page",
                    "EndpointType": "PageHighlightImage"
                }
            },
            "ResponseLevel": "Public"
        },
        "UriDescription": "Page by ID",
        "EndpointType": "Page",
        "Timing": {
            "Total": {
                "time": 0.03983,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}