The jiraServiceManagement:portalRequestDetail
module adds a panel to a portal request.
The content of the module is shown below the Activity panel on a portal request.
This module can be used in Jira Service Management.
For UI Kit 1, see the PortalRequestDetail component documentation for more details.
Unlicensed user access: This module supports interaction with customer accounts and unlicensed accounts. It does not support anonymous access. For information, see Access to Forge apps for unlicensed users.
Property | Type | Required | Description |
---|---|---|---|
key |
| Yes |
A key for the module, which other modules can refer to. Must be unique within the manifest. Regex: |
function | string | Required if using UI Kit 1. | A reference to the function module that defines the module. Only used in UI Kit 1. |
resource | string | Required if using custom UI or the latest version of UI Kit. | A reference to the static resources entry that your context menu app wants to display. See resources for more details. |
render | 'native' | Yes for UI Kit. | Indicates the module uses UI Kit. |
resolver | { function: string } or{ endpoint: string } | Yes | Set the Set the |
viewportSize | 'small' , 'medium' , 'large' or 'xlarge' | The display size of resource . Can only be set if the module is using the
resource property. Remove this property to enable automatic resizing of the module. | |
title | string | Yes | The title of the portal request detail panel, which is displayed above the panel. |
unlicensedAccess | List<string> | A list of unlicensed user types that can access this function. Valid values for this module are: unlicensed and customer . This module does not support anonymous access. For more information, see
Access to Forge apps for unlicensed Jira Service Management users. |
Use the useProductContext hook to access the extension context in UI Kit or getContext bridge method in custom UI.
Property | Type | Description |
---|---|---|
type | string | The type of the module. |
portal.id | number | The id of the service desk, where the module is rendered. |
request.key | string | The key of the request, where the module is rendered. |
request.typeId | number | The id of the request type, where the module is rendered. |
request.property | object | The request properties(if any) stored during request creation through
jiraServiceManagement:portalRequestCreatePropertyPanel module |
Property | Type | Description |
---|---|---|
type | string | The type of the module. |
portal.id | number | The id of the service desk, where the module is rendered. |
request.key | string | The key of the request, where the module is rendered. |
request.typeId | number | The id of the request type, where the module is rendered. |
Rate this page: