Fetch printable form

[ ]

When form’s source code is submitted for generation, it is queued to ensure a stable response even under high load. To obtain the result, send a GET request to the https://api.aspose.cloud/v5.0/omr/GenerateTemplate/GetGenerateTemplate Aspose.OMR Cloud REST API endpoint. To authorize the request, pass the access token in Authorization header (Bearer authentication).

Provide the unique identifier of the generation task in id parameter:

curl --location 'https://api.aspose.cloud/v5.0/omr/GenerateTemplate/GetGenerateTemplate?id=7ec63522-e35f-4f9d-8b06-0da1876220b6' \
--header 'Accept: text/plain' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...TMpXEfk3BOozpOiEhetRKfDNc8LEPQHBqg'

Generated form

The form is returned in JSON format in the response body.

	"id": "7ec63522-e35f-4f9d-8b06-0da1876220b6",
	"responseStatusCode": "Ok",
	"results": [
			"type": "Png",
			"type": "Omr",
			"data": "ewoJIlZlcnNpb24iOiAiMS4wIiwKCSJOYW1lIjogIk15VGVtcGxhdGUiLAoJIlBhZ2VzIjogWwo...VyYXRlZCI6IHRydWUKfQ=="
	"error": null
Property Type Description
id string Unique identifier of the generation task. Equals to the value of the id request property.
responseStatusCode string Generation response status.
results array This list includes at least 2 entries:
  • Printable form pages as PNG images ("type": "Png"). Their dimensions match the provided paper size and orientation. Each page is always saved as a separate file.
  • A recognition pattern used by Aspose.OMR recognition engine, in a special .OMR format ("type": "Omr"). This file is required for recognizing filled forms, make sure you save it along with the printable form images!
error/messages array Generation error messages, if any.
Even if the form is generated, you can still get notifications and warnings about non-fatal generation errors.