RenderingRequest

Retrieves a RenderingRequest list.

Returns a list of RenderingRequests.

GET/api/rendering-requests

Retrieves a RenderingRequest list.

curl --request GET \
  --url 'https://app.output.rocks/api/rendering-requests?page=1' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

[
  {
    "id": 12345,
    "externalId": "ext-123",
    "templateIdentifier": "my-template",
    "format": "pdf",
    "webhookIdentifier": "my-webhook",
    "mailServerIdentifier": "my-webhook",
    "brandIdentifier": "default",
    "comment": "Here is my comment",
    "origin": "api",
    "externalState": "string",
    "state": "done",
    "blocked": true
  }
]

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Query Parameters

flags[]

string[]

Flags to fetch additional data Flags to load file contents will be applied only on lists with a maximum length of 10

page

integerdefault:1

The collection page number

externalId

string

No description provided.

Response

200application/json

RenderingRequest collection

integer

RenderingRequest ID generated by Output.Rocks.

Example: 12345

externalId

string

Optional external ID provided by origin application

Example: "ext-123"

templateIdentifier

string

Template identifier provided in request

Example: "my-template"

format

enum<string>

Document format to be used for rendered documents

Available options: pdfdocodtrtfhtmltxt

Example: "pdf"

webhookIdentifier

string

Webhook identifier provided in request

Example: "my-webhook"

mailServerIdentifier

string

Mail-Server identifier provided in request

Example: "my-webhook"

brandIdentifier

string

Brand identifier resolved by the rendering workflow

Example: "default"

comment

string

Comment for the rendering request

Example: "Here is my comment"

origin

string

Rendering Request Origin (api / data collector)

Example: "api"

externalState

string

state

string

Workflow state of the request: start - Rendering request created mapped - Rendering request is mapped. Document & Email renderings (if any) are created. done - Rendering request is completely handled anonymized - Rendering request is anonymized (data is deleted)

Example: "done"

blocked

boolean

Available options: truefalse