• Renderer
  • postRender a document
• Templates
  • getGet a template
  • putSave a template
  • delDelete a template
  • getGet a list of available templates

API docs by Redocly

DocumentRendering API (v9.1)

Download OpenAPI specification:Download

Artionet: support@artionet.com URL: https://www.artionet.ch/

Welcome to the DocumentRendering API documentation.

You can test the API using Swagger.

You can find a detailed documentation by following this link.

Renderer

Render a document

Allows to render a document based on either a provided template or a saved template using provided data.

Request Body schema: application/json

inputFormat required	string [ 1 .. 10 ] characters
outputFormat required	string [ 1 .. 10 ] characters
data	string or null
rendererOptions	string or null
templateData	string or null
templateName	string or null <= 50 characters

Responses

https://api.egov4.ch/document-rendering/demo/v9-1/renderer/documents

Request samples

• Payload

Content type

application/json

{

• "inputFormat": "string",
• "outputFormat": "string",
• "data": "string",
• "rendererOptions": "string",
• "templateData": "string",
• "templateName": "string"

}

Response samples

• 400
• 404
• 422

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Templates

Get a template

Allows to get a template based on its name.

path Parameters

templateName required

string <= 50 characters

Responses

https://api.egov4.ch/document-rendering/demo/v9-1/templates/{templateName}

Response samples

• 200
• 404

Content type

application/json

{

• "name": "string",
• "data": "string"

}

Save a template

Allows to save/overwrite a template to use it with the rendering endpoint.

path Parameters

templateName required

string

Request Body schema:

application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

data required

string non-empty

Responses

https://api.egov4.ch/document-rendering/demo/v9-1/templates/{templateName}

Request samples

• Payload

Content type

application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

{

• "data": "string"

}

Response samples

• 400
• 422

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Delete a template

Allows to delete a template.

path Parameters

templateName required

string <= 50 characters

Responses

https://api.egov4.ch/document-rendering/demo/v9-1/templates/{templateName}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Get a list of available templates

Allows to get a list of existing templates.

Responses

https://api.egov4.ch/document-rendering/demo/v9-1/templates

Response samples

• 200

Content type

application/json

[

• {

  • "name": "string"

  }

]