RepositoryResource

Application REST endpoint to access and manipulate specific Repository data.

The following resources are part of this group:

/repository

Mount Point: /api/repository

POST

Deploy a repository to a replication group.

Parameters

name description type default
replicationGroupId (no documentation provided) query

Request Body

element: svn-repository
media types: */*
application/xml

(no documentation provided)

Response Body

element: (custom)
media types: application/xml

(no documentation provided)

Status Codes

code description
202 Accepted
400 Bad Request - see Exception
404 Replication Group not found
409 Conflict - see Exception
401 Authentication required.
403 Authorization required - access forbidden

Response Headers

name description
Content Location Path to relevant Task

/repository/create

Mount Point: /api/repository/create

POST

Creates new repository on each node within given replication group

Request Body

element: svn-repository
media types: application/xml

(no documentation provided)

Response Body

element: (custom)
media types: application/xml
application/json

taskiId

Status Codes

code description
202 Accepted
400 Bad Request - problem with repository path
404 Replication group not found
409 Repository already exists OR more than 1 replication group exists with given name
401 Authentication required.
403 Authorization required - access forbidden

Response Headers

name description
Content Location Path to relevant Task

/repository/search

Mount Point: /api/repository/search

GET

Find the repository with the specified parameter(s)

Parameters

name description type default
filesystemPath (no documentation provided) query
withPendingTransactions true/false query false
withPendingTransactionsForAllNodes (no documentation provided) query false

Response Body

element: svn-repository
media types: application/xml

(no documentation provided)

Status Codes

code description
200 Ok
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}

Mount Point: /api/repository/{repositoryId}

GET

Get the specified Repository by Id

Parameters

name description type default
repositoryId (no documentation provided) path
withPendingTransactions true/false query false
withPendingTransactionsForAllNodes (no documentation provided) query false
withRepoSize (no documentation provided) query true

Response Body

element: svn-repository
media types: application/xml

(no documentation provided)

Status Codes

code description
200 Ok
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden

DELETE

Remove repository by id

Parameters

name description type default
repositoryId (no documentation provided) path

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

Status Codes

code description
200 Ok
202 Accepted
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden

Response Headers

name description
Content Location Path to relevant Task

/repository/{repositoryId}/clearTxnBlocks

Mount Point: /api/repository/{repositoryId}/clearTxnBlocks

PUT

Advanced use only. See User Manual for usage.

Parameters

name description type default
repositoryId (no documentation provided) path
consistencyCheck (no documentation provided) query false

Request Body

element: nodes
media types: application/xml

(no documentation provided)

Response Body

element: (custom)
media types: application/xml

(no documentation provided)

Status Codes

code description
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/clearTxnBlocksLocalNode

Mount Point: /api/repository/{repositoryId}/clearTxnBlocksLocalNode

PUT

Advanced use only. See User Manual for usage.

Parameters

name description type default
repositoryId (no documentation provided) path

Response Body

element: (custom)
media types: application/xml

(no documentation provided)

Status Codes

code description
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/consistencyCheck

Mount Point: /api/repository/{repositoryId}/consistencyCheck

POST

Start consistency check for specified repository

Parameters

name description type default
repositoryId (no documentation provided) path
numberOfRevisions Number of revisions to check. -1 indicates to check all revisions. -2 indicates to check the default number of revisions. query -2

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

Status Codes

code description
202 Accepted
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden

Response Headers

name description
Content Location Path to relevant Task

/repository/{repositoryId}/history

Mount Point: /api/repository/{repositoryId}/history

GET

Parameters

name description type default
repositoryId (no documentation provided) path

Response Body

element: (custom)
media types: application/xml

(no documentation provided)

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/nodeCount

Mount Point: /api/repository/{repositoryId}/nodeCount

GET

Finds the number of nodes that the specified repository is deployed to.

Parameters

name description type default
repositoryId (no documentation provided) path

Response Body

element: (custom)
media types: text/plain

(no documentation provided)

Status Codes

code description
200 Ok
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/prepareToUnsideline

Mount Point: /api/repository/{repositoryId}/prepareToUnsideline

PUT

Parameters

name description type default
repositoryId (no documentation provided) path

Response Body

element: (custom)
media types: application/xml
text/plain
application/json

(no documentation provided)

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/removeSkipThreshold

Mount Point: /api/repository/{repositoryId}/removeSkipThreshold

PUT

Advanced use only. See User Manual for usage.

Parameters

name description type default
repositoryId (no documentation provided) path

Request Body

element: nodes
media types: application/xml

(no documentation provided)

Response Body

element: (custom)
media types: application/xml

(no documentation provided)

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/repairTxnSequence

Mount Point: /api/repository/{repositoryId}/repairTxnSequence

PUT

Parameters

name description type default
repositoryId (no documentation provided) path

Request Body

element: nodes
media types: application/xml

(no documentation provided)

Response Body

element: (custom)
media types: application/xml

(no documentation provided)

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/replicationGroup

Mount Point: /api/repository/{repositoryId}/replicationGroup

GET

Get the replicationGroup associated with the given Repository Id.

Parameters

name description type default
repositoryId (no documentation provided) path
withPendingTransactions Indicate if the returned replication group should include pending transactions query false

Response Body

element: replicationGroup
media types: application/xml

(no documentation provided)

Status Codes

code description
200 Ok
400 Bad Request - see Exception
404 Repository/ReplicationGroup not found
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/size

Mount Point: /api/repository/{repositoryId}/size

GET

Get the size of the given Repository Id.

Parameters

name description type default
repositoryId (no documentation provided) path

Response Body

element: size
media types: application/xml

(no documentation provided)

Status Codes

code description
200 Ok
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/skipThreshold

Mount Point: /api/repository/{repositoryId}/skipThreshold

GET

Advanced use only. See User Manual for usage.

Parameters

name description type default
repositoryId (no documentation provided) path

Response Body

element: (custom)
media types: application/xml

(no documentation provided)

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/startoutput

Mount Point: /api/repository/{repositoryId}/startoutput

PUT

Advanced use only. See User Manual for usage.

Parameters

name description type default
repositoryId (no documentation provided) path
consistencyCheck (no documentation provided) query false

Request Body

element: nodes
media types: application/xml

(no documentation provided)

Response Body

element: (custom)
media types: application/xml

(no documentation provided)

Status Codes

code description
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/stophelper

Mount Point: /api/repository/{repositoryId}/stophelper

PUT

Advanced use only. See User Manual for usage.

Parameters

name description type default
repositoryId (no documentation provided) path
threshold (no documentation provided) query
helperNodeId (no documentation provided) query

Response Body

element: (custom)
media types: application/xml

(no documentation provided)

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/stopoutput

Mount Point: /api/repository/{repositoryId}/stopoutput

PUT

Advanced use only. See User Manual for usage.

Parameters

name description type default
repositoryId (no documentation provided) path

Request Body

element: nodes
media types: application/xml

(no documentation provided)

Response Body

element: (custom)
media types: application/xml

(no documentation provided)

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/txn

Mount Point: /api/repository/{repositoryId}/txn

GET

Parameters

name description type default
repositoryId (no documentation provided) path

Response Body

element: (custom)
media types: application/xml
application/json

(no documentation provided)

Status Codes

code description
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/uncoordinated-stopoutput

Mount Point: /api/repository/{repositoryId}/uncoordinated-stopoutput

PUT

Advanced use only. See User Manual for usage.

Parameters

name description type default
repositoryId (no documentation provided) path

Response Body

element: (custom)
media types: application/xml

(no documentation provided)

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/unsideline

Mount Point: /api/repository/{repositoryId}/unsideline

PUT

Parameters

name description type default
repositoryId (no documentation provided) path
resumeFrom (no documentation provided) query
membershipId (no documentation provided) query

Response Body

element: (custom)
media types: application/xml

(no documentation provided)

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/globalReadOnly/{readOnly}

Mount Point: /api/repository/{repositoryId}/globalReadOnly/{readOnly}

PUT

Set the globalReadOnly flag of specified repository

Parameters

name description type default
repositoryId (no documentation provided) path
readOnly true/false path

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

Status Codes

code description
202 Accepted
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/lastdelivered/{nodeName}

Mount Point: /api/repository/{repositoryId}/lastdelivered/{nodeName}

GET

Advanced use only. See User Manual for usage.

Parameters

name description type default
repositoryId (no documentation provided) path
nodeName (no documentation provided) path

Response Body

element: (custom)
media types: application/xml

(no documentation provided)

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/lastkey/{nodeName}

Mount Point: /api/repository/{repositoryId}/lastkey/{nodeName}

GET

Advanced use only. See User Manual for usage.

Parameters

name description type default
repositoryId (no documentation provided) path
nodeName (no documentation provided) path

Response Body

element: (custom)
media types: application/xml

(no documentation provided)

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/lastoutput/{nodeName}

Mount Point: /api/repository/{repositoryId}/lastoutput/{nodeName}

GET

Advanced use only. See User Manual for usage.

Parameters

name description type default
repositoryId (no documentation provided) path
nodeName (no documentation provided) path

Response Body

element: (custom)
media types: application/xml
text/plain

(no documentation provided)

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/localReadOnly/{readOnly}

Mount Point: /api/repository/{repositoryId}/localReadOnly/{readOnly}

PUT

Set/Reset the local read-only on the repository. Calling this method will result in any pending proposals to be retried.

If readOnly flag is 'true', then the repository will be sent into read-only mode.

Parameters

name description type default
repositoryId (no documentation provided) path
readOnly (no documentation provided) path

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

Status Codes

code description
202 Accepted
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden

Response Headers

name description
TODO Path to relevant Task

/repository/{repositoryId}/replicationGroup/{replicationGroupId}

Mount Point: /api/repository/{repositoryId}/replicationGroup/{replicationGroupId}

PUT

Change the replication group associated with a repository.

Parameters

name description type default
repositoryId (no documentation provided) path
replicationGroupId (no documentation provided) path

Response Body

element: (custom)
media types: application/xml

(no documentation provided)

Status Codes

code description
202 Accepted
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/skipThreshold/{key}

Mount Point: /api/repository/{repositoryId}/skipThreshold/{key}

PUT

Advanced use only. See User Manual for usage.

Parameters

name description type default
repositoryId (no documentation provided) path
key (no documentation provided) path

Request Body

element: nodes
media types: application/xml

(no documentation provided)

Response Body

element: (custom)
media types: application/xml

(no documentation provided)

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/txn/acquireBlock

Mount Point: /api/repository/{repositoryId}/txn/acquireBlock

PUT

Parameters

name description type default
repositoryId (no documentation provided) path
checkQuorum (no documentation provided) query true

Response Body

element: (custom)
media types: application/xml
application/json

(no documentation provided)

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/txn/failedBlocks

Mount Point: /api/repository/{repositoryId}/txn/failedBlocks

GET

Parameters

name description type default
repositoryId (no documentation provided) path

Response Body

element: (custom)
media types: application/xml
application/json

(no documentation provided)

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/txn/removeBlocks

Mount Point: /api/repository/{repositoryId}/txn/removeBlocks

PUT

Parameters

name description type default
repositoryId (no documentation provided) path

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/txn/failedBlocks/removeBlocks

Mount Point: /api/repository/{repositoryId}/txn/failedBlocks/removeBlocks

PUT

Parameters

name description type default
repositoryId (no documentation provided) path

Response Body

element: (custom)
media types: application/xml
application/json

(no documentation provided)

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden

/repository/{repositoryId}/txn/removeBlock/identity/{identity}

Mount Point: /api/repository/{repositoryId}/txn/removeBlock/identity/{identity}

PUT

Parameters

name description type default
repositoryId (no documentation provided) path
identity (no documentation provided) path

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden