Export JSON data definition

Here you can find details related to the Checklist data export of your project. The JSON file is structured in two sections:

Panel definition: all data related to the definition of your Checklist panel done from the app admin interface in the Project Settings
Panel data: all Checklist data items recorded in each Jira issue.

The panel definition is translated in the following way:

Field	Scope	Description
id	CLOUD ON PREMISE	Identifier of the panel definition
name	CLOUD ON PREMISE	Name of the panel definition
autoPopulate	ON PREMISE	Defines how a created issue is populated with this panel : "do_not_auto_populate": don’t do anything on creation "auto_populate_with_first": populate the issue with the first available template "auto_populate_with_all": populate the issue with all available template
projectId	CLOUD ON PREMISE	Identifier of the Jira project in which this panel is defined
lastUpdate	CLOUD ON PREMISE	Information about the latest update on this panel More details about LastUpdate
customerPortalParameters	CLOUD	Information about the customer portal parameters chosen More details about PortalParameters
issueTypes	CLOUD ON PREMISE	Information about the issue types associated with this panel (linked to requestTypes) More details about IssueTypes
requestTypes	CLOUD	Information about the request types associated to this panel More details about RequestTypes
permissions	CLOUD ON PREMISE	Information about when and by whom the panel can be edited More details about Permissions
templates	CLOUD ON PREMISE	Information about the defined templates for the panel More details about Templates
attributes	CLOUD ON PREMISE	Information about the different panel attributes More details about Attributes

CODE

{
  "id": string,
  "name": string,
  "autoPopulate": "do_not_auto_populate"|"auto_populate_with_first"|"auto_populate_with_all",
  "projectId": string,
  "lastUpdate": {LastUpdate},
  "customerPortalParameters": {PortalParameters},
  "issueTypes": [{IssueTypes}],
  "requestTypes": [{RequestTypes}],
  "permissions": {Permissions},
  "templates": [{Templates}],
  "attributes": [{Attributes}]
}

LastUpdate

Field

Scope

Description

user

CLOUD ON PREMISE

User responsible for the update which contains:

avatar: User to the user avatar
displayName: Full name of the user

date

CLOUD ON PREMISE

Date of the update. The format of the date is related to the Jira configuration

BASH

{
  "user": {
	"avatar": string,
	"displayName": string
	},
  "date": string
}

PortalParameters

Field	Scope	Description
isVisibleOnCustomerPortal	CLOUD	Specifies if the panel is visible on Customer Portal
dateisMandatoryOnCustomerPortal	CLOUD	Specifies if the panel can be empty on Customer Portal
mandatoryCustomerPortalMessage	CLOUD	Message displayed when creating a request (on Customer Portal) with an empty panel

BASH

{
  "isVisibleOnCustomerPortal": boolean,
  "isMandatoryOnCustomerPortal": boolean,
  "mandatoryCustomerPortalMessage": string
}

IssueTypes

Field	Scope	Description
id	CLOUD ON PREMISE	Identifier of the issue type
originalName	CLOUD ON PREMISE	Name of the issue type

BASH

[
  {
    "id": string,
    "originalName": string
  }
]

RequestTypes

Field	Scope	Description
id	CLOUD	Identifier of the request type
originalName	CLOUD	Name of the request type
issueTypeId	CLOUD	Identifier of the issue type linked to the request type

BASH

[
  {
    "id": "52",
    "originalName": "Report a system problem",
    "issueTypeId": "10008"
  }
]

Permissions

Field	Scope	Description
issueStatuses	CLOUD ON PREMISE	Panel is editable only when the issue is in one of the selected statuses, so the array contains ids of the statuses
projectRoles	ON PREMISE	Panel is editable only by users with one of the selected roles, so the array contains ids of the roles
userCustomFields	CLOUD ON PREMISE	Panel is editable only if current user matches one of the selected user custom fields, so the array contains names of the custom fields

BASH

{
  "issueStatuses": [string],
  "projectRoles": [string],
  "userCustomFields": [string]
}

Templates

Field	Scope	Description
id	CLOUD ON PREMISE	Identifier of the template
name	CLOUD ON PREMISE	Name of the template
jql (optional)	CLOUD ON PREMISE	Template will be available only on issues matching the JQL
panel	CLOUD ON PREMISE	Template entries which contains rows corresponding to each entry of the template

BASH

{
    "id": string,
    "name": string
    "jql": string,
    "panel": {
      "rows": [{Cell}]
    }
}

Cell

Field	Scope	Description
type	CLOUD ON PREMISE	Type of the template attribute (all types listed in Attributes except File and Version)
value	CLOUD ON PREMISE	Each cell type has a corresponding value type

BASH

{
  id: {
    "type": "text"|"multiline"|"component"|"issue"|"select"|"user"|"checkbox"|"date"|"number",
    "value": string|[string]|boolean|number
  }
}

Attributes

Here is the exhaustive list of attributes.

Text

Field	Scope	Description
id	CLOUD ON PREMISE	Identifier of the attribute
name	CLOUD ON PREMISE	Name of the attribute
type	CLOUD ON PREMISE	Type of the attribute, can be “text” for single-line text or “multiline” for multi-line text
mandatory	CLOUD ON PREMISE	Defines if the attribute is mandatory
helpText	CLOUD ON PREMISE	Text displayed as a hint to the user
defaultValue	CLOUD ON PREMISE	Value to pre-populate the attribute

BASH

{
  "id": string,
  "name": string,
  "type": "text"|"multiline",
  "mandatory": boolean,
  "helpText": string,
  "defaultValue": "string"|null
}

Date

Field	Scope	Description
id	CLOUD ON PREMISE	Identifier of the attribute
name	CLOUD ON PREMISE	Name of the attribute
type	CLOUD ON PREMISE	Type of the attribute
mandatory	CLOUD ON PREMISE	Defines if the attribute is mandatory
helpText	CLOUD ON PREMISE	Text displayed as a hint to the user
defaultValue	CLOUD ON PREMISE	Value to pre-populate the attribute

BASH

{
  "id": string,
  "name": string,
  "type": "date",
  "mandatory": boolean,
  "helpText": string,
  "defaultValue": number
}

User

Field	Scope	Description
id	CLOUD ON PREMISE	Identifier of the attribute
name	CLOUD ON PREMISE	Name of the attribute
type	CLOUD ON PREMISE	Type of the attribute
mandatory	CLOUD ON PREMISE	Defines if the attribute is mandatory
helpText	CLOUD ON PREMISE	Text displayed as a hint to the user
defaultValue	CLOUD ON PREMISE	No value to pre-populate the attribute, so it will always be null

BASH

{
  "id": string,
  "name": string,
  "type": "user",
  "mandatory": boolean,
  "helpText": string,
  "defaultValue": null
}

Calculation

Field	Scope	Description
id	CLOUD ON PREMISE	Identifier of the attribute
name	CLOUD ON PREMISE	Name of the attribute
type	CLOUD ON PREMISE	Type of the attribute
mandatory	CLOUD ON PREMISE	Defines if the attribute is mandatory
footer	CLOUD ON PREMISE	Defines what the footer will display
formula	CLOUD ON PREMISE	Information about the formula to be calculated, it contains: content: content of the formula mode: calculation mode, it can be "basic" or "advanced" references: array of references in the formula described below
isFixedDecimalsLength (optional)	CLOUD ON PREMISE	Specifies if the number of decimals is fixed
decimalsLength (optional)	CLOUD ON PREMISE	Specifies the number of decimals

BASH

{
  "id": string,
  "name": string,
  "type": "calculated",
  "mandatory": boolean,
  "footer": "none"|"average"|"min"|"max"|"sum",
  "formula": {
    "content": string,
    "mode": "basic"|"advanced",
    "references": [{References}]
  },
  "isFixedDecimalsLength": boolean,
  "decimalsLength": number
}

References

Field	Scope	Description
id	CLOUD ON PREMISE	Reference identifier
name	CLOUD ON PREMISE	Reference name
baseType	CLOUD ON PREMISE	Reference baseType

BASH

{
 "id": string,
  "name": string,
  "baseType": "attribute"
}

Checkbox

Field	Scope	Description
id	CLOUD ON PREMISE	Identifier of the attribute
name	CLOUD ON PREMISE	Name of the attribute
type	CLOUD ON PREMISE	Type of the attribute
mandatory	CLOUD ON PREMISE	Defines if the attribute is mandatory
helpText	CLOUD ON PREMISE	Text displayed as a hint to the user
defaultValue	CLOUD ON PREMISE	Value to pre-populate the attribute
footer	CLOUD ON PREMISE	Defines what the footer will display
headerDisplayType	CLOUD ON PREMISE	Defines what the header will display

BASH

{
 "id": string,
  "name": string,
  "type": "checkbox",
  "mandatory": boolean,
  "helpText": string,
  "defaultValue": boolean,
  "footer": "none"|"percentagechecked"|"percentageunchecked",
  "headerDisplayType": "master"|"attr_name"|"both"|"empty"
}

Component

Field	Scope	Description
id	CLOUD ON PREMISE	Identifier of the attribute
name	CLOUD ON PREMISE	Name of the attribute
type	CLOUD ON PREMISE	Type of the attribute
mandatory	CLOUD ON PREMISE	Defines if the attribute is mandatory
helpText	CLOUD ON PREMISE	Text displayed as a hint to the user
defaultValue	CLOUD ON PREMISE	No value to pre-populate the attribute, so it will always be null

BASH

{
 "id": string,
  "name": string,
  "type": "component",
  "mandatory": boolean,
  "helpText": string,
  "defaultValue": null
}

File

Field	Scope	Description
id	CLOUD ON PREMISE	Identifier of the attribute
name	CLOUD ON PREMISE	Name of the attribute
type	CLOUD ON PREMISE	Type of the attribute
mandatory	CLOUD ON PREMISE	Defines if the attribute is mandatory
helpText	CLOUD ON PREMISE	No text displayed as a hint to the user, so it will always be null
defaultValue	CLOUD ON PREMISE	No value to pre-populate the attribute, so it will always be null

BASH

{
 "id": string,
  "name": string,
  "type": "file",
  "mandatory": boolean,
  "helpText": null,
  "defaultValue": null
}

Issue

Field	Scope	Description
id	CLOUD ON PREMISE	Identifier of the attribute
name	CLOUD ON PREMISE	Name of the attribute
type	CLOUD ON PREMISE	Type of the attribute
mandatory	CLOUD ON PREMISE	Defines if the attribute is mandatory
helpText	CLOUD ON PREMISE	Text displayed as a hint to the user
defaultValue	CLOUD ON PREMISE	No value to pre-populate the attribute, so it will always be null
jql (optional)	CLOUD ON PREMISE	JQL that can filter the issues displayed in the select list

BASH

{
 "id": string,
  "name": string,
  "type": "issue",
  "mandatory": boolean,
  "helpText": string,
  "defaultValue": null,
  "jql": string
}

Number

Field	Scope	Description
id	CLOUD ON PREMISE	Identifier of the attribute
name	CLOUD ON PREMISE	Name of the attribute
type	CLOUD ON PREMISE	Type of the attribute
mandatory	CLOUD ON PREMISE	Defines if the attribute is mandatory
helpText	CLOUD ON PREMISE	Text displayed as a hint to the user
defaultValue	CLOUD ON PREMISE	Value to pre-populate the attribute
footer	CLOUD ON PREMISE	Defines what the footer will display
formatting	CLOUD ON PREMISE	Defines of the number will be formatted

BASH

{
 "id": string,
  "name": string,
  "type": "number",
  "mandatory": boolean,
  "helpText": string,
  "defaultValue": number,
  "footer": "none"|"average"|"min"|"max"|"sum",
  "formatting": "space"|"comma"|"raw"
}

Select list

Field	Scope	Description
id	CLOUD ON PREMISE	Identifier of the attribute
name	CLOUD ON PREMISE	Name of the attribute
type	CLOUD ON PREMISE	Type of the attribute
mandatory	CLOUD ON PREMISE	Defines if the attribute is mandatory
helpText	CLOUD ON PREMISE	Text displayed as a hint to the user
defaultValue	CLOUD ON PREMISE	Value to pre-populate the attribute, which is an array of string(s) corresponding to the id of a list option
optionList	CLOUD ON PREMISE	Available options in the list, which contains: id: option identifier name: option name color: color of the border around the option's content active: defines if the attribute is visible or not
selectionMode	CLOUD ON PREMISE	Defines the select list mode, either single or multiple

BASH

{
  "id": string,
  "name": string,
  "type": "select",
  "mandatory": boolean,
  "helpText": null,
  "defaultValue": [string],
  "optionList": [
    {
      "id": string,
      "name": string,
      "color": "none"|"default"|"success"|"error"|"current"|"complete"|"moved",
      "active": boolean
    }
  ],
  "selectionMode": "single"|"multiple"
}

Version

Field	Scope	Description
id	CLOUD ON PREMISE	Identifier of the attribute
name	CLOUD ON PREMISE	Name of the attribute
type	CLOUD ON PREMISE	Type of the attribute
mandatory	CLOUD ON PREMISE	Defines if the attribute is mandatory
helpText	CLOUD ON PREMISE	Text displayed as a hint to the user
defaultValue	CLOUD ON PREMISE	No value to pre-populate the attribute, so it will always be null
version	CLOUD ON PREMISE	Specifies available version

BASH

{
 "id": string,
  "name": string,
  "type": "version",
  "mandatory": boolean,
  "helpText": string,
  "defaultValue": null,
  "version": "all"|"released"|"unreleased"
}