Create almighty glossary

[aslakknutsen]

Defining names like:

• workitem
• workitemtype
• remoteworkitem
• user
• project
• identity
• tracker
• tracker query
• tracker item

[pranavgore09]

WorkItemType(WIT) : Most basic data structure of the system responsible for defining how a WorkItem will look like and what are valid components/fields a WorkItem will have.

Example- a Task can be a WIT

{
   "name":"Task",
   "fields":{
      "system.owner":{
         "required":true,
         "kind":"user"
      },
      "system.title":{
         "required":true,
         "kind":"string"
      },
      "system.duration":{
         "required":true,
         "kind":"integer"
      }
   },
 "extendedTypeID": null
}

This is a WIT, which will be used while creating WorkItem of type Task.
One can create WIT based on existing WorkItemTypes. Defining relation to parent type will be done by the parameter "extendedTypeID" which can hold name of the WIT as its parent.

[pranavgore09]

WorkItem (WI) : This defines one specific instance in the planner. It can be a project instance, task instance, issue instance, bug instance. As said instance, it will hold the state and information(actual values) about that work item. It must have a type and it must follow the rules defined by that type.

Example - Work Item of type Task (Refer this example of WIT first)

{
    "type": "Task",
    "name": "task1",
    "fields": {
        "system.owner": "dev_user",
        "system.title": "Write API for user registration",
        "system.duration":3
    }
}

This is a work item that has type as Task. Hence it should follow rules defined in Task WIT.
Consider system.title, it is Required and should be a String as per Type Field definition. Similarly system.duration is Required and should be an Integer value. So Work Item should follow such rules defined by its type.

[pmuir]

I've picked this up

[pmuir]

@pranavgore09 good writeups :-)