BamBam! API Documentation

Tasks

Table of contents:

List tasks

Returns the tasks in the account.

Resource URL
GET
/tasks
GET Parameters
Name Description
projects integers CSV The ID number of the projects with the tickets to fetch; separated by commas.
assignment integers CSV The ID number of the users assigned to the tickets; separated by commas.
authors integers CSV The ID number of the ticket author; separated by commas
statuses integers CSV The ID number of the statuses; separated by commas
milestones integers CSV The ID number of the milestones; separated by commas.
labels integers CSV The ID number of the labels; separated by commas
priorities strings CSV The name of the priorities: CRITICAL, HIGH, NORMAL, LOW, MINOR; separated by commas.
statusesTypes strings CSV The name of the statuses: OPEN, RESOLVED, CLOSED; separated by commas.
date YYYY-MM-DD in gmt The due date in YYYY-MM-DD format. If only this parameter is given, the list will contain entries from the beginning up to this date.
fromDate YYYY-MM-DD in gmt See above; the beginning of the scope of time.
toDate YYYY-MM-DD in gmt See above; the end of the scope of time.
Example
Request
GET
https://pickles.dobambam.com/api/tasks?projects=13&assignment=27&authors=9&statuses=7&priorities=CRITICAL,HIGH,NORMAL&statusesTypes=OPEN&fromDate=2014-10-01&toDate=2014-10-31
Sample Response
{
  "success": true,
  "data": [
    {
      "id": 42,
      "relativeId": 1,
      "projectId": 13,
      "author": {
        "id": 9,
        "avatarSmall": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/0/9/a20ea01f098745877c13baf57757e35d/w/30/30/AVATAR.png",
        "avatarLarge": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/0/9/a20ea01f098745877c13baf57757e35d/w/60/60/AVATAR.png",
        "avatarMicro": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/0/9/a20ea01f098745877c13baf57757e35d/w/16/16/AVATAR.png",
        "shortName": "Owner L."
      },
      "created": "2014-10-22T06:47:32",
      "title": "strict: a = uViewonly",
      "priority": "NORMAL",
      "status": {
        "id": 7,
        "name": "Open",
        "type": "OPEN"
      },
      "labels": [],
      "hasDescription": true,
      "hasAttachments": false,
      "lastEdited": "2014-10-22T06:47:32",
      "visibility": "ALL",
      "visibilityGroup": null,
      "assignment": [
        {
          "id": 27,
          "avatarSmall": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/2/7/b5c526fdb27de3d203dd96068ed3dc56/w/30/30/AVATAR.png",
          "avatarLarge": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/2/7/b5c526fdb27de3d203dd96068ed3dc56/w/60/60/AVATAR.png",
          "avatarMicro": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/2/7/b5c526fdb27de3d203dd96068ed3dc56/w/16/16/AVATAR.png",
          "shortName": "ViewOnly L."
        }
      ],
      "dueDate": "2016-02-20",
      "estimation": 120
    }
  ]
}

Get

Returns a single task.

Resource URL
GET
/tasks/:taskId
Example
Request
GET
https://pickles.dobambam.com/api/task/42
Sample Response
{
  "success": true,
  "data": {
    "id": 42,
    "relativeId": 1,
    "projectId": 13,
    "author": {
      "id": 9,
      "avatarSmall": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/0/9/a20ea01f098745877c13baf57757e35d/w/30/30/AVATAR.png",
      "avatarLarge": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/0/9/a20ea01f098745877c13baf57757e35d/w/60/60/AVATAR.png",
      "avatarMicro": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/0/9/a20ea01f098745877c13baf57757e35d/w/16/16/AVATAR.png",
      "shortName": "Owner L.",
      "firstName": "Owner",
      "lastName": "Lastname"
    },
    "created": "2014-10-22T06:47:32",
    "title": "strict: a = uViewonly",
    "priority": "NORMAL",
    "status": {
      "id": 7,
      "name": "Open",
      "type": "OPEN"
    },
    "labels": [],
    "hasDescription": true,
    "hasAttachments": false,
    "lastEdited": "2014-10-22T06:47:32",
    "visibility": "ALL",
    "visibilityGroup": null,
    "assignment": [
      {
        "id": 27,
        "avatarSmall": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/2/7/b5c526fdb27de3d203dd96068ed3dc56/w/30/30/AVATAR.png",
        "avatarLarge": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/2/7/b5c526fdb27de3d203dd96068ed3dc56/w/60/60/AVATAR.png",
        "avatarMicro": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/2/7/b5c526fdb27de3d203dd96068ed3dc56/w/16/16/AVATAR.png",
        "shortName": "ViewOnly L.",
        "firstName": "ViewOnly",
        "lastName": "Lastname"
      }
    ],
    "dueDate": "2016-02-20",
    "estimation": 120,
    "content": "<p>Description</p>",
    "updates": []
  }
}

Add task

Creates a new task.

Resource URL
POST
/tasks
Example
Request
POST
https://pickles.dobambam.com/api/tasks
POST parameters
Name Description
title Required string The title of new task.
project Required integer The ID number of the project.
status string The ID number of the initial status.
assignees array of integers The ID number of the users assigned to the ticket.
labels array of strings Labels attached to the task.
content string Text in the task description.
milestone integer The ID number of the milestone.
priority string The name of the priority: CRITICAL, HIGH, NORMAL, LOW or MINOR.
dueDate YYYY-MM-DD in gmt The due date in YYYY-MM-DD format.
estimation integer Estimated time.
visibility string ALL or GROUP or ASSIGNEES.
visibilityGroup integer Only for visibility GROUP.
Sample Request
{
  "title": "New example task",
  "project": 1,
  "status": 1,
  "assignees": [2],
  "labels": ["label1", "label2"],
  "content": "Task description",
  "milestone": 1,
  "priority": "HIGH",
  "dueDate": "2016-12-31",
  "estimation": 60,
  "visibility": "GROUP",
  "visibilityGroup": 1
}
Sample Response
{
  "success": true,
  "data": {
    "id": 1,
    "relativeId": 1,
    "projectId": 1,
    "author": {
      "id": 1,
      "avatarSmall": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/0/9/a20ea01f098745877c13baf57757e35d/w/30/30/AVATAR.png",
      "avatarLarge": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/0/9/a20ea01f098745877c13baf57757e35d/w/60/60/AVATAR.png",
      "avatarMicro": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/0/9/a20ea01f098745877c13baf57757e35d/w/16/16/AVATAR.png",
      "shortName": "Owner L.",
      "firstName": "Owner",
      "lastName": "Lastname"
    },
    "created": "2016-10-05T06:47:32",
    "title": "New example task",
    "priority": "HIGH",
    "status": {
      "id": 1,
      "name": "In progress",
      "type": "OPEN"
    },
    "labels": [
      {
        "id": 1,
        "name": "label1"
      },
      {
        "id": 2,
        "name": "label2"
      }
    ],
    "hasDescription": true,
    "hasAttachments": false,
    "lastEdited": "2016-10-05T06:47:32",
    "visibility": "GROUP",
    "visibilityGroup": 1,
    "assignment": [
      {
        "id": 2,
        "avatarSmall": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/2/7/b5c526fdb27de3d203dd96068ed3dc56/w/30/30/AVATAR.png",
        "avatarLarge": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/2/7/b5c526fdb27de3d203dd96068ed3dc56/w/60/60/AVATAR.png",
        "avatarMicro": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/2/7/b5c526fdb27de3d203dd96068ed3dc56/w/16/16/AVATAR.png",
        "shortName": "ViewOnly L.",
        "firstName": "ViewOnly",
        "lastName": "Lastname"
      }
    ],
    "dueDate": "2016-02-20",
    "estimation": 60,
    "content": "Task description",
    "updates": []
  }
}

Update task

Updates a desired task.

Resource URL
PUT
/task/:taskId
Example
Request
PUT
https://pickles.dobambam.com/api/task/1
POST parameters
Name Description
title string The title of new task.
project integer The ID number of the project.
status string The ID number of the initial status.
assignees array of integers The ID number of the users assigned to the ticket. Send an empty array to clear.
labels array of strings Labels attached to the task. Send an empty array to clear.
content string Text in the task description.
milestone integer The ID number of the milestone. Send 0 to clear.
priority string The name of the priority: CRITICAL, HIGH, NORMAL, LOW or MINOR.
dueDate YYYY-MM-DD in gmt The due date in YYYY-MM-DD format. Send an empty string to clear.
estimation integer Estimated time. Send -1 to clear.
visibility string ALL or GROUP or ASSIGNEES.
visibilityGroup integer Only for visibility GROUP.
timeEntry integer The value (in minutes) of a time trackinkg entry.
timeEntryType string The type of the new time entry: BILLABLE, UN_BILLABLE, SETTLED. If not set, the default value is BILLABLE.
timeEntryClock boolean Defines if the currently active timer should be clocked in or not.
Sample Request
{
  "title": "New example task",
  "project": 1,
  "status": 1,
  "assignees": [2],
  "labels": ["label1", "label2"],
  "content": "Task description",
  "milestone": 1,
  "priority": "HIGH",
  "dueDate": "2016-12-31",
  "estimation": 60,
  "visibility": "GROUP",
  "visibilityGroup": 1,
  "timeEntry": 30,
  "timeEntryType": "BILLABLE"
}
Sample Response
{
  "success": true,
  "data": {
    "id": 1,
    "relativeId": 1,
    "projectId": 1,
    "author": {
      "id": 1,
      "avatarSmall": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/0/9/a20ea01f098745877c13baf57757e35d/w/30/30/AVATAR.png",
      "avatarLarge": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/0/9/a20ea01f098745877c13baf57757e35d/w/60/60/AVATAR.png",
      "avatarMicro": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/0/9/a20ea01f098745877c13baf57757e35d/w/16/16/AVATAR.png",
      "shortName": "Owner L.",
      "firstName": "Owner",
      "lastName": "Lastname"
    },
    "created": "2016-10-05T06:47:32",
    "title": "New example task",
    "priority": "HIGH",
    "status": {
      "id": 1,
      "name": "In progress",
      "type": "OPEN"
    },
    "labels": [
      {
        "id": 1,
        "name": "label1"
      },
      {
        "id": 2,
        "name": "label2"
      }
    ],
    "hasDescription": true,
    "hasAttachments": false,
    "lastEdited": "2016-10-05T06:47:32",
    "visibility": "GROUP",
    "visibilityGroup": 1,
    "assignment": [
      {
        "id": 2,
        "avatarSmall": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/2/7/b5c526fdb27de3d203dd96068ed3dc56/w/30/30/AVATAR.png",
        "avatarLarge": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/2/7/b5c526fdb27de3d203dd96068ed3dc56/w/60/60/AVATAR.png",
        "avatarMicro": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/2/7/b5c526fdb27de3d203dd96068ed3dc56/w/16/16/AVATAR.png",
        "shortName": "ViewOnly L.",
        "firstName": "ViewOnly",
        "lastName": "Lastname"
      }
    ],
    "dueDate": "2016-02-20",
    "estimation": 60,
    "content": "Task description",
    "updates": [
    {
        "id": 1,
        "created": "2017-03-27T10:33:48",
        "author": {
          "id": 4,
          "avatarSmall": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/2/7/b5c526fdb27de3d203dd96068ed3dc56/w/30/30/AVATAR.png",
          "avatarLarge": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/2/7/b5c526fdb27de3d203dd96068ed3dc56/w/60/60/AVATAR.png",
          "avatarMicro": "https://pickles.dobambam.com/image-server/user/0/0/0/0/0/2/7/b5c526fdb27de3d203dd96068ed3dc56/w/16/16/AVATAR.png",
          "shortName": "ViewOnly L.",
          "firstName": "ViewOnly",
          "lastName": "Lastname"
        },
        "timeEntry": {
          "id": 1,
          "type": "BILLABLE",
          "value": 30,
          "category": "TICKETS",
          "entryDate": "2017-03-27"
        }
      }
    ]
  }
}
Create a free account
Leave a message

Have a question about BamBam! or one of our apps? Leave a message here and we'll get back to you as soon as we can.