Draft entities

The drafts feature indicates whether drafts of work items (epics, features, user stories, and defects) can be created.

Use drafts to bypass validation rules when POSTing work items via the API. This allows integrations using the API to quickly create work items without, for example, validating required fields.

Example: A partner is building a mobile app for submitting defects to ALM Octane. The mobile app shows a simple dialog with only the following fields: name, description, severity, and attachments. The app users can use this dialog to quickly submit defects, and fill it defect details later. If, however, ALM Octane has a rule that makes some other field mandatory when Severity is Critical, the mobile app cannot be used as a quick and easy method for creating a defect. The solution is to use drafts for the initial defect submission by the mobile app, and later on edit the details when not using the mobile app.

To see which entities support the draft feature, get metadata for the entity. For details, see Entity metadata reference.

By default, when creating draft work items, the work items are automatically created as drafts.

  • You can create (POST) work items with rule validation by setting the is_draft field to false.

  • You can create (POST) draft work items without rule validation by setting the is_draft field to true or by omitting the is_draft field.

  • You cannot bypass rule validation when modifying (PUTting) draft entities. At this stage, mandatory fields must be specified.

Example: 
POST .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/defects
{
  "data": [{
      "subtype": "defect",
      "name": "Takes too long to load shopping cart."
       "parent": {
            "type": "work_item",
            "id": "1001"
        },
      "is_draft": false
 }]
}