v1

latestOpenAPI 3.0.12026-08-041753011.2 MB

Scheduling

Get all assignments

get/v1/workspaces/{workspaceId}/scheduling/assignments/all

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

Query parameters

namestring

If provided, assignments will be filtered by name

Example:Bugfixing

If provided, assignments will be filtered by name

startstring required

Represents a start date in the yyyy-MM-ddThh:mm:ssZ format.

Example:2020-01-01T00:00:00Z

Represents a start date in the yyyy-MM-ddThh:mm:ssZ format.

endstring required

Represents a start date in the yyyy-MM-ddThh:mm:ssZ format.

Example:2021-01-01T00:00:00Z

Represents a start date in the yyyy-MM-ddThh:mm:ssZ format.

sort-column'PROJECT' | 'USER' | 'ID'

Represents the column as the sorting criteria.

sort-order'ASCENDING' | 'DESCENDING'

Represents the sorting mode.

pageinteger

Page number.

Example:1

Page number.

page-sizeinteger

Page size.

Example:50

Page size.

Response

billableboolean

Indicates whether assignment is billable or not.

clientIdstring

Represents client identifier across the system.

clientNamestring

Represents project name.

hoursPerDaynumber double

Represents number of hours per day as double.

idstring

Represents assignment identifier across the system.

notestring

Represents assignment note.

projectArchivedboolean

projectBillableboolean

projectColorstring

Color format ^#(?:[0-9a-fA-F]{6}){1}$. Explanation: A valid color code should start with '#' and consist of six hexadecimal characters, representing a color in hexadecimal format. Color value is in standard RGB hexadecimal format.

projectIdstring

Represents project identifier across the system.

projectNamestring

Represents project name.

startTimestring

Represents start time in hh:mm:ss format.

taskIdstring

Represents task identifier across the system.

taskNamestring

Represents task name.

userIdstring

Represents user identifier across the system.

userNamestring

Represents user name.

workspaceIdstring

Represents workspace identifier across the system.

Example response

[
  {
    "clientId": "36b687e29ae1f428e7ebe109",
    "clientName": "Software Development",
    "hoursPerDay": 7.5,
    "id": "74a687e29ae1f428e7ebe505",
    "note": "This is a sample note for an assignment.",
    "projectColor": "#000000",
    "projectId": "56b687e29ae1f428e7ebe504",
    "projectName": "Software Development",
    "startTime": "10:00:00",
    "taskId": "36b687e29ae1f428e7ebe109",
    "taskName": "Bugfixing",
    "userId": "72k687e29ae1f428e7ebe109",
    "userName": "John Doe",
    "workspaceId": "64a687e29ae1f428e7ebe303"
  }
]