Examples

To view and test the integration's mapping against examples of the third-party API responses, use the jq playground in your data sources page. Find the integration in the list of data sources and click on it to open the playground.

Defaults

Default blueprints

The integration creates the following default blueprints:

Jira Server Project blueprint (Click to expand)

{
  "identifier": "jiraServerProject",
  "title": "Jira Server Project",
  "icon": "Jira",
  "description": "A Jira project",
  "schema": {
    "properties": {
      "url": {
        "title": "Project URL",
        "type": "string",
        "format": "url",
        "description": "URL to the project in Jira"
      }
    }
  },
  "calculationProperties": {}
}

Jira Server User blueprint (Click to expand)

{
  "identifier": "jiraServerUser",
  "title": "Jira Server User",
  "icon": "User",
  "description": "A Jira user account",
  "schema": {
    "properties": {
      "emailAddress": {
        "title": "Email",
        "type": "string",
        "format": "email",
        "description": "User's email address"
      },
      "active": {
        "title": "Active Status",
        "type": "boolean",
        "description": "Whether the user account is active"
      },
      "timeZone": {
        "title": "Time Zone",
        "type": "string",
        "description": "User's configured time zone"
      },
      "locale": {
        "title": "Locale",
        "type": "string",
        "description": "User's configured locale"
      },
      "avatarUrl": {
        "title": "Avatar URL",
        "type": "string",
        "format": "url",
        "description": "URL for user's 48x48 avatar image"
      }
    }
  },
  "relations": {},
  "mirrorProperties": {},
  "calculationProperties": {},
  "aggregationProperties": {}
}

Jira Server Issue blueprint (Click to expand)

{
  "identifier": "jiraServerIssue",
  "title": "Jira Server Issue",
  "icon": "Jira",
  "schema": {
    "properties": {
      "url": {
        "title": "Issue URL",
        "type": "string",
        "format": "url",
        "description": "URL to the issue in Jira"
      },
      "status": {
        "title": "Status",
        "type": "string",
        "description": "The status of the issue"
      },
      "issueType": {
        "title": "Type",
        "type": "string",
        "description": "The type of the issue"
      },
      "components": {
        "title": "Components",
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "The components related to this issue"
      },
      "creator": {
        "title": "Creator",
        "type": "string",
        "description": "The user that created the issue",
        "format": "user"
      },
      "priority": {
        "title": "Priority",
        "type": "string",
        "description": "The priority of the issue"
      },
      "labels": {
        "items": {
          "type": "string"
        },
        "title": "Labels",
        "type": "array"
      },
      "created": {
        "title": "Created At",
        "type": "string",
        "description": "The created datetime of the issue",
        "format": "date-time"
      },
      "updated": {
        "title": "Updated At",
        "type": "string",
        "description": "The updated datetime of the issue",
        "format": "date-time"
      },
      "resolutionDate": {
        "title": "Resolved At",
        "type": "string",
        "description": "The datetime the issue changed to a resolved state",
        "format": "date-time"
      }
    }
  },
  "calculationProperties": {},
  "mirrorProperties": {},
  "aggregationProperties": {},
  "relations": {
    "project": {
      "target": "jiraServerProject",
      "title": "Project",
      "description": "The Jira project that contains this issue",
      "required": false,
      "many": false
    },
    "assignee": {
      "target": "jiraServerUser",
      "title": "Assignee",
      "required": false,
      "many": false
    },
    "reporter": {
      "target": "jiraServerUser",
      "title": "Reporter",
      "required": false,
      "many": false
    }
  }
}

Default mapping configuration

This is the default mapping configuration for this integration:

Default mapping configuration (Click to expand)

createMissingRelatedEntities: true
deleteDependentEntities: true

resources:
  - kind: project
    selector:
      query: "true"
    port:
      entity:
        mappings:
          identifier: .key
          title: .name
          blueprint: '"jiraServerProject"'
          properties:
            url: (.self | split("/") | .[:3] | join("/")) + "/projects/" + .key

  - kind: user
    selector:
      query: "true"
    port:
      entity:
        mappings:
          identifier: .key
          title: .displayName
          blueprint: '"jiraServerUser"'
          properties:
            emailAddress: .emailAddress
            active: .active
            timeZone: .timeZone
            locale: .locale
            avatarUrl: .avatarUrls["48x48"]

  - kind: issue
    selector:
      query: "true"
      # jql: 'project = "KEY"' # Optional: Filter issues using JQL
    port:
      entity:
        mappings:
          identifier: .key
          title: .fields.summary
          blueprint: '"jiraServerIssue"'
          properties:
            url: (.self | split("/") | .[:3] | join("/")) + "/browse/" + .key
            status: .fields.status.name
            issueType: .fields.issuetype.name
            components: .fields.components | map(.name)
            creator: .fields.creator.displayName
            priority: .fields.priority.name
            labels: .fields.labels
            created: .fields.created
            updated: .fields.updated
            resolutionDate: .fields.resolutiondate
        relations:
          project: .fields.project.key
          assignee: .fields.assignee.key
          reporter: .fields.reporter.key