GeneratorResource

GeneratorResource REST endpoint to control generation of access control files Copyright 2014 WANdisco.

The following resources are part of this group:

/generator

Mount Point: /api/generator

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

/generator/generatenow

Mount Point: /api/generator/generatenow

PUT

Regenerate files without committing pending changes (if shadow model is switched on)

Response Body

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

ID of the task monitoring the proposal

Status Codes

code description
202 Accepted - proposed
401 Authentication required.
403 Authorization required - access forbidden

/generator/resetserialnumber

Mount Point: /api/generator/resetserialnumber

PUT

Proposes setting the generation serial number to 0

Response Body

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

ID of the task monitoring the proposal

Status Codes

code description
202 Accepted - proposed
401 Authentication required.
403 Authorization required - access forbidden

/generator/serialnumber

Mount Point: /api/generator/serialnumber

GET

Retrieve the current generation serial number

Response Body

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

the serial number

Status Codes

code description
200 OK
401 Authentication required.
403 Authorization required - access forbidden

/generator/{id}

Mount Point: /api/generator/{id}

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