Node

An Object

Table of Contents

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 is 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 to help you get started!

Parent

This Node is contained within a Repository.

Properties

The following properties are available:

Property Type Default Read-Only Description
_doc string No The primary ID
_system object No Metadata maintained by the system

Methods

The following methods are available:

Acquire

GET /repositories/{repositoryId}/branches/{branchId}/group/acquire

Parameters

Name Required Type Description
repositoryId true string
branchId true string The ID of the branch
id true string
createIfNotFound false boolean

Response

{}

Acquire

GET /repositories/{repositoryId}/branches/{branchId}/person/acquire

Parameters

Name Required Type Description
repositoryId true string
branchId true string
id true string
createIfNotFound false boolean

Response

{}

Add

POST /repositories/{repositoryId}/branches/{branchId}/i18n/add

Parameters

Name Required Type Description
repositoryId true string
branchId true string
masterNodeId true string
translationNodeId true string
edition false string
locale true string

Response

{}

Ancestorbytype

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/ancestorbytype

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
type true string

Response

{}

Associate

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/associate

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
node true string
type false string
directionality false string

Response

{}

Associations

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/associations

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Attachments

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Attachments

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Attachments

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/versions/{changesetId}/attachments

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
changesetId true string The ID of the changeset

Response

{}

Blogs

GET /repositories/{repositoryId}/branches/{branchId}/blogs

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Change_qname

PUT /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/change_qname

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
qname true string

Response

{}

Change_qname

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/change_qname

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
qname true string

Response

{}

Change_qname

PUT /repositories/{repositoryId}/b/{branchId}/nodes/{nodeId}/change_qname

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
qname true string

Response

{}

Change_qname

POST /repositories/{repositoryId}/b/{branchId}/nodes/{nodeId}/change_qname

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
qname true string

Response

{}

Change_qname

PUT /repositories/{repositoryId}/branches/{branchId}/n/{nodeId}/change_qname

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
qname true string

Response

{}

Change_qname

POST /repositories/{repositoryId}/branches/{branchId}/n/{nodeId}/change_qname

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
qname true string

Response

{}

Change_qname

PUT /repositories/{repositoryId}/b/{branchId}/n/{nodeId}/change_qname

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
qname true string

Response

{}

Change_qname

POST /repositories/{repositoryId}/b/{branchId}/n/{nodeId}/change_qname

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
qname true string

Response

{}

Change_type

PUT /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/change_type

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
type true string

Response

{}

Change_type

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/change_type

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
type true string

Response

{}

Change_type

PUT /repositories/{repositoryId}/b/{branchId}/nodes/{nodeId}/change_type

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
type true string

Response

{}

Change_type

POST /repositories/{repositoryId}/b/{branchId}/nodes/{nodeId}/change_type

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
type true string

Response

{}

Change_type

PUT /repositories/{repositoryId}/branches/{branchId}/n/{nodeId}/change_type

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
type true string

Response

{}

Change_type

POST /repositories/{repositoryId}/branches/{branchId}/n/{nodeId}/change_type

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
type true string

Response

{}

Change_type

PUT /repositories/{repositoryId}/b/{branchId}/n/{nodeId}/change_type

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
type true string

Response

{}

Change_type

POST /repositories/{repositoryId}/b/{branchId}/n/{nodeId}/change_type

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
type true string

Response

{}

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
branchId true string
nodeId true string
permissionId true string
id true string

Response

{
  "$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
branchId true string
nodeId true string
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "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

{
  "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
branchId true string

Response

{
  "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"
          }
        }
      }
    }
  }
}

Children

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/children

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Copy

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/copy

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
targetNodeId true string
targetPath false string
schedule false string

Response

{}

Copy

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments/{attachmentId}/copy

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
attachmentId true string
id true string

Response

{}

Deep

GET /repositories/{repositoryId}/branches/{branchId}/nodes/query/deep

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Deep

POST /repositories/{repositoryId}/branches/{branchId}/nodes/query/deep

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Delete

POST /repositories/{repositoryId}/branches/{branchId}/nodes/delete

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Delete

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/delete

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Diff

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/versions/{changesetId}/diff

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
changesetId true string

Response

{}

Editions

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/i18n/editions

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Features

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/features

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Features

GET /repositories/{repositoryId}/b/{branchId}/nodes/{nodeId}/features

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Features

GET /repositories/{repositoryId}/branches/{branchId}/n/{nodeId}/features

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Features

GET /repositories/{repositoryId}/b/{branchId}/n/{nodeId}/features

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Find

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/find

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Find

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/relatives/find

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Find

POST /repositories/{repositoryId}/branches/{branchId}/nodes/find

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Forms

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/forms

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Forms

GET /repositories/{repositoryId}/branches/{branchId}/definitions/{qname}/forms

Parameters

Name Required Type Description
repositoryId true string
branchId true string
qname true string

Response

{}

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
branchId true string
nodeId true string
authorityId true string
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

I18n

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/i18n

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
edition false string
locale true string

Response

{}

I18n

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/i18n

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
locale true string
edition false string

Response

{}

Incoming

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/incoming

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Items

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/list/{associationTypeId}/items

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
associationTypeId true string

Response

{}

Items

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/list/{associationTypeId}/items

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
associationTypeId true string

Response

{}

Items

POST /repositories/{repositoryId}/branches/{branchId}/lists/{listKey}/items

Parameters

Name Required Type Description
repositoryId true string
branchId true string
listKey true string

Response

{}

Items

DELETE /repositories/{repositoryId}/branches/{branchId}/lists/{listKey}/items

Parameters

Name Required Type Description
repositoryId true string
branchId true string
listKey true string

Response

{}

Items

GET /repositories/{repositoryId}/branches/{branchId}/lists/{listKey}/items

Parameters

Name Required Type Description
repositoryId true string
branchId true string
listKey true string

Response

{}

Items

POST /repositories/{repositoryId}/b/{branchId}/lists/{listKey}/items

Parameters

Name Required Type Description
repositoryId true string
branchId true string
listKey true string

Response

{}

Items

DELETE /repositories/{repositoryId}/b/{branchId}/lists/{listKey}/items

Parameters

Name Required Type Description
repositoryId true string
branchId true string
listKey true string

Response

{}

Items

GET /repositories/{repositoryId}/b/{branchId}/lists/{listKey}/items

Parameters

Name Required Type Description
repositoryId true string
branchId true string
listKey true string

Response

{}

Locales

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/i18n/locales

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
edition false string

Response

{}

Lock

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/lock

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Lock

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/lock

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Lookup

POST /repositories/{repositoryId}/branches/{branchId}/lookup

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Move

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/move

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
targetNodeId true string
targetPath false string

Response

{}

Movenodes

POST /repositories/{repositoryId}/branches/{branchId}/movenodes

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Mutual

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/mutual

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Nodes

GET /repositories/{repositoryId}/branches/{branchId}/nodes

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Nodes

POST /repositories/{repositoryId}/branches/{branchId}/nodes

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Nodes

PUT /repositories/{repositoryId}/branches/{branchId}/nodes

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Outgoing

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/outgoing

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Path

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/path

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
rootNodeId false string

Response

{}

Paths

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/paths

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Posts

GET /repositories/{repositoryId}/branches/{branchId}/blogs/{blogId}/posts

Parameters

Name Required Type Description
repositoryId true string
branchId true string
blogId true string

Response

{}

Predelete

POST /repositories/{repositoryId}/branches/{branchId}/nodes/predelete

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Predelete

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/predelete

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Queries for matches

Queries for matches
GET /repositories/{repositoryId}/branches/{branchId}/nodes/query

Parameters

Name Required Type Description
repositoryId true string
branchId 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

Response

{
  "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}/relatives/query

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{
  "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
branchId 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

Response

{
  "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
branchId 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

Response

{
  "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
branchId true string
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

Response

{
  "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
branchId true string
nodeId true string
associationTypeId true string

Response

{
  "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
branchId true string
listKey true string

Response

{
  "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}/b/{branchId}/lists/{listKey}/items/query

Parameters

Name Required Type Description
repositoryId true string
branchId true string
listKey true string

Response

{
  "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
branchId true string
nodeId true string

Response

{
  "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
branchId true string
nodeId true string
id true string

Response

{
  "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 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

{
  "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"
                }
              }
            }
          }
        }
      }
    }
  }
}

Recreate

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

Response

{}

Refresh

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/refresh

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Relatives

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/relatives

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Remove

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/i18n/remove

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Renditions

GET /ref/web/renditions

Parameters

Name Required Type Description
reference true string
id false string

Response

{}

Repair

POST /repositories/{repositoryId}/branches/{branchId}/paths/repair

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Restore

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/versions/{changesetId}/restore

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
changesetId true string

Response

{}

Restore

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments/{attachmentId}/restore

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
attachmentId true string

Response

{}

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
branchId true string
nodeId true string
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Search

GET /repositories/{repositoryId}/branches/{branchId}/nodes/search

Parameters

Name Required Type Description
repositoryId true string
branchId true string
text true string

Response

{}

Search

POST /repositories/{repositoryId}/branches/{branchId}/nodes/search

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Search

GET /repositories/{repositoryId}/branches/{branchId}/lists/{listKey}/items/search

Parameters

Name Required Type Description
repositoryId true string
branchId true string
listKey true string
text true string

Response

{}

Search

GET /repositories/{repositoryId}/b/{branchId}/lists/{listKey}/items/search

Parameters

Name Required Type Description
repositoryId true string
branchId true string
listKey true string
text true string

Response

{}

Search

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/list/{associationTypeId}/items/search

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
associationTypeId true string
text true string

Response

{}

Start

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/move/start

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
targetNodeId true string
targetPath false string

Response

{}

Start

POST /repositories/{repositoryId}/branches/{branchId}/nodes/transact/start

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Start

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/copy/start

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
targetNodeId true string
targetPath false string
schedule false string

Response

{}

Start

POST /repositories/{repositoryId}/branches/{branchId}/nodes/copy/start

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Start

POST /repositories/{repositoryId}/branches/{branchId}/nodes/move/start

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Starts an export job for this resource

Starts an export job for this resource
POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/export

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
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

{
  "type": "object",
  "description": "Export Configuration",
  "properties": {
    "startDate": {
      "type": "object"
    },
    "endDate": {
      "type": "object"
    },
    "startChangeset": {
      "type": "string"
    },
    "endChangeset": {
      "type": "string"
    },
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}

Starts an import job for this resource

Starts an import job for this resource
POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/import

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
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

{
  "type": "object",
  "description": "Import Configuration",
  "properties": {
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "substitutions": {
      "type": "string"
    }
  }
}

Touch

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/touch

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Transform

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments/{attachmentId}/transform

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
attachmentId true string

Response

{}

Translations

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/i18n/translations

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
edition false string

Response

{}

Traverse

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/traverse

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Tree

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/tree

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
path false string
base false string
depth false string
properties false string
object false string
containers false string

Response

{}

Tree

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/tree

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
path false string
base false string
depth false string
properties false string
object false string
containers false string

Response

{}

Tree

POST /repositories/{repositoryId}/branches/{branchId}/content/type/tree

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Type

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments/{attachmentId}/type

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
attachmentId true string
type true string

Response

{}

Unassociate

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/unassociate

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
node true string
type false string
directionality false string

Response

{}

Undelete

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/undelete

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Unlock

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/unlock

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Unmount

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/unmount

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Unzip

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments/{attachmentId}/unzip

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
attachmentId true string

Response

{}

Update

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/update

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Versions

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/versions

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string The ID of the node

Response

{}

_repair

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments/_repair

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

{attachmentId}

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments/{attachmentId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
attachmentId true string

Response

{}

{attachmentId}

DELETE /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments/{attachmentId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
attachmentId true string

Response

{}

{attachmentId}

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/attachments/{attachmentId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
attachmentId true string

Response

{}

{attachmentId}

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/versions/{changesetId}/attachments/{attachmentId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
attachmentId true string
changesetId true string The ID of the changeset

Response

{}

{changesetId}

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/versions/{changesetId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
changesetId true string

Response

{}

{featureId}

PUT /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/features/{featureId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
featureId true string

Response

{}

{featureId}

DELETE /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/features/{featureId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
featureId true string

Response

{}

{featureId}

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/features/{featureId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
featureId true string

Response

{}

{featureId}

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/features/{featureId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string The ID of the node
featureId true string

Response

{}

{featureId}

PUT /repositories/{repositoryId}/b/{branchId}/nodes/{nodeId}/features/{featureId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
featureId true string

Response

{}

{featureId}

DELETE /repositories/{repositoryId}/b/{branchId}/nodes/{nodeId}/features/{featureId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
featureId true string

Response

{}

{featureId}

GET /repositories/{repositoryId}/b/{branchId}/nodes/{nodeId}/features/{featureId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
featureId true string

Response

{}

{featureId}

POST /repositories/{repositoryId}/b/{branchId}/nodes/{nodeId}/features/{featureId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string The ID of the node
featureId true string

Response

{}

{featureId}

PUT /repositories/{repositoryId}/branches/{branchId}/n/{nodeId}/features/{featureId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
featureId true string

Response

{}

{featureId}

GET /repositories/{repositoryId}/branches/{branchId}/n/{nodeId}/features/{featureId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
featureId true string

Response

{}

{featureId}

POST /repositories/{repositoryId}/branches/{branchId}/n/{nodeId}/features/{featureId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string The ID of the node
featureId true string

Response

{}

{featureId}

PUT /repositories/{repositoryId}/b/{branchId}/n/{nodeId}/features/{featureId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
featureId true string

Response

{}

{featureId}

DELETE /repositories/{repositoryId}/b/{branchId}/n/{nodeId}/features/{featureId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
featureId true string

Response

{}

{featureId}

GET /repositories/{repositoryId}/b/{branchId}/n/{nodeId}/features/{featureId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
featureId true string

Response

{}

{featureId}

POST /repositories/{repositoryId}/b/{branchId}/n/{nodeId}/features/{featureId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string The ID of the node
featureId true string

Response

{}

{formKey}

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/forms/{formKey}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
formKey true string

Response

{}

{formKey}

GET /repositories/{repositoryId}/branches/{branchId}/definitions/{qname}/forms/{formKey}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
qname true string
formKey true string either form key or a form id

Response

{}

{itemId}

DELETE /repositories/{repositoryId}/branches/{branchId}/lists/{listKey}/items/{itemId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
listKey true string
itemId true string

Response

{}

{itemId}

DELETE /repositories/{repositoryId}/b/{branchId}/lists/{listKey}/items/{itemId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
listKey true string
itemId true string

Response

{}

{itemId}

DELETE /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/list/{associationTypeId}/items/{itemId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
associationTypeId true string
itemId true string

Response

{}

{listKey}

DELETE /repositories/{repositoryId}/branches/{branchId}/lists/{listKey}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
listKey true string

Response

{}

{listKey}

POST /repositories/{repositoryId}/branches/{branchId}/lists/{listKey}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
listKey true string
type true string

Response

{}

{listKey}

GET /repositories/{repositoryId}/branches/{branchId}/lists/{listKey}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
listKey true string

Response

{}

{listKey}

DELETE /repositories/{repositoryId}/b/{branchId}/lists/{listKey}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
listKey true string

Response

{}

{listKey}

POST /repositories/{repositoryId}/b/{branchId}/lists/{listKey}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
listKey true string
type true string

Response

{}

{listKey}

GET /repositories/{repositoryId}/b/{branchId}/lists/{listKey}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
listKey true string

Response

{}

{mountKey}

POST /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/mount/{mountKey}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
mountKey true string

Response

{}

{name}

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}/preview/{name}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string
name true string

Response

{}

{nodeId}

DELETE /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

{nodeId}

GET /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

{nodeId}

PATCH /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

{nodeId}

PUT /repositories/{repositoryId}/branches/{branchId}/nodes/{nodeId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string
nodeId true string

Response

{}

Schema


{
  "type": "object",
  "extends": "document",
  "description": "Node",
  "container": "repository",
  "properties": {
    "_doc": null,
    "_system": null
  },
  "id": "node"
}