Jira Service Management is Atlassian’s modern IT service management (ITSM) solution designed to help teams efficiently manage service requests, incidents, problems, assets, and changes across your organization. Built on the Jira platform, Jira Service Management empowers IT, DevOps, HR, facilities, and other business teams to deliver exceptional, collaborative service.
Jira Service Management (JSM) goes beyond traditional issue tracking by providing features purpose-built for service teams, such as integrated SLAs, customizable request types, automation, robust queues, and seamless customer portals. Through the JSM API and Actana integration, you can automate, monitor, and interact with all aspects of your service management workflows.
Key features of Jira Service Management include:
- Service Request Management: Streamline intake, triage, and resolution of IT or business requests via customizable forms, queues, and automated routing.
- Incident and Problem Management: Log, track, escalate, and resolve incidents with tools for root cause analysis, post-incident reviews, and real-time collaboration.
- SLA Tracking and Reporting: Define, monitor, and report on service level agreements to ensure timely service delivery and accountability.
- Asset and Configuration Management: Maintain an up-to-date inventory of assets, configuration items, and their relationships to improve visibility and impact analysis.
- Queue Management: Manage workload and priorities using powerful queues for service agents, including filtering, sorting, and bulk actions.
- Customer and Organization Management: Group customers into organizations, manage user permissions, and improve communication through tailored customer portals.
With Actana’s Jira Service Management integration, you can create, monitor, and update service requests, fetch and manage customer organizations, track active queues, and automate ITSM operations programmatically. Build intelligent service desk agents, automate workflows triggered by service events, and ensure both end-users and service teams benefit from proactive, AI-powered support.
Integrate with Jira Service Management for IT service management. Create and manage service requests, handle customers and organizations, track SLAs, and manage queues.
Get all service desks from Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
expand | string | No | Comma-separated fields to expand in the response |
start | number | No | Start index for pagination (e.g., 0, 50, 100) |
limit | number | No | Maximum results to return (e.g., 10, 25, 50) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
serviceDesks | array | List of service desks |
↳ id | string | Service desk ID |
↳ projectId | string | Associated Jira project ID |
↳ projectName | string | Associated project name |
↳ projectKey | string | Associated project key |
↳ name | string | Service desk name |
↳ description | string | Service desk description |
↳ leadDisplayName | string | Project lead display name |
total | number | Total number of service desks |
isLastPage | boolean | Whether this is the last page |
Get request types for a service desk in Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
serviceDeskId | string | Yes | Service Desk ID (e.g., "1", "2") |
searchQuery | string | No | Filter request types by name |
groupId | string | No | Filter by request type group ID |
expand | string | No | Comma-separated fields to expand in the response |
start | number | No | Start index for pagination (e.g., 0, 50, 100) |
limit | number | No | Maximum results to return (e.g., 10, 25, 50) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
requestTypes | array | List of request types |
↳ id | string | Request type ID |
↳ name | string | Request type name |
↳ description | string | Request type description |
↳ helpText | string | Help text for customers |
↳ issueTypeId | string | Associated Jira issue type ID |
↳ serviceDeskId | string | Parent service desk ID |
↳ groupIds | json | Groups this request type belongs to |
↳ icon | json | Request type icon with id and links |
↳ restrictionStatus | string | OPEN or RESTRICTED |
total | number | Total number of request types |
isLastPage | boolean | Whether this is the last page |
Create a new service request in Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
serviceDeskId | string | Yes | Service Desk ID (e.g., "1", "2") |
requestTypeId | string | Yes | Request Type ID (e.g., "10", "15") |
summary | string | No | Summary/title for the service request (required unless using Form Answers) |
description | string | No | Description for the service request |
raiseOnBehalfOf | string | No | Account ID of customer to raise request on behalf of |
requestFieldValues | json | No | Request field values as key-value pairs (overrides summary/description if provided) |
formAnswers | json | No | Form answers using numeric form question IDs as keys (e.g., {"1": {"text": "Title"}, "4": {"choices": ["5"]}}). Keys are question IDs from the Jira Form, not Jira field names. |
requestParticipants | string | No | Comma-separated account IDs to add as request participants |
channel | string | No | Channel the request originates from (e.g., portal, email) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueId | string | Created request issue ID |
issueKey | string | Created request issue key (e.g., SD-123) |
requestTypeId | string | Request type ID |
serviceDeskId | string | Service desk ID |
createdDate | json | Creation date with iso8601, friendly, epochMillis |
currentStatus | json | Current status with status name and category |
reporter | json | Reporter user with accountId, displayName, emailAddress |
success | boolean | Whether the request was created successfully |
url | string | URL to the created request |
Get a single service request from Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., SD-123) |
expand | string | No | Comma-separated fields to expand: participant, status, sla, requestType, serviceDesk, attachment, comment, action |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueId | string | Jira issue ID |
issueKey | string | Issue key (e.g., SD-123) |
requestTypeId | string | Request type ID |
serviceDeskId | string | Service desk ID |
createdDate | json | Creation date with iso8601, friendly, epochMillis |
currentStatus | object | Current request status |
↳ status | string | Status name |
↳ statusCategory | string | Status category (NEW, INDETERMINATE, DONE) |
↳ statusDate | json | Status change date with iso8601, friendly, epochMillis |
reporter | object | Reporter user details |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | User display name |
↳ emailAddress | string | User email address |
↳ active | boolean | Whether the account is active |
requestFieldValues | array | Request field values |
↳ fieldId | string | Field identifier |
↳ label | string | Human-readable field label |
↳ value | json | Field value |
↳ renderedValue | json | HTML-rendered field value |
url | string | URL to the request |
request | json | The service request object |
Get multiple service requests from Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
serviceDeskId | string | No | Filter by service desk ID (e.g., "1", "2") |
requestOwnership | string | No | Filter by ownership: OWNED_REQUESTS, PARTICIPATED_REQUESTS, APPROVER, ALL_REQUESTS |
requestStatus | string | No | Filter by status: OPEN_REQUESTS, CLOSED_REQUESTS, ALL_REQUESTS |
requestTypeId | string | No | Filter by request type ID |
searchTerm | string | No | Search term to filter requests (e.g., "password reset", "laptop") |
expand | string | No | Comma-separated fields to expand: participant, status, sla, requestType, serviceDesk, attachment, comment, action |
start | number | No | Start index for pagination (e.g., 0, 50, 100) |
limit | number | No | Maximum results to return (e.g., 10, 25, 50) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
requests | array | List of service requests |
↳ issueId | string | Jira issue ID |
↳ issueKey | string | Issue key (e.g., SD-123) |
↳ requestTypeId | string | Request type ID |
↳ serviceDeskId | string | Service desk ID |
↳ createdDate | json | Creation date with iso8601, friendly, epochMillis |
↳ currentStatus | object | Current request status |
↳ status | string | Status name |
↳ statusCategory | string | Status category (NEW, INDETERMINATE, DONE) |
↳ statusDate | json | Status change date with iso8601, friendly, epochMillis |
↳ reporter | object | Reporter user details |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | User display name |
↳ emailAddress | string | User email address |
↳ active | boolean | Whether the account is active |
↳ requestFieldValues | array | Request field values |
↳ fieldId | string | Field identifier |
↳ label | string | Human-readable field label |
↳ value | json | Field value |
↳ renderedValue | json | HTML-rendered field value |
total | number | Total number of requests in current page |
isLastPage | boolean | Whether this is the last page |
Add a comment (public or internal) to a service request in Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., SD-123) |
body | string | Yes | Comment body text |
isPublic | boolean | Yes | Whether the comment is public (visible to customer) or internal (true/false) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
commentId | string | Created comment ID |
body | string | Comment body text |
isPublic | boolean | Whether the comment is public |
author | object | Comment author |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | User display name |
↳ emailAddress | string | User email address |
↳ active | boolean | Whether the account is active |
createdDate | json | Comment creation date with iso8601, friendly, epochMillis |
success | boolean | Whether the comment was added successfully |
Get comments for a service request in Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., SD-123) |
isPublic | boolean | No | Filter to only public comments (true/false) |
internal | boolean | No | Filter to only internal comments (true/false) |
expand | string | No | Comma-separated fields to expand: renderedBody, attachment |
start | number | No | Start index for pagination (e.g., 0, 50, 100) |
limit | number | No | Maximum results to return (e.g., 10, 25, 50) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
comments | array | List of comments |
↳ id | string | Comment ID |
↳ body | string | Comment body text |
↳ public | boolean | Whether the comment is public |
↳ author | object | Comment author |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | User display name |
↳ emailAddress | string | User email address |
↳ active | boolean | Whether the account is active |
↳ created | json | Creation date with iso8601, friendly, epochMillis |
↳ renderedBody | json | HTML-rendered comment body (when expand=renderedBody) |
total | number | Total number of comments |
isLastPage | boolean | Whether this is the last page |
Get customers for a service desk in Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
serviceDeskId | string | Yes | Service Desk ID (e.g., "1", "2") |
query | string | No | Search query to filter customers (e.g., "john", "acme") |
start | number | No | Start index for pagination (e.g., 0, 50, 100) |
limit | number | No | Maximum results to return (e.g., 10, 25, 50) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
customers | array | List of customers |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Display name |
↳ emailAddress | string | Email address |
↳ active | boolean | Whether the account is active |
↳ timeZone | string | User timezone |
total | number | Total number of customers |
isLastPage | boolean | Whether this is the last page |
Add customers to a service desk in Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
serviceDeskId | string | Yes | Service Desk ID (e.g., "1", "2") |
accountIds | string | No | Comma-separated Atlassian account IDs to add as customers |
emails | string | No | Comma-separated email addresses to add as customers |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
serviceDeskId | string | Service desk ID |
success | boolean | Whether customers were added successfully |
Get organizations for a service desk in Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
serviceDeskId | string | Yes | Service Desk ID (e.g., "1", "2") |
start | number | No | Start index for pagination (e.g., 0, 50, 100) |
limit | number | No | Maximum results to return (e.g., 10, 25, 50) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
organizations | array | List of organizations |
↳ id | string | Organization ID |
↳ name | string | Organization name |
total | number | Total number of organizations |
isLastPage | boolean | Whether this is the last page |
Create a new organization in Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
name | string | Yes | Name of the organization to create |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
organizationId | string | ID of the created organization |
name | string | Name of the created organization |
success | boolean | Whether the operation succeeded |
Add an organization to a service desk in Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
serviceDeskId | string | Yes | Service Desk ID (e.g., "1", "2") |
organizationId | string | Yes | Organization ID to add to the service desk |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
serviceDeskId | string | Service Desk ID |
organizationId | string | Organization ID added |
success | boolean | Whether the operation succeeded |
Get queues for a service desk in Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
serviceDeskId | string | Yes | Service Desk ID (e.g., "1", "2") |
includeCount | boolean | No | Include issue count for each queue (true/false) |
start | number | No | Start index for pagination (e.g., 0, 50, 100) |
limit | number | No | Maximum results to return (e.g., 10, 25, 50) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
queues | array | List of queues |
↳ id | string | Queue ID |
↳ name | string | Queue name |
↳ jql | string | JQL filter for the queue |
↳ fields | json | Fields displayed in the queue |
↳ issueCount | number | Number of issues in the queue |
total | number | Total number of queues |
isLastPage | boolean | Whether this is the last page |
Get SLA information for a service request in Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., SD-123) |
start | number | No | Start index for pagination (e.g., 0, 50, 100) |
limit | number | No | Maximum results to return (e.g., 10, 25, 50) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
slas | array | List of SLA metrics |
↳ id | string | SLA metric ID |
↳ name | string | SLA metric name |
↳ completedCycles | json | Completed SLA cycles with startTime, stopTime, breachTime, breached, goalDuration, elapsedTime, remainingTime (each time as DateDTO, durations as DurationDTO) |
↳ ongoingCycle | json | Ongoing SLA cycle with startTime, breachTime, breached, paused, withinCalendarHours, goalDuration, elapsedTime, remainingTime |
total | number | Total number of SLAs |
isLastPage | boolean | Whether this is the last page |
Get available transitions for a service request in Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., SD-123) |
start | number | No | Start index for pagination (e.g., 0, 50, 100) |
limit | number | No | Maximum results to return (e.g., 10, 25, 50) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
transitions | array | List of available transitions |
↳ id | string | Transition ID |
↳ name | string | Transition name |
total | number | Total number of transitions |
isLastPage | boolean | Whether this is the last page |
Transition a service request to a new status in Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., SD-123) |
transitionId | string | Yes | Transition ID to apply |
comment | string | No | Optional comment to add during transition |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
transitionId | string | Applied transition ID |
success | boolean | Whether the transition was successful |
Get participants for a request in Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., SD-123) |
start | number | No | Start index for pagination (e.g., 0, 50, 100) |
limit | number | No | Maximum results to return (e.g., 10, 25, 50) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
participants | array | List of participants |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Display name |
↳ emailAddress | string | Email address |
↳ active | boolean | Whether the account is active |
total | number | Total number of participants |
isLastPage | boolean | Whether this is the last page |
Add participants to a request in Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., SD-123) |
accountIds | string | Yes | Comma-separated account IDs to add as participants |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
participants | array | List of added participants |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Display name |
↳ emailAddress | string | Email address |
↳ active | boolean | Whether the account is active |
success | boolean | Whether the operation succeeded |
Get approvals for a request in Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., SD-123) |
start | number | No | Start index for pagination (e.g., 0, 50, 100) |
limit | number | No | Maximum results to return (e.g., 10, 25, 50) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
approvals | array | List of approvals |
↳ id | string | Approval ID |
↳ name | string | Approval description |
↳ finalDecision | string | Final decision: pending, approved, or declined |
↳ canAnswerApproval | boolean | Whether current user can respond |
↳ approvers | array | List of approvers with their decisions |
↳ approver | object | Approver user details |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | User display name |
↳ emailAddress | string | User email address |
↳ active | boolean | Whether the account is active |
↳ approverDecision | string | Decision: pending, approved, or declined |
↳ createdDate | json | Creation date |
↳ completedDate | json | Completion date |
total | number | Total number of approvals |
isLastPage | boolean | Whether this is the last page |
Approve or decline an approval request in Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., SD-123) |
approvalId | string | Yes | Approval ID to answer |
decision | string | Yes | Decision: "approve" or "decline" |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
approvalId | string | Approval ID |
decision | string | Decision made (approve/decline) |
id | string | Approval ID from response |
name | string | Approval description |
finalDecision | string | Final approval decision: pending, approved, or declined |
canAnswerApproval | boolean | Whether the current user can still respond |
approvers | array | Updated list of approvers with decisions |
↳ approver | object | Approver user details |
↳ accountId | string | Approver account ID |
↳ displayName | string | Approver display name |
↳ emailAddress | string | Approver email |
↳ active | boolean | Whether the account is active |
↳ approverDecision | string | Individual approver decision |
createdDate | json | Approval creation date |
completedDate | json | Approval completion date |
approval | json | The approval object |
success | boolean | Whether the operation succeeded |
Get the fields required to create a request of a specific type in Jira Service Management
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
serviceDeskId | string | Yes | Service Desk ID (e.g., "1", "2") |
requestTypeId | string | Yes | Request Type ID (e.g., "10", "15") |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
serviceDeskId | string | Service desk ID |
requestTypeId | string | Request type ID |
canAddRequestParticipants | boolean | Whether participants can be added to requests of this type |
canRaiseOnBehalfOf | boolean | Whether requests can be raised on behalf of another user |
requestTypeFields | array | List of fields for this request type |
↳ fieldId | string | Field identifier (e.g., summary, description, customfield_10010) |
↳ name | string | Human-readable field name |
↳ description | string | Help text for the field |
↳ required | boolean | Whether the field is required |
↳ visible | boolean | Whether the field is visible |
↳ validValues | json | Allowed values for select fields |
↳ presetValues | json | Pre-populated values |
↳ defaultValues | json | Default values for the field |
↳ jiraSchema | json | Jira field schema with type, system, custom, customId |
List forms (ProForma/JSM Forms) in a Jira project to discover form IDs for request types
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
projectIdOrKey | string | Yes | Jira project ID or key (e.g., "10001" or "SD") |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
projectIdOrKey | string | Project ID or key |
templates | array | List of forms in the project |
↳ id | string | Form template ID (UUID) |
↳ name | string | Form template name |
↳ updated | string | Last updated timestamp (ISO 8601) |
↳ issueCreateIssueTypeIds | json | Issue type IDs that auto-attach this form on issue create |
↳ issueCreateRequestTypeIds | json | Request type IDs that auto-attach this form on issue create |
↳ portalRequestTypeIds | json | Request type IDs that show this form on the customer portal |
↳ recommendedIssueRequestTypeIds | json | Request type IDs that recommend this form |
total | number | Total number of forms |
Get the full structure of a ProForma/JSM form including all questions, field types, choices, layout, and conditions
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
projectIdOrKey | string | Yes | Jira project ID or key (e.g., "10001" or "SD") |
formId | string | Yes | Form ID (UUID from Get Form Templates) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
projectIdOrKey | string | Project ID or key |
formId | string | Form ID |
design | json | Full form design with questions (field types, labels, choices, validation), layout (field ordering), and conditions |
updated | string | Last updated timestamp |
publish | json | Publishing and request type configuration |
List forms (ProForma/JSM Forms) attached to a Jira issue with metadata (name, submitted status, lock)
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., "SD-123", "10001") |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
forms | array | List of forms attached to the issue |
↳ id | string | Form instance ID (UUID) |
↳ name | string | Form name |
↳ updated | string | Last updated timestamp (ISO 8601) |
↳ submitted | boolean | Whether the form has been submitted |
↳ lock | boolean | Whether the form is locked |
↳ internal | boolean | Whether the form is internal-only |
↳ formTemplateId | string | Source form template ID (UUID) |
total | number | Total number of forms |
Attach a form template to an existing Jira issue or JSM request
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key to attach the form to (e.g., "SD-123") |
formTemplateId | string | Yes | Form template UUID (from Get Form Templates) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
id | string | Attached form instance ID (UUID) |
name | string | Form name |
updated | string | Last updated timestamp |
submitted | boolean | Whether the form has been submitted |
lock | boolean | Whether the form is locked |
internal | boolean | Whether the form is internal only |
formTemplateId | string | Form template ID |
Save answers to a form attached to a Jira issue or JSM request
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., "SD-123") |
formId | string | Yes | Form instance UUID (from Attach Form or Get Issue Forms) |
answers | json | Yes | Form answers using numeric question IDs as keys (e.g., {"1": {"text": "Title"}, "4": {"choices": ["5"]}}) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
formId | string | Form instance UUID |
state | json | Form state with status (open, submitted, locked) |
updated | string | Last updated timestamp |
Submit a form on a Jira issue or JSM request, locking it from further edits
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., "SD-123") |
formId | string | Yes | Form instance UUID (from Attach Form or Get Issue Forms) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
formId | string | Form instance UUID |
status | string | Form status after submission (open, submitted, locked) |
Get a single form with full design, state, and answers from a Jira issue
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., "SD-123") |
formId | string | Yes | Form instance UUID (from Attach Form or Get Issue Forms) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
formId | string | Form instance UUID |
design | json | Full form design with questions, layout, conditions, sections, settings |
state | json | Form state with answers map, status (o=open, s=submitted, l=locked), visibility (i=internal, e=external) |
updated | string | Last updated timestamp |
Get simplified answers from a form attached to a Jira issue or JSM request
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., "SD-123") |
formId | string | Yes | Form instance UUID (from Attach Form or Get Issue Forms) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
formId | string | Form instance UUID |
answers | json | Simplified form answers as key-value pairs (question label to answer text/choices) |
Reopen a submitted form on a Jira issue or JSM request, allowing further edits
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., "SD-123") |
formId | string | Yes | Form instance UUID (from Get Issue Forms) |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
formId | string | Form instance UUID |
status | string | Form status after reopening (open, submitted, locked) |
Remove a form from a Jira issue or JSM request
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., "SD-123") |
formId | string | Yes | Form instance UUID to delete |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
formId | string | Deleted form instance UUID |
deleted | boolean | Whether the form was successfully deleted |
Make a form visible to customers on a Jira issue or JSM request
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., "SD-123") |
formId | string | Yes | Form instance UUID |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
formId | string | Form instance UUID |
visibility | string | Form visibility after change (internal or external) |
Make a form internal only (not visible to customers) on a Jira issue or JSM request
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
issueIdOrKey | string | Yes | Issue ID or key (e.g., "SD-123") |
formId | string | Yes | Form instance UUID |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
issueIdOrKey | string | Issue ID or key |
formId | string | Form instance UUID |
visibility | string | Form visibility after change (internal or external) |
Copy forms from one Jira issue to another
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
cloudId | string | No | Jira Cloud ID for the instance |
sourceIssueIdOrKey | string | Yes | Source issue ID or key to copy forms from (e.g., "SD-123") |
targetIssueIdOrKey | string | Yes | Target issue ID or key to copy forms to (e.g., "SD-456") |
formIds | json | No | Optional JSON array of form UUIDs to copy (e.g., ["uuid1", "uuid2"]). If omitted, copies all forms. |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of the operation |
sourceIssueIdOrKey | string | Source issue ID or key |
targetIssueIdOrKey | string | Target issue ID or key |
copiedForms | json | Array of successfully copied forms |
errors | json | Array of errors encountered during copy |
