rest.template_version_manager.abstract_views

REST abstract views for the template version manager API

class rest.template_version_manager.abstract_views.AbstractStatusTemplateVersion(**kwargs)

Bases: rest_framework.views.APIView

Set template version status

get_object(pk)

Get template from db

Parameters:pk – ObjectId
Returns:Template
patch(*args, **kwargs)

Set status

Parameters:
  • request – HTTP request
  • pk – ObjectId
Returns:

200

content: None

  • code: 400 content: Validation error / bad request
  • code: 403 content: Authentication error
  • code: 404 content: Object was not found
  • code: 500 content: Internal server error
Return type:

  • code
status_update(template_object)

Perform an update of the object status

class rest.template_version_manager.abstract_views.AbstractStatusTemplateVersionManager(**kwargs)

Bases: rest.template_version_manager.abstract_views.AbstractTemplateVersionManagerDetail

Set template version manager status

patch(request, pk)

Set status

Parameters:
  • request – HTTP request
  • pk – ObjectId
Returns:

200

content: None

  • code: 400 content: Validation error
  • code: 403 content: Authentication error
  • code: 404 content: Object was not found
  • code: 500 content: Internal server error
Return type:

  • code
status_update(template_version_manager_object)

Perform an update of the object status.

class rest.template_version_manager.abstract_views.AbstractTemplateList(**kwargs)

Bases: rest_framework.views.APIView

Create a template

get_user()

Retrieve a user

post(request)

Create a template

Parameters:
  • { – “title”: “title”, “filename”: “filename”, “content”: “<xs:schema xmlns:xs=’http://www.w3.org/2001/XMLSchema’><xs:element name=’root’/></xs:schema>”
  • } –

Note

“dependencies_dict”: json.dumps({“schemaLocation1”: “id1” ,”schemaLocation2”:”id2”})

Parameters:request – HTTP request
Returns:
201
content: Created template
  • code: 400 content: Validation error / not unique / XSD error
  • code: 500 content: Internal server error
Return type:
  • code
class rest.template_version_manager.abstract_views.AbstractTemplateVersionManagerDetail(**kwargs)

Bases: rest_framework.views.APIView

Template Version Manager Detail

get_object(pk)

Get template version manager from db

Parameters:pk – ObjectId
Returns:TemplateVersionManager
class rest.template_version_manager.abstract_views.AbstractTemplateVersionManagerList(**kwargs)

Bases: rest_framework.views.APIView

List template version managers

get(request)

Get template version managers

Url Parameters:

template: template_id title: document_title
Parameters:request – HTTP request
Returns:
200
content: List of template version manager
  • code: 500 content: Internal server error
Return type:
  • code
get_template_version_managers()

Return template version managers