Request
| Uri | /api/v2/node/:nodeid?_responseLevel=GrantAccess |
|---|---|
| Method | OPTIONS |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
Options
Methods
OPTIONS
| Permissions |
|
|---|
GET
| Permissions |
|
|---|
PATCH
| Permissions |
|
|---|
DELETE
| Permissions |
|
|---|
Parameters
PATCH
| AlbumTemplateUri | uri | Specify album presets by providing an AlbumTemplateUri. Only applicable for Type=Album. |
|---|---|---|
| AutoRename | boolean | Whether to automatically generate a unique UrlName if the given UrlName already exists. |
| CoverImageUri | uri | |
| Description | text | Human-readable description for this node. May contain basic HTML. Some node types display this to the user; some merely use it for search engine optimization. |
| HideOwner | boolean | Whether to hide the identity of this node's owner from visitors. Only applicable to Album nodes. |
| HighlightImageUri | uri | |
| Keywords | array | Array of keywords describing the content of this node. Some node types use this for search engine optimization. |
| Name | text | Human-readable name for this node. |
| Password | text | |
| PasswordHint | text | |
| Privacy |
select
|
Privacy level for this node. NOTE: This may be overridden by a more restrictive privacy setting inherited from one of this node's ancestors. See EffectivePrivacy. |
| ResetUrlName | boolean | Set the UrlName of this node to a generated value based on the Name of this node. |
| SecurityType |
select
|
Security type for this node. NOTE: This may be overridden by a more restrictive security setting inherited from one of this node's ancestors. See EffectiveSecurityType. |
| ShowCoverImage | boolean | Whether or not to display the cover image when possible. |
| SmugSearchable |
select
|
Acceptable values differ for root nodes and child nodes. Root nodes: No, Local, LocalUser, Yes Child nodes: No, Inherit from User |
| SortDirection |
select
|
|
| SortMethod |
select
|
|
| UrlName | text | This is usually a URL-friendly version of the human-readable name. Must start with a capital letter. |
| WorldSearchable |
select
|
Acceptable values differ for root nodes and child nodes. Root nodes: No, HomeOnly, Yes Child nodes: No, Inherit from User |
Output Fields
| CoverImageUri | uri | |
|---|---|---|
| DateAdded | datetimeiso8601 | |
| DateModified | datetimeiso8601 | |
| Description | text | Human-readable description for this node. May contain basic HTML. Some node types display this to the user; some merely use it for search engine optimization. |
| EffectivePrivacy |
select
|
Effective privacy level of this node. This takes into account the effect of privacy settings from this node's ancestors. |
| EffectiveSecurityType |
select
|
Effective security type of this node. This takes into account the effect of security settings from this node's ancestors. |
| FormattedValues | hash | Alternative versions of certain fields formatted for use in different contexts. |
| HasChildren | boolean | Whether this node contains any child nodes. |
| HideOwner | boolean | Whether to hide the identity of this node's owner from visitors. Only applicable to Album nodes. |
| HighlightImageUri | uri | |
| IsRoot | boolean | Whether this node is the owner's root node. |
| Keywords | array | Array of keywords describing the content of this node. Some node types use this for search engine optimization. |
| Name | text | Human-readable name for this node. |
| NodeID | text | This node's ID |
| Password | text | |
| PasswordHint | text | |
| Privacy |
select
|
Privacy level for this node. NOTE: This may be overridden by a more restrictive privacy setting inherited from one of this node's ancestors. See EffectivePrivacy. |
| SecurityType |
select
|
Security type for this node. NOTE: This may be overridden by a more restrictive security setting inherited from one of this node's ancestors. See EffectiveSecurityType. |
| ShowCoverImage | boolean | Whether or not to display the cover image when possible. |
| SmugSearchable |
select
|
Acceptable values differ for root nodes and child nodes. Root nodes: No, Local, LocalUser, Yes Child nodes: No, Inherit from User |
| SortDirection |
select
|
|
| SortIndex | integer | |
| SortMethod |
select
|
|
| Type |
select
|
|
| UrlName | text | This is usually a URL-friendly version of the human-readable name. Must start with a capital letter. |
| UrlPath | text | |
| WorldSearchable |
select
|
Acceptable values differ for root nodes and child nodes. Root nodes: No, HomeOnly, Yes Child nodes: No, Inherit from User |
JSON
{
"Request": {
"Version": "v2",
"Method": "OPTIONS",
"Uri": "/api/v2/node/:nodeid?_responseLevel=GrantAccess"
},
"Options": {
"MethodDetails": {
"OPTIONS": {
"Permissions": [
"Read"
]
},
"GET": {
"Permissions": [
"Read"
]
},
"PATCH": {
"Permissions": [
"Modify"
]
},
"DELETE": {
"Permissions": [
"Modify"
]
}
},
"Methods": [
"OPTIONS",
"GET",
"PATCH",
"DELETE"
],
"ParameterDescription": {
"Boolean": "For true return type true or 1, for false type false or 0",
"Uri": "Absolute or relative URL, restricted to Locator(s) of the supplied URL if not null. Up to a MAX_LENGTH in length.",
"Text": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)",
"Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)",
"Array": "An indexed array of values with a length in the range MIN_COUNT to MAX_COUNT, inclusive.",
"Select": "Select one option. Options should pass only the \"Value\"."
},
"Parameters": {
"PATCH": [
{
"Name": "AutoRename",
"Required": false,
"ReadOnly": false,
"Default": false,
"Description": "Whether to automatically generate a unique UrlName if the given UrlName already exists.",
"Type": "Boolean"
},
{
"Name": "CoverImageUri",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": [
"Image"
]
},
{
"Name": "Description",
"Required": false,
"ReadOnly": false,
"Default": null,
"Description": "Human-readable description for this node. May contain basic HTML. Some node types display this to the user; some merely use it for search engine optimization.",
"Type": "Text",
"MIN_CHARS": 0,
"MAX_CHARS": 65535
},
{
"Name": "HideOwner",
"Required": false,
"ReadOnly": false,
"Default": false,
"Description": "Whether to hide the identity of this node's owner from visitors. Only applicable to Album nodes.",
"Type": "Boolean"
},
{
"Name": "HighlightImageUri",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": [
"Image"
]
},
{
"Name": "Name",
"Required": false,
"ReadOnly": false,
"Default": null,
"Description": "Human-readable name for this node.",
"Type": "Varchar",
"MIN_CHARS": 1,
"MAX_CHARS": 254
},
{
"Name": "Keywords",
"Required": false,
"ReadOnly": false,
"Default": [],
"Description": "Array of keywords describing the content of this node. Some node types use this for search engine optimization.",
"Type": "Array",
"ITEM_TYPE": "Varchar",
"MIN_COUNT": 0,
"MAX_COUNT": "INFINITY"
},
{
"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": "Unlisted",
"Description": "Privacy level for this node. NOTE: This may be overridden by a more restrictive privacy setting inherited from one of this node's ancestors. See EffectivePrivacy.",
"Type": "Select",
"OPTIONS": [
"Public",
"Unlisted",
"Private"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "SecurityType",
"Required": false,
"ReadOnly": false,
"Default": "None",
"Description": "Security type for this node. NOTE: This may be overridden by a more restrictive security setting inherited from one of this node's ancestors. See EffectiveSecurityType.",
"Type": "Select",
"OPTIONS": [
"None",
"Password",
"GrantAccess"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "ShowCoverImage",
"Required": false,
"ReadOnly": false,
"Default": true,
"Description": "Whether or not to display the cover image when possible.",
"Type": "Boolean"
},
{
"Name": "SmugSearchable",
"Required": false,
"ReadOnly": false,
"Default": "Inherit from User",
"Description": "Acceptable values differ for root nodes and child nodes.\n\nRoot nodes: No, Local, LocalUser, Yes\nChild nodes: No, Inherit from User",
"Type": "Select",
"OPTIONS": [
"No",
"Local",
"LocalUser",
"Yes",
"Inherit from User"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "SortDirection",
"Required": false,
"ReadOnly": false,
"Default": "Descending",
"Type": "Select",
"OPTIONS": [
"Ascending",
"Descending"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "SortMethod",
"Required": false,
"ReadOnly": false,
"Default": "DateModified",
"Type": "Select",
"OPTIONS": [
"SortIndex",
"Name",
"DateAdded",
"DateModified"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "UrlName",
"Required": false,
"ReadOnly": false,
"Default": null,
"Description": "This is usually a URL-friendly version of the human-readable name. Must start with a capital letter.",
"Type": "Varchar",
"MIN_CHARS": 1,
"MAX_CHARS": 60
},
{
"Name": "WorldSearchable",
"Required": false,
"ReadOnly": false,
"Default": "Inherit from User",
"Description": "Acceptable values differ for root nodes and child nodes.\n\nRoot nodes: No, HomeOnly, Yes\nChild nodes: No, Inherit from User",
"Type": "Select",
"OPTIONS": [
"No",
"HomeOnly",
"Yes",
"Inherit from User"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "ResetUrlName",
"Required": false,
"ReadOnly": false,
"Default": false,
"Description": "Set the UrlName of this node to a generated value based on the Name of this node.",
"Type": "Boolean"
},
{
"Name": "AlbumTemplateUri",
"Required": false,
"ReadOnly": false,
"Default": null,
"Description": "Specify album presets by providing an AlbumTemplateUri. Only applicable for Type=Album.",
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": [
"AlbumTemplate"
]
}
],
"DELETE": []
},
"MediaTypes": [
"application/json",
"application/vnd.php.serialized",
"application/x-msgpack",
"text/html",
"text/csv"
],
"Output": [
{
"Name": "CoverImageUri",
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": [
"Image"
]
},
{
"Name": "Description",
"Description": "Human-readable description for this node. May contain basic HTML. Some node types display this to the user; some merely use it for search engine optimization.",
"Type": "Text",
"MIN_CHARS": 0,
"MAX_CHARS": 65535
},
{
"Name": "HideOwner",
"Description": "Whether to hide the identity of this node's owner from visitors. Only applicable to Album nodes.",
"Type": "Boolean"
},
{
"Name": "HighlightImageUri",
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": [
"Image"
]
},
{
"Name": "Name",
"Description": "Human-readable name for this node.",
"Type": "Varchar",
"MIN_CHARS": 1,
"MAX_CHARS": 254
},
{
"Name": "Keywords",
"Description": "Array of keywords describing the content of this node. Some node types use this for search engine optimization.",
"Type": "Array",
"ITEM_TYPE": "Varchar",
"MIN_COUNT": 0,
"MAX_COUNT": "INFINITY"
},
{
"Name": "Password",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 50
},
{
"Name": "PasswordHint",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 255
},
{
"Name": "Privacy",
"Description": "Privacy level for this node. NOTE: This may be overridden by a more restrictive privacy setting inherited from one of this node's ancestors. See EffectivePrivacy.",
"Type": "Select",
"OPTIONS": [
"Public",
"Unlisted",
"Private"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "SecurityType",
"Description": "Security type for this node. NOTE: This may be overridden by a more restrictive security setting inherited from one of this node's ancestors. See EffectiveSecurityType.",
"Type": "Select",
"OPTIONS": [
"None",
"Password",
"GrantAccess"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "ShowCoverImage",
"Description": "Whether or not to display the cover image when possible.",
"Type": "Boolean"
},
{
"Name": "SmugSearchable",
"Description": "Acceptable values differ for root nodes and child nodes.\n\nRoot nodes: No, Local, LocalUser, Yes\nChild nodes: No, Inherit from User",
"Type": "Select",
"OPTIONS": [
"No",
"Local",
"LocalUser",
"Yes",
"Inherit from User"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "SortDirection",
"Type": "Select",
"OPTIONS": [
"Ascending",
"Descending"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "SortMethod",
"Type": "Select",
"OPTIONS": [
"SortIndex",
"Name",
"DateAdded",
"DateModified"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "Type",
"Type": "Select",
"OPTIONS": [
"Album",
"Page",
"Folder",
"System Album",
"System Page"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "UrlName",
"Description": "This is usually a URL-friendly version of the human-readable name. Must start with a capital letter.",
"Type": "Varchar",
"MIN_CHARS": 1,
"MAX_CHARS": 60
},
{
"Name": "WorldSearchable",
"Description": "Acceptable values differ for root nodes and child nodes.\n\nRoot nodes: No, HomeOnly, Yes\nChild nodes: No, Inherit from User",
"Type": "Select",
"OPTIONS": [
"No",
"HomeOnly",
"Yes",
"Inherit from User"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "DateAdded",
"Type": "DateTimeISO8601"
},
{
"Name": "DateModified",
"Type": "DateTimeISO8601"
},
{
"Name": "EffectivePrivacy",
"Description": "Effective privacy level of this node. This takes into account the effect of privacy settings from this node's ancestors.",
"Type": "Select",
"OPTIONS": [
"Public",
"Unlisted",
"Private"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "EffectiveSecurityType",
"Description": "Effective security type of this node. This takes into account the effect of security settings from this node's ancestors.",
"Type": "Select",
"OPTIONS": [
"None",
"Password",
"GrantAccess"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "FormattedValues",
"Description": "Alternative versions of certain fields formatted for use in different contexts.",
"Type": "Hash"
},
{
"Name": "HasChildren",
"Description": "Whether this node contains any child nodes.",
"Type": "Boolean"
},
{
"Name": "IsRoot",
"Description": "Whether this node is the owner's root node.",
"Type": "Boolean"
},
{
"Name": "NodeID",
"Description": "This node's ID",
"Type": "Varchar",
"MIN_CHARS": 1,
"MAX_CHARS": "INFINITY"
},
{
"Name": "SortIndex",
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "UrlPath",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
}
],
"ResponseLevels": [
"Full",
"Public",
"Password",
"GrantAccess"
],
"Path": [
{
"type": "path",
"text": "api"
},
{
"type": "path",
"text": "v2"
},
{
"type": "path",
"text": "node"
},
{
"type": "singleparam",
"param_name": "nodeid",
"param_value": null
}
]
},
"Code": 200,
"Message": "Ok",
"Response": {
"Timing": {
"Total": {
"time": 0.01303,
"cycles": 1,
"objects": 0
}
}
}
}