Branch

An Object

Table of Contents

A branch is a workspace for your content. Each repository supports one or more branches. You basically create all of your content items in a branch. This includes articles, blog posts, new items, documents, Office files, PDFs, etc. You name it. They go into a branch.

You can have as many branches as you want. Each branch is a completely isolated workspace. Thus, you can create your own branch for your own projects. You can work on those projects and when you're happy with it, you can share it with the rest of the team.

Or, you can create a branch and invite a bunch of people to work with you. They're your own workspaces. You can play with them however you want.

Changesets and Branches

You can think of a branch in the same way as you might think of the tree of a branch. Like that old Maple tree in the backyard when you were a kid. Remember that tree? You used to climb it. Then one day, you fell out of it and now, pretty much, that's all you hear about when you go home for family reunions.

Anyway, yeah, so a branch is like a tree branch. Each tree branch stems from a previous branch. And branches are made up of changesets.

A changeset is a bit like a layer from a transparency. When you write content into a branch, it goes onto a new changeset. Every time you make a change, like when you update something or delete something, it also goes onto a new changeset. And so, in this way, branches grow in length.

Branches also maintain a "tip" view which is the sum total of all changes, creates, updates and deletes that you make while working with the branch. Thus, at all times, the full "changeset history" of everything you've done is maintained but so is a "tip" view that gives you a real-time view of what is effectively a top-most version of all your content.

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 Branch 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:

Add Team Member

Adds a principal as a member of a Team against the given branch
POST /repositories/{repositoryId}/branches/{branchId}/teams/{teamKey}/members/add

Parameters

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

Archive

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

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Behaviors

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

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Candidates

GET /repositories/{repositoryId}/branches/{branchId}/admin/dictionary/repair/candidates

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Candidates

GET /repositories/{repositoryId}/b/{branchId}/admin/dictionary/repair/candidates

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Chain

GET /repositories/{repositoryId}/branches/chain

Parameters

Name Required Type Description
repositoryId true string

Response

{}

Chain

GET /repositories/{repositoryId}/b/chain

Parameters

Name Required Type Description
repositoryId true string

Response

{}

Changeset

POST /repositories/{repositoryId}/branches/{branchId}/diffs/changeset

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Check Membership

Checks whether a principal belongs to a Team for the given branch
POST /repositories/{repositoryId}/branches/{branchId}/teams/{teamKey}/members/check

Parameters

Name Required Type Description
repositoryId true string
branchId true string
teamKey true string
id true string

Response

{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "belongs": {
      "type": "boolean"
    },
    "ok": null
  }
}

Check Permission

Checks whether one or more authorities against the specified branch are granted for a given set of users
POST /repositories/{repositoryId}/branches/{branchId}/permissions/{permissionId}/check

Parameters

Name Required Type Description
repositoryId true string
branchId 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 branch for the given user
POST /repositories/{repositoryId}/branches/{branchId}/authorities/{authorityId}/check

Parameters

Name Required Type Description
repositoryId true string
branchId true string
authorityId true string
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 branch are granted for a given set of users
POST /repositories/{repositoryId}/branches/authorities/check

Parameters

Name Required Type Description
repositoryId true string The ID of the repository

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 branch are granted for a given set of users
POST /repositories/{repositoryId}/branches/permissions/check

Parameters

Name Required Type Description
repositoryId 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}/definitions/{qname}/children

Parameters

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

Response

{}

Children

GET /repositories/{repositoryId}/b/{branchId}/definitions/{qname}/children

Parameters

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

Response

{}

Conflicting

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

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Copyfrom

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

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
branchId true string The ID of the branch
id true string

Response

{}

Count

POST /repositories/{repositoryId}/branches/{branchId}/diffs/nodeproperty/count

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Count

POST /repositories/{repositoryId}/branches/{branchId}/diffs/node/count

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Create Branch

Creates a new Branch
POST /repositories/{repositoryId}/branches

Parameters

Name Required Type Description
repositoryId true string
changeset true string
branch false string

Response

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

Create Branch

Creates a new Branch
POST /repositories/{repositoryId}/branches/

Parameters

Name Required Type Description
repositoryId true string
changeset true string
branch false string

Response

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

Create Branch

Creates a new Branch
POST /repositories/{repositoryId}/b

Parameters

Name Required Type Description
repositoryId true string
changeset true string
branch false string

Response

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

Create Branch

Creates a new Branch
POST /repositories/{repositoryId}/b/

Parameters

Name Required Type Description
repositoryId true string
changeset true string
branch false string

Response

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

Create a Team

Creates a Team against the given branch
POST /repositories/{repositoryId}/branches/{branchId}/teams

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{
  "type": "object",
  "extends": "document",
  "description": "Team",
  "properties": {
    "teamableObjectTypeId": {
      "type": "string",
      "readonly": true
    },
    "teamableObjectId": {
      "type": "string",
      "readonly": true
    },
    "key": {
      "type": "string"
    },
    "groupId": {
      "type": "string"
    },
    "groupDomainId": {
      "type": "string"
    },
    "roleKeys": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_doc": null,
    "_system": null
  }
}

Definitions

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

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Definitions

GET /repositories/{repositoryId}/b/{branchId}/definitions

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Delete

POST /repositories/{repositoryId}/branches/{branchId}/indexes/{name}/delete

Parameters

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

Response

{}

Delete

POST /repositories/{repositoryId}/snapshots/{snapshotId}/delete

Parameters

Name Required Type Description
repositoryId true string
snapshotId true string

Response

{}

Delete Branch

Deletes an existing Branch
POST /repositories/{repositoryId}/branches/{branchId}/delete

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

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

Delete Branch

Deletes an existing Branch
DELETE /repositories/{repositoryId}/branches/{branchId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

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

Deletes a Team

Deletes a Team against the given branch
DELETE /repositories/{repositoryId}/branches/{branchId}/teams/{teamKey}

Parameters

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

Response

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

Descendants

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

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Descendants

GET /repositories/{repositoryId}/b/{branchId}/descendants

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Export

GET /repositories/{repositoryId}/branches/{branchId}/diff/export

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
branchId true string The ID of the branch
id true string

Response

{}

Export

GET /repositories/{repositoryId}/branches/{branchId}/changes/export

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
branchId true string The ID of the branch
id true string
view false string

Response

{}

Find-duplicate-filenames

POST /repositories/{repositoryId}/branches/{branchId}/admin/find-duplicate-filenames

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Finds the other branches from which a branch can safely pull from

Finds the other branches from which a branch can safely pull from
GET /repositories/{repositoryId}/branches/{branchId}/pull/sources

Parameters

Name Required Type Description
repositoryId true string
branchId true string
all false string

Response

{}

Forks

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

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Forks

GET /repositories/{repositoryId}/b/{branchId}/forks

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Forms

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

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Forms

GET /repositories/{repositoryId}/b/{branchId}/forms

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Generate

POST /repositories/{repositoryId}/branches/{branchId}/qnames/generate

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Generate

POST /repositories/{repositoryId}/b/{branchId}/qnames/generate

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Get Team

Retrieves a Team against the given branch
GET /repositories/{repositoryId}/branches/{branchId}/teams/{teamKey}

Parameters

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

Response

{
  "type": "object",
  "extends": "document",
  "description": "Team",
  "properties": {
    "teamableObjectTypeId": {
      "type": "string",
      "readonly": true
    },
    "teamableObjectId": {
      "type": "string",
      "readonly": true
    },
    "key": {
      "type": "string"
    },
    "groupId": {
      "type": "string"
    },
    "groupDomainId": {
      "type": "string"
    },
    "roleKeys": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_doc": null,
    "_system": null
  }
}

Gets the branches with which this branch has merge conflicts.

Gets the branches with which this branch has merge conflicts.
GET /repositories/{repositoryId}/branches/{branchId}/merges

Parameters

Name Required Type Description
repositoryId true string
branchId true string
mergeType false string

Response

{}

Grant Authority

Grants an authority against the specified branch to a given user
POST /repositories/{repositoryId}/branches/{branchId}/authorities/{authorityId}/grant

Parameters

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

Grant Authority to Team

Assigns an Authority to a Team for the given branch
POST /repositories/{repositoryId}/branches/{branchId}/teams/{teamKey}/authorities/{authorityId}/grant

Parameters

Name Required Type Description
repositoryId true string
branchId true string
teamKey true string
authorityId true string

Response

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

Index

DELETE /repositories/{repositoryId}/branches/{branchId}/path/index

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Index

POST /repositories/{repositoryId}/branches/{branchId}/admin/collections/index

Parameters

Name Required Type Description
repositoryId true string
branchId true string
force false string

Response

{}

Index

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

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Indexes

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

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
branchId true string The ID of the branch

Response

{}

Indexes

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

Parameters

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

Response

{}

Info

GET /repositories/{repositoryId}/branches/{branchId}/deployments/info

Parameters

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

Response

{}

Info

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

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
branchId true string The ID of the branch

Response

{}

Initruntime

POST /repositories/{repositoryId}/branches/{branchId}/admin/initruntime

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Invalidates any branch changes for the given branch

Invalidates any branch changes for the given branch
POST /repositories/{repositoryId}/branches/{branchId}/changes/invalidate

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Joins

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

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Joins

GET /repositories/{repositoryId}/b/{branchId}/joins

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

List

GET /repositories/{repositoryId}/branches/{branchId}/tree/list

Parameters

Name Required Type Description
repositoryId true string
branchId true string
mode false string
archived true string
snapshots true string
releases true string
editorial true string
active true string
inactive true string
temporary true string

Response

{}

List

GET /repositories/{repositoryId}/branches/tree/list

Parameters

Name Required Type Description
repositoryId true string
snapshot true string
archived true string
temporary true string

Response

{}

List Team Authorities

Retrieves a list of the authorities defined to be granted by a Team
GET /repositories/{repositoryId}/branches/{branchId}/teams/{teamKey}/authorities

Parameters

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

Response

{
  "type": "object",
  "description": "List of Authorities",
  "properties": {
    "authorities": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

List Teams

Lists the Teams against the given branch
GET /repositories/{repositoryId}/branches/{branchId}/teams

Parameters

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

Lists Branch

Retrieves a list of Branch instances
GET /repositories/{repositoryId}/branches

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
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_branch"
      }
    }
  }
}

Lists Branch

Retrieves a list of Branch instances
GET /repositories/{repositoryId}/branches/

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
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_branch"
      }
    }
  }
}

Lists Branch

Retrieves a list of Branch instances
GET /repositories/{repositoryId}/b

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
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_branch"
      }
    }
  }
}

Lists Branch

Retrieves a list of Branch instances
GET /repositories/{repositoryId}/b/

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
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_branch"
      }
    }
  }
}

Lists Team Members

Lists the members of a Team against the given branch
GET /repositories/{repositoryId}/branches/{branchId}/teams/{teamKey}/members

Parameters

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

Merges a source branch into a target branch. The source branch is specified using the 'id' parameter. The target branch is the branch identified by the resource path.

Merges a source branch into a target branch. The source branch is specified using the 'id' parameter. The target branch is the branch identified by the resource path.
POST /repositories/{repositoryId}/branches/{branchId}/merge

Parameters

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

Response

{}

Network

POST /repositories/{repositoryId}/branches/network

Parameters

Name Required Type Description
repositoryId true string
workspace true string

Response

{}

Nodediffs

GET /repositories/{repositoryId}/branches/{branchId}/history/nodediffs

Parameters

Name Required Type Description
repositoryId true string
branchId true string
root false string
tip false string
include_root false string

Response

{}

Policies

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

Parameters

Name Required Type Description
repositoryId true string
branchId true string
containerOnly false string

Response

{}

Promote

POST /repositories/{repositoryId}/branches/{branchId}/admin/promote

Parameters

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

Response

{}

Properties

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

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
branchId true string The ID of the branch
excludeSystem true boolean

Response

{}

Queries for Branch

Queries for instances of type Branch
POST /repositories/{repositoryId}/branches/query

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
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_branch"
      }
    }
  }
}

Queries for Branch

Queries for instances of type Branch
POST /repositories/{repositoryId}/b/query

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
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_branch"
      }
    }
  }
}

Query

Queries for matches
POST /repositories/{repositoryId}/branches/{branchId}/behaviors/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}/deployments/verification/query

Parameters

Name Required Type Description
repositoryId 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}/definitions/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}/b/{branchId}/definitions/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"
      }
    }
  }
}

Read ACL

Read the Access Control List for the specified branch
GET /repositories/{repositoryId}/branches/{branchId}/acl/list

Parameters

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

Read the Access Control List for the specified branch and the given principal
GET /repositories/{repositoryId}/branches/{branchId}/acl

Parameters

Name Required Type Description
repositoryId true string
branchId 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 branch
POST /repositories/{repositoryId}/branches/{branchId}/authorities

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": "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 Branch

Reads an instance of a Branch
GET /repositories/{repositoryId}/branches/{branchId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

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

Read Branch

Reads an instance of a Branch
GET /repositories/{repositoryId}/b/{branchId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

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

Rebases the branch to a different root changeset.

Rebases the branch to a different root changeset.
POST /repositories/{repositoryId}/branches/{branchId}/rebase/start

Parameters

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

Response

{}

Refreshtype

POST /repositories/{repositoryId}/branches/{branchId}/admin/refreshtype

Parameters

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

Response

{}

Remove Team Member

Remove a principal from a team's membership list
POST /repositories/{repositoryId}/branches/{branchId}/teams/{teamKey}/members/remove

Parameters

Name Required Type Description
repositoryId true string
branchId true string
teamKey true string
id true string

Response

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

Repair

POST /repositories/{repositoryId}/admin/dictionary/repair

Parameters

Name Required Type Description
repositoryId true string
delete false string

Response

{}

Repair

POST /repositories/{repositoryId}/branches/{branchId}/admin/dictionary/repair

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Repair

POST /repositories/{repositoryId}/b/{branchId}/admin/dictionary/repair

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Repairkb

POST /repositories/{repositoryId}/branches/{branchId}/admin/repairkb

Parameters

Name Required Type Description
repositoryId true string
branchId true string The ID of the branch
refresh false string

Response

{}

Reset

POST /repositories/{repositoryId}/branches/{branchId}/admin/reset

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Resets the branch to a given prior changeset. This moves the branch head back to the given changeset and deletes the changesets that would otherwise now be dangling. The prior changeset must exist on the branch.

Resets the branch to a given prior changeset. This moves the branch head back to the given changeset and deletes the changesets that would otherwise now be dangling. The prior changeset must exist on the branch.
POST /repositories/{repositoryId}/branches/{branchId}/reset/start

Parameters

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

Response

{}

Revert

POST /repositories/{repositoryId}/branches/{branchId}/changes/revert

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Revert

POST /repositories/{repositoryId}/b/{branchId}/changes/revert

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Reverts the branch to a given prior changeset. This creates a new changeset whose contents restore the state from a previous changeset. The delta between the prior changeset and the tip is calculated and content operations are performed to effectively restore the prior tip state. The prior changeset must exist on the branch.

Reverts the branch to a given prior changeset. This creates a new changeset whose contents restore the state from a previous changeset. The delta between the prior changeset and the tip is calculated and content operations are performed to effectively restore the prior tip state. The prior changeset must exist on the branch.
POST /repositories/{repositoryId}/branches/{branchId}/revert/start

Parameters

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

Response

{}

Revoke Authority

Revokes an authority against the specified branch from a given user
POST /repositories/{repositoryId}/branches/{branchId}/authorities/{authorityId}/revoke

Parameters

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

Revoke Authority from Team

Revokes an Authority from a Team for the given branch
POST /repositories/{repositoryId}/branches/{branchId}/teams/{teamKey}/authorities/{authorityId}/revoke

Parameters

Name Required Type Description
repositoryId true string
branchId true string
teamKey true string
authorityId true string

Response

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

Schemas

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

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Schemas

GET /repositories/{repositoryId}/b/{branchId}/schemas

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Snapshots

POST /repositories/{repositoryId}/snapshots

Parameters

Name Required Type Description
repositoryId true string
changeset true string

Response

{}

Snapshots

GET /repositories/{repositoryId}/snapshots

Parameters

Name Required Type Description
repositoryId true string The ID of the repository

Response

{}

Start

POST /repositories/{repositoryId}/branches/{branchId}/search/index/validate/start

Parameters

Name Required Type Description
repositoryId true string
branchId true string
repair false string

Response

{}

Start

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

Parameters

Name Required Type Description
repositoryId true string
branchId true string
commit false string

Response

{}

Start

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

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
branchId true string The ID of the branch

Response

{}

Start

POST /repositories/{repositoryId}/branches/{branchId}/search/index/create/start

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Start

POST /repositories/{repositoryId}/branches/{branchId}/view/create/start

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Start

POST /repositories/{repositoryId}/branches/create/start

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
branch true string
changeset false string

Response

{}

Start

POST /repositories/{repositoryId}/branches/{branchId}/path/index/create/start

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Start

POST /repositories/{repositoryId}/snapshots/start

Parameters

Name Required Type Description
repositoryId true string
changeset true string

Response

{}

Start

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

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
branchId true string The ID of the branch

Response

{}

Start

POST /repositories/{repositoryId}/branches/{branchId}/embeddings/index/drop/start

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Start

POST /repositories/{repositoryId}/branches/{branchId}/cherrypick/start

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
branchId true string The ID of the branch

Response

{}

Start

POST /repositories/{repositoryId}/branches/{branchId}/deployments/verification/start

Parameters

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

Response

{}

Start

POST /repositories/{repositoryId}/branches/{branchId}/search/index/drop/start

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Start

POST /repositories/{repositoryId}/branches/{branchId}/history/start

Parameters

Name Required Type Description
repositoryId true string
branchId true string
root false string
tip false string
include_root false string
view false string

Response

{}

Start

POST /repositories/{repositoryId}/branches/{branchId}/embeddings/index/create/start

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Start

POST /repositories/{repositoryId}/branches/{branchId}/copyfrom/start

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
branchId true string The ID of the branch
id true string

Response

{}

Start

POST /repositories/{repositoryId}/branches/{branchId}/path/index/validate/start

Parameters

Name Required Type Description
repositoryId true string
branchId true string
repair false string

Response

{}

Starts a job to find all the changes made in one branch that would be applied during a merge. The source branch is specified using the 'id' parameter. The target branch is the branch identified by the resource path. A view can be applied using the 'view' parameter (valid value is 'editorial').

Starts a job to find all the changes made in one branch that would be applied during a merge. The source branch is specified using the 'id' parameter. The target branch is the branch identified by the resource path. A view can be applied using the 'view' parameter (valid value is 'editorial').
POST /repositories/{repositoryId}/branches/{branchId}/changes/start

Parameters

Name Required Type Description
repositoryId true string
branchId true string
id true string
view false string
filter false string
source false string
target false string
force false string

Response

{}

Starts an export job for this resource

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

Parameters

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

Parameters

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

Starts the diff-ing of a source and target branch. The source branch is specified using the 'id' parameter. The target branch is the branch identified by the resource path.

Starts the diff-ing of a source and target branch. The source branch is specified using the 'id' parameter. The target branch is the branch identified by the resource path.
POST /repositories/{repositoryId}/branches/{branchId}/diff/start

Parameters

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

Response

{}

Starts the merging of a source branch into a target branch. The source branch is specified using the 'id' parameter. The target branch is the branch identified by the resource path.

Starts the merging of a source branch into a target branch. The source branch is specified using the 'id' parameter. The target branch is the branch identified by the resource path.
POST /repositories/{repositoryId}/branches/{branchId}/merge/start

Parameters

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

Response

{}

Summarize Access Policy

Retrieves an access policy summary for a Team on the given branch
GET /repositories/{repositoryId}/branches/{branchId}/teams/{teamKey}/access/policies/summary

Parameters

Name Required Type Description
repositoryId true string
branchId true string
teamKey true string
scope false string
info false string
order false string

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Tree

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

Parameters

Name Required Type Description
repositoryId true string
branchId true string
mode false string
archived true string
snapshots true string
releases true string
editorial true string
active true string
inactive true string
temporary true string

Response

{}

Tree

GET /repositories/{repositoryId}/branches/tree

Parameters

Name Required Type Description
repositoryId true string
snapshot true string
archived true string
temporary true string

Response

{}

Unarchive

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

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Update Branch

Updates an existing Branch
POST /repositories/{repositoryId}/branches/{branchId}/update

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

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

Update Branch

Updates an existing Branch
POST /repositories/{repositoryId}/b/{branchId}/update

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

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

Update Branch

Updates an existing Branch
PUT /repositories/{repositoryId}/branches/{branchId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

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

Update Branch

Updates an existing Branch
PUT /repositories/{repositoryId}/b/{branchId}

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

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

Update a Team

Updates a Team against the given branch
PUT /repositories/{repositoryId}/branches/{branchId}/teams/{teamKey}

Parameters

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

Response

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

Upgradeschema

POST /repositories/{repositoryId}/branches/{branchId}/admin/upgradeschema

Parameters

Name Required Type Description
repositoryId true string
branchId true string

Response

{}

Validate

POST /repositories/{repositoryId}/branches/{branchId}/definitions/{qname}/validate

Parameters

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

Response

{}

Validate

POST /repositories/{repositoryId}/b/{branchId}/definitions/{qname}/validate

Parameters

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

Response

{}

{docId}

GET /repositories/{repositoryId}/branches/{branchId}/search/index/documents/{docId}

Parameters

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

Response

{}

{name}

DELETE /repositories/{repositoryId}/branches/{branchId}/indexes/{name}

Parameters

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

Response

{}

{qname}

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

Parameters

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

Response

{}

{qname}

GET /repositories/{repositoryId}/b/{branchId}/definitions/{qname}

Parameters

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

Response

{}

{qname}

GET /repositories/{repositoryId}/branches/{branchId}/qnames/{qname}

Parameters

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

Response

{}

{qname}

GET /repositories/{repositoryId}/b/{branchId}/qnames/{qname}

Parameters

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

Response

{}

{qname}

GET /repositories/{repositoryId}/branches/{branchId}/schemas/{qname}

Parameters

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

Response

{}

{qname}

GET /repositories/{repositoryId}/b/{branchId}/schemas/{qname}

Parameters

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

Response

{}

{snapshotId}

GET /repositories/{repositoryId}/snapshots/{snapshotId}

Parameters

Name Required Type Description
repositoryId true string
snapshotId true string

Response

{}

{snapshotId}

DELETE /repositories/{repositoryId}/snapshots/{snapshotId}

Parameters

Name Required Type Description
repositoryId true string
snapshotId true string

Response

{}

Schema


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