rest.template_version_manager.views

REST views for the template version manager API

class rest.template_version_manager.views.CurrentTemplateVersion(**kwargs)

Bases: core_main_app.rest.template_version_manager.abstract_views.AbstractStatusTemplateVersion

Update status to current

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)

status_update(template_object)

Update status to current

Parameters:template_object – template_version Returns:TemplateVersion

class rest.template_version_manager.views.DisableTemplateVersion(**kwargs)

Bases: core_main_app.rest.template_version_manager.abstract_views.AbstractStatusTemplateVersion

Update status to disabled

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)

status_update(template_object)

Update status to disabled

Parameters:template_object – template_version Returns:TemplateVersion

class rest.template_version_manager.views.DisableTemplateVersionManager(**kwargs)

Bases: core_main_app.rest.template_version_manager.abstract_views.AbstractStatusTemplateVersionManager

Update status to disabled

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)

status_update(template_version_manager_object)

Update status to disabled

Parameters:template_version_manager_object – template_version_manager Returns:TemplateVersionManager

class rest.template_version_manager.views.GlobalTemplateList(**kwargs)

Bases: core_main_app.rest.template_version_manager.abstract_views.AbstractTemplateList

Create a Template (global schema)

get_user()

The user is None for a global template

Returns:None

post(*args, **kwargs)

Create a Template (global schema)

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.views.GlobalTemplateVersionManagerList(**kwargs)

Bases: core_main_app.rest.template_version_manager.abstract_views.AbstractTemplateVersionManagerList

List all GlobalTemplateVersionManager

get_template_version_managers()

Get GlobalTemplateVersionManager

Returns:List of GlobalTemplateVersionManager

class rest.template_version_manager.views.RestoreTemplateVersion(**kwargs)

Bases: core_main_app.rest.template_version_manager.abstract_views.AbstractStatusTemplateVersion

Update status to restored

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)

status_update(template_object)

Update status to restored

Parameters:template_object – template_version Returns:TemplateVersion

class rest.template_version_manager.views.RestoreTemplateVersionManager(**kwargs)

Bases: core_main_app.rest.template_version_manager.abstract_views.AbstractStatusTemplateVersionManager

Update status to restored

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)

status_update(template_version_manager_object)

Update status to restored

Parameters:template_version_manager_object – template_version_manager

class rest.template_version_manager.views.TemplateVersion(**kwargs)

Bases: core_main_app.rest.template_version_manager.abstract_views.AbstractTemplateVersionManagerDetail

Create a TemplateVersion

post(*args, **kwargs)

Create a TemplateVersion

Parameters:

• { – “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:

200

content: Created TemplateVersionManager

• code: 400 content: Validation error
• code: 404 content: Template was not found
• code: 500 content: Internal server error

Return type:

• code

class rest.template_version_manager.views.TemplateVersionManagerDetail(**kwargs)

Bases: rest_framework.views.APIView

Retrieve a TemplateVersionManager

get(request, pk)

Retrieve a TemplateVersionManager

Parameters:

• request – HTTP request
• pk – ObjectId

Returns:

200

content: TemplateVersionManager

• code: 404 content: Object was not found
• code: 500 content: Internal server error

Return type:

• code

get_object(pk)

Get TemplateVersionManager from db

Parameters:pk – ObjectId Returns:TemplateVersionManager

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)

class rest.template_version_manager.views.UserTemplateList(**kwargs)

Bases: core_main_app.rest.template_version_manager.abstract_views.AbstractTemplateList

Create a Template (linked to the user)

get_user()

Retrieve the user from the request

Returns:User ID

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)

post(request)

Create a Template (linked to the user)

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.views.UserTemplateVersionManagerList(**kwargs)

Bases: core_main_app.rest.template_version_manager.abstract_views.AbstractTemplateVersionManagerList

List all UserTemplateVersionManager

get_template_version_managers()

Get all UserTemplateVersionManager

Returns:List of UserTemplateVersionManager

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)