createItem

A mutation to create a new Item on a specific Roadmap.

As with in-app behaviour, you must specify a summary (Item Name) when creating a new Item. Given that Items are associated with a single, specific roadmap, a valid roadmapID must also be specified in order to create a new Item. All other fields are optional.

An Item can only have actual date(s) (a single date or Start and End Dates) or a bucket time, but not both.

If the intent is to create a sub-Item as part of an Item hierarchy, a valid parentItemID must be specified. All in-app restrictions pertaining to sub-Items will also be enforced via the API (eg. maximum number of allowed sub-Items in a given family).

Sample Mutation

// Create item mutation
mutation {
 createItem (
   roadmapID: "5e4d7d53caec436c46595378"
   summary : "Shopify Integration"
   description : "Set-up a storefront on Shopify"
   startDate : "2021-03-03"
   endDate : "2021-06-03"
   fields : [{
     id : "5e4d7d53caec436c465953cd"
     value : ["Rachel"]
   }, {
     id : "5e4d7d53caec436c465953bc"
     value : ["Infrastructure"]
   }]
 ) {
   id
   summary
   startDate
   endDate
   fields (limit: 10, offset: 0) {
    page {
     ... on ItemListField {
      fieldID
      fieldName
      valueID
      value
   }
  }
 }
}

Sample Response

/Create item mutation result
{
 "data": {
   "createItem": {
     "id": "5e4d9b8da52d7029a0e1a9f6",
     "summary": "Shopify Integration",
     "startDate": "2021-03-03",
     "endDate": "2021-06-03",
     "fields": {
       "page": [
         {
          "fieldID": "5e4d7d53caec436c465953cd",
          "fieldName": "Owner (Ecommerce Roadmap)",
          "valueID": "5e4d7d53caec436c465953d9",
          "value": "Rachel"
         },
         {
          "fieldID": "5e4d7d53caec436c465953bc",
          "fieldName": "Theme (Ecommerce Roadmap)",
          "valueID": "5e4d7d53caec436c465953ca",
          "value": "Infrastructure"
     }
   ]
  }
 }
}

"errors": [
  {
    "message": "Summary must be specified.",
    "path": [
      "createItem"
    ]
    "extensions": {
      "code": "BAD_USER_INPUT",
      "serviceName": "roadmapping"
      "query": "mutation {\n  createItem(roadmap ID: \"5e6019c8a8239d440c8ad4e4\", summary: \"\") {\n     id\n     summary\n   }\n}",
      "variables": {}
      "exception": {
        "stacktrace": [
           "UserInputError: Summary must be specified.",
           "    at validateAndUpdateItemModal
(/srv/roadmunk/app/build/development/server/api/graphql/modules/Items.js:41:10)",
           "    at createItem
(/srv/roadmunk/app/build/development/server/api/graphql/modules/Items.js:396:15)",
           "    at runMicrotasks (<anonymous>)",
           "    at processTicksAndRejections (internal/process/task_queues.js:93:5)"
     ]
    }
   }
  }
 ],
 "data": null
}