--- title: "Node" description: "Discover how Nodes store and connect content in arbitrary graph structures within a repository. Perfect for developers! (Gitana 4.0)" product: "Gitana" version: "4.0" url: "/documentation/gitana/4.0/reference/types/node" --- # Node An Object 1. [Platform](/documentation/gitana/4.0/reference/types/platform.md) 2. [Repository](/documentation/gitana/4.0/reference/types/repository.md) 3. [Node](/documentation/gitana/4.0/reference/types/node.md) ##### Table of Contents - [Overview](#top "Overview") - [Parent](#parent "Parent") - [Properties](#properties "Properties") - [Methods](#methods "Methods") - [Schema](#schema "Schema") All of the content in your branch is stored as Nodes. Nodes are vertexes in an arbitrarily structured graph. You store your content in Nodes and you relate Nodes to one another using Associations. Associations are a special kind of Node that points from one non-association Node to another. Nodes are also typed. Every node you create takes on a type. Types are identified by their QName which consists of a `prefix` and `local name`. You don't have to provide types for your Nodes if you don't want to. If nothing is provided, the default node type of `n:node` is used. > **Note:** Drop in one of our language drivers to accelerate your development. > Here are links to some of our popular [Cookbooks](/documentation/gitana/4.0/developers/cookbooks/overview.md) to help you get started! > > - [C#](/documentation/gitana/4.0/developers/cookbooks/csharp.md) > - [Go](/documentation/gitana/4.0/developers/cookbooks/go.md) > - [Java](/documentation/gitana/4.0/developers/cookbooks/java.md) > - [JavaScript](/documentation/gitana/4.0/developers/cookbooks/javascript2.md) > - [PHP](/documentation/gitana/4.0/developers/cookbooks/php.md) > - [Python](/documentation/gitana/4.0/developers/cookbooks/python.md) > - [Ruby](/documentation/gitana/4.0/developers/cookbooks/ruby.md) ## Parent This Node is contained within a [Repository](/documentation/gitana/4.0/reference/types/repository.md). ## Properties The following properties are available: | Property | Type | Default | Read-Only | Description | | --- | --- | --- | --- | --- | | \_doc | string | | No | The primary ID | | \_features | object | | Yes | This object contains all of the configuration for features which have been applied to this node instance. Feature configurations are keyed by feature QName. | | \_qname | string | | Yes | The QName for this node instance. | | \_system | object | | No | Metadata maintained by the system | | \_type | string | | Yes | The QName for the type of this node. | ## Methods The following methods are available: - [Acquire Group](#get-repositories-repositoryid-branches-branchid-group-acquire "Acquire Group") - [Acquire Person](#get-repositories-repositoryid-branches-branchid-person-acquire "Acquire Person") - [Add Feature](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-features-featureid "Add Feature") - [Add I18n](#post-repositories-repositoryid-branches-branchid-i18n-add "Add I18n") - [Ancestorbytype Node](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-ancestorbytype "Ancestorbytype Node") - [Associate](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-associate "Associate") - [Change Qname Node](#put-repositories-repositoryid-branches-branchid-nodes-nodeid-changeqname "Change Qname Node") - [Change Qname Node](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-changeqname "Change Qname Node") - [Change Type Node](#put-repositories-repositoryid-branches-branchid-nodes-nodeid-changetype "Change Type Node") - [Change Type Node](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-changetype "Change Type Node") - [Check Permission](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-permissions-permissionid-check "Check Permission") - [Check Single Authority](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-authorities-authorityid-check "Check Single Authority") - [Check multiple Authorities](#post-repositories-repositoryid-branches-branchid-nodes-authorities-check "Check multiple Authorities") - [Check multiple Permissions](#post-repositories-repositoryid-branches-branchid-nodes-permissions-check "Check multiple Permissions") - [Copy Attachment](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-attachments-attachmentid-copy "Copy Attachment") - [Copy Node](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-copy "Copy Node") - [Create Item](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-list-associationtypeid-items "Create Item") - [Create Item](#post-repositories-repositoryid-branches-branchid-lists-listkey-items "Create Item") - [Create Movenode](#post-repositories-repositoryid-branches-branchid-movenodes "Create Movenode") - [Create Node](#post-repositories-repositoryid-branches-branchid-nodes "Create Node") - [Deep Query](#get-repositories-repositoryid-branches-branchid-nodes-query-deep "Deep Query") - [Deep Query](#post-repositories-repositoryid-branches-branchid-nodes-query-deep "Deep Query") - [Delete Attachment](#delete-repositories-repositoryid-branches-branchid-nodes-nodeid-attachments-attachmentid "Delete Attachment") - [Delete Item](#delete-repositories-repositoryid-branches-branchid-lists-listkey-items-itemid "Delete Item") - [Delete Item](#delete-repositories-repositoryid-branches-branchid-nodes-nodeid-list-associationtypeid-items-itemid "Delete Item") - [Delete Items](#delete-repositories-repositoryid-branches-branchid-lists-listkey-items "Delete Items") - [Delete List](#delete-repositories-repositoryid-branches-branchid-lists-listkey "Delete List") - [Delete Node](#delete-repositories-repositoryid-branches-branchid-nodes-nodeid "Delete Node") - [Delete Node](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-delete "Delete Node") - [Delete Nodes](#post-repositories-repositoryid-branches-branchid-nodes-delete "Delete Nodes") - [Download Attachment](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-attachments-attachmentid "Download Attachment") - [Download Preview](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-preview-name "Download Preview") - [Editions I18n](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-i18n-editions "Editions I18n") - [Export Node](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-export "Export Node") - [Find Nodes](#post-repositories-repositoryid-branches-branchid-nodes-find "Find Nodes") - [Find Relatives](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-relatives-find "Find Relatives") - [Find around a Node](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-find "Find around a Node") - [Grant Authority](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-authorities-authorityid-grant "Grant Authority") - [I18n Node](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-i18n "I18n Node") - [Import Node](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-import "Import Node") - [List Associations](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-associations "List Associations") - [List Attachments](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-attachments "List Attachments") - [List Attachments](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-versions-changesetid-attachments "List Attachments") - [List Attachments](#get-repositories-repositoryid-branches-branchid-deletions-nodeid-attachments "List Attachments") - [List Blogs](#get-repositories-repositoryid-branches-branchid-blogs "List Blogs") - [List Children](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-children "List Children") - [List Data List Items](#get-repositories-repositoryid-branches-branchid-lists-listkey-items "List Data List Items") - [List Features](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-features "List Features") - [List Forms](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-forms "List Forms") - [List Forms](#get-repositories-repositoryid-branches-branchid-definitions-qname-forms "List Forms") - [List Incoming Associations](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-incoming "List Incoming Associations") - [List Items](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-list-associationtypeid-items "List Items") - [List Mutual Associations](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-mutual "List Mutual Associations") - [List Outgoing Associations](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-outgoing "List Outgoing Associations") - [List Paths](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-paths "List Paths") - [List Posts](#get-repositories-repositoryid-branches-branchid-blogs-blogid-posts "List Posts") - [List Relatives](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-relatives "List Relatives") - [List Versions](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-versions "List Versions") - [Lists Node](#get-repositories-repositoryid-branches-branchid-nodes "Lists Node") - [Locales I18n](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-i18n-locales "Locales I18n") - [Lock Node](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-lock "Lock Node") - [Lookup Branche](#post-repositories-repositoryid-branches-branchid-lookup "Lookup Branche") - [Move Node](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-move "Move Node") - [Patch Node](#patch-repositories-repositoryid-branches-branchid-nodes-nodeid "Patch Node") - [Predelete Node](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-predelete "Predelete Node") - [Predelete Nodes](#post-repositories-repositoryid-branches-branchid-nodes-predelete "Predelete Nodes") - [Query](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-relatives-query "Query") - [Query](#post-repositories-repositoryid-branches-branchid-nodes-query "Query") - [Query](#get-repositories-repositoryid-branches-branchid-nodes-query "Query") - [Query](#post-repositories-repositoryid-branches-branchid-blogs-query "Query") - [Query](#post-repositories-repositoryid-branches-branchid-blogs-blogid-posts-query "Query") - [Query](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-list-associationtypeid-items-query "Query") - [Query](#post-repositories-repositoryid-branches-branchid-lists-listkey-items-query "Query") - [Read ACL](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-acl-list "Read ACL") - [Read ACL for Principal](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-acl "Read ACL for Principal") - [Read Attachment](#get-repositories-repositoryid-branches-branchid-deletions-nodeid-attachments-attachmentid "Read Attachment") - [Read Attachment](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-versions-changesetid-attachments-attachmentid "Read Attachment") - [Read Authorities Report](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-authorities "Read Authorities Report") - [Read Data List](#get-repositories-repositoryid-branches-branchid-lists-listkey "Read Data List") - [Read Diff Version](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-versions-changesetid-diff "Read Diff Version") - [Read Feature](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-features-featureid "Read Feature") - [Read Form](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-forms-formkey "Read Form") - [Read Form](#get-repositories-repositoryid-branches-branchid-definitions-qname-forms-formkey "Read Form") - [Read I18n Node](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-i18n "Read I18n Node") - [Read Lock Node](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-lock "Read Lock Node") - [Read Node](#get-repositories-repositoryid-branches-branchid-nodes-nodeid "Read Node") - [Read Path Node](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-path "Read Path Node") - [Read Tree](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-tree "Read Tree") - [Read Tree](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-tree "Read Tree") - [Read Version](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-versions-changesetid "Read Version") - [Recreate Filenames](#post-repositories-repositoryid-branches-branchid-filenames-recreate "Recreate Filenames") - [Refresh Node](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-refresh "Refresh Node") - [Remove Feature](#delete-repositories-repositoryid-branches-branchid-nodes-nodeid-features-featureid "Remove Feature") - [Remove I18n](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-i18n-remove "Remove I18n") - [Renditions Web](#get-ref-web-renditions "Renditions Web") - [Repair Attachments](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-attachments-repair "Repair Attachments") - [Repair Paths](#post-repositories-repositoryid-branches-branchid-paths-repair "Repair Paths") - [Restore Attachment](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-attachments-attachmentid-restore "Restore Attachment") - [Restore Version](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-versions-changesetid-restore "Restore Version") - [Revoke Authority](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-authorities-authorityid-revoke "Revoke Authority") - [Search Items](#get-repositories-repositoryid-branches-branchid-lists-listkey-items-search "Search Items") - [Search Items](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-list-associationtypeid-items-search "Search Items") - [Search Nodes](#get-repositories-repositoryid-branches-branchid-nodes-search "Search Nodes") - [Search Nodes](#post-repositories-repositoryid-branches-branchid-nodes-search "Search Nodes") - [Start Copy](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-copy-start "Start Copy") - [Start Copy](#post-repositories-repositoryid-branches-branchid-nodes-copy-start "Start Copy") - [Start Move](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-move-start "Start Move") - [Start Move](#post-repositories-repositoryid-branches-branchid-nodes-move-start "Start Move") - [Start Transact](#post-repositories-repositoryid-branches-branchid-nodes-transact-start "Start Transact") - [Touch Node](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-touch "Touch Node") - [Transform Attachment](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-attachments-attachmentid-transform "Transform Attachment") - [Translations I18n](#get-repositories-repositoryid-branches-branchid-nodes-nodeid-i18n-translations "Translations I18n") - [Traverse](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-traverse "Traverse") - [Tree Type](#post-repositories-repositoryid-branches-branchid-content-type-tree "Tree Type") - [Type Attachment](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-attachments-attachmentid-type "Type Attachment") - [Unassociate](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-unassociate "Unassociate") - [Undelete Node](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-undelete "Undelete Node") - [Unlock Node](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-unlock "Unlock Node") - [Unmount Node](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-unmount "Unmount Node") - [Unzip Attachment](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-attachments-attachmentid-unzip "Unzip Attachment") - [Update Feature](#put-repositories-repositoryid-branches-branchid-nodes-nodeid-features-featureid "Update Feature") - [Update List](#post-repositories-repositoryid-branches-branchid-lists-listkey "Update List") - [Update Mount](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-mount-mountkey "Update Mount") - [Update Node](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-update "Update Node") - [Update Node](#put-repositories-repositoryid-branches-branchid-nodes-nodeid "Update Node") - [Update Nodes](#put-repositories-repositoryid-branches-branchid-nodes "Update Nodes") - [Upload Attachment](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-attachments-attachmentid "Upload Attachment") - [Upload Attachments](#post-repositories-repositoryid-branches-branchid-nodes-nodeid-attachments "Upload Attachments") ### Acquire Group GET /repositories/{repositoryId}/branches/{branchId}/group/acquire #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | id | true | string | | | createIfNotFound | false | boolean | | ### Acquire Person GET /repositories/{repositoryId}/branches/{branchId}/person/acquire #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | id | true | string | | | createIfNotFound | false | boolean | | ### Add Feature Adds a feature to this node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/features/{featureId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | featureId | true | string | The QName of the feature, for example `f:container` | ### Add I18n POST /repositories/{repositoryId}/branches/{branchId}/i18n/add #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | masterNodeId | true | string | | | translationNodeId | true | string | | | edition | false | string | | | locale | true | string | | ### Ancestorbytype Node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/ancestorbytype #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | type | true | string | | ### Associate Creates an association from this node to another node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/associate #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | node | true | string | The ID of the other (target) node | | type | false | string | The association type (QName). If not specified, `a:linked` is used. | | directionality | false | string | | ### Change Qname Node PUT /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/change\_qname #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | qname | true | string | | ### Change Qname Node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/change\_qname #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | qname | true | string | | ### Change Type Node PUT /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/change\_type #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | type | true | string | | ### Change Type Node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/change\_type #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | type | true | string | | ### Check Permission Checks whether one or more authorities against the specified node are granted for a given set of users POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/permissions/{permissionId}/check #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | permissionId | true | string | The ID of the permission | | id | true | string | | #### Response ```json { "$ref": "#/components/schemas/checkPermission" } ``` ### Check Single Authority Checks whether a single authority is granted against the specified node for the given user POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/authorities/{authorityId}/check #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | authorityId | true | string | The ID or authority key for the authority | | id | true | string | | #### Response ```json { "type": "object", "description": "Check", "extends": "status", "properties": { "check": { "type": "boolean" }, "ok": null } } ``` ### Check multiple Authorities Checks whether one or more authorities against the specified node are granted for a given set of users POST /repositories/{repositoryId}/branches/{branchId}/nodes/authorities/check #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | #### Response ```json { "type": "object", "description": "Check Multiple Authorities Out", "properties": { "checks": { "type": "array", "items": { "type": "object", "properties": { "permissionedId": { "type": "string" }, "principalId": { "type": "string" }, "authorityId": { "type": "string" }, "result": { "type": "boolean" } } } } } } ``` ### Check multiple Permissions Checks whether one or more permissions against the specified node are granted for a given set of users POST /repositories/{repositoryId}/branches/{branchId}/nodes/permissions/check #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | #### Response ```json { "type": "object", "description": "Check Multiple Permissions Out", "properties": { "checks": { "type": "array", "items": { "type": "object", "properties": { "permissionedId": { "type": "string" }, "principalId": { "type": "string" }, "permissionId": { "type": "string" }, "result": { "type": "boolean" } } } } } } ``` ### Copy Attachment POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments/{attachmentId}/copy #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | attachmentId | true | string | | | id | true | string | | ### Copy Node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/copy #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | targetNodeId | true | string | | | targetPath | false | string | | | schedule | false | string | | ### Create Item POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/list/{associationTypeId}/items #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | associationTypeId | true | string | | ### Create Item POST /repositories/{repositoryId}/branches/{branchId}/lists/{listKey}/items #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | listKey | true | string | The key of the data list. A branch has at most one data list per key. | ### Create Movenode POST /repositories/{repositoryId}/branches/{branchId}/movenodes #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | ### Create Node Creates a new Node POST /repositories/{repositoryId}/branches/{branchId}/nodes #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | ### Deep Query GET /repositories/{repositoryId}/branches/{branchId}/nodes/query/deep #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | ### Deep Query POST /repositories/{repositoryId}/branches/{branchId}/nodes/query/deep #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | ### Delete Attachment Deletes an attachment DELETE /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments/{attachmentId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | attachmentId | true | string | The ID of the attachment, for example `default` | ### Delete Item DELETE /repositories/{repositoryId}/branches/{branchId}/lists/{listKey}/items/{itemId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | listKey | true | string | The key of the data list. A branch has at most one data list per key. | | itemId | true | string | | ### Delete Item DELETE /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/list/{associationTypeId}/items/{itemId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | associationTypeId | true | string | | | itemId | true | string | | ### Delete Items DELETE /repositories/{repositoryId}/branches/{branchId}/lists/{listKey}/items #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | listKey | true | string | The key of the data list. A branch has at most one data list per key. | ### Delete List DELETE /repositories/{repositoryId}/branches/{branchId}/lists/{listKey} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | listKey | true | string | The key of the data list. A branch has at most one data list per key. | ### Delete Node Deletes an existing Node DELETE /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | The node is marked as deleted on the tip changeset. Its previous edits and versions are preserved. ### Delete Node Deletes an existing Node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/delete #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | The node is marked as deleted on the tip changeset. Its previous edits and versions are preserved. ### Delete Nodes POST /repositories/{repositoryId}/branches/{branchId}/nodes/delete #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | ### Download Attachment Downloads an attachment GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments/{attachmentId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | attachmentId | true | string | The ID of the attachment, for example `default` | Pass `a=true` to set the `Content-Disposition` header. ### Download Preview Downloads a preview stream of a node attachment GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/preview/{name} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | name | true | string | | ### Editions I18n GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/i18n/editions #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### Export Node Starts an export job for this resource POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/export #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | groupId | false | string | The Group ID to be assigned to the exported archive | | artifactId | false | string | The Artifact ID to be assigned to the exported archive | | versionId | false | string | The Version ID to be assigned to the exported archive | | vaultId | false | string | The ID of the vault where the exported archive should be saved | | schedule | false | string | Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous') | #### Response ```json { "type": "object", "description": "Export Configuration", "properties": { "startDate": { "type": "object", "description": "Only include objects whose modification date is after this time (epoch millis). This is used for partial or rolling exports." }, "endDate": { "type": "object", "description": "Only include objects whose modification date is before this time (epoch millis). This is used for partial or rolling exports." }, "startChangeset": { "type": "string", "description": "Only include data that is relevant to changesets at or beyond the specified changeset." }, "endChangeset": { "type": "string", "description": "Only include data that is relevant to changesets at or before the specified changeset." }, "includeACLs": { "type": "boolean", "default": true, "description": "Whether to include ACLs during export." }, "includeTeams": { "type": "boolean", "default": true, "description": "Whether to include Teams during export." }, "includeActivities": { "type": "boolean", "default": true, "description": "Whether to include Activities during export." }, "includeBinaries": { "type": "boolean", "default": true, "description": "Whether to include Binaries for data stores during export." }, "includeAttachments": { "type": "boolean", "default": true, "description": "Whether to include Attachments for Attachables during export." }, "artifactDependencies": { "type": "array", "items": { "type": "object" } }, "artifactIncludes": { "type": "array", "items": { "type": "object" } }, "forceIncludes": { "type": "boolean" } } } ``` ### Find Nodes Runs a query and/or a search and composes the results into a single result set POST /repositories/{repositoryId}/branches/{branchId}/nodes/find #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | The JSON payload holds a `query` block (MongoDB query), a `search` block (ElasticSearch), or both. ### Find Relatives POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/relatives/find #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### Find around a Node Runs a traversal from this node, optionally combined with a query and/or a search, and composes the results into a single result set POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/find #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | The `traverse` block is required. If `search` or `query` are provided, their result sets are intersected with the traversal space. ### Grant Authority Grants an authority against the specified node to a given user POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/authorities/{authorityId}/grant #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | authorityId | true | string | The ID or authority key for the authority | | id | true | string | | #### Response ```json { "type": "object", "description": "Status of Operation", "properties": { "ok": { "type": "boolean", "description": "Indicates whether the operation succeeded or not" } } } ``` ### I18n Node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/i18n #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | edition | false | string | | | locale | true | string | | ### Import Node Starts an import job for this resource POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/import #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | groupId | false | string | The Group ID to be assigned to the exported archive | | artifactId | false | string | The Artifact ID to be assigned to the exported archive | | versionId | false | string | The Version ID to be assigned to the exported archive | | vaultId | false | string | The ID of the vault where the exported archive should be saved | | schedule | false | string | Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous') | #### Response ```json { "type": "object", "description": "Import Configuration", "properties": { "includeACLs": { "type": "boolean", "default": true, "description": "Whether to include ACLs during import." }, "includeTeams": { "type": "boolean", "default": true, "description": "Whether to include Teams during import." }, "includeActivities": { "type": "boolean", "default": true, "description": "Whether to include Activities during import." }, "includeBinaries": { "type": "boolean", "default": true, "description": "Whether to include Binaries for data stores during import." }, "includeAttachments": { "type": "boolean", "default": true, "description": "Whether to include Attachments for Attachables during import." }, "strategy": { "type": "array", "items": { "type": "string" }, "default": "CLONE", "description": "Either CLONE or COPY_EVERYTHING. Use CLONE to keep the same IDs on import. Use COPY_EVERYTHING to generate all new IDs for all entries on every import." }, "substitutions": { "type": "string" } } } ``` ### List Associations Retrieves the associations of this node, including INCOMING, OUTGOING and MUTUAL associations GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/associations #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### List Attachments Lists the attachments for a node GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### List Attachments GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/versions/{changesetId}/attachments #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | changesetId | true | string | The ID of the changeset | ### List Attachments GET /repositories/{repositoryId}/branches/{branchId}/deletions/{nodeId}/attachments #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### List Blogs GET /repositories/{repositoryId}/branches/{branchId}/blogs #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | ### List Children Retrieves a list of the child nodes of this node GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/children #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### List Data List Items Retrieves a list of the items in a data list GET /repositories/{repositoryId}/branches/{branchId}/lists/{listKey}/items #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | listKey | true | string | The key of the data list. A branch has at most one data list per key. | ### List Features Retrieves the features applied to this node GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/features #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### List Forms GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/forms #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### List Forms GET /repositories/{repositoryId}/branches/{branchId}/definitions/{qname}/forms #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | qname | true | string | | ### List Incoming Associations Retrieves the incoming associations of this node GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/incoming #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### List Items GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/list/{associationTypeId}/items #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | associationTypeId | true | string | | ### List Mutual Associations Retrieves the mutual (undirected) associations of this node GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/mutual #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### List Outgoing Associations Retrieves the outgoing associations of this node GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/outgoing #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### List Paths GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/paths #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### List Posts GET /repositories/{repositoryId}/branches/{branchId}/blogs/{blogId}/posts #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | blogId | true | string | | ### List Relatives GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/relatives #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### List Versions Retrieves a list of the versions of this node GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/versions #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### Lists Node Retrieves a list of Node instances GET /repositories/{repositoryId}/branches/{branchId}/nodes #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | ### Locales I18n GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/i18n/locales #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | edition | false | string | | ### Lock Node Locks this node so that only the user who took out the lock can make changes to it POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/lock #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | Other users can still read the node. Users with Owner or Manager authorities against the node can still change it and unlock it. ### Lookup Branche POST /repositories/{repositoryId}/branches/{branchId}/lookup #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | ### Move Node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/move #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | targetNodeId | true | string | | | targetPath | false | string | | ### Patch Node Applies a JSON Patch (RFC 6902) to an existing node PATCH /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | Send a JSON array of JSON Patch operations with the content type `application/json`. Patching only modifies an existing node; it can't create or delete nodes. ### Predelete Node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/predelete #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### Predelete Nodes POST /repositories/{repositoryId}/branches/{branchId}/nodes/predelete #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | ### Query Queries for items of type node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/relatives/query #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | #### Response ```json { "type": "object", "description": "Result Map", "properties": { "total_rows": { "type": "number" }, "offset": { "type": "number" }, "size": { "type": "number" }, "rows": { "type": "array", "items": { "type": "object" } } } } ``` ### Query Queries for matches POST /repositories/{repositoryId}/branches/{branchId}/nodes/query #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | sort | false | object | Defines how to sort fields in the result set | | skip | false | number | Skips the result set cursor ahead the specified number of records | | limit | false | number | Specifies the number of records to be handed back in the result set | This method supports pagination. #### Response ```json { "type": "object", "description": "Result Map", "properties": { "total_rows": { "type": "number" }, "offset": { "type": "number" }, "size": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/resultmap" } } } } ``` ### Query Queries for matches GET /repositories/{repositoryId}/branches/{branchId}/nodes/query #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | sort | false | object | Defines how to sort fields in the result set | | skip | false | number | Skips the result set cursor ahead the specified number of records | | limit | false | number | Specifies the number of records to be handed back in the result set | This method supports pagination. #### Response ```json { "type": "object", "description": "Result Map", "properties": { "total_rows": { "type": "number" }, "offset": { "type": "number" }, "size": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/resultmap" } } } } ``` ### Query Queries for matches POST /repositories/{repositoryId}/branches/{branchId}/blogs/query #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | sort | false | object | Defines how to sort fields in the result set | | skip | false | number | Skips the result set cursor ahead the specified number of records | | limit | false | number | Specifies the number of records to be handed back in the result set | This method supports pagination. #### Response ```json { "type": "object", "description": "Result Map", "properties": { "total_rows": { "type": "number" }, "offset": { "type": "number" }, "size": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/resultmap" } } } } ``` ### Query Queries for matches POST /repositories/{repositoryId}/branches/{branchId}/blogs/{blogId}/posts/query #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | blogId | true | string | | | sort | false | object | Defines how to sort fields in the result set | | skip | false | number | Skips the result set cursor ahead the specified number of records | | limit | false | number | Specifies the number of records to be handed back in the result set | This method supports pagination. #### Response ```json { "type": "object", "description": "Result Map", "properties": { "total_rows": { "type": "number" }, "offset": { "type": "number" }, "size": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/resultmap" } } } } ``` ### Query Queries for items of type node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/list/{associationTypeId}/items/query #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | associationTypeId | true | string | | #### Response ```json { "type": "object", "description": "Result Map", "properties": { "total_rows": { "type": "number" }, "offset": { "type": "number" }, "size": { "type": "number" }, "rows": { "type": "array", "items": { "type": "object" } } } } ``` ### Query Queries for items of type node POST /repositories/{repositoryId}/branches/{branchId}/lists/{listKey}/items/query #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | listKey | true | string | The key of the data list. A branch has at most one data list per key. | #### Response ```json { "type": "object", "description": "Result Map", "properties": { "total_rows": { "type": "number" }, "offset": { "type": "number" }, "size": { "type": "number" }, "rows": { "type": "array", "items": { "type": "object" } } } } ``` ### Read ACL Read the Access Control List for the specified node GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/acl/list #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | #### Response ```json { "type": "object", "description": "Result Map of ACL entries", "properties": { "total_rows": { "type": "number" }, "offset": { "type": "number" }, "size": { "type": "number" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "_doc": { "type": "string", "title": "Principal ID" }, "name": { "type": "string", "title": "Principal Name" }, "type": { "type": "string", "title": "Principal Type" }, "domainId": { "type": "string" }, "domainQualifiedId": { "type": "string" }, "domainQualifiedName": { "type": "string" }, "principalId": { "type": "string", "title": "Principal ID" }, "userEmail": { "type": "string" }, "userFirstName": { "type": "string" }, "userLastName": { "type": "string" }, "authorities": { "type": "array", "title": "Authorities", "items": { "type": "string", "title": "Authority Key" } } } } } } } ``` ### Read ACL for Principal Reads the ACL for a node and specific actor GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/acl #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | id | true | string | | #### Response ```json { "type": "object", "description": "Result Map of Authority Keys", "properties": { "total_rows": { "type": "number" }, "offset": { "type": "number" }, "size": { "type": "number" }, "rows": { "type": "array", "items": { "type": "string", "description": "Authority Key" } } } } ``` ### Read Attachment GET /repositories/{repositoryId}/branches/{branchId}/deletions/{nodeId}/attachments/{attachmentId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | attachmentId | true | string | | ### Read Attachment GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/versions/{changesetId}/attachments/{attachmentId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | attachmentId | true | string | | | changesetId | true | string | The ID of the changeset | ### Read Authorities Report Read the Authorities Report for the specified node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/authorities #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | #### Response ```json { "type": "object", "description": "Authority Report", "properties": { "principalId": { "type": "object", "properties": { "id": { "type": "object", "properties": { "role-key": { "type": "string" }, "principal": { "type": "string" }, "permissioned": { "type": "string" }, "inheritsFrom": { "type": "object", "properties": { "id": { "type": "string" }, "principal": { "type": "string" }, "permissioned": { "type": "string" } } } } } } } } } ``` ### Read Data List Reads the data list with the given key GET /repositories/{repositoryId}/branches/{branchId}/lists/{listKey} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | listKey | true | string | The key of the data list. A branch has at most one data list per key. | ### Read Diff Version GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/versions/{changesetId}/diff #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | changesetId | true | string | The ID of the changeset | ### Read Feature Reads the configuration of a feature applied to this node GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/features/{featureId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | featureId | true | string | The QName of the feature, for example `f:container` | ### Read Form GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/forms/{formKey} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | formKey | true | string | either form key or a form id | ### Read Form GET /repositories/{repositoryId}/branches/{branchId}/definitions/{qname}/forms/{formKey} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | qname | true | string | | | formKey | true | string | either form key or a form id | ### Read I18n Node GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/i18n #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | locale | true | string | | | edition | false | string | | ### Read Lock Node GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/lock #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### Read Node Reads an instance of a Node GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | Use `root` as the `nodeId` to read the root node of the branch. ### Read Path Node GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/path #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | rootNodeId | false | string | | ### Read Tree Retrieves the folder and file structure beneath this node in a single call POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/tree #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | path | false | string | An offset path from the node, for example `/shows/game-of-thrones` | | base | false | string | | | depth | false | string | Limits the depth of the tree: `1` returns only the immediate children, `2` also returns grandchildren. If not specified, the full tree is returned. | | properties | false | string | If `true`, each element in the tree includes a `properties` object with the properties of the node | | object | false | string | | | containers | false | string | If `true`, only containers (folders) are returned | Use `root` as the `nodeId` to start from the root node of the branch. The JSON payload may hold a query (MongoDB syntax) to filter the tree, or a `search` field to filter it with a full-text search. ### Read Tree Retrieves the folder and file structure beneath this node in a single call GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/tree #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | path | false | string | An offset path from the node, for example `/shows/game-of-thrones` | | base | false | string | | | depth | false | string | Limits the depth of the tree: `1` returns only the immediate children, `2` also returns grandchildren. If not specified, the full tree is returned. | | properties | false | string | If `true`, each element in the tree includes a `properties` object with the properties of the node | | object | false | string | | | containers | false | string | If `true`, only containers (folders) are returned | Use `root` as the `nodeId` to start from the root node of the branch. ### Read Version Reads a version of this node GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/versions/{changesetId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | changesetId | true | string | The ID of the changeset | ### Recreate Filenames POST /repositories/{repositoryId}/branches/{branchId}/filenames/recreate #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | ### Refresh Node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/refresh #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### Remove Feature Removes a feature from this node DELETE /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/features/{featureId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | featureId | true | string | The QName of the feature, for example `f:container` | ### Remove I18n POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/i18n/remove #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### Renditions Web GET /ref/web/renditions #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | reference | true | string | | | id | false | string | | ### Repair Attachments POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments/\_repair #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### Repair Paths POST /repositories/{repositoryId}/branches/{branchId}/paths/repair #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | ### Restore Attachment POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments/{attachmentId}/restore #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | attachmentId | true | string | | ### Restore Version POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/versions/{changesetId}/restore #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | changesetId | true | string | The ID of the changeset | ### Revoke Authority Revokes an authority against the specified node from a given user POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/authorities/{authorityId}/revoke #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | authorityId | true | string | The ID or authority key for the authority | | id | true | string | | #### Response ```json { "type": "object", "description": "Status of Operation", "properties": { "ok": { "type": "boolean", "description": "Indicates whether the operation succeeded or not" } } } ``` ### Search Items GET /repositories/{repositoryId}/branches/{branchId}/lists/{listKey}/items/search #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | listKey | true | string | The key of the data list. A branch has at most one data list per key. | | text | true | string | | ### Search Items POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/list/{associationTypeId}/items/search #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | associationTypeId | true | string | | | text | true | string | | ### Search Nodes Searches for nodes using a text search GET /repositories/{repositoryId}/branches/{branchId}/nodes/search #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | text | true | string | The text to search for: a keyword, a phrase or an ElasticSearch Query String | ### Search Nodes Searches for nodes using the ElasticSearch Query DSL POST /repositories/{repositoryId}/branches/{branchId}/nodes/search #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | Send a JSON payload whose `search` field holds the ElasticSearch DSL configuration block. ### Start Copy POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/copy/start #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | targetNodeId | true | string | | | targetPath | false | string | | | schedule | false | string | | ### Start Copy POST /repositories/{repositoryId}/branches/{branchId}/nodes/copy/start #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | ### Start Move POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/move/start #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | targetNodeId | true | string | | | targetPath | false | string | | ### Start Move POST /repositories/{repositoryId}/branches/{branchId}/nodes/move/start #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | ### Start Transact POST /repositories/{repositoryId}/branches/{branchId}/nodes/transact/start #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | ### Touch Node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/touch #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### Transform Attachment POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments/{attachmentId}/transform #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | attachmentId | true | string | | ### Translations I18n GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/i18n/translations #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | edition | false | string | | ### Traverse Walks the content graph from this node and returns the nodes that match the traversal POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/traverse #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | The JSON payload describes the association types to follow (with their direction), the `depth` and the node `types` to hand back. ### Tree Type POST /repositories/{repositoryId}/branches/{branchId}/content/type/tree #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | ### Type Attachment POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments/{attachmentId}/type #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | attachmentId | true | string | | | type | true | string | | ### Unassociate Removes the association between this node and another node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/unassociate #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | node | true | string | The ID of the other (target) node | | type | false | string | The association type (QName). If not specified, `a:linked` is used. | | directionality | false | string | | ### Undelete Node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/undelete #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### Unlock Node Releases the lock on this node. Only the user who took out the lock, or a user with Owner or Manager authorities against the node, can unlock it. POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/unlock #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### Unmount Node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/unmount #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### Unzip Attachment POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments/{attachmentId}/unzip #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | attachmentId | true | string | | ### Update Feature PUT /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/features/{featureId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | featureId | true | string | | ### Update List POST /repositories/{repositoryId}/branches/{branchId}/lists/{listKey} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | listKey | true | string | The key of the data list. A branch has at most one data list per key. | | type | true | string | | ### Update Mount POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/mount/{mountKey} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | mountKey | true | string | | ### Update Node Updates an existing Node POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/update #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### Update Node Updates an existing Node PUT /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ### Update Nodes PUT /repositories/{repositoryId}/branches/{branchId}/nodes #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | ### Upload Attachment Uploads an attachment POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments/{attachmentId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | | attachmentId | true | string | The ID of the attachment, for example `default` | ### Upload Attachments Uploads one or more attachments POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | branchId | true | string | The ID of the branch | | nodeId | true | string | The ID of the node | ## Schema ```json { "type": "object", "extends": "document", "description": "Node", "container": "repository", "properties": { "_doc": null, "_system": null, "_features": { "type": "object", "readonly": true, "description": "This object contains all of the configuration for features which have been applied to this node instance. Feature configurations are keyed by feature QName." }, "_qname": { "type": "string", "readonly": true, "description": "The QName for this node instance." }, "_type": { "type": "string", "readonly": true, "description": "The QName for the type of this node." } }, "id": "node" } ```