jira-forms-api

Jira Forms API

Server path: /jira-forms-api | Type: Application | PCID required: Yes

Tools

Tool	Description
jira-forms-api_add_form	Add form
jira-forms-api_copy_forms	Copy forms
jira-forms-api_delete_form	Delete form
jira-forms-api_externalise_form	Change visibility to external
jira-forms-api_get_form	Get form
jira-forms-api_get_form_external_data	Get external form data
jira-forms-api_get_form_index	Get form index
jira-forms-api_get_form_simplified_answers	Get form simplified answers
jira-forms-api_get_form_template	Get form template
jira-forms-api_get_form_template_external_data	Get external form data on a request type
jira-forms-api_get_form_template_index	Get project form index
jira-forms-api_get_issue_form_attachments_metadata	Get form attachments metadata
jira-forms-api_get_request_form	Get form
jira-forms-api_get_request_form_attachments_metadata	Get form attachments metadata
jira-forms-api_get_request_form_external_data	Get external form data
jira-forms-api_get_request_form_index	Get form index
jira-forms-api_get_request_form_simplified_answers	Get form simplified answers
jira-forms-api_get_request_type_form_template	Get form on a request type
jira-forms-api_internalise_form	Change visibility to internal
jira-forms-api_reopen_form	Reopen form
jira-forms-api_save_form_answers	Save form answers
jira-forms-api_save_request_form_answers	Save form answers
jira-forms-api_submit_form	Submit form
jira-forms-api_submit_request_form	Submit form

---

jira-forms-api_add_form

Add form

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID
formTemplate	object	Yes	—	Metadata of the template the form was created from.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    },
    "formTemplate": {
      "type": "object",
      "description": "Metadata of the template the form was created from.",
      "properties": {
        "id": {
          "type": "string",
          "description": "ID of the form template."
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey",
    "formTemplate"
  ]
}

---

jira-forms-api_copy_forms

Copy forms

Parameters:

Parameter	Type	Required	Default	Description
sourceIssueIdOrKey	string	Yes	—	The source issue key or ID
targetIssueIdOrKey	string	Yes	—	The target issue key or ID
ids	object[]	No	—	An array of form IDs. If not specified, copies all forms.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sourceIssueIdOrKey": {
      "type": "string",
      "description": "The source issue key or ID"
    },
    "targetIssueIdOrKey": {
      "type": "string",
      "description": "The target issue key or ID"
    },
    "ids": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "value": {
            "type": "string",
            "format": "uuid",
            "description": "The value value"
          }
        },
        "required": [
          "value"
        ]
      },
      "description": "An array of form IDs. If not specified, copies all forms."
    }
  },
  "required": [
    "PCID",
    "sourceIssueIdOrKey",
    "targetIssueIdOrKey"
  ]
}

---

jira-forms-api_delete_form

Delete form

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID
formId	string	Yes	—	The ID of the form

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    },
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey",
    "formId"
  ]
}

---

jira-forms-api_externalise_form

Change visibility to external

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID
formId	string	Yes	—	The ID of the form

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    },
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey",
    "formId"
  ]
}

---

jira-forms-api_get_form

Get form

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID
formId	string	Yes	—	The ID of the form

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    },
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey",
    "formId"
  ]
}

---

jira-forms-api_get_form_external_data

Get external form data

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID
formId	string	Yes	—	The ID of the form

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    },
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey",
    "formId"
  ]
}

---

jira-forms-api_get_form_index

Get form index

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey"
  ]
}

---

jira-forms-api_get_form_simplified_answers

Get form simplified answers

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID
formId	string	Yes	—	The ID of the form

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    },
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey",
    "formId"
  ]
}

---

jira-forms-api_get_form_template

Get form template

Parameters:

Parameter	Type	Required	Default	Description
projectIdOrKey	string	Yes	—	The project key or ID
formId	string	Yes	—	The ID of the form
requestLanguage	string	No	—	The requested language for the form to be translated to

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "projectIdOrKey": {
      "type": "string",
      "description": "The project key or ID"
    },
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    },
    "requestLanguage": {
      "type": "string",
      "description": "The requested language for the form to be translated to"
    }
  },
  "required": [
    "PCID",
    "projectIdOrKey",
    "formId"
  ]
}

---

jira-forms-api_get_form_template_external_data

Get external form data on a request type

Parameters:

Parameter	Type	Required	Default	Description
serviceDeskId	string	Yes	—	The service desk ID. This can alternatively be a project identifier.
requestTypeId	integer	Yes	—	The request type ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "serviceDeskId": {
      "type": "string",
      "description": "The service desk ID. This can alternatively be a [project identifier](#project-identifiers)."
    },
    "requestTypeId": {
      "type": "integer",
      "description": "The request type ID"
    }
  },
  "required": [
    "PCID",
    "serviceDeskId",
    "requestTypeId"
  ]
}

---

jira-forms-api_get_form_template_index

Get project form index

Parameters:

Parameter	Type	Required	Default	Description
projectIdOrKey	string	Yes	—	The project key or ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "projectIdOrKey": {
      "type": "string",
      "description": "The project key or ID"
    }
  },
  "required": [
    "PCID",
    "projectIdOrKey"
  ]
}

---

jira-forms-api_get_issue_form_attachments_metadata

Get form attachments metadata

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID
formId	string	Yes	—	The ID of the form

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    },
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey",
    "formId"
  ]
}

---

jira-forms-api_get_request_form

Get form

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID
formId	string	Yes	—	The ID of the form

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    },
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey",
    "formId"
  ]
}

---

jira-forms-api_get_request_form_attachments_metadata

Get form attachments metadata

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID
formId	string	Yes	—	The ID of the form

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    },
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey",
    "formId"
  ]
}

---

jira-forms-api_get_request_form_external_data

Get external form data

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID
formId	string	Yes	—	The ID of the form

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    },
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey",
    "formId"
  ]
}

---

jira-forms-api_get_request_form_index

Get form index

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey"
  ]
}

---

jira-forms-api_get_request_form_simplified_answers

Get form simplified answers

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID
formId	string	Yes	—	The ID of the form

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    },
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey",
    "formId"
  ]
}

---

jira-forms-api_get_request_type_form_template

Get form on a request type

Parameters:

Parameter	Type	Required	Default	Description
serviceDeskId	string	Yes	—	The service desk ID. This can alternatively be a project identifier.
requestTypeId	integer	Yes	—	The request type ID
requestLanguage	string	No	—	The requested language for the form to be translated to

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "serviceDeskId": {
      "type": "string",
      "description": "The service desk ID. This can alternatively be a [project identifier](#project-identifiers)."
    },
    "requestTypeId": {
      "type": "integer",
      "description": "The request type ID"
    },
    "requestLanguage": {
      "type": "string",
      "description": "The requested language for the form to be translated to"
    }
  },
  "required": [
    "PCID",
    "serviceDeskId",
    "requestTypeId"
  ]
}

---

jira-forms-api_internalise_form

Change visibility to internal

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID
formId	string	Yes	—	The ID of the form

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    },
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey",
    "formId"
  ]
}

---

jira-forms-api_reopen_form

Reopen form

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID
formId	string	Yes	—	The ID of the form

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    },
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey",
    "formId"
  ]
}

---

jira-forms-api_save_form_answers

Save form answers

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID
formId	string	Yes	—	The ID of the form
answers	object	Yes	—	The answers to the form fields. It contains a mapping of form field IDs to their corresponding values.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    },
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    },
    "answers": {
      "type": "object",
      "description": "The answers to the form fields. It contains a mapping of form field IDs to their corresponding values."
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey",
    "formId",
    "answers"
  ]
}

---

jira-forms-api_save_request_form_answers

Save form answers

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID
formId	string	Yes	—	The ID of the form
answers	object	Yes	—	The answers to the form fields. It contains a mapping of form field IDs to their corresponding values.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    },
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    },
    "answers": {
      "type": "object",
      "description": "The answers to the form fields. It contains a mapping of form field IDs to their corresponding values."
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey",
    "formId",
    "answers"
  ]
}

---

jira-forms-api_submit_form

Submit form

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID
formId	string	Yes	—	The ID of the form

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    },
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey",
    "formId"
  ]
}

---

jira-forms-api_submit_request_form

Submit form

Parameters:

Parameter	Type	Required	Default	Description
issueIdOrKey	string	Yes	—	The issue key or ID
formId	string	Yes	—	The ID of the form

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "issueIdOrKey": {
      "type": "string",
      "description": "The issue key or ID"
    },
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    }
  },
  "required": [
    "PCID",
    "issueIdOrKey",
    "formId"
  ]
}