Checklists for Jira

https://docs.herocoders.com/checklist
Admin
Checklists for Jira helps teams build checklist-based workflows within Jira to standardize...
Tokens:187,053
Snippets:1,171
Trust Score:8.2
Update:5 days ago
Show doc for...
Tokens:
Raw
### Example response for Get Checklist (application/json)

Source: https://docs.herocoders.com/checklist/checklist-api.md

Shows the JSON response structure for a successful GET request. The checklist is stored in the customfield_XXXXX field as a formatted string. The response is truncated with '(...) // omitted for brevity' comments.

```json
{
  "expand": "",
  "id": "10002",
  "self": "https://your-domain.atlassian.net/rest/api/2/issue/10002",
  "key": "DEMO-1",
  "fields": {
  (...) // omitted for brevity
    "customfield_XXXXX": "--- Tested on\n* Chrome\n* Safari\n* Firefox\n* Edge\n* [x] IE11",
  }
  (...) // omitted for brevity
}
```

--------------------------------

### Install required Node.js modules

Source: https://docs.herocoders.com/checklist/checklist-api.md

Install axios and lodash modules required for the script.

```bash
npm install axios lodash
```

--------------------------------

### Example JSON response from field search API

Source: https://docs.herocoders.com/checklist/checklist-completed.md

Example response showing the custom field IDs (customfield_10034 and customfield_10099) for the 'Checklist Completed' fields. The description field helps identify fields from different plugin versions.

```JSON
{
  "maxResults": 50,
  "startAt": 0,
  "total": 2,
  "isLast": true,
  "values": [
    {
      "id": "customfield_10034",
      "name": "Checklist Completed",
      "schema": {
        "type": "string",
        "custom": "com.atlassian.jira.plugin.system.customfieldtypes:textfield",
        "customId": 10034
      },
      "description": "Do not delete. Custom field with Checklist completion status. Automatically created and managed by work item Checklist Pro (Sandbox)."
    },
    {
      "id": "customfield_10099",
      "name": "Checklist Completed",
      "schema": {
        "type": "string",
        "custom": "com.atlassian.jira.plugin.system.customfieldtypes:textfield",
        "customId": 10099
      },
      "description": "Do not delete. Custom field with Checklist completion status. Automatically created and managed by work item Checklist Free."
    }
  ]
}
```

--------------------------------

### Example YAML copied from 'Copy Checklist as YAML'

Source: https://docs.herocoders.com/checklist/checklist-content-yaml-custom-field-deprecated.md

Shows the YAML structure generated by the 'Copy Checklist as YAML' option. Use Ctrl+P to paste the clipboard content. The YAML includes items with text, checked status, and optional description.

```yaml
items:
  - text: '--- Optional checklist header/title'
    checked: false
  - text: item 1
    checked: false
  - text: item 2 with **description**
    checked: false
    description: example description
```
Tokens:
Raw