Bitbucket modules
Common modules
Compass modules
Confluence modules
Jira modules
Jira Service Management modules

Jira Service Management portal request detail

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.

Example of a Portal Request Detail

Properties

PropertyTypeRequiredDescription
key

string

Yes

A key for the module, which other modules can refer to. Must be unique within the manifest.

Regex: ^[a-zA-Z0-9_-]+$

functionstringRequired if using UI Kit 1.A reference to the function module that defines the module. Only used in UI Kit 1.
resourcestringRequired if using custom UI or the current 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 function property if you are using a hosted function module for your resolver.

Set the endpoint property if you are using Forge remote (preview) to integrate with a remote back end.

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.
titlestringYesThe title of the portal request detail panel, which is displayed above the panel.
unlicensedAccessList<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.

Extension context

UI Kit and Custom UI

Use the useProductContext hook to access the extension context in UI Kit or getContext bridge method in custom UI.

PropertyTypeDescription
typestringThe type of the module.
portal:
id
numberThe id of the service desk, where the module is rendered.
request:
key
stringThe key of the request, where the module is rendered.
request:
typeId
numberThe id of the request type, where the module is rendered.
request:
property
objectThe request properties(if any) stored during request creation through jiraServiceManagement:portalRequestCreatePropertyPanel module

UI Kit 1

PropertyTypeDescription
typestringThe type of the module.
portal:
id
numberThe id of the service desk, where the module is rendered.
request:
key
stringThe key of the request, where the module is rendered.
request:
typeId
numberThe id of the request type, where the module is rendered.

Rate this page: