PrintDiagram

Use this resource to produce a PDF file that contains a process diagram.

Method summary

HTTP Method	Path	Description
GET	/scr/api/PrintDiagram	Produces a PDF file that contains a process diagram.

Description: Use this method to produce a PDF file that contains a process diagram.

Resource information

Requirements	Description
Response format	PDF
Requires authentication	Yes. The user must have at least participant access to the process that is printed.
Supports OAuth 2 client credentials	Yes using a User Service ID containing Artifact Reporting Category
Rate limited	Not yet

Parameters

Name	Location	Description	Required	Type
X-On-Behalf-Of	Header	The user context. The value must be a username in the account. The user must have permission to perform the action in the account and in the specified parent space, if any.	Required if Service ID OAuth credentials are used. Not required when using User Service ID OAuth credential.	String
processId	Query	The ID of the process to print.	Yes	String
expandSubprocesses	Query	Whether to expand subprocesses in the printed diagram. The values are `true` or `false`. If this parameter is omitted, no subprocesses are expanded.	No	Boolean
includeLinkedProcesses	Query	The type of linked processes to include in the export. The values are `direct` for processes directly linked to the process that is being exported, or `all` to include the indirectly linked processes as well. If this parameter is omitted, no linked processes are included in the export.	No	String
showActivityNumbering	Query	Whether to show activity numbering in the diagram. The values are `true` or `false`. If this parameter is omitted, the activities are not numbered in the output.	No	Boolean
showColorLegend	Query	Whether to show the color legend in the diagram. The values are `true` or `false`. If this parameter is omitted, the color legend is not included in the output.	No	Boolean

Response

The PDF view of the diagram

Example input

Using OAuth 2 client credentials:

curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/PrintDiagram?processId=80012"

Response messages

HTTP code	Reason
200	The request was completed successfully.
400	There was an error processing the request. Required parameters were missing or contained invalid values.
401	The user isn't authorized to make the request.
403	The user does not have access to the process that is printed.