Help Page Templates

Manage custom help pages workflows and certifications.

Operation	Method	Syntax
Create workflow help page	POST	{veza_url}/api/preview/awf/help_page_templates
List all help pages	GET	{veza_url}/api/preview/awf/help_page_templates
Get workflow help page	GET	{veza_url}/api/preview/awf/help_page_templates/{workflow_id}
Get certification help page	GET	{veza_url}/api/preview/awf/certification_help_page?{cert_id}
Delete workflow help page	DELETE	{veza_url}/api/preview/awf/help_page_templates/{workflow_id}
Update workflow help page	PUT	{veza_url}/api/preview/awf/help_page_templates

Create workflow help page

Add a help splash page for Workflow reviewers by providing the base64-encoded template_body, name, and an existing workflow_id to apply the template to.

Only one help page can exist at a time for a given workflow.

Reviewers can access help pages from Certification view by clicking the User Guide icon. The help page will also appear when viewing the certification for the first time.

The base64-encoded template can use markdown and placeholders, for example:

# Help for {{WORKFLOW_NAME}}

## Formatting

Formatting text in Markdown:

- *Italic text*
- **Bold text**
- `Code block`
- [Link text](https://example.com)

## Bullet Lists

Bullet lists in Markdown:

- Item 1
- Item 2
- Item 3

## Numbered Lists

Numbered lists in Markdown:

1. First item
2. Second item
3. Third item

## Placeholders

The following placeholders are available:

- {{WORKFLOW_NAME}}
- {{WORKFLOW_URL}}
- {{WORKFLOW_TIME}}
- {{WORKFLOW_OWNER}}
- {{WORKFLOW_DESCRIPTION}}
- {{WORKFLOW_CERT_STARTED_ON_DATE}}
- {{WORKFLOW_CERT_STARTED_ON_TIME}}
- {{WORKFLOW_CERT_CREATED_BY}}
- {{WORKFLOW_CERT_LAST_UPDATED_ON_DATE}}
- {{WORKFLOW_CERT_LAST_UPDATED_ON_TIME}}
- {{WORKFLOW_CERT_LAST_UPDATED_BY}}
- {{WORKFLOW_CERT_COMPLETED_ON_DATE}}
- {{WORKFLOW_CERT_COMPLETED_ON_TIME}}
- {{WORKFLOW_CERT_COMPLETED_BY}}
- {{WORKFLOW_CERT_LAST_ACTIVITY_ON_DATE}}
- {{WORKFLOW_CERT_LAST_ACTIVITY_ON_TIME}}
- {{WORKFLOW_CERT_LAST_ACTIVITY_BY}}
- {{WORKFLOW_CERT_DUE_ON_DATE}}
- {{WORKFLOW_CERT_REVIEWERS}}

You can edit the template in a text file and encode the contents with the command:

cat template.md | base64

Example request:

POST {{veza_url}}/api/preview/awf/help_page_templates

{
  "value": {
    "workflow_id": "8c1772da-a7c3-4dc7-8b09-b900af011ee5",
    "name": "help",
    "template_body": "SGVsbG8sIFdvcmxkIQo="
  }
}

List help pages

Get all configured help page templates.

GET {veza_url}/api/preview/awf/help_page_templates

Example response:

{
    "values": [
        {
            "workflow_id": "8c1772da-a7c3-4dc7-8b09-b900af011ee5",
            "name": "help"
        }
    ]
}

Get workflow help page

Returns the current help page template for an existing workflow id.

Example request:

GET {{veza_url}}/api/preview/awf/help_page_templates/{{workflow_id}}

Get certification help page

Returns the decoded template for a given certification id.

Example request:

GET {{veza_url}}/api/preview/awf/certification_help_page?certification_id={{cert_id}}

Example response:

{
    "content": "# Help for Reviewers\n\n## Formatting\n\nHere's an example of how to format text in Markdown:\n\n"
}

Delete workflow help page

Permanently remove the help page template for a workflow id. It will no longer apply to certifications for the workflow.

Example request:

DELETE {{veza_url}}/api/preview/awf/help_page_templates/{{workflow_id}}

Update workflow help page

PUT {veza_url}/api/preview/awf/help_page_templates

Update the help page for the specified workflow_id:

Example request:

{
  "value": {
    "name": "string",
    "template_body": "string",
    "workflow_id": "string"
  }
}