Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleExpand

Query parameters

  • issueKey: string (required)

Responses

  • Status
    colourGreen
    titlestatus 200
    application/json Returns a list of all checklists associated with the provided issue key in JSON format
    Example

Code Block
languagejson
{
    "checklists": [
        {
            "checklistId": 5829,
            "issueId": 1011513657,
            "itemsmentionedUsers": [{
                {"mariya": "mariya"
            },
       "id": 50829,    "items": [
               "rank": 0, {
                    "labelid": "Release instructions"26403,
                    "typechecklistId": "heading"829,
                    "levellabel": 1"INVEST",
                    "quotesrank": []0,
                },    "status": null,
           {                     "id"quotes": 50830[],
                    "rankassignees": 1[],
                    "labelhistory": "Preparation", {
                        "typeid": "heading",19902,
                        "levelitemId": 226403,
                    "quotes": []   "checklistId": 829,
            },            "type": "ITEM_CREATED",
   {                     "idfrom": 50831"",
                        "rankto": 2"",
                        "labeldate": 1718634937972,
"Add  feature permissions",                     "typeuser": "itemAdmin Admin",
                    "status": {
   },
                    "idmandatory": 4false,
 
                      "rankvalue": 2"## INVEST",
                        "namelevel": "DONE",
   2,
                    "colortype": "GREENHEADING",
                    "isCheckbox": false
       "default": true,        },
                "statusState": "CHECKED"{
                    "id": }26398,
                    "quoteschecklistId": 829,
[]                 },   "label": "**Independent.** The user story is self contained. @mariya   ",
  {                     "idrank": 508321,
                    "rankstatus": 3,{
                        "labelid": "Send1,
`internal` announcement with presentation",                     "typerank": "item",0,
                        "statusstatusState": {"UNCHECKED",
                        "idname": "TO 4DO",
                        "rankcolor": 2"GRAY",
                        "namedefault": "DONE",true
                        "color": "GREEN"},
                        "defaultquotes": true[],
 
                      "statusStateassignees": "CHECKED"[
                    },    {
                "quotes": []                 }"id": 518,
                {            "userName": "mariya",
       "id": 50833,                    "displayName": "rankmariya":
4,                     "label": "Prepare branch", }
                   "type": "item" ],
                    "statushistory": {
                        "id": 219904,
                        "rankitemId": 626398,
                        "namechecklistId": "IN PROGRESS"829,
                        "colortype": "BLUEITEM_UPDATED",
                        "defaultfrom": "TO trueDO",
                        "statusStateto": "UNCHECKED"
 TO DO",
                  },      "date": 1718634945507,
             "quotes": [          "user": "Admin Admin"
            {        },
                    "idmandatory": 1439,
       false,
                    "rank": 0value": "**Independent.** The user story is self contained. @mariya ",
                    "level": null,
                    "type": "item",
                    "isCheckbox": true
                },
                {
                    "id": 26399,
                    "checklistId": 829,
                    "label": "**Negotiable.** The details of the user story can be negotiated and refined, as the team gets a better understanding of the requirements.",
                    "rank": 2,
                    "status": {
                        "id": 1,
                        "rank": 0,
                        "statusState": "UNCHECKED",
                        "name": "TO DO",
                        "color": "GRAY",
                        "default": true
                    },
                    "quotes": [],
                    "assignees": [],
                    "history": {
                        "id": 19898,
                        "itemId": 26399,
                        "checklistId": 829,
                        "type": "ITEM_CREATED",
                        "from": "",
                        "to": "TO DO",
                        "date": 1718634937972,
                        "user": "Admin Admin"
                    },
                    "mandatory": false,
                    "value": "**Negotiable.** The details of the user story can be negotiated and refined, as the team gets a better understanding of the requirements.",
                    "level": null,
                    "type": "item",
                    "isCheckbox": true
                },
                {
                    "id": 26400,
                    "checklistId": 829,
                    "label": "**Valuable.** The user story clearly defines and provides value to the end-users or stakeholders.",
                    "rank": 3,
                    "status": {
                        "id": 1,
                        "rank": 0,
                        "statusState": "UNCHECKED",
                        "name": "TO DO",
                        "color": "GRAY",
                        "default": true
                    },
                    "quotes": [],
                    "assignees": [],
                    "history": {
                        "id": 19899,
                        "itemId": 26400,
                        "checklistId": 829,
                        "type": "ITEM_CREATED",
                        "from": "",
                        "to": "TO DO",
                        "date": 1718634937972,
                        "user": "Admin Admin"
                    },
                    "mandatory": false,
                    "value": "**Valuable.** The user story clearly defines and provides value to the end-users or stakeholders.",
                    "level": null,
                    "type": "item",
                    "isCheckbox": true
                },
                {
                    "id": 26401,
                    "checklistId": 829,
                    "label": "**Estimable.** The user story may be accurately estimated.",
                    "rank": 4,
                    "status": {
                        "id": 1,
                        "rank": 0,
                        "statusState": "UNCHECKED",
                        "name": "TO DO",
                        "color": "GRAY",
                        "default": true
                    },
                    "quotes": [],
                    "assignees": [],
                    "history": {
                        "id": 19900,
                        "itemId": 26401,
                        "checklistId": 829,
                        "type": "ITEM_CREATED",
                        "from": "",
                        "to": "TO DO",
                        "date": 1718634937972,
                        "user": "Admin Admin"
                    },
                    "mandatory": false,
                    "value": "**Estimable.** The user story may be accurately estimated.",
                    "level": null,
                    "type": "item",
                    "isCheckbox": true
                },
                {
                    "id": 26402,
                    "checklistId": 829,
                    "label": "**Testable.** ",
                    "rank": 5,
                    "status": {
                        "id": 1,
                        "rank": 0,
                        "statusState": "UNCHECKED",
                        "name": "TO DO",
                        "color": "GRAY",
                        "default": true
                    },
                    "quotes": [
                        {
                            "id": 5626,
                            "rank": 0,
                            "text": "The user story may be tested ",
                            "label": "The user story may be tested ",
                            "value": "The user story may be tested "
                        },
                        {
                            "id": 5627,
                            "rank": 1,
                            "text": "and has a clear acceptance criterias for evaluation of completion.",
                            "label": "and has a clear acceptance criterias for evaluation of completion.",
                            "value": "and has a clear acceptance criterias for evaluation of completion."
                        }
                    ],
                    "assignees": [],
                    "history": {
                        "id": 19901,
                        "itemId": 26402,
                        "checklistId": 829,
                        "type": "ITEM_CREATED",
                        "from": "",
                        "to": "TO DO",
                        "date": 1718634937972,
                        "user": "Admin Admin"
                    },
                    "mandatory": false,
                    "value": "**Testable.** ",
                    "level": null,
                    "type": "item",
                    "isCheckbox": true
                },
                {
                    "id": 26404,
                    "checklistId": 829,
           "text         "label": "*Note: mergethis featureis toan masterexample",
                    "rank": 6,
           "label": "* merge feature to master"         "status": null,
                    "quotes": [],
             },       "assignees": [],
                 {   "history": {
                        "id": 144019903,
                            "rankitemId": 126404,
   
                        "textchecklistId": "* set tag",
829,
                           "labeltype": "ITEM_CREATED"*,
set tag"                         }"from": "",
                        {
   "to": "",
                        "iddate": 14411718634937972,
                        "user": "Admin Admin"
 "rank": 2,                  },
          "text": "* update changelog.com",       "mandatory": false,
                    "labelvalue": "* update changelog.com"Note: this is an example",
                    "level": null,
        }            "type": "raw",
       ]             "isCheckbox": false
  }             ], }
           "mentionedUsers": {} ]
        }
    ]
}

  • Status
    colourRed
    titlestatus 400
    Returned if the issue key is not provided

  • Status
    colourRed
    titlestatus 404
    Returned if the requested issue is not found

...

Expand
titleExpand

Path parameters

  • checklistId: number (required)

Body parameters (application/json) - list of JSON objects:

  • id: number

  • rank: number

  • label: string

  • level: number

  • mandatory: boolean

  • status: object

    • id: number (required) - new status id

Example

Changes the item 50859 26401 position and changes label + status of item 50860 26398:

Code Block
languagejson
[
    {
                 "id": 5085926401,
                 "rank": 32
    },
    {
                  "id": 5086026398,
                  "label": "Add feature permissions",**Independent.** The user story is self contained",
                  "status": {
                        "id": 2
                    }
    }
]

Responses

  • Status
    colourGreen
    titleSTATUS 200
    Returns a list of all checklists associated with the same issue in JSON format

  • Status
    colourRed
    titlestatus 400
    Returned if the request body is invalid

  • Status
    colourRed
    titlestatus 404
    Returned if the requested checklist is not found

...

Expand
titleExpand

Query parameters:

  • migrationOption: string

    • possible values: OVERRIDE, APPEND, ADD-IF-EMPTY

  • migrationType: string

    • possible values: STORAGE, ELEMENTS, MY_TO_DO, RESTORE_FROM_HISTORY

  • projectIds: array of project IDs,

  • START_DATE: date

  • END_DATE: date

  • dryRun: boolean

    • value: true - no changes will be made. Use it to see and confirm the list of issue IDs where the checklist data needs to be restored

    • value: false - apply changes to the list of issues from dryRun mode

Example

Code Block
languagejson
{
    "migrationOption": "OVERRIDE",
    "migrationType": "ELEMENTS",
    "projectIds": [11001, 10900],
    "parameters":{"START_DATE": "2024-05-01T14:26:00", "END_DATE":"2024-05-03T14:26:00"},
     "dryRun": true}
}

Responses

  • Status
    colourGreen
    titlestatus 200
    application/json Returns list of existing templates in JSON format

  • Status
    colourRed
    titlestatus 400
    status 400 - returned if values for query parameters are not correct

...