Repository
A Data Store
A Repository is a data store where you can store content objects - things like articles, blog entries, web site pages, video files, PDFs and much more. Repositories feature changeset versioning so that you can safely make changes without anything getting lost.
Repositories also give you dictionary services for defining content types, validation logic, behaviors and rules that trigger when content events are triggered.
Note |
Parent
This Repository is contained within a Platform.
Objects
This Repository contains the following objects:
- Release
- Branch
- Changeset
- Diff
- Link Check
- Node
- Association
- Merge Conflict
- Branch Group
- Workspace
- Property Diff
- Pull Request
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 | |
binaryStorageProviderType | string | No | The type identifier for the binary storage provider that backs this data store | |
datastoreId | string | Yes | The ID of the data store | |
datastoreTypeId | string | Yes | The data store type identifier | |
description | string | No | A description of the data store | |
enableAuditing | boolean | No | If true, then the data store will collect audit records for all service-level operations (such as CRUD operations). This incurs a slight performance penalty but guarantees you a record of all interactions with data for changesets, branches and nodes in the data store. | |
enableAuthorities | boolean | true | No | Whether to check access control rights for principals against this data store |
locked | boolean | Yes | Whether the data store is presently locked. If the data store is locked, then write operations against it will block. | |
lockedBy | string | No | The principal that holds the lock (if the data store is locked) | |
maxsize | number | No | The maximum allowed allocation size (on disk) of the data store in bytes. If this size of the data store exceeds this value, write operations will fail. A value of -1 indicates that there is no upper limit. | |
objectcount | number | No | The number of objects stored within the data store. This includes system-maintained objects. This value is updated periodically and may not be precise at the moment it is read. | |
size | number | Yes | The last-recorded allocation size (on disk) of the data store in bytes. This value is updated periodically and may not be precise at the moment it is read. | |
statisticsDate | object | No | Records the time when statistics were last run against the data store. Statistics are run periodically to calculate the data store size and object allocations. | |
statisticsDirty | boolean | Yes | Whether writes have occurred against this data store since the last time statistics were run. This signals to the system that statistics need to be collected at the next available opportunity. | |
title | string | No | The title of the data store |
Methods
The following methods are available:
- Add Team Member
- Check Membership
- Check Permission
- Check Single Authority
- Check multiple Authorities
- Check multiple Permissions
- Compress
- Compress
- Create Repository
- Create Repository
- Create a Team
- Creates a role for a repository
- Delete Repository
- Delete Repository
- Deletes a Team
- Deletes a role for a repository
- Deletes a role for a repository
- Get Team
- Grant Authority
- Grant Authority to Team
- Info
- List Team Authorities
- List Teams
- Lists Repository
- Lists Repository
- Lists Team Members
- Lists the roles for a repository
- Lock
- Queries for Repository
- Query
- Query
- Read ACL
- Read ACL for Principal
- Read Authorities Report
- Read Repository
- Reads a role for a repository
- Remove Team Member
- Revoke Authority
- Revoke Authority from Team
- Starts an export job for this resource
- Starts an import job for this resource
- Stats
- Syncanchors
- Unlock
- Update Repository
- Update Repository
- Update a Team
- Updates a role for a repository
- Updates a role for a repository
- {filename}
- {filename}
- {filename}
Add Team Member
Adds a principal as a member of a Team against the given repository
POST /repositories/{repositoryId}/teams/{teamKey}/members/add
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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"
}
}
}
}
Check Membership
Checks whether a principal belongs to a Team for the given repository
POST /repositories/{repositoryId}/teams/{teamKey}/members/check
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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 repository are granted for a given set of users
POST /repositories/{repositoryId}/permissions/{permissionId}/check
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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 repository for the given user
POST /repositories/{repositoryId}/authorities/{authorityId}/check
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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 repository are granted for a given set of users
POST /repositories/authorities/check
Parameters
This function has no parameters.
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 repository are granted for a given set of users
POST /repositories/permissions/check
Parameters
This function has no parameters.
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"
}
}
}
}
}
}
Compress
POST /repositories/{repositoryId}/branches/{branchId}/compress
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string | |
branchId | true | string | |
startChangesetRev | false | string | |
endChangesetRev | false | string | |
force | false | string |
Response
{}
Compress
POST /repositories/{repositoryId}/compress
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string | |
startChangesetRev | false | string | |
endChangesetRev | false | string | |
force | false | string |
Response
{}
Create Repository
Creates a new Repository
POST /repositories
Parameters
This function has no parameters.
Response
{
"type": "object",
"description": "Status of Operation",
"properties": {
"ok": {
"type": "boolean",
"description": "Indicates whether the operation succeeded or not"
}
}
}
Create Repository
Creates a new Repository
POST /repositories/
Parameters
This function has no parameters.
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 repository
POST /repositories/{repositoryId}/teams
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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
}
}
Creates a role for a repository
Creates a role for a repository
POST /repositories/{repositoryId}/roles
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string | |
HTTP Payload | true | string | HTTP Payload |
Response
{
"type": "object",
"description": "Status of Operation",
"properties": {
"ok": {
"type": "boolean",
"description": "Indicates whether the operation succeeded or not"
}
}
}
Delete Repository
Deletes an existing Repository
DELETE /repositories/{repositoryId}
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string |
Response
{
"type": "object",
"description": "Status of Operation",
"properties": {
"ok": {
"type": "boolean",
"description": "Indicates whether the operation succeeded or not"
}
}
}
Delete Repository
Deletes an existing Repository
POST /repositories/{repositoryId}/delete
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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 repository
DELETE /repositories/{repositoryId}/teams/{teamKey}
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string | |
teamKey | true | string |
Response
{
"type": "object",
"description": "Status of Operation",
"properties": {
"ok": {
"type": "boolean",
"description": "Indicates whether the operation succeeded or not"
}
}
}
Deletes a role for a repository
Deletes a role for a repository
DELETE /repositories/{repositoryId}/roles/{roleKeyOrId}
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string | |
roleKeyOrId | true | string |
Response
{
"type": "object",
"description": "Status of Operation",
"properties": {
"ok": {
"type": "boolean",
"description": "Indicates whether the operation succeeded or not"
}
}
}
Deletes a role for a repository
Deletes a role for a repository
POST /repositories/{repositoryId}/roles/{roleKeyOrId}/delete
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string | |
roleKeyOrId | true | string |
Response
{
"type": "object",
"description": "Status of Operation",
"properties": {
"ok": {
"type": "boolean",
"description": "Indicates whether the operation succeeded or not"
}
}
}
Get Team
Retrieves a Team against the given repository
GET /repositories/{repositoryId}/teams/{teamKey}
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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
}
}
Grant Authority
Grants an authority against the specified repository to a given user
POST /repositories/{repositoryId}/authorities/{authorityId}/grant
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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 repository
POST /repositories/{repositoryId}/teams/{teamKey}/authorities/{authorityId}/grant
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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"
}
}
}
Info
GET /repositories/{repositoryId}/info
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string | The ID of the repository |
Response
{}
List Team Authorities
Retrieves a list of the authorities defined to be granted by a Team
GET /repositories/{repositoryId}/teams/{teamKey}/authorities
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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 repository
GET /repositories/{repositoryId}/teams
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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 Repository
Retrieves a list of Repository instances
GET /repositories
Parameters
Name | Required | Type | Description |
---|---|---|---|
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_repository"
}
}
}
}
Lists Repository
Retrieves a list of Repository instances
GET /repositories/
Parameters
Name | Required | Type | Description |
---|---|---|---|
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_repository"
}
}
}
}
Lists Team Members
Lists the members of a Team against the given repository
GET /repositories/{repositoryId}/teams/{teamKey}/members
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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"
}
}
}
}
Lists the roles for a repository
Lists the roles for a repository
GET /repositories/{repositoryId}/roles
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string | |
inherited | false | string |
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"
}
}
}
}
Lock
POST /repositories/{repositoryId}/lock
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string |
Response
{}
Queries for Repository
Queries for instances of type Repository
POST /repositories/query
Parameters
Name | Required | Type | Description |
---|---|---|---|
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_repository"
}
}
}
}
Query
Queries for matches
POST /repositories/{repositoryId}/diffs/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}/propertydiffs/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"
}
}
}
}
Read ACL
Read the Access Control List for the specified repository
GET /repositories/{repositoryId}/acl/list
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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 repository and specific actor
GET /repositories/{repositoryId}/acl
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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 repository
POST /repositories/{repositoryId}/authorities
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string | The ID of the repository |
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 Repository
Reads an instance of a Repository
GET /repositories/{repositoryId}
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string |
Response
{
"type": "object",
"extends": "datastore",
"container": "platform",
"description": "Repository",
"properties": {
"enableAuditing": {
"type": "boolean",
"description": "If true, then the data store will collect audit records for all service-level operations (such as CRUD operations). This incurs a slight performance penalty but guarantees you a record of all interactions with data for changesets, branches and nodes in the data store.",
"default": false
},
"title": null,
"description": null,
"datastoreId": null,
"datastoreTypeId": null,
"enableAuthorities": null,
"size": null,
"maxsize": null,
"objectcount": null,
"locked": null,
"lockedBy": null,
"statisticsDate": null,
"statisticsDirty": null,
"binaryStorageProviderType": null,
"_doc": null,
"_system": null
}
}
Reads a role for a repository
Reads a role for a repository
GET /repositories/{repositoryId}/roles/{roleKeyOrId}
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string | |
roleKeyOrId | true | string | |
inherited | false | string |
Response
{
"$ref": "#/components/schemas/"
}
Remove Team Member
Remove a principal from a team's membership list
POST /repositories/{repositoryId}/teams/{teamKey}/members/remove
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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"
}
}
}
Revoke Authority
Revokes an authority against the specified repository from a given user
POST /repositories/{repositoryId}/authorities/{authorityId}/revoke
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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 repository
POST /repositories/{repositoryId}/teams/{teamKey}/authorities/{authorityId}/revoke
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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"
}
}
}
Starts an export job for this resource
Starts an export job for this resource
POST /repositories/{repositoryId}/export
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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}/import
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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"
}
}
}
Stats
POST /repositories/{repositoryId}/stats
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string |
Response
{}
Syncanchors
POST /repositories/{repositoryId}/admin/syncanchors
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string |
Response
{}
Unlock
POST /repositories/{repositoryId}/unlock
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string |
Response
{}
Update Repository
Updates an existing Repository
PUT /repositories/{repositoryId}
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string |
Response
{
"type": "object",
"description": "Status of Operation",
"properties": {
"ok": {
"type": "boolean",
"description": "Indicates whether the operation succeeded or not"
}
}
}
Update Repository
Updates an existing Repository
POST /repositories/{repositoryId}/update
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | 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 repository
PUT /repositories/{repositoryId}/teams/{teamKey}
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string | |
teamKey | true | string |
Response
{
"type": "object",
"description": "Status of Operation",
"properties": {
"ok": {
"type": "boolean",
"description": "Indicates whether the operation succeeded or not"
}
}
}
Updates a role for a repository
Updates a role for a repository
PUT /repositories/{repositoryId}/roles/{roleKeyOrId}
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string | |
roleKeyOrId | true | string | |
HTTP Payload | true | string | HTTP Payload |
Response
{
"type": "object",
"description": "Status of Operation",
"properties": {
"ok": {
"type": "boolean",
"description": "Indicates whether the operation succeeded or not"
}
}
}
Updates a role for a repository
Updates a role for a repository
POST /repositories/{repositoryId}/roles/{roleKeyOrId}/update
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string | |
roleKeyOrId | true | string | |
HTTP Payload | true | string | HTTP Payload |
Response
{
"type": "object",
"description": "Status of Operation",
"properties": {
"ok": {
"type": "boolean",
"description": "Indicates whether the operation succeeded or not"
}
}
}
{filename}
GET /repositories/{repositoryId}/files/{filename}
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string | |
filename | true | string |
Response
{}
{filename}
DELETE /repositories/{repositoryId}/files/{filename}
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string | |
filename | true | string |
Response
{}
{filename}
POST /repositories/{repositoryId}/files/{filename}
Parameters
Name | Required | Type | Description |
---|---|---|---|
repositoryId | true | string | |
filename | true | string |
Response
{}
Schema
{
"type": "object",
"extends": "datastore",
"container": "platform",
"description": "Repository",
"properties": {
"enableAuditing": {
"type": "boolean",
"description": "If true, then the data store will collect audit records for all service-level operations (such as CRUD operations). This incurs a slight performance penalty but guarantees you a record of all interactions with data for changesets, branches and nodes in the data store.",
"default": false
},
"title": null,
"description": null,
"datastoreId": null,
"datastoreTypeId": null,
"enableAuthorities": null,
"size": null,
"maxsize": null,
"objectcount": null,
"locked": null,
"lockedBy": null,
"statisticsDate": null,
"statisticsDirty": null,
"binaryStorageProviderType": null,
"_doc": null,
"_system": null
},
"id": "repository"
}