RepositoryTemplateResource

RepositoryTemplateResource REST endpoint for querying and manipulating ACP repository templates Copyright 2017 WANdisco.

The following resources are part of this group:

/repositorytemplates

Mount Point: /repositorytemplates

POST

Create a repo template

Request Body

element: repositorytemplate
media types: */*
application/xml

RepositoryTemplateDTO representation of the new template

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

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 id
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

/repositorytemplates/generators

Mount Point: /repositorytemplates/generators

GET

Retrieve all generators based on the current license type if the type query param is not included in the request, otherwise will retrieve all generators specific to Git or SVN depending on the value of the type query param.

Parameters

name description type default
type optional query param, which if included, must be one of SVN or GIT query

Response Body

element: generator
media types: application/xml
application/json

List of GeneratorDTOs

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

/repositorytemplates/{id}

Mount Point: /repositorytemplates/{id}

The following operations are supported on this resource:

PUT

Update a repo template

Parameters

name description type default
id target template path

Request Body

element: repositorytemplate
media types: */*
application/xml

RepositoryTemplateDTO representation of the updated template

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

Deletes an access control object

Parameters

name description type default
id ID of the model object to delete path

Response Body

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

ID of the task monitoring the deletion

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

/repositorytemplates/{repositorytemplate_id}/generatorassignments

Mount Point: /repositorytemplates/{repositorytemplate_id}/generatorassignments

POST

Create a generator assignment

Parameters

name description type default
repositorytemplate_id the target repo template path

Request Body

element: generatorassignment
media types: */*
application/xml

GeneratorAssignmentDTO representation of the new generator assignment

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

GET

Retrieve the generator assignments

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
repositorytemplate_id ID of the parent repository template path
pageSize number of entries per page query 1
pageNumber page to return query 1
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 GeneratorAssignmentDTOs

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

/repositorytemplates/{repositorytemplate_id}/generatorassignments/{generatorassignment_id}

Mount Point: /repositorytemplates/{repositorytemplate_id}/generatorassignments/{generatorassignment_id}

PUT

Update a generator assignment

Parameters

name description type default
repositorytemplate_id the target repo template path
generatorassignment_id the target generator assignment path

Request Body

element: generatorassignment
media types: */*
application/xml

GeneratorAssignmentDTO representation of the updated generator assignment

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 generator assignment

Parameters

name description type default
repositorytemplate_id parent repo template ID path
generatorassignment_id target generator ID 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