RepositoryResource Resource

Application REST endpoint to access and manipulate specific Repository data.

POST /repository

Deploy a repository to a replication group.

Request Parameters
name type description default
replicationGroupId query
Request Body
media type data type
application/json FSFSRepositoryDTO (JSON)
application/xml FSFSRepositoryDTO (XML)
Response Codes
code condition
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 Body
media type data type description
application/xml responseImpl (XML)
Response Headers
name description
Content Location Path to relevant Task

Example

Request
POST /repository
Content-Type: application/json
Accept: application/xml

                
{
  "repositoryIdentity" : "...",
  "name" : "...",
  "fileSystemPath" : "...",
  "globalReadOnly" : true,
  "localReadOnly" : true,
  "readOnlyReason" : "...",
  "readOnlyTime" : 12345,
  "latestRevision" : {
    "revision" : "...",
    "timestamp" : 12345
  },
  "state" : { },
  "replicationGroupId" : "...",
  "pendingTransactions" : 12345,
  "pendingTransactionsForAllNodes" : {
    "repositoryNodesTransactions" : [ {
      "nodeId" : "...",
      "lastOutput" : 12345,
      "lastDelivered" : 12345,
      "pendingTransactions" : 12345
    }, {
      "nodeId" : "...",
      "lastOutput" : 12345,
      "lastDelivered" : 12345,
      "pendingTransactions" : 12345
    } ]
  },
  "dsmId" : "...",
  "isInitTxnSequenced" : true,
  "txnSequence" : 12345
}
Response
HTTP/1.1 202 Accepted
Content-Type: application/xml
Content Location: ...

                
<r-----/>

POST /repository/create

Creates new repository on each node within given replication group

Request Body
media type data type description
application/xml FSFSRepositoryDTO (XML) - FSFSRepositoryDTO containing new repository information
Response Codes
code condition
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
503 Repository could not be deployed as there are not enough nodes active to carry out the request.
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/json ResponseImpl (JSON) taskiId
application/xml responseImpl (XML)
Response Headers
name description
Content Location Path to relevant Task

Example

Request
POST /repository/create
Content-Type: application/xml
Accept: application/json

                
<svn-repository>
  <repositoryIdentity>...</repositoryIdentity>
  <name>...</name>
  <fileSystemPath>...</fileSystemPath>
  <globalReadOnly>...</globalReadOnly>
  <localReadOnly>...</localReadOnly>
  <readOnlyReason>...</readOnlyReason>
  <readOnlyTime>...</readOnlyTime>
  <latestRevision>
    <timestamp>...</timestamp>
  </latestRevision>
  <state/>
  <replicationGroupId>...</replicationGroupId>
  <pendingTransactions>...</pendingTransactions>
  <pendingTransactionsForAllNodes>
    <repositoryNodesTransactions>
      <nodeId>...</nodeId>
      <lastOutput>...</lastOutput>
      <lastDelivered>...</lastDelivered>
      <pendingTransactions>...</pendingTransactions>
    </repositoryNodesTransactions>
  </pendingTransactionsForAllNodes>
  <dsmId>...</dsmId>
  <isInitTxnSequenced>...</isInitTxnSequenced>
  <txnSequence>...</txnSequence>
</svn-repository>
Response
HTTP/1.1 202 Accepted
Content-Type: application/json
Content Location: ...

                
{
  "entity" : { },
  "statusType" : {
    "reasonPhrase" : "...",
    "statusCode" : 12345,
    "family" : "CLIENT_ERROR"
  },
  "entityType" : {
    "typeName" : "..."
  },
  "status" : 12345,
  "metadata" : {
    "property1" : [ { }, { } ],
    "property2" : [ { }, { } ]
  }
}

GET /repository/search

Find the repository with the specified parameter(s)

Request Parameters
name type description default constraints
filesystemPath query    
withPendingTransactions query true/false false boolean
withPendingTransactionsForAllNodes query false boolean
Response Codes
code condition
200 Ok
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml FSFSRepositoryDTO (XML)

Example

Request
GET /repository/search
Content-Type: */*
Accept: application/xml

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<svn-repository>
  <repositoryIdentity>...</repositoryIdentity>
  <name>...</name>
  <fileSystemPath>...</fileSystemPath>
  <globalReadOnly>...</globalReadOnly>
  <localReadOnly>...</localReadOnly>
  <readOnlyReason>...</readOnlyReason>
  <readOnlyTime>...</readOnlyTime>
  <latestRevision>
    <timestamp>...</timestamp>
  </latestRevision>
  <state/>
  <replicationGroupId>...</replicationGroupId>
  <pendingTransactions>...</pendingTransactions>
  <pendingTransactionsForAllNodes>
    <repositoryNodesTransactions>
      <nodeId>...</nodeId>
      <lastOutput>...</lastOutput>
      <lastDelivered>...</lastDelivered>
      <pendingTransactions>...</pendingTransactions>
    </repositoryNodesTransactions>
  </pendingTransactionsForAllNodes>
  <dsmId>...</dsmId>
  <isInitTxnSequenced>...</isInitTxnSequenced>
  <txnSequence>...</txnSequence>
</svn-repository>

PUT /repository/stophelperall

Advanced use only. See User Manual for usage.

Request Parameters
name type description constraints
helperNodeId query - node id to operate on.  
threshold query - threshold of sync stop operation - will be set per repo later. long
Request Body
media type data type description
application/xml repositoryAndHelperListDTO (XML) - repository ids list
Response Codes
code condition
202 Accepted
400 Bad Request - see Exception
404 Repository not found
500 Internal Server Error
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml repositoryGsnListDTO (XML)

Example

Request
PUT /repository/stophelperall
Content-Type: application/xml
Accept: application/xml

                
<repositoryAndHelperList>
  <repoList>...</repoList>
  <nodeList>
    <node>
      <nodeIdentity>...</nodeIdentity>
      <locationIdentity>...</locationIdentity>
      <isLocal>...</isLocal>
      <isUp>...</isUp>
      <isStopped>...</isStopped>
      <lastStatusChange>...</lastStatusChange>
      <attributes/>
    </node>
  </nodeList>
</repositoryAndHelperList>
Response
HTTP/1.1 202 Accepted
Content-Type: application/xml

                
<repositoryGsnList>
  <list>
    <repositoryIdentity>...</repositoryIdentity>
    <gsn>...</gsn>
  </list>
</repositoryGsnList>

DELETE /repository/{repositoryId}

Remove repository by id

Request Parameters
name type description
repositoryId path
Response Codes
code condition
200 Ok
202 Accepted
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/json ResponseImpl (JSON)
application/xml responseImpl (XML)
Response Headers
name description
Content Location Path to relevant Task

Example

Request
DELETE /repository/{repositoryId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content Location: ...

                
{
  "entity" : { },
  "statusType" : {
    "reasonPhrase" : "...",
    "statusCode" : 12345,
    "family" : "INFORMATIONAL"
  },
  "entityType" : {
    "typeName" : "..."
  },
  "status" : 12345,
  "metadata" : {
    "property1" : [ { }, { } ],
    "property2" : [ { }, { } ]
  }
}

GET /repository/{repositoryId}

Get the specified Repository by Id

Request Parameters
name type description default constraints
repositoryId path    
withPendingTransactions query true/false false boolean
withPendingTransactionsForAllNodes query false boolean
Response Codes
code condition
200 Ok
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml FSFSRepositoryDTO (XML)

Example

Request
GET /repository/{repositoryId}
Content-Type: */*
Accept: application/xml

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<svn-repository>
  <repositoryIdentity>...</repositoryIdentity>
  <name>...</name>
  <fileSystemPath>...</fileSystemPath>
  <globalReadOnly>...</globalReadOnly>
  <localReadOnly>...</localReadOnly>
  <readOnlyReason>...</readOnlyReason>
  <readOnlyTime>...</readOnlyTime>
  <latestRevision>
    <timestamp>...</timestamp>
  </latestRevision>
  <state/>
  <replicationGroupId>...</replicationGroupId>
  <pendingTransactions>...</pendingTransactions>
  <pendingTransactionsForAllNodes>
    <repositoryNodesTransactions>
      <nodeId>...</nodeId>
      <lastOutput>...</lastOutput>
      <lastDelivered>...</lastDelivered>
      <pendingTransactions>...</pendingTransactions>
    </repositoryNodesTransactions>
  </pendingTransactionsForAllNodes>
  <dsmId>...</dsmId>
  <isInitTxnSequenced>...</isInitTxnSequenced>
  <txnSequence>...</txnSequence>
</svn-repository>

PUT /repository/{repositoryId}/clearTxnBlocks

Advanced use only. See User Manual for usage.

Request Parameters
name type description default constraints
repositoryId path    
consistencyCheck query false boolean
Request Body
media type data type
application/xml nodeListDTO (XML)
Response Codes
code condition
202 Accepted
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml responseImpl (XML)

Example

Request
PUT /repository/{repositoryId}/clearTxnBlocks
Content-Type: application/xml
Accept: application/xml

                
<nodes>
  <node>
    <nodeIdentity>...</nodeIdentity>
    <locationIdentity>...</locationIdentity>
    <isLocal>...</isLocal>
    <isUp>...</isUp>
    <isStopped>...</isStopped>
    <lastStatusChange>...</lastStatusChange>
    <attributes>
      <attribute/>
    </attributes>
  </node>
</nodes>
Response
HTTP/1.1 202 Accepted
Content-Type: application/xml

                
<r-----/>

PUT /repository/{repositoryId}/clearTxnBlocksLocalNode

Advanced use only. See User Manual for usage.

Request Parameters
name type description
repositoryId path
Response Codes
code condition
202 Accepted
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml responseImpl (XML)

Example

Request
PUT /repository/{repositoryId}/clearTxnBlocksLocalNode
Content-Type: application/xml
Accept: application/xml

                
...
Response
HTTP/1.1 202 Accepted
Content-Type: application/xml

                
<r-----/>

POST /repository/{repositoryId}/consistencyCheck

Start consistency check for specified repository

Request Parameters
name type description default constraints
repositoryId path    
numberOfRevisions query Number of revisions to check. -1 indicates to check all revisions. -2 indicates to check the default number of revisions. -2 int
Response Codes
code condition
202 Accepted
400 Bad Request - see Exception
404 Repository not found
503 Service Unavailable
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/json ResponseImpl (JSON)
application/xml responseImpl (XML)
Response Headers
name description
Content Location Path to relevant Task

Example

Request
POST /repository/{repositoryId}/consistencyCheck
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 202 Accepted
Content-Type: application/json
Content Location: ...

                
{
  "entity" : { },
  "statusType" : {
    "reasonPhrase" : "...",
    "statusCode" : 12345,
    "family" : "OTHER"
  },
  "entityType" : {
    "typeName" : "..."
  },
  "status" : 12345,
  "metadata" : {
    "property1" : [ { }, { } ],
    "property2" : [ { }, { } ]
  }
}

GET /repository/{repositoryId}/history

Request Parameters
name type description
repositoryId path
Response Codes
code condition
200 Ok
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml historyDTO (XML)

Example

Request
GET /repository/{repositoryId}/history
Content-Type: */*
Accept: application/xml

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<history>
  <historyItem>
    <agreementKey>...</agreementKey>
    <value>...</value>
    <timeStamp>...</timeStamp>
  </historyItem>
</history>

GET /repository/{repositoryId}/nodeCount

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

Request Parameters
name type description
repositoryId path
Response Codes
code condition
200 Ok
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
text/plain (custom)

Example

Request
GET /repository/{repositoryId}/nodeCount
Content-Type: */*
Accept: text/plain

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...

PUT /repository/{repositoryId}/prepareToUnsideline

Request Parameters
name type description
repositoryId path
Response Codes
code condition
200 Ok
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/json string (JSON)
application/xml string (XML)
text/plain (custom)

Example

Request
PUT /repository/{repositoryId}/prepareToUnsideline
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

PUT /repository/{repositoryId}/removeSkipThreshold

Advanced use only. See User Manual for usage.

Request Parameters
name type description
repositoryId path
Request Body
media type data type
application/xml nodeListDTO (XML)
Response Codes
code condition
202 Accepted
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml responseImpl (XML)

Example

Request
PUT /repository/{repositoryId}/removeSkipThreshold
Content-Type: application/xml
Accept: application/xml

                
<nodes>
  <node>
    <nodeIdentity>...</nodeIdentity>
    <locationIdentity>...</locationIdentity>
    <isLocal>...</isLocal>
    <isUp>...</isUp>
    <isStopped>...</isStopped>
    <lastStatusChange>...</lastStatusChange>
    <attributes>
      <attribute/>
    </attributes>
  </node>
</nodes>
Response
HTTP/1.1 202 Accepted
Content-Type: application/xml

                
<r-----/>

PUT /repository/{repositoryId}/repairTxnSequence

Request Parameters
name type description
repositoryId path
Request Body
media type data type
application/xml nodeListDTO (XML)
Response Codes
code condition
202 Accepted
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml responseImpl (XML)

Example

Request
PUT /repository/{repositoryId}/repairTxnSequence
Content-Type: application/xml
Accept: application/xml

                
<nodes>
  <node>
    <nodeIdentity>...</nodeIdentity>
    <locationIdentity>...</locationIdentity>
    <isLocal>...</isLocal>
    <isUp>...</isUp>
    <isStopped>...</isStopped>
    <lastStatusChange>...</lastStatusChange>
    <attributes>
      <attribute/>
    </attributes>
  </node>
</nodes>
Response
HTTP/1.1 202 Accepted
Content-Type: application/xml

                
<r-----/>

GET /repository/{repositoryId}/replicationGroup

Get the replicationGroup associated with the given Repository Id.

Request Parameters
name type description default constraints
repositoryId path    
withPendingTransactions query Indicate if the returned replication group should include pending transactions false boolean
Response Codes
code condition
200 Ok
404 Repository/ReplicationGroup not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml VCSReplicationGroupDTO (XML)

Example

Request
GET /repository/{repositoryId}/replicationGroup
Content-Type: */*
Accept: application/xml

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<replicationGroup>
  <state>...</state>
  <replicationGroupName>...</replicationGroupName>
  <schedule>
    <scheduledNodeLists>
      <dayOfWeek>...</dayOfWeek>
      <hourOfDay>...</hourOfDay>
      <scheduled>...</scheduled>
      <scheduledNodes/>
      <membershipId>...</membershipId>
      <quorum>...</quorum>
    </scheduledNodeLists>
  </schedule>
  <replicationGroupIdentity>...</replicationGroupIdentity>
  <repositoryIds>...</repositoryIds>
  <scheduleManagingNodeId>...</scheduleManagingNodeId>
  <rotationSuspended>...</rotationSuspended>
  <pendingTransactions>...</pendingTransactions>
  <dsmId>...</dsmId>
  <nodes>
    <replicationGroupNodes>
      <node/>
      <role>...</role>
      <managingNode>...</managingNode>
    </replicationGroupNodes>
  </nodes>
</replicationGroup>

GET /repository/{repositoryId}/size

Get the size of the given Repository Id.

Request Parameters
name type description
repositoryId path
Response Codes
code condition
200 Ok
404 Repository not found
500 Internal Server Error
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml repositorySizeDTO (XML)

Example

Request
GET /repository/{repositoryId}/size
Content-Type: */*
Accept: application/xml

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<size>
  <size>...</size>
</size>

GET /repository/{repositoryId}/skipThreshold

Advanced use only. See User Manual for usage.

Request Parameters
name type description
repositoryId path
Response Codes
code condition
200 Ok
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml string (XML)

Example

Request
GET /repository/{repositoryId}/skipThreshold
Content-Type: application/xml
Accept: application/xml

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
...

PUT /repository/{repositoryId}/startoutput

Advanced use only. See User Manual for usage.

Request Parameters
name type description default constraints
repositoryId path    
consistencyCheck query false boolean
Request Body
media type data type
application/xml nodeListDTO (XML)
Response Codes
code condition
202 Accepted
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml responseImpl (XML)

Example

Request
PUT /repository/{repositoryId}/startoutput
Content-Type: application/xml
Accept: application/xml

                
<nodes>
  <node>
    <nodeIdentity>...</nodeIdentity>
    <locationIdentity>...</locationIdentity>
    <isLocal>...</isLocal>
    <isUp>...</isUp>
    <isStopped>...</isStopped>
    <lastStatusChange>...</lastStatusChange>
    <attributes>
      <attribute/>
    </attributes>
  </node>
</nodes>
Response
HTTP/1.1 202 Accepted
Content-Type: application/xml

                
<r-----/>

PUT /repository/{repositoryId}/stophelper

Advanced use only. See User Manual for usage.

Request Parameters
name type description constraints
repositoryId path  
helperNodeId query  
threshold query long
Response Codes
code condition
202 Accepted
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml responseImpl (XML)

Example

Request
PUT /repository/{repositoryId}/stophelper
Content-Type: application/xml
Accept: application/xml

                
...
Response
HTTP/1.1 202 Accepted
Content-Type: application/xml

                
<r-----/>

PUT /repository/{repositoryId}/stopoutput

Advanced use only. See User Manual for usage.

Request Parameters
name type description
repositoryId path
Request Body
media type data type
application/xml nodeListDTO (XML)
Response Codes
code condition
202 Accepted
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml responseImpl (XML)

Example

Request
PUT /repository/{repositoryId}/stopoutput
Content-Type: application/xml
Accept: application/xml

                
<nodes>
  <node>
    <nodeIdentity>...</nodeIdentity>
    <locationIdentity>...</locationIdentity>
    <isLocal>...</isLocal>
    <isUp>...</isUp>
    <isStopped>...</isStopped>
    <lastStatusChange>...</lastStatusChange>
    <attributes>
      <attribute/>
    </attributes>
  </node>
</nodes>
Response
HTTP/1.1 202 Accepted
Content-Type: application/xml

                
<r-----/>

GET /repository/{repositoryId}/txn

Request Parameters
name type description
repositoryId path
Response Codes
code condition
200 Ok
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/json TransactionBlockListDTO (JSON)
application/xml transactionBlockListDTO (XML)

Example

Request
GET /repository/{repositoryId}/txn
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "transactionBlockList" : [ {
    "identity" : "...",
    "repositoryIdentity" : "...",
    "repositoryName" : "...",
    "startOffset" : 12345,
    "endOffset" : 12345,
    "thresholdLimit" : 12345,
    "currentSequence" : 12345
  }, {
    "identity" : "...",
    "repositoryIdentity" : "...",
    "repositoryName" : "...",
    "startOffset" : 12345,
    "endOffset" : 12345,
    "thresholdLimit" : 12345,
    "currentSequence" : 12345
  } ],
  "knownTxnSequence" : 12345
}

PUT /repository/{repositoryId}/uncoordinated-stopoutput

Advanced use only. See User Manual for usage.

Request Parameters
name type description
repositoryId path
Response Codes
code condition
200 Ok
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml responseImpl (XML)

Example

Request
PUT /repository/{repositoryId}/uncoordinated-stopoutput
Content-Type: application/xml
Accept: application/xml

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<r-----/>

PUT /repository/{repositoryId}/unsideline

Request Parameters
name type description
repositoryId path
membershipId query
resumeFrom query
Response Codes
code condition
200 Ok
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml repositoryGsnListDTO (XML)

Example

Request
PUT /repository/{repositoryId}/unsideline
Content-Type: */*
Accept: application/xml

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
<repositoryGsnList>
  <list>
    <repositoryIdentity>...</repositoryIdentity>
    <gsn>...</gsn>
  </list>
</repositoryGsnList>

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

Set the globalReadOnly flag of specified repository

Request Parameters
name type description
readOnly path true/false
repositoryId path
Response Codes
code condition
202 Accepted
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/json ResponseImpl (JSON)
application/xml responseImpl (XML)

Example

Request
PUT /repository/{repositoryId}/globalReadOnly/{readOnly}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 202 Accepted
Content-Type: application/json

                
{
  "entity" : { },
  "statusType" : {
    "reasonPhrase" : "...",
    "statusCode" : 12345,
    "family" : "INFORMATIONAL"
  },
  "entityType" : {
    "typeName" : "..."
  },
  "status" : 12345,
  "metadata" : {
    "property1" : [ { }, { } ],
    "property2" : [ { }, { } ]
  }
}

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

Advanced use only. See User Manual for usage.

Request Parameters
name type description
nodeName path
repositoryId path
Response Codes
code condition
200 Ok
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml string (XML)

Example

Request
GET /repository/{repositoryId}/lastdelivered/{nodeName}
Content-Type: application/xml
Accept: application/xml

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
...

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

Advanced use only. See User Manual for usage.

Request Parameters
name type description
nodeName path
repositoryId path
Response Codes
code condition
200 Ok
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml string (XML)

Example

Request
GET /repository/{repositoryId}/lastkey/{nodeName}
Content-Type: application/xml
Accept: application/xml

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
...

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

Advanced use only. See User Manual for usage.

Request Parameters
name type description
nodeName path
repositoryId path
Response Codes
code condition
200 Ok
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml string (XML)
text/plain (custom)

Example

Request
GET /repository/{repositoryId}/lastoutput/{nodeName}
Content-Type: */*
Accept: application/xml

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
...

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

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.

Request Parameters
name type description
readOnly path
repositoryId path
Response Codes
code condition
202 Accepted
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/json ResponseImpl (JSON)
application/xml responseImpl (XML)
Response Headers
name description
TODO Path to relevant Task

Example

Request
PUT /repository/{repositoryId}/localReadOnly/{readOnly}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 202 Accepted
Content-Type: application/json
TODO: ...

                
{
  "entity" : { },
  "statusType" : {
    "reasonPhrase" : "...",
    "statusCode" : 12345,
    "family" : "SUCCESSFUL"
  },
  "entityType" : {
    "typeName" : "..."
  },
  "status" : 12345,
  "metadata" : {
    "property1" : [ { }, { } ],
    "property2" : [ { }, { } ]
  }
}

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

Change the replication group associated with a repository.

Request Parameters
name type description default
replicationGroupId path
repositoryId path
Response Codes
code condition
202 Accepted
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml responseImpl (XML)

Example

Request
PUT /repository/{repositoryId}/replicationGroup/{replicationGroupId}
Content-Type: */*
Accept: application/xml

                
...
Response
HTTP/1.1 202 Accepted
Content-Type: application/xml

                
<r-----/>

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

Advanced use only. See User Manual for usage.

Request Parameters
name type description
key path
repositoryId path
Request Body
media type data type
application/xml nodeListDTO (XML)
Response Codes
code condition
202 Accepted
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/xml repositoryGsnListDTO (XML)

Example

Request
PUT /repository/{repositoryId}/skipThreshold/{key}
Content-Type: application/xml
Accept: application/xml

                
<nodes>
  <node>
    <nodeIdentity>...</nodeIdentity>
    <locationIdentity>...</locationIdentity>
    <isLocal>...</isLocal>
    <isUp>...</isUp>
    <isStopped>...</isStopped>
    <lastStatusChange>...</lastStatusChange>
    <attributes>
      <attribute/>
    </attributes>
  </node>
</nodes>
Response
HTTP/1.1 202 Accepted
Content-Type: application/xml

                
<repositoryGsnList>
  <list>
    <repositoryIdentity>...</repositoryIdentity>
    <gsn>...</gsn>
  </list>
</repositoryGsnList>

PUT /repository/{repositoryId}/txn/acquireBlock

Request Parameters
name type description default constraints
repositoryId path    
checkQuorum query true boolean
Response Codes
code condition
202 Accepted
404 Repository not found
500 Internal Server Error - see Exception
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/json ResponseImpl (JSON)
application/xml responseImpl (XML)

Example

Request
PUT /repository/{repositoryId}/txn/acquireBlock
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 202 Accepted
Content-Type: application/json

                
{
  "entity" : { },
  "statusType" : {
    "reasonPhrase" : "...",
    "statusCode" : 12345,
    "family" : "INFORMATIONAL"
  },
  "entityType" : {
    "typeName" : "..."
  },
  "status" : 12345,
  "metadata" : {
    "property1" : [ { }, { } ],
    "property2" : [ { }, { } ]
  }
}

GET /repository/{repositoryId}/txn/failedBlocks

Request Parameters
name type description
repositoryId path
Response Codes
code condition
200 Ok
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/json AcquireBlockListDTO (JSON)
application/xml acquireBlockListDTO (XML)

Example

Request
GET /repository/{repositoryId}/txn/failedBlocks
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "acquireBlockList" : [ {
    "identity" : "...",
    "nodeIdentity" : "...",
    "repositoryIdentity" : "...",
    "lastSequence" : 12345,
    "blockSize" : 12345
  }, {
    "identity" : "...",
    "nodeIdentity" : "...",
    "repositoryIdentity" : "...",
    "lastSequence" : 12345,
    "blockSize" : 12345
  } ]
}

PUT /repository/{repositoryId}/txn/removeBlocks

Request Parameters
name type description
repositoryId path
Response Codes
code condition
200 Ok
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/json ResponseImpl (JSON)
application/xml responseImpl (XML)

Example

Request
PUT /repository/{repositoryId}/txn/removeBlocks
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entity" : { },
  "statusType" : {
    "reasonPhrase" : "...",
    "statusCode" : 12345,
    "family" : "INFORMATIONAL"
  },
  "entityType" : {
    "typeName" : "..."
  },
  "status" : 12345,
  "metadata" : {
    "property1" : [ { }, { } ],
    "property2" : [ { }, { } ]
  }
}

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

Request Parameters
name type description
repositoryId path
Response Codes
code condition
200 Ok
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/json ResponseImpl (JSON)
application/xml responseImpl (XML)

Example

Request
PUT /repository/{repositoryId}/txn/failedBlocks/removeBlocks
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entity" : { },
  "statusType" : {
    "reasonPhrase" : "...",
    "statusCode" : 12345,
    "family" : "INFORMATIONAL"
  },
  "entityType" : {
    "typeName" : "..."
  },
  "status" : 12345,
  "metadata" : {
    "property1" : [ { }, { } ],
    "property2" : [ { }, { } ]
  }
}

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

Request Parameters
name type description
identity path
repositoryId path
Response Codes
code condition
200 Ok
401 Authentication required.
403 Authorization required - access forbidden
Response Body
media type data type description
application/json ResponseImpl (JSON)
application/xml responseImpl (XML)

Example

Request
PUT /repository/{repositoryId}/txn/removeBlock/identity/{identity}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entity" : { },
  "statusType" : {
    "reasonPhrase" : "...",
    "statusCode" : 12345,
    "family" : "OTHER"
  },
  "entityType" : {
    "typeName" : "..."
  },
  "status" : 12345,
  "metadata" : {
    "property1" : [ { }, { } ],
    "property2" : [ { }, { } ]
  }
}