RepositoryResource
RepositoryResource REST endpoint for querying and manipulating ACP repositories Copyright 2013 WANdisco.
The following resources are part of this group:
- /repositories
- /repositories/templates
- /repositories/{id}
- /repositories/{repository_id}/repositorytemplates/{repositorytemplate_id}
/repositories
Mount Point: /api/repositories
GET
Retrieve paged list of access control objects
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | "true" to query the current/enforced model, i.e. the model as it was the last time files where generated, "false" to query the pending/shadow model, i.e. the model as it will be when pending batch updates are eventually applied at some point in the future. Note that this query param is only applicable/relevant for when batched updates is enabled, if batch updates is disabled, this query param is ignored. | query | false |
| pageSize | number of entries per page | query | 20 |
| pageNumber | page to return | query | 1 |
| fieldList | list of fields to be populated in returned DTOs | query | |
| sortAscending | "true" if results should be sorted ascending | query | true |
| sortColumn | column name to perform sort by | query | name |
| searchKeyList | list of keys to search by | query | |
| searchValueList | list of values to search for | query |
Response Body
| element: | pagedresultlist |
| media types: | application/xml application/json |
a PagedResultListDTO of returned DTOs
Status Codes
| code | description |
|---|---|
| 200 | OK |
| 400 | Bad request - see returned ExceptionDTO |
| 503 | Service unavailable - see returned ExceptionDTO |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |
POST
Create a repository
Request Body
| element: | repository |
| media types: | */* application/xml |
RepositoryDTO representation of the repo
Response Body
| element: | (custom) |
| media types: | */* application/xml |
ID of the task monitoring the proposal
Status Codes
| code | description |
|---|---|
| 202 | Accepted - proposed |
| 400 | Bad request - see returned ExceptionDTO |
| 503 | Service unavailable - see returned ExceptionDTO |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |
/repositories/templates
Mount Point: /api/repositories/templates
GET
Retrieve paged list of repositories filtered by whether or not they have templates
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | "true" to query the current/enforced model, i.e. the model as it was the last time files where generated, "false" to query the pending/shadow model, i.e. the model as it will be when pending batch updates are eventually applied at some point in the future. Note that this query param is only applicable/relevant for when batched updates is enabled, if batch updates is disabled, this query param is ignored. | query | false |
| pageSize | number of entries per page | query | 20 |
| pageNumber | page to return | query | 1 |
| fieldList | list of fields to be populated in returned DTOs | query | |
| sortAscending | "true" if results should be sorted ascending | query | true |
| sortColumn | column name to perform sort by | query | name |
| searchKeyList | list of keys to search by | query | |
| searchValueList | list of values to search for | query | |
| withTemplates | true to retrieve only repos that have templates | query | true |
Response Body
| element: | pagedresultlist |
| media types: | application/xml application/json |
a PagedResultListDTO of RepositoryDTOs
Status Codes
| code | description |
|---|---|
| 200 | OK |
| 400 | Bad request - see returned ExceptionDTO |
| 503 | Service unavailable - see returned ExceptionDTO |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |
/repositories/{id}
Mount Point: /api/repositories/{id}
The following operations are supported on this resource:
PUT
Update a repository
Parameters
| name | description | type | default |
|---|---|---|---|
| id | ID of target | path |
Request Body
| element: | repository |
| media types: | */* application/xml |
RepositoryDTO representation of the edited repo
Response Body
| element: | (custom) |
| media types: | */* application/xml |
ID of the task monitoring the proposal
Status Codes
| code | description |
|---|---|
| 202 | Accepted - proposed |
| 404 | Not found - see returned ExceptionDTO |
| 400 | Bad request - see returned ExceptionDTO |
| 503 | Service unavailable - see returned ExceptionDTO |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |
DELETE
Delete a repository
Parameters
| name | description | type | default |
|---|---|---|---|
| id | ID of the repository to delete | path |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
ID of the task monitoring the proposal
Status Codes
| code | description |
|---|---|
| 202 | Accepted - proposed |
| 404 | Not found - see returned ExceptionDTO |
| 400 | Bad request - see returned ExceptionDTO |
| 503 | Service unavailable - see returned ExceptionDTO |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |
GET
Retrieves an access control object
Parameters
| name | description | type | default |
|---|---|---|---|
| id | ID of the object to be retrieved | path | |
| queryEnforced | "true" to query the current/enforced model, i.e. the model as it was the last time files where generated, "false" to query the pending/shadow model, i.e. the model as it will be when pending batch updates are eventually applied at some point in the future. Note that this query param is only applicable/relevant for when batched updates is enabled, if batch updates is disabled, this query param is ignored. | query | false |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
a DTO representation of the object
Status Codes
| code | description |
|---|---|
| 200 | OK |
| 404 | Not found - see returned ExceptionDTO |
| 400 | Bad request - see returned ExceptionDTO |
| 503 | Service unavailable - see returned ExceptionDTO |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |
/repositories/{repository_id}/repositorytemplates/{repositorytemplate_id}
Mount Point: /api/repositories/{repository_id}/repositorytemplates/{repositorytemplate_id}
PUT
Update a repo template
Parameters
| name | description | type | default |
|---|---|---|---|
| repository_id | target repo | path | |
| repositorytemplate_id | target template | path |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
ID of the task monitoring the proposal
Status Codes
| code | description |
|---|---|
| 202 | Accepted - proposed |
| 404 | Not found - see returned ExceptionDTO |
| 400 | Bad request - see returned ExceptionDTO |
| 503 | Service unavailable - see returned ExceptionDTO |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |
DELETE
Delete a repo template
Parameters
| name | description | type | default |
|---|---|---|---|
| repository_id | target repo | path | |
| repositorytemplate_id | target template | path |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
ID of the task monitoring the proposal
Status Codes
| code | description |
|---|---|
| 202 | Accepted - proposed |
| 404 | Not found - see returned ExceptionDTO |
| 400 | Bad request - see returned ExceptionDTO |
| 503 | Service unavailable - see returned ExceptionDTO |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |