Start a timer on a card

POST

/boards/{board}/cards/{card}/time-tracks/start

const url = 'https://projects.work.optidata.cloud/api/boards/1/cards/1/time-tracks/start';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://projects.work.optidata.cloud/api/boards/1/cards/1/time-tracks/start \
  --header 'Authorization: Bearer <token>'

Starts a running time entry for the caller on this card. Blocked with 422 while the card has unsatisfied required custom fields.

Authorizations

bearerAuth

Parameters

Path Parameters

board

required

integer

Board id.

card

required

integer

Card id (must belong to the board).

Responses

200

Timer started.

application/json

object

message

string

Example

{
  "message": "Time tracking started"
}

401

Missing, invalid or expired bearer passport.

application/json

object

error

string

Example

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

The authenticated user lacks the required board permission.

application/json

object

message

string

Example

{
  "message": "This action is unauthorized."
}

404

Resource not found, or a nested resource does not belong to its parent in the path.

application/json

object

message

string

Example

{
  "message": "Not found."
}

422

Validation failed.

application/json

object

message

First validation error message.

string

errors

Map of field name → list of error messages.

object

key

additional properties

Array<string>

Example

{
  "message": "The name field is required.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}