These placeholders are available in only the specified page template.
Portal Home:
cards | Array of object required for cards in home page. |
announcement | Recent Announcement Object |
cards | |
title | Title of the card |
content | Sub text of the card |
img | image url for the card image |
url | Link url of the card |
announcement | |
title | Title of the announcement |
created_at | Announcement created date and time (needs formatting) |
planned_start_date | Announcement start date and time (needs formatting) |
Announcement created user’s name | |
user.avatar_url | Announcement created user’s profile pic url |
Announcement List:
announcements | Array of objects |
announcements | |
id | Announcement ID |
title | Title of the announcement |
created_at | Announcement created date and time (needs formatting) |
planned_start_date | Announcement start date and time (needs formatting) |
user.avatar_url | Announcement created user’s profile pic url |
Announcement created user’s name | |
Announcement View:
id | Announcement ID |
title | Title of the announcement |
created_at | Announcement created date and time (needs formatting) |
planned_start_date | Announcement start date and time (needs formatting) |
user.avatar_url | Announcement created user’s profile pic url |
Announcement created user’s name | |
description | Description of the Announcement |
Solutions Home
categories | Array of categories object |
categories | |
id | ID of the category |
name | Name of the category |
folders_count | Number of folders inside the category |
Solutions Category Home
folders | Array of folders object available inside the selected category |
folders | |
id | ID of the folder |
name | Name of the folder |
articles | Array of articles available inside the folder |
articles | |
id | ID of the solution article |
title | Title of the solution article |
external_url | URL of the article, (If the article is an external article |
description | Description of the article |
Articles List
id | ID of the solution article |
title | Title of the solution article |
external_url | URL of the article, (If the article is an external article |
description | Description of the article |
modified_at | Last modified date and time of the article |
other_catg | Array of other folders available inside the same category |
other_catg | |
id | ID of the folder |
name | Name of the folder |
Article View
id | ID of the solution article |
title | Title of the solution article |
description | Description of the article |
modified_at | Last modified date and time of the article |
ID of the folder where the article is available | |
Name of the folder where the article is available | |
ID of the category where the article is available | |
Name of the category where the article is available | |
voted_by_user | Boolean. Returns true if the logged in user already voted for the article |
attachments | Array of attachment object |
Ticket Details
human_display_id | Display ID of the ticket |
subject | Subject of the Ticket |
status | Status ID of the ticket |
status_name | Status Name of the ticket |
cc_emails | Array of email IDs added in the “Add People / CC” section |
ticket_type | type of the ticket (“Incident” | “Service Request”) |
source_name | Source Name of the ticket |
created_at | Created Date and Time of the ticket |
status_updated_at | Last updated date and time of the status of the ticket |
closed_at | Date and Time of the ticket when closed |
description_html | Description of the Ticket |
requested_catalog_items | Array of Catalog Items (Available only for Service Request Tickets) |
requester_avatar | Profile Pic URL of the requester |
requester_id | ID of the requester |
requester_name | Name of the requester |
requester_status_name | Status Name to be displayed to the requester |
responder_avatar | Profile Pic URL of the Agent assigned to the ticket |
responder_id | ID of the Agent assigned to the ticket |
responder_name | Name of the Agent assigned to the ticket |
responder_title | Title of the Agent assigned to the ticket |
associated_assets | Array of assets associated to the ticket |
attachments | Array of attachments |
cloud_files | Array of cloud attachments |
notes | Array of replies / notes of the ticket |
notes_count | Total number of notes / replies available for the ticket |
requested_catalog_items | |
item_id | ID of the service catalog item |
name | Name of the Service Catalog Item |
short_description | Short Description of the service catalog item |
description | Description of the service catalog item |
cost | Cost of the Item. Will be null if the cost is not visible in the portal |
delivery_time | Delivery time of the Item. Will be null if the delivery time is not visible in the portal |
quantity | Requested quantity of the item |
location | Location of the item |
stage | Stage of the Requested Item |
loaned | Boolean. Returns true if the Request is loaner request |
from_date | Loaner From date |
to_date | Loaner To date |
attachments | |
id | ID of the attachment |
content_file_name | Name of the file attached |
content_content_type | File Type of the attached file |
content_file_size | Size of the attachment in bytes |
attachment_path | URL for the attachment |
associated_assets | |
display_id | ID of the asset |
name | Name of the Asset |
Ticket List
subject | Subject of the ticket |
human_display_id | Display ID of the ticket |
display_id | ID of the ticket |
created_at | Created Date and Time of the ticket |
responder_id | ID of the Agent assigned the ticket |
responder_name | Name of the Agent assigned to the ticket |
ID of the status of the ticket | |
Name of the status of the ticket | |
ID of the source of the ticket | |
Name of the source of the ticket |
