RepositoriesResource

RepositoriesResource REST endpoint to access and manipulate collections of Repository data. Copyright 2012 WANdisco.

The following resources are part of this group:

/repositories

Mount Point: /api/repositories

GET

Find all repositories. Can specify optional parameters to get a filtered, sorted and paged list of repositories.

Parameters

name description type default
offset index into the result set query
numberToGet maximum number of results to return query
filterValue a pattern to match repository names by query
sortField name of the attribute to sort the results by query
sortAscending whether the results are sorted ascending or descending query true
excludes a list of repository IDs to exclude from the results query
state The state the repository currently is in query ALL
withPendingTransactions Indicate if we should retrieve the pending transactions for the repositories query false
withPendingTransactionsForAllNodes (no documentation provided) query false

Response Body

element: svn-repositories
media types: application/xml

the list of repositories that matches the search criteria

Status Codes

code description
200 Ok
400 Bad Request - see Exception

/repositories/consistencyCheck

Mount Point: /api/repositories/consistencyCheck

POST

Start consistency check for specified repositories, returns a list of repos that couldn't be checked due to not existing on the local node

Parameters

name description type default
numberOfRevisions Number of revisions to check. -1 indicates to check all revisions. -2 indicates the default number of revisions. query -2

Request Body

element: svn-repositories
media types: application/xml
application/json

FSFSRepositoryListDTO containing a list of repos to consistency check (an empty list will trigeer a check of all repositories)

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

Response Headers

name description
Content Location Path to relevant Task

/repositories/consistencyCheckQuantity

Mount Point: /api/repositories/consistencyCheckQuantity

GET

Returns the number of revisions to check when performing default consistency checks such as: deploying a new repo, adding a new learner, scheduled consistency checks

Response Body

element: (custom)
media types: text/plain

(no documentation provided)

Status Codes

code description
200 OK

/repositories/count

Mount Point: /api/repositories/count

GET

Finds the number of repositories that match the specified filter.

Parameters

name description type default
filterValue a pattern to match repository names by query
replicationGroupId (no documentation provided) query
excludes a list of repository IDs to exclude from the results query
state The state the repository currently is in query ALL

Response Body

element: (custom)
media types: text/plain

the list of repositories that matches the search criteria

Status Codes

code description
200 Ok
400 Bad Request - see Exception

/repositories/ecosystem

Mount Point: /api/repositories/ecosystem

GET

Return the set of repositories that are currently known about from all nodes.

Response Body

element: svn-repositories
media types: application/xml

(no documentation provided)

Status Codes

code description
200 Ok
400 Bad Request - see Exception

/repositories/failed

Mount Point: /api/repositories/failed

DELETE

removes repositories that have failed to deploy.

Response Body

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

(no documentation provided)

Status Codes

code description
200 Ok
404 Not Found - see Exception

/repositories/globalConsistencyCheck

Mount Point: /api/repositories/globalConsistencyCheck

POST

Start consistency check for specified repositories, returns a list of repos that couldn't be checked due to not existing on the local node

Parameters

name description type default
numberOfRevisions Number of revisions to check. -1 indicates to check all revisions. -2 indicates 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

Response Headers

name description
Content Location Path to relevant Task

/repositories/scheduledConsistencyCheckEnabled

Mount Point: /api/repositories/scheduledConsistencyCheckEnabled

GET

Returns true if the scheduled consistency check is enabled

Response Body

element: (custom)
media types: text/plain

(no documentation provided)

Status Codes

code description
200 OK

/repositories/scheduledConsistencyCheckFrequency

Mount Point: /api/repositories/scheduledConsistencyCheckFrequency

GET

Returns frequency of the scheduled consistency check in hours

Response Body

element: (custom)
media types: text/plain

(no documentation provided)

Status Codes

code description
200 OK

/repositories/search

Mount Point: /api/repositories/search

GET

Find all repositories. Can specify optional param to reduce the number of repos depending on different criteria

Parameters

name description type default
replicationGroupId (no documentation provided) query
offset (no documentation provided) query
numberToGet (no documentation provided) query
filterValue (no documentation provided) query
sortField (no documentation provided) query
sortAscending (no documentation provided) query true
excludes (no documentation provided) query
withPendingTransactions (no documentation provided) query false
withPendingTransactionsForAllNodes (no documentation provided) query false

Response Body

element: svn-repositories
media types: application/xml

(no documentation provided)

Status Codes

code description
200 Ok
400 Bad Request - see Exception

/repositories/stats

Mount Point: /api/repositories/stats

DELETE

Reset stats for all the repositories a node knows about

Response Body

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

(no documentation provided)

Status Codes

code description
200 Ok
404 Not Found - see Exception

/repositories/ecosystem/count

Mount Point: /api/repositories/ecosystem/count

GET

Response Body

element: (custom)
media types: text/plain

(no documentation provided)

Status Codes

code description
200 Ok
400 Bad Request - see Exception

/repositories/scheduledConsistencyCheckEnabled/{enabled}

Mount Point: /api/repositories/scheduledConsistencyCheckEnabled/{enabled}

PUT

Enables/disables scheduled consistency checks

Parameters

name description type default
enabled (no documentation provided) path

Response Body

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

(no documentation provided)

Status Codes

code description
200 Ok
400 Bad Request - See Exception

/repositories/scheduledConsistencyCheckFrequency/{frequency}

Mount Point: /api/repositories/scheduledConsistencyCheckFrequency/{frequency}

PUT

Sets the frequency of the scheduled consistency check in hours

Parameters

name description type default
frequency (no documentation provided) path

Response Body

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

(no documentation provided)

Status Codes

code description
200 Ok
400 Bad Request - See Exception

/repositories/{revisionQuantity}/consistencyCheckQuantity

Mount Point: /api/repositories/{revisionQuantity}/consistencyCheckQuantity

PUT

Sets the number of revisions to check for default consistency checks such as: deploying a new repo, adding a new learner, scheduled consistency checks

Parameters

name description type default
revisionQuantity (no documentation provided) path

Response Body

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

(no documentation provided)

Status Codes

code description
200 Ok
400 Bad Request - See Exception