Generate Document Template

+ More

Table of Contents

Details Request URL Headers POST body Sample Request

Details

Generates a document of specified type (Plain Text, HTML, PDF, or in JSON format) based on the provided document template and additional input parameters.

Request

URL

POST https://{server_name}/m42Services/api/documenttemplate/{documentTemplateObjectId}/generate

Headers

For a list of available HTTP request headers see Web Services: REST API integration.

POST body

Element	Description	Type	Required
`Type`	`1`: Plain text format `2`: Plain text format (all text is placed in a single line with removed white spaces and tabulators) `3`: HTML format `4`: PDF format `5`: Specifies that the content type is JSON format. This type is used for structured data representation.		Required
`Lcid`	Defienes the language, e.g.: `1033` for English `1031` for German If not specified, is taken from the current process.		Optional
`Parameters`	should be specified only if the Document Template requires input parameters		Optional
`SkinId`	if not specified, the default Document Template skin will be applied. See also, Administration application → Services & Processes → Document Template → Skins.		Optional
`Tag`	Document Template can have several versions and each version is marked with a tag. If not specified, the value is taken from the current (latest) version of the Document Template.	GUID	Optional
`UserTimeZone`	Data and time format. If not specified, the default value is set.		Optional

Sample Request

https://{server_name}/m42Services/api/documenttemplate/91a74304-5821-e811-a882-f079595b3ec7/generate

{
  "Type": 1,
  "Lcid": 1033,
  "Parameters": {
    "SPSActivityClassBase": "8968de08-b88e-c76e-fb19-27141c06b13f"
  },
  "SkinId": "d086c906-d5c7-ec11-339d-9828a6146d72",
  "Tag": "b08cd2a5-2ffe-4102-88bf-f1ed12c5bbb0",
  "UserTimeZone": "W. Europe Standard Time"
}