RepositoriesResource
RepositoriesResource REST endpoint to access and manipulate collections of Repository data. Copyright 2012 WANdisco.
The following resources are part of this group:
- /repositories
- /repositories/count
- /repositories/ecosystem
- /repositories/failed
- /repositories/search
- /repositories/ecosystem/count
/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 |
| fastDataOnly | Indicate if we should retrieve the NFF and rev info for the repositories | query | false |
Response Body
| element: | git-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/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: | git-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/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 |
| fastDataOnly | (no documentation provided) | query | true |
Response Body
| element: | git-repositories |
| media types: | application/xml |
(no documentation provided)
Status Codes
| code | description |
|---|---|
| 200 | Ok |
| 400 | Bad Request - 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 |