v4

latestOpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Dynamic modules

Get modules

Returns all modules registered dynamically by the calling app.

Permissions required: Only Connect apps can make this request.

get/rest/atlassian-connect/1/app/module/dynamic

Response

Returned if the request is successful.

modulesConnectModule[] required

A list of app modules in the same format as the modules property in the app descriptor.

Example response

{
  "jiraEntityProperties": [
    {
      "keyConfigurations": [
        {
          "extractions": [
            {
              "objectName": "extension",
              "type": "text",
              "alias": "attachmentExtension"
            }
          ],
          "propertyKey": "attachment"
        }
      ],
      "entityType": "issue",
      "name": {
        "value": "Attachment Index Document"
      },
      "key": "dynamic-attachment-entity-property"
    }
  ],
  "jiraIssueFields": [
    {
      "description": {
        "value": "A dynamically added single-select field"
      },
      "type": "single_select",
      "extractions": [
        {
          "path": "category",
          "type": "text",
          "name": "categoryName"
        }
      ],
      "name": {
        "value": "Dynamic single select"
      },
      "key": "dynamic-select-field"
    }
  ]
}