v1

latestOpenAPI 3.0.12026-08-041753011.2 MB

Scheduling

Get all scheduled assignments per project

post/v1/workspaces/{workspaceId}/scheduling/assignments/projects/totals

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

Request body

endstring date-time required

Represents an end date in the yyyy-MM-ddThh:mm:ssZ format.

pageinteger

Page number.

pageSizeinteger

Page size.

searchstring

Represents a term for searching projects and clients by name.

startstring date-time required

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

statusFilter'PUBLISHED' | 'UNPUBLISHED' | 'ALL'

Filters assignments by status.

Example request

{
  "end": "2021-01-01T00:00:00Z",
  "page": 1,
  "pageSize": 50,
  "search": "Project name",
  "start": "2020-01-01T00:00:00Z",
  "statusFilter": "PUBLISHED"
}

Response

clientNamestring

Represents project name.

projectArchivedboolean

Indicates whether project is archived or not.

projectBillableboolean

Indicates whether project is billable or not.

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.

taskIdstring

Represents task identifier across the system.

taskNamestring

Represents task name.

totalHoursnumber double

Represents project total hours as double.

workspaceIdstring

Represents workspace identifier across the system.

Example response

[
  {
    "clientName": "Software Development",
    "milestones": [
      {
        "date": "2020-01-01T08:00:00Z",
        "id": "34a687e29ae1f428e7ebe303",
        "name": "Q3",
        "projectId": "5b641568b07987035750505e",
        "workspaceId": "64a687e29ae1f428e7ebe303"
      }
    ],
    "projectColor": "#000000",
    "projectId": "56b687e29ae1f428e7ebe504",
    "projectName": "Software Development",
    "taskId": "36b687e29ae1f428e7ebe109",
    "taskName": "Bugfixing",
    "totalHours": 490.5,
    "workspaceId": "64a687e29ae1f428e7ebe303"
  }
]