API docs by Redocly

Public FlexiProject APIs (v1)

Download OpenAPI specification:

Budget

Create budget item for project

Create budget item for project

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
name
string or null
order
integer or null <int32>
parentId
string <24-digit hex string> (ObjectId)
type
integer <int32> (Budget.BudgetItemType)
Enum: 0 1 2 100

Responses

Request samples

Content type
{
  • "name": "string",
  • "order": 0,
  • "parentId": "000000000000000000000000",
  • "type": 0
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "projectId": "000000000000000000000000",
  • "name": "string",
  • "parentId": "000000000000000000000000",
  • "order": 0,
  • "type": 0,
  • "amount": 0.1,
  • "date": "2019-08-24T14:15:22Z",
  • "baselineAmount": 0.1,
  • "baselineDate": "2019-08-24T14:15:22Z",
  • "scheduleItemId": "000000000000000000000000",
  • "dateType": 0,
  • "daysDiff": 0,
  • "organizationalCellId": "000000000000000000000000",
  • "expenseTypeId": "000000000000000000000000",
  • "capexOpex": 0,
  • "supplier": "string",
  • "documentNumber": "string",
  • "description": "string",
  • "budgetLineTemplateId": "000000000000000000000000",
  • "isCompleted": true,
  • "commentsCount": 0,
  • "attachmentsCount": 0
}

Create clone of budget item for project

Create clone of budget item for project

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
BudgetItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "projectId": "000000000000000000000000",
  • "name": "string",
  • "parentId": "000000000000000000000000",
  • "order": 0,
  • "type": 0,
  • "amount": 0.1,
  • "date": "2019-08-24T14:15:22Z",
  • "baselineAmount": 0.1,
  • "baselineDate": "2019-08-24T14:15:22Z",
  • "scheduleItemId": "000000000000000000000000",
  • "dateType": 0,
  • "daysDiff": 0,
  • "organizationalCellId": "000000000000000000000000",
  • "expenseTypeId": "000000000000000000000000",
  • "capexOpex": 0,
  • "supplier": "string",
  • "documentNumber": "string",
  • "description": "string",
  • "budgetLineTemplateId": "000000000000000000000000",
  • "isCompleted": true,
  • "commentsCount": 0,
  • "attachmentsCount": 0
}

Get a specific budget item from project by its uni

Get a specific budget item from project by its unique id

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
BudgetItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "projectId": "000000000000000000000000",
  • "name": "string",
  • "parentId": "000000000000000000000000",
  • "order": 0,
  • "type": 0,
  • "amount": 0.1,
  • "date": "2019-08-24T14:15:22Z",
  • "baselineAmount": 0.1,
  • "baselineDate": "2019-08-24T14:15:22Z",
  • "scheduleItemId": "000000000000000000000000",
  • "dateType": 0,
  • "daysDiff": 0,
  • "organizationalCellId": "000000000000000000000000",
  • "expenseTypeId": "000000000000000000000000",
  • "capexOpex": 0,
  • "supplier": "string",
  • "documentNumber": "string",
  • "description": "string",
  • "budgetLineTemplateId": "000000000000000000000000",
  • "isCompleted": true,
  • "commentsCount": 0,
  • "attachmentsCount": 0,
  • "attachments": [
    ],
  • "comments": [
    ],
  • "historyItems": [
    ]
}

Delete budget item from project

Delete budget item from project

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
BudgetItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Get a list of all budget items from project

Get a list of all budget items from project

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "projectBudget": {
    }
}

Get a list of baseline budget items from project

Get a list of baseline budget items from project

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update budget item's name

Update budget item's name

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
BudgetItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update budget item's amount

Update budget item's amount

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
BudgetItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
number or null <double>

Responses

Request samples

Content type
{
  • "value": 0.1
}

Response samples

Content type
application/json
0.1

Update budget item's date

Update budget item's date

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
BudgetItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null <date-time>

Responses

Request samples

Content type
{
  • "value": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
"2019-08-24T14:15:22Z"

Update budget item's position

Update budget item's position

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
BudgetItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
order
integer <int32>
parentId
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "order": 0,
  • "parentId": "000000000000000000000000"
}

Response samples

Content type
application/json
{
  • "order": 0,
  • "parentId": "000000000000000000000000"
}

Update budget item's capexOpex

Update budget item's capexOpex

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
BudgetItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
integer <int32> (Budget.CapexOpex)
Enum: 0 1 2

Responses

Request samples

Content type
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

Update budget item's description

Update budget item's description

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
BudgetItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update budget item's document number

Update budget item's document number

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
BudgetItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update budget item's expense type

Update budget item's expense type

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
BudgetItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "value": "000000000000000000000000"
}

Response samples

Content type
application/json
"000000000000000000000000"

Update budget item's cost center

Update budget item's cost center

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
BudgetItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "value": "000000000000000000000000"
}

Response samples

Content type
application/json
"000000000000000000000000"

Update budget item's supplier

Update budget item's supplier

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
BudgetItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update budget item's schedule

Update budget item's schedule

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
BudgetItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
itemId
string <24-digit hex string> (ObjectId)
dateType
integer <int32> (Budget.ScheduleDateType)
Enum: 0 1 2
daysDiff
integer <int32>

Responses

Request samples

Content type
{
  • "itemId": "000000000000000000000000",
  • "dateType": 0,
  • "daysDiff": 0
}

Response samples

Content type
application/json
{
  • "itemId": "000000000000000000000000",
  • "dateType": 0,
  • "daysDiff": 0
}

Update budget item's isCompleted status

Update budget item's isCompleted status

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
BudgetItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
boolean

Responses

Request samples

Content type
{
  • "value": true
}

Response samples

Content type
application/json
true

Update budget item's type

Update budget item's type

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
BudgetItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
integer <int32> (Budget.BudgetItemType)
Enum: 0 1 2 100

Responses

Request samples

Content type
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

BudgetTemplate

Create budget item template

Create budget item template

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
name
string or null
order
integer or null <int32>
parentId
string <24-digit hex string> (ObjectId)
type
integer <int32> (Budget.BudgetItemType)
Enum: 0 1 2 100

Responses

Request samples

Content type
{
  • "name": "string",
  • "order": 0,
  • "parentId": "000000000000000000000000",
  • "type": 0
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "oldId": 0,
  • "name": "string",
  • "parentId": "000000000000000000000000",
  • "order": 0,
  • "projectTemplateId": "000000000000000000000000",
  • "type": 0,
  • "amount": 0.1,
  • "day": 0,
  • "scheduleItemId": "000000000000000000000000",
  • "dateType": 0,
  • "daysDiff": 0,
  • "organizationalCellId": "000000000000000000000000",
  • "expenseTypeId": "000000000000000000000000",
  • "capexOpex": 0,
  • "supplier": "string",
  • "documentNumber": "string",
  • "description": "string",
  • "attachments": [
    ]
}

Create budget item template's clone

Create budget item template's clone

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "oldId": 0,
  • "name": "string",
  • "parentId": "000000000000000000000000",
  • "order": 0,
  • "projectTemplateId": "000000000000000000000000",
  • "type": 0,
  • "amount": 0.1,
  • "day": 0,
  • "scheduleItemId": "000000000000000000000000",
  • "dateType": 0,
  • "daysDiff": 0,
  • "organizationalCellId": "000000000000000000000000",
  • "expenseTypeId": "000000000000000000000000",
  • "capexOpex": 0,
  • "supplier": "string",
  • "documentNumber": "string",
  • "description": "string",
  • "attachments": [
    ]
}

Get a specific budget item template by its unique

Get a specific budget item template by its unique id

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "oldId": 0,
  • "name": "string",
  • "parentId": "000000000000000000000000",
  • "order": 0,
  • "projectTemplateId": "000000000000000000000000",
  • "type": 0,
  • "amount": 0.1,
  • "day": 0,
  • "scheduleItemId": "000000000000000000000000",
  • "dateType": 0,
  • "daysDiff": 0,
  • "organizationalCellId": "000000000000000000000000",
  • "expenseTypeId": "000000000000000000000000",
  • "capexOpex": 0,
  • "supplier": "string",
  • "documentNumber": "string",
  • "description": "string",
  • "attachments": [
    ]
}

Delete budget item template

Delete budget item template

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Get all budget template items from project templat

Get all budget template items from project template

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update budget template item's name

Update budget template item's name

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update budget template item's description

Update budget template item's description

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update budget template item's day

Update budget template item's day

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
integer or null <int32>

Responses

Request samples

Content type
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

Update budget template item's amount

Update budget template item's amount

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
number or null <double>

Responses

Request samples

Content type
{
  • "value": 0.1
}

Response samples

Content type
application/json
0.1

Update budget template item's position

Update budget template item's position

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
order
integer <int32>
parentId
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "order": 0,
  • "parentId": "000000000000000000000000"
}

Response samples

Content type
application/json
{
  • "order": 0,
  • "parentId": "000000000000000000000000"
}

Update budget template item's related schedule ite

Update budget template item's related schedule item template

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
itemId
string <24-digit hex string> (ObjectId)
dateType
integer <int32> (Budget.ScheduleDateType)
Enum: 0 1 2
daysDiff
integer <int32>

Responses

Request samples

Content type
{
  • "itemId": "000000000000000000000000",
  • "dateType": 0,
  • "daysDiff": 0
}

Response samples

Content type
application/json
{
  • "itemId": "000000000000000000000000",
  • "dateType": 0,
  • "daysDiff": 0
}

Update budget template item's cost center

Update budget template item's cost center

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "value": "000000000000000000000000"
}

Response samples

Content type
application/json
"000000000000000000000000"

Update budget template item's expense type

Update budget template item's expense type

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "value": "000000000000000000000000"
}

Response samples

Content type
application/json
"000000000000000000000000"

Update budget template item's capexOpex

Update budget template item's capexOpex

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
integer <int32> (Budget.CapexOpex)
Enum: 0 1 2

Responses

Request samples

Content type
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

Update budget template item's document number

Update budget template item's document number

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update budget template item's supplier

Update budget template item's supplier

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update budget template item's type

Update budget template item's type

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
integer <int32> (Budget.BudgetItemType)
Enum: 0 1 2 100

Responses

Request samples

Content type
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

CharterTemplate

Get a specific project charter template by its uni

Get a specific project charter template by its unique id

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "fields": [
    ],
  • "workspaceIds": [
    ]
}

Get a list of all project charter templates

Get a list of all project charter templates

query Parameters
object (Templates.BusinessLogic.ProjectCharter.Commands.Read.All.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of all project charter templates associ

Get a list of all project charter templates associated with given project

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CurrentUser

Get global permissions for current user

Get global permissions for current user

query Parameters
object (BusinessLogic.CurrentUser.Commands.Read.User.GlobalPermissions.Request)

Responses

Response samples

Content type
application/json
{
  • "property1": 0,
  • "property2": 0
}

Get project permissions for current user

Get project permissions for current user

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "isScheduleOwner": true,
  • "isProductOwner": true,
  • "isRiskOwner": true,
  • "isAdmin": true,
  • "permissions": {
    }
}

Get portfolio permissions for current user

Get portfolio permissions for current user

path Parameters
PortfolioId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "userId": "string",
  • "mode": 0
}

Get projects program permissions for current user

Get projects program permissions for current user

path Parameters
ProgramId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "userId": "string",
  • "mode": 0
}

Get active dashboard id for current user if it exi

Get active dashboard id for current user if it exists

query Parameters
object (BusinessLogic.CurrentUser.Commands.Read.User.ActiveDashboard.Request)

Responses

Response samples

Content type
application/json
"000000000000000000000000"

Set active dashboard id for current user

Set active dashboard id for current user

Request Body schema:
value
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "value": "000000000000000000000000"
}

Response samples

Content type
application/json
{
  • "userId": "string",
  • "mode": 0
}

Get a list of all available tasks to current user.

Get a list of all available tasks to current user. Supports filtering, sorting, and pagination

query Parameters
Name
string
FromEndDate
string <date-time>
ToEndDate
string <date-time>
CompletionDateRangeFrom
string <date-time>
CompletionDateRangeTo
string <date-time>
OnlyInCompleted
boolean
ShowArchived
boolean
PageNumber
integer <int32>
PageSize
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "pagesCount": 0,
  • "pageSize": 0,
  • "pageNumber": 0
}

Get a specific task by its unique id

Get a specific task by its unique id

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "progress": 0,
  • "parentId": "000000000000000000000000",
  • "wbs": "string",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "projectId": "000000000000000000000000",
  • "projectName": "string",
  • "projectAvatarFileRepositoryItemId": "string",
  • "type": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "duration": 0,
  • "attachmentsCount": 0,
  • "commentsCount": 0,
  • "projectIsArchived": true,
  • "jiraIssueId": "string",
  • "canChangeProgress": true,
  • "ownerIds": [
    ],
  • "creatorId": "string",
  • "hasRecurrence": true,
  • "childrenCount": 0
}

Get a list of all current user's delegated schedul

Get a list of all current user's delegated schedule items. Supports filtering, sorting, and pagination

query Parameters
Name
string
FromEndDate
string <date-time>
ToEndDate
string <date-time>
CompletionDateRangeFrom
string <date-time>
CompletionDateRangeTo
string <date-time>
OwnerIds
Array of strings
OnlyInCompleted
boolean
PageNumber
integer <int32>
PageSize
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "pagesCount": 0,
  • "pageSize": 0,
  • "pageNumber": 0
}

Get a list of all current user's delegated schedul

Get a list of all current user's delegated schedule items' owner ids

query Parameters
object (BusinessLogic.CurrentUser.Commands.Read.DelegatedOwners.Request)

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get a list of all current user's watched schedule

Get a list of all current user's watched schedule items. Supports filtering, sorting, and pagination

query Parameters
Name
string
FromDate
string <date-time>
ToDate
string <date-time>
StatusIds
Array of integers <int32> (Schedule.ScheduleStatus) [ items <int32 > ]
Items Enum: 0 1 2
PageNumber
integer <int32>
PageSize
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0,
  • "pagesCount": 0,
  • "pageSize": 0,
  • "pageNumber": 0
}

Get details of watched schedule item

Get details of watched schedule item

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "scheduleItem": {
    },
  • "predecessors": [
    ],
  • "successors": [
    ],
  • "parents": [
    ],
  • "children": [
    ],
  • "project": {
    }
}

Get history of watched schedule item

Get history of watched schedule item

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of all organization users

Get a list of all organization users

query Parameters
object (BusinessLogic.CurrentUser.Commands.Read.Users.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get current user

Get current user

query Parameters
object (BusinessLogic.CurrentUser.Commands.Read.User.Info.Request)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "userName": "string",
  • "fullName": "string",
  • "email": "user@example.com",
  • "avatarFileRepositoryItemId": "string",
  • "languageCulture": "string",
  • "selectedTenantId": "string",
  • "domainName": "string",
  • "webClientTheme": "string",
  • "webClientColor": "string",
  • "webClientScale": 0,
  • "lastLoginDate": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "isConfirmed": true,
  • "isAdmin": true,
  • "licenseType": 0,
  • "userGroupIds": [
    ],
  • "externalId": "string",
  • "managerId": "string",
  • "departmentId": "000000000000000000000000",
  • "status": 0,
  • "lastVisitedVersion": "string",
  • "isMfaEnabled": true,
  • "isMfaRequired": true,
  • "workspaceIds": [
    ]
}

Update current user

Update current user

Request Body schema:
fullName
string or null
avatarFileRepositoryItemId
string or null
languageCulture
string or null
webClientTheme
string or null
webClientColor
string or null
webClientScale
integer <int32>
isMfaEnabled
boolean

Responses

Request samples

Content type
{
  • "fullName": "string",
  • "avatarFileRepositoryItemId": "string",
  • "languageCulture": "string",
  • "webClientTheme": "string",
  • "webClientColor": "string",
  • "webClientScale": 0,
  • "isMfaEnabled": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "userName": "string",
  • "fullName": "string",
  • "email": "user@example.com",
  • "avatarFileRepositoryItemId": "string",
  • "languageCulture": "string",
  • "selectedTenantId": "string",
  • "domainName": "string",
  • "webClientTheme": "string",
  • "webClientColor": "string",
  • "webClientScale": 0,
  • "lastLoginDate": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "isConfirmed": true,
  • "isAdmin": true,
  • "licenseType": 0,
  • "userGroupIds": [
    ],
  • "externalId": "string",
  • "managerId": "string",
  • "departmentId": "000000000000000000000000",
  • "status": 0,
  • "lastVisitedVersion": "string",
  • "isMfaEnabled": true,
  • "isMfaRequired": true,
  • "workspaceIds": [
    ]
}

Set current user's avatar

Set current user's avatar

Responses

Response samples

Content type
"string"

Get current user's notification settings

Get current user's notification settings

query Parameters
object (BusinessLogic.CurrentUser.Commands.Read.User.NotificationSettings.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get current user's schedule columns

Get current user's schedule columns

query Parameters
object (Organization.BusinessLogic.ScheduleColumns.Commands.Read.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update current user's notification settings

Update current user's notification settings

path Parameters
Type
required
integer <int32> (Users.Settings.UserNotificationSettingType)
Enum: 1 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Request Body schema:
shift
integer <int32>
isEnabled
boolean

Responses

Request samples

Content type
{
  • "shift": 0,
  • "isEnabled": true
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "isEnabled": true,
  • "shift": 0
}

Get details of schedule item

Get details of schedule item

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "scheduleItem": {
    },
  • "predecessors": [
    ],
  • "successors": [
    ],
  • "parents": [
    ],
  • "children": [
    ],
  • "project": {
    }
}

Update progress of schedule item

Update progress of schedule item

path Parameters
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
integer <int32>

Responses

Request samples

Content type
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

Get a specific task by its unique id

Get a specific task by its unique id

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
0
0

Get current user's worktime

Get current user's worktime

query Parameters
FromDate
string <date-time>
ToDate
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Department

Get all departments in organization

Get all departments in organization

query Parameters
object (Organization.BusinessLogic.Departments.Commands.Read.All.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create department

Create department

Request Body schema:
name
string or null
color
string or null
managerId
string or null
members
Array of strings or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "color": "string",
  • "managerId": "string",
  • "members": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Update department

Update department

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
name
string or null
color
string or null
managerId
string or null
members
Array of strings or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "color": "string",
  • "managerId": "string",
  • "members": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete department

Delete department

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

ExpenseType

Get all expense types in organization

Get all expense types in organization

query Parameters
object (Organization.BusinessLogic.ExpenseTypes.Commands.Read.All.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create expense type

Create expense type

Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "value": "string"
}

Get a specific expense type by its unique id

Get a specific expense type by its unique id

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "value": "string"
}

Update expense type

Update expense type

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "value": "string"
}

Delete expense type

Delete expense type

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

File

Get file by its unique id

Get file by its unique id

path Parameters
fileId
required
string

Responses

Response samples

Content type
No sample

Get image by its unique id

Get image by its unique id

path Parameters
fileId
required
string
query Parameters
secret
string

Responses

Response samples

Content type
No sample

Get attachment by its unique id

Get attachment by its unique id

path Parameters
fileId
required
string
query Parameters
secret
string

Responses

Response samples

Content type
No sample

Holidays

Get all global holidays in organization

Get all global holidays in organization

query Parameters
object (BusinessLogic.Resources.GlobalHolidays.Commands.Read.List.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create global holiday

Create global holiday

Request Body schema:
name
string or null
dateFrom
string <date-time>
dateTo
string <date-time>
isRecurring
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "dateFrom": "2019-08-24T14:15:22Z",
  • "dateTo": "2019-08-24T14:15:22Z",
  • "isRecurring": true
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "dateFrom": "2019-08-24T14:15:22Z",
  • "dateTo": "2019-08-24T14:15:22Z",
  • "isRecurring": true
}

Get a specific global holiday by its unique id

Get a specific global holiday by its unique id

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "dateFrom": "2019-08-24T14:15:22Z",
  • "dateTo": "2019-08-24T14:15:22Z",
  • "isRecurring": true
}

Delete global holiday

Delete global holiday

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Update global holiday

Update global holiday

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
name
string or null
dateFrom
string <date-time>
dateTo
string <date-time>
isRecurring
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "dateFrom": "2019-08-24T14:15:22Z",
  • "dateTo": "2019-08-24T14:15:22Z",
  • "isRecurring": true
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "dateFrom": "2019-08-24T14:15:22Z",
  • "dateTo": "2019-08-24T14:15:22Z",
  • "isRecurring": true
}

OrganizationalCell

Get all cost centers in organization

Get all cost centers in organization

query Parameters
object (Organization.BusinessLogic.OrganizationalCells.Commands.Read.All.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create cost center

Create cost center

Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "value": "string",
  • "id": "000000000000000000000000"
}

Get a specific cost center by its unique id

Get a specific cost center by its unique id

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "value": "string",
  • "id": "000000000000000000000000"
}

Update cost center

Update cost center

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "value": "string",
  • "id": "000000000000000000000000"
}

Delete cost center

Delete cost center

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Portfolio

Get summary of all portfolios

Get summary of all portfolios

query Parameters
object (BusinessLogic.Portfolios.Commands.Read.AllSummary.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all portfolios

Get all portfolios

query Parameters
object (BusinessLogic.Portfolios.Commands.Read.All.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create portfolio

Create portfolio

Request Body schema:
name
string or null

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "000000000000000000000000",
  • "description": "string",
  • "budget": 0.1,
  • "revenue": 0.1,
  • "savings": 0.1,
  • "npv": 0.1,
  • "uiConfig": "string"
}

Get a list of portfolios available to current user

Get a list of portfolios available to current user

query Parameters
object (BusinessLogic.Portfolios.Commands.Read.UserPortfolios.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a specific portfolio by its id

Get a specific portfolio by its id

path Parameters
PortfolioId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update portfolio

Update portfolio

path Parameters
PortfolioId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
name
string or null
description
string or null
budget
number <double>
revenue
number <double>
savings
number <double>
npv
number <double>

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "budget": 0.1,
  • "revenue": 0.1,
  • "savings": 0.1,
  • "npv": 0.1
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "000000000000000000000000",
  • "description": "string",
  • "budget": 0.1,
  • "revenue": 0.1,
  • "savings": 0.1,
  • "npv": 0.1,
  • "uiConfig": "string"
}

Remove portfolio

Remove portfolio

path Parameters
PortfolioId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Get all projects

Get all projects

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds projects to portfolio

Adds projects to portfolio

path Parameters
PortfolioId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
Array of strings or null <24-digit hex string> (ObjectId) [ items <24-digit hex string > ]

Responses

Request samples

Content type
{
  • "value": [
    ]
}

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Get portfolio's projects

Get portfolio's projects

path Parameters
PortfolioId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
query Parameters
ShouldIncludeMilestones
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of risks in portfolio's projects

Get a list of risks in portfolio's projects

path Parameters
PortfolioId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Remove project from portfolio

Remove project from portfolio

path Parameters
PortfolioId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Get organization's condition history

Get organization's condition history

query Parameters
object (Organization.BusinessLogic.ConditionHistory.Commands.Read.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get project's condition history

Get project's condition history

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of user permissions for specific portfo

Get a list of user permissions for specific portfolio

path Parameters
PortfolioId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update user's permissions for specific portfolio

Update user's permissions for specific portfolio

path Parameters
PortfolioId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
Array
userId
string or null
mode
integer <int32> (Portfolios.PortfolioPermissionMode)
Enum: 0 1

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of admin permissions for specific portf

Get a list of admin permissions for specific portfolio

query Parameters
object (BusinessLogic.Portfolios.Commands.Read.AdminPermissions.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product

Get a specific product from project by its unique

Get a specific product from project by its unique id

path Parameters
ProductId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "projectId": "000000000000000000000000",
  • "name": "string",
  • "scheduleItemId": "000000000000000000000000",
  • "ownerId": "string",
  • "status": 0,
  • "description": "string",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "bestPractices": [
    ],
  • "templates": [
    ],
  • "finalProducts": [
    ]
}

Delete product from project

Delete product from project

path Parameters
ProductId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Get all products from project

Get all products from project

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create product

Create product

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
name
string or null

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "projectId": "000000000000000000000000",
  • "name": "string",
  • "scheduleItemId": "000000000000000000000000",
  • "ownerId": "string",
  • "status": 0,
  • "description": "string",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "bestPractices": [
    ],
  • "templates": [
    ],
  • "finalProducts": [
    ]
}

Update product's name

Update product's name

path Parameters
ProductId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update product's owner

Update product's owner

path Parameters
ProductId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update product's finish date

Update product's finish date

path Parameters
ProductId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null <date-time>

Responses

Request samples

Content type
{
  • "value": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
"2019-08-24T14:15:22Z"

Update product's related schedule item

Update product's related schedule item

path Parameters
ProductId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "value": "000000000000000000000000"
}

Response samples

Content type
application/json
"000000000000000000000000"

Update product's status

Update product's status

path Parameters
ProductId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
integer <int32> (Products.ProductStatus)
Enum: 0 1 2

Responses

Request samples

Content type
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

Update product's description

Update product's description

path Parameters
ProductId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

ProductTemplate

Get a specific product template from project templ

Get a specific product template from project template by its unique id

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProductTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "ownerId": "string",
  • "itemTemplateId": "000000000000000000000000",
  • "endDay": 0,
  • "description": "string",
  • "attachments": [
    ],
  • "id": "000000000000000000000000",
  • "projectTemplateId": "000000000000000000000000"
}

Update product templates

Update product templates

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProductTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
name
string or null
ownerId
string or null
itemTemplateId
string <24-digit hex string> (ObjectId)
endDay
integer or null <int32>
description
string or null
Array of objects or null (Templates.ProductTemplateAttachment.Dto)

Responses

Request samples

Content type
{
  • "name": "string",
  • "ownerId": "string",
  • "itemTemplateId": "000000000000000000000000",
  • "endDay": 0,
  • "description": "string",
  • "attachments": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "ownerId": "string",
  • "itemTemplateId": "000000000000000000000000",
  • "endDay": 0,
  • "description": "string",
  • "attachments": [
    ],
  • "id": "000000000000000000000000",
  • "projectTemplateId": "000000000000000000000000"
}

Delete product template

Delete product template

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProductTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Get all product templates from project template

Get all product templates from project template

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create product template

Create product template

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
name
string or null
ownerId
string or null
itemTemplateId
string <24-digit hex string> (ObjectId)
endDay
integer or null <int32>
description
string or null
Array of objects or null (Templates.ProductTemplateAttachment.Dto)

Responses

Request samples

Content type
{
  • "name": "string",
  • "ownerId": "string",
  • "itemTemplateId": "000000000000000000000000",
  • "endDay": 0,
  • "description": "string",
  • "attachments": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "ownerId": "string",
  • "itemTemplateId": "000000000000000000000000",
  • "endDay": 0,
  • "description": "string",
  • "attachments": [
    ],
  • "id": "000000000000000000000000",
  • "projectTemplateId": "000000000000000000000000"
}

Project

Get all projects

Get all projects

query Parameters
with
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create project

Create project

Request Body schema:
name
string or null
activeTabs
Array of integers or null <int32> (Projects.ProjectTab) [ items <int32 > ]
Enum: 0 1 2 3 4 5 6 7 8 9 10
workspaceIds
Array of strings or null <24-digit hex string> (ObjectId) [ items <24-digit hex string > ]

Responses

Request samples

Content type
{
  • "name": "string",
  • "activeTabs": [
    ],
  • "workspaceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "stageId": "000000000000000000000000",
  • "conditionId": "000000000000000000000000",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "projectTemplateId": "000000000000000000000000",
  • "scoringId": "000000000000000000000000",
  • "schedule": {
    },
  • "budget": {
    },
  • "progress": 0,
  • "projectManagerIds": [
    ],
  • "portfolioIds": [
    ],
  • "workingDays": [
    ],
  • "avatarFileRepositoryItemId": "string",
  • "fieldValues": [
    ],
  • "fieldHooks": [
    ],
  • "isArchived": true,
  • "jiraProjectId": "string",
  • "activeTabs": [
    ],
  • "taskFilterType": 0,
  • "jiraTasksJql": "string",
  • "workspaceIds": [
    ]
}

Update project

Update project

Request Body schema:
id
string <24-digit hex string> (ObjectId)
name
string or null

Responses

Request samples

Content type
{
  • "id": "000000000000000000000000",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "stageId": "000000000000000000000000",
  • "conditionId": "000000000000000000000000",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "projectTemplateId": "000000000000000000000000",
  • "scoringId": "000000000000000000000000",
  • "schedule": {
    },
  • "budget": {
    },
  • "progress": 0,
  • "projectManagerIds": [
    ],
  • "portfolioIds": [
    ],
  • "workingDays": [
    ],
  • "avatarFileRepositoryItemId": "string",
  • "fieldValues": [
    ],
  • "fieldHooks": [
    ],
  • "isArchived": true,
  • "jiraProjectId": "string",
  • "activeTabs": [
    ],
  • "taskFilterType": 0,
  • "jiraTasksJql": "string",
  • "workspaceIds": [
    ]
}

Get all projects for which current user has access

Get all projects for which current user has access to

query Parameters
object (BusinessLogic.Project.Commands.Read.All.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all projects in which current user has admin p

Get all projects in which current user has admin permissions

query Parameters
object (BusinessLogic.Project.Commands.Read.AdminProjects.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get aspecific project by its unique id

Get aspecific project by its unique id

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "stageId": "000000000000000000000000",
  • "conditionId": "000000000000000000000000",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "projectTemplateId": "000000000000000000000000",
  • "scoringId": "000000000000000000000000",
  • "schedule": {
    },
  • "budget": {
    },
  • "progress": 0,
  • "projectManagerIds": [
    ],
  • "portfolioIds": [
    ],
  • "workingDays": [
    ],
  • "avatarFileRepositoryItemId": "string",
  • "fieldValues": [
    ],
  • "fieldHooks": [
    ],
  • "isArchived": true,
  • "jiraProjectId": "string",
  • "activeTabs": [
    ],
  • "taskFilterType": 0,
  • "jiraTasksJql": "string",
  • "workspaceIds": [
    ]
}

Delete project

Delete project

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
query Parameters
name
string

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Get project's summary

Get project's summary

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "stageId": "000000000000000000000000",
  • "conditionId": "000000000000000000000000",
  • "reviewDate": "2019-08-24T14:15:22Z",
  • "managerIds": [
    ],
  • "portfolioIds": [
    ],
  • "schedule": {
    },
  • "description": "string",
  • "isArchived": true,
  • "budget": {
    },
  • "jiraProjectId": "string"
}

Get project's schedule columns

Get project's schedule columns

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create project from template

Create project from template

Request Body schema:
name
string or null
projectTemplateId
string <24-digit hex string> (ObjectId)
startDate
string or null <date-time>
endDate
string or null <date-time>
workingDays
Array of integers or null <int32> (System.DayOfWeek) unique [ items <int32 > ]
Enum: 0 1 2 3 4 5 6
activeTabs
Array of integers or null <int32> (Projects.ProjectTab) [ items <int32 > ]
Enum: 0 1 2 3 4 5 6 7 8 9 10
workspaceIds
Array of strings or null <24-digit hex string> (ObjectId) [ items <24-digit hex string > ]

Responses

Request samples

Content type
{
  • "name": "string",
  • "projectTemplateId": "000000000000000000000000",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "workingDays": [
    ],
  • "activeTabs": [
    ],
  • "workspaceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "stageId": "000000000000000000000000",
  • "conditionId": "000000000000000000000000",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "projectTemplateId": "000000000000000000000000",
  • "scoringId": "000000000000000000000000",
  • "schedule": {
    },
  • "budget": {
    },
  • "progress": 0,
  • "projectManagerIds": [
    ],
  • "portfolioIds": [
    ],
  • "workingDays": [
    ],
  • "avatarFileRepositoryItemId": "string",
  • "fieldValues": [
    ],
  • "fieldHooks": [
    ],
  • "isArchived": true,
  • "jiraProjectId": "string",
  • "activeTabs": [
    ],
  • "taskFilterType": 0,
  • "jiraTasksJql": "string",
  • "workspaceIds": [
    ]
}

Create project's copy

Create project's copy

Request Body schema:
sourceId
string <24-digit hex string> (ObjectId)
name
string or null
workspaceIds
Array of strings or null <24-digit hex string> (ObjectId) [ items <24-digit hex string > ]

Responses

Request samples

Content type
{
  • "sourceId": "000000000000000000000000",
  • "name": "string",
  • "workspaceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "stageId": "000000000000000000000000",
  • "conditionId": "000000000000000000000000",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "projectTemplateId": "000000000000000000000000",
  • "scoringId": "000000000000000000000000",
  • "schedule": {
    },
  • "budget": {
    },
  • "progress": 0,
  • "projectManagerIds": [
    ],
  • "portfolioIds": [
    ],
  • "workingDays": [
    ],
  • "avatarFileRepositoryItemId": "string",
  • "fieldValues": [
    ],
  • "fieldHooks": [
    ],
  • "isArchived": true,
  • "jiraProjectId": "string",
  • "activeTabs": [
    ],
  • "taskFilterType": 0,
  • "jiraTasksJql": "string",
  • "workspaceIds": [
    ]
}

Update project's isArchived status

Update project's isArchived status

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
boolean

Responses

Request samples

Content type
{
  • "value": true
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "stageId": "000000000000000000000000",
  • "conditionId": "000000000000000000000000",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "projectTemplateId": "000000000000000000000000",
  • "scoringId": "000000000000000000000000",
  • "schedule": {
    },
  • "budget": {
    },
  • "progress": 0,
  • "projectManagerIds": [
    ],
  • "portfolioIds": [
    ],
  • "workingDays": [
    ],
  • "avatarFileRepositoryItemId": "string",
  • "fieldValues": [
    ],
  • "fieldHooks": [
    ],
  • "isArchived": true,
  • "jiraProjectId": "string",
  • "activeTabs": [
    ],
  • "taskFilterType": 0,
  • "jiraTasksJql": "string",
  • "workspaceIds": [
    ]
}

Get project's settings

Get project's settings

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "managers": [
    ],
  • "number": "string",
  • "projectStageId": "000000000000000000000000",
  • "roleAssignments": [
    ],
  • "workingDays": [
    ],
  • "projectHolidays": [
    ],
  • "scheduleColumnIds": [
    ],
  • "avatarFileRepositoryItemId": "string",
  • "fieldValues": [
    ],
  • "jiraIssueTypes": [
    ],
  • "jiraFilterType": 0,
  • "jiraTasksJql": "string",
  • "description": "string",
  • "portfolioIds": [
    ],
  • "scoringTemplateId": "000000000000000000000000",
  • "isArchived": true,
  • "jiraProjectId": "string",
  • "activeTabs": [
    ],
  • "fieldHooks": [
    ],
  • "workspaceIds": [
    ]
}

Update project's name

Update project's name

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update project's avatar

Update project's avatar

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update project's description

Update project's description

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update project's stage

Update project's stage

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "value": "000000000000000000000000"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "managers": [
    ],
  • "number": "string",
  • "projectStageId": "000000000000000000000000",
  • "roleAssignments": [
    ],
  • "workingDays": [
    ],
  • "projectHolidays": [
    ],
  • "scheduleColumnIds": [
    ],
  • "avatarFileRepositoryItemId": "string",
  • "fieldValues": [
    ],
  • "jiraIssueTypes": [
    ],
  • "jiraFilterType": 0,
  • "jiraTasksJql": "string",
  • "description": "string",
  • "portfolioIds": [
    ],
  • "scoringTemplateId": "000000000000000000000000",
  • "isArchived": true,
  • "jiraProjectId": "string",
  • "activeTabs": [
    ],
  • "fieldHooks": [
    ],
  • "workspaceIds": [
    ]
}

Update project's number

Update project's number

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update project's field value

Update project's field value

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
FieldId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
any or null

Responses

Request samples

Content type
{
  • "value": null
}

Response samples

Content type
application/json
null

Update project's managers

Update project's managers

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
managers
Array of strings or null

Responses

Request samples

Content type
{
  • "managers": [
    ]
}

Response samples

Content type
application/json
[
  • "string"
]

Update project's role assignments

Update project's role assignments

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
RoleId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
userIds
Array of strings or null

Responses

Request samples

Content type
{
  • "userIds": [
    ]
}

Response samples

Content type
application/json
[
  • "string"
]

Adds project to workspace

Adds project to workspace

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
WorkspaceId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • "000000000000000000000000"
]

Remove project from workspace

Remove project from workspace

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
WorkspaceId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • "000000000000000000000000"
]

Get project's avatar

Get project's avatar

path Parameters
id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
"string"

Get all users that are schedule item, risk or prod

Get all users that are schedule item, risk or product owner in project

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all schedule items' time allocations from proj

Get all schedule items' time allocations from project

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
query Parameters
FromDate
string <date-time>
ToDate
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all schedule owner allocations from project

Get all schedule owner allocations from project

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update resource time allocation for schedule item

Update resource time allocation for schedule item in project

path Parameters
OwnerId
required
string
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
number <double>

Responses

Request samples

Content type
{
  • "value": 0.1
}

Response samples

Content type
application/json
0.1

Get all work time items from project

Get all work time items from project

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get organization's condition history

Get organization's condition history

path Parameters
projectId
required
string
query Parameters
object (Organization.BusinessLogic.ConditionHistory.Commands.Read.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get project's working days and holidays

Get project's working days and holidays

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "workingDays": [
    ],
  • "projectHolidays": [
    ]
}

Update project's working days and holidays

Update project's working days and holidays

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
workingDays
Array of integers or null <int32> (System.DayOfWeek) unique [ items <int32 > ]
Enum: 0 1 2 3 4 5 6
Array of objects or null (Projects.ProjectHoliday.Dto)

Responses

Request samples

Content type
{
  • "workingDays": [
    ],
  • "projectHolidays": [
    ]
}

Response samples

Content type
application/json
{
  • "workingDays": [
    ],
  • "projectHolidays": [
    ]
}

ProjectCharter

Get all project charters from project

Get all project charters from project

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a specific project charter from project

Get a specific project charter from project

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectCharterId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "projectId": "000000000000000000000000",
  • "changeRequestId": "000000000000000000000000",
  • "createDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "status": 0,
  • "name": "string",
  • "charterTemplateId": "000000000000000000000000",
  • "fields": [
    ],
  • "responses": [
    ]
}

ProjectConditionHistory

Get project's condition history

Get project's condition history

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create project's condition history item

Create project's condition history item

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
conditionId
string <24-digit hex string> (ObjectId)
text
string or null

Responses

Request samples

Content type
{
  • "conditionId": "000000000000000000000000",
  • "text": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get project's specific condition history item by i

Get project's specific condition history item by its unique id

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
projectId
required
string
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

ProjectConditions

Get all project conditions in organization

Get all project conditions in organization

query Parameters
object (Organization.BusinessLogic.ProjectConditions.Commands.Read.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create project condition

Create project condition

Request Body schema:
order
integer <int32>
color
string or null
name
string or null

Responses

Request samples

Content type
{
  • "order": 0,
  • "color": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "order": 0,
  • "color": "string",
  • "name": "string"
}

Update project condition

Update project condition

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
order
integer <int32>
color
string or null
name
string or null

Responses

Request samples

Content type
{
  • "order": 0,
  • "color": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "order": 0,
  • "color": "string",
  • "name": "string"
}

Delete project condition

Delete project condition

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

ProjectFields

Get all project fields in organization

Get all project fields in organization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ProjectRole

Get all project roles in organization

Get all project roles in organization

query Parameters
object (Organization.BusinessLogic.ProjectRoles.Commands.Read.All.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create project role

Create project role

Request Body schema:
name
string or null
object or null
isAdmin
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "permissions": {
    },
  • "isAdmin": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Get a specific project role by its unique id

Get a specific project role by its unique id

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "permissions": {
    },
  • "isAdmin": true,
  • "id": "000000000000000000000000"
}

Update project role

Update project role

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
name
string or null
object or null
isAdmin
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "permissions": {
    },
  • "isAdmin": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete project role

Delete project role

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

ProjectStages

Get all project stages in organization

Get all project stages in organization

query Parameters
object (Organization.BusinessLogic.ProjectStages.Commands.Read.All.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create project stage

Create project stage

Request Body schema:
name
string or null
color
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "color": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "color": "string",
  • "order": 0
}

Update project stage

Update project stage

path Parameters
StageId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
name
string or null
color
string or null
order
integer <int32>

Responses

Request samples

Content type
{
  • "name": "string",
  • "color": "string",
  • "order": 0
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "color": "string",
  • "order": 0
}

Delete project stage

Delete project stage

path Parameters
StageId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
query Parameters
ReplacementStageId
string <24-digit hex string> (ObjectId)
Example: ReplacementStageId=000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

ProjectTemplate

Get all project templates that current user has ac

Get all project templates that current user has access to

query Parameters
object (Templates.BusinessLogic.Projects.Commands.ReadAll.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create project template

Create project template

Request Body schema:
name
string or null
description
string or null
workspaceIds
Array of strings or null <24-digit hex string> (ObjectId) [ items <24-digit hex string > ]

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "workspaceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "scheduleColumnIds": [
    ],
  • "workspaceIds": [
    ]
}

Get a specific project template by its unique id

Get a specific project template by its unique id

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "scheduleColumnIds": [
    ],
  • "workspaceIds": [
    ]
}

Update project template

Update project template

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
name
string or null
description
string or null
scheduleColumnIds
Array of strings or null <24-digit hex string> (ObjectId) [ items <24-digit hex string > ]
workspaceIds
Array of strings or null <24-digit hex string> (ObjectId) [ items <24-digit hex string > ]

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "scheduleColumnIds": [
    ],
  • "workspaceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "scheduleColumnIds": [
    ],
  • "workspaceIds": [
    ]
}

Delete project template

Delete project template

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Create project template's clone

Create project template's clone

Request Body schema:
name
string or null
description
string or null
projectTemplateId
string <24-digit hex string> (ObjectId)
workspaceIds
Array of strings or null <24-digit hex string> (ObjectId) [ items <24-digit hex string > ]

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "projectTemplateId": "000000000000000000000000",
  • "workspaceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "scheduleColumnIds": [
    ],
  • "workspaceIds": [
    ]
}

Create project from project

Create project from project

Request Body schema:
name
string or null
description
string or null
projectId
string <24-digit hex string> (ObjectId)
workspaceIds
Array of strings or null <24-digit hex string> (ObjectId) [ items <24-digit hex string > ]

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "projectId": "000000000000000000000000",
  • "workspaceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "scheduleColumnIds": [
    ],
  • "workspaceIds": [
    ]
}

Get project template's schedule columns

Get project template's schedule columns

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all project templates that are available for s

Get all project templates that are available for selected project

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Resources

Get a list of global holidays

Get a list of global holidays

query Parameters
object (BusinessLogic.Resources.GlobalHolidays.Commands.Read.List.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get default capacity for resource

Get default capacity for resource

path Parameters
Id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update default capacity for resource

Update default capacity for resource

path Parameters
UserId
required
string
Request Body schema:
Array
dayOfWeek
integer <int32> (System.DayOfWeek)
Enum: 0 1 2 3 4 5 6
capacity
number <double>

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Create capacity exception for user

Create capacity exception for user

path Parameters
UserId
required
string
Request Body schema:
name
string or null
fromDate
string <date-time>
toDate
string <date-time>
capacity
number <double>

Responses

Request samples

Content type
{
  • "name": "string",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "capacity": 0.1
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "capacity": 0.1,
  • "externalId": "string"
}

Get a list of capacity exception for user

Get a list of capacity exception for user

path Parameters
UserId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update capacity exception for user

Update capacity exception for user

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
UserId
required
string
Request Body schema:
name
string or null
fromDate
string <date-time>
toDate
string <date-time>
capacity
number <double>

Responses

Request samples

Content type
{
  • "name": "string",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "capacity": 0.1
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "capacity": 0.1,
  • "externalId": "string"
}

Delete capacity exception for user

Delete capacity exception for user

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
UserId
required
string

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Review

Get all reviews from project

Get all reviews from project

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a specific review from project by its unique i

Get a specific review from project by its unique id

path Parameters
ReviewId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Reviews

Get all reviews

Get all reviews

query Parameters
object (BusinessLogic.Reviews.Commands.Read.Reviews.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create review

Create review

Request Body schema:
name
string or null
date
string <date-time>
groupId
string <24-digit hex string> (ObjectId)
templateId
string <24-digit hex string> (ObjectId)
description
string or null
uiConfig
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "groupId": "000000000000000000000000",
  • "templateId": "000000000000000000000000",
  • "description": "string",
  • "uiConfig": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "groupId": "000000000000000000000000",
  • "date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "isArchived": true,
  • "archiveDate": "2019-08-24T14:15:22Z",
  • "templateId": "000000000000000000000000",
  • "fields": [
    ],
  • "type": "string",
  • "uiConfig": "string"
}

Get a specific review by its unique id

Get a specific review by its unique id

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "groupId": "000000000000000000000000",
  • "date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "isArchived": true,
  • "archiveDate": "2019-08-24T14:15:22Z",
  • "templateId": "000000000000000000000000",
  • "fields": [
    ],
  • "type": "string",
  • "uiConfig": "string"
}

Update review

Update review

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
name
string or null
date
string <date-time>
groupId
string <24-digit hex string> (ObjectId)
description
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "groupId": "000000000000000000000000",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "groupId": "000000000000000000000000",
  • "date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "isArchived": true,
  • "archiveDate": "2019-08-24T14:15:22Z",
  • "templateId": "000000000000000000000000",
  • "fields": [
    ],
  • "type": "string",
  • "uiConfig": "string"
}

Delete review

Delete review

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Update review's isArchived status

Update review's isArchived status

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
boolean

Responses

Request samples

Content type
{
  • "value": true
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "groupId": "000000000000000000000000",
  • "date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "isArchived": true,
  • "archiveDate": "2019-08-24T14:15:22Z",
  • "templateId": "000000000000000000000000",
  • "fields": [
    ],
  • "type": "string",
  • "uiConfig": "string"
}

Get all review groups

Get all review groups

query Parameters
object (BusinessLogic.Reviews.Commands.Read.ReviewGroups.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create review group

Create review group

Request Body schema:
name
string or null
groupId
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "name": "string",
  • "groupId": "000000000000000000000000"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "groupId": "000000000000000000000000",
  • "type": "string"
}

Update review group

Update review group

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
name
string or null
groupId
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "name": "string",
  • "groupId": "000000000000000000000000"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "groupId": "000000000000000000000000",
  • "type": "string"
}

Delete review group

Delete review group

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Get all projects

Get all projects

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of projects in review

Get a list of projects in review

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "projectStages": [
    ],
  • "projectRoles": [
    ],
  • "projectConditions": [
    ],
  • "projects": [
    ]
}

Adds projects to review

Adds projects to review

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
Array of strings or null <24-digit hex string> (ObjectId) [ items <24-digit hex string > ]

Responses

Request samples

Content type
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • "000000000000000000000000"
]

Remove project from review

Remove project from review

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Get project's details

Get project's details

path Parameters
ReviewId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "projectStages": [
    ],
  • "projectRoles": [
    ],
  • "projectConditions": [
    ],
  • "attachments": [
    ],
  • "portfolios": [
    ],
  • "riskImpacts": [
    ],
  • "riskProbabilities": [
    ],
  • "project": {
    },
  • "scoring": {
    },
  • "projectConditionHistory": {
    },
  • "organizationConditionHistory": {
    },
  • "reviewResponses": [
    ],
  • "comments": [
    ]
}

Update project's field value

Update project's field value

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ReviewId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
FieldId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
any or null

Responses

Request samples

Content type
{
  • "value": null
}

Response samples

Content type
application/json
null

Get a list of reviews which contain given project

Get a list of reviews which contain given project

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ReviewTemplate

Get a specific review template by its unique id

Get a specific review template by its unique id

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "fields": [
    ]
}

Get a list of all review templates

Get a list of all review templates

query Parameters
object (Templates.BusinessLogic.ProjectReview.Commands.Read.All.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Risk

Get all risks from project

Get all risks from project

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create risk

Create risk

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
name
string or null

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "projectId": "000000000000000000000000",
  • "description": "string",
  • "status": 0,
  • "probabilityId": "000000000000000000000000",
  • "impactId": "000000000000000000000000",
  • "riskCategoryId": "000000000000000000000000",
  • "budgetImpactAmount": 0.1,
  • "budgetImpact": "string",
  • "scheduleImpactDays": 0,
  • "scheduleImpact": "string",
  • "finalProductImpact": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "scheduleItemId": "000000000000000000000000",
  • "ownerId": "string"
}

Get a specific risk from project by its unique id

Get a specific risk from project by its unique id

path Parameters
RiskId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "projectId": "000000000000000000000000",
  • "description": "string",
  • "status": 0,
  • "probabilityId": "000000000000000000000000",
  • "impactId": "000000000000000000000000",
  • "riskCategoryId": "000000000000000000000000",
  • "budgetImpactAmount": 0.1,
  • "budgetImpact": "string",
  • "scheduleImpactDays": 0,
  • "scheduleImpact": "string",
  • "finalProductImpact": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "scheduleItemId": "000000000000000000000000",
  • "ownerId": "string",
  • "attachments": [
    ],
  • "comments": [
    ]
}

Delete risk

Delete risk

path Parameters
RiskId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Update risk's name

Update risk's name

path Parameters
RiskId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update risk's description

Update risk's description

path Parameters
RiskId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update risk's status

Update risk's status

path Parameters
RiskId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
integer <int32> (Risks.RiskStatus)
Enum: 0 1 -1

Responses

Request samples

Content type
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

Update risk's probability

Update risk's probability

path Parameters
RiskId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "value": "000000000000000000000000"
}

Response samples

Content type
application/json
"000000000000000000000000"

Update risk's impact

Update risk's impact

path Parameters
RiskId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "value": "000000000000000000000000"
}

Response samples

Content type
application/json
"000000000000000000000000"

Update risk's category

Update risk's category

path Parameters
RiskId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "value": "000000000000000000000000"
}

Response samples

Content type
application/json
"000000000000000000000000"

Update risk's budget impact amount

Update risk's budget impact amount

path Parameters
RiskId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
number <double>

Responses

Request samples

Content type
{
  • "value": 0.1
}

Response samples

Content type
application/json
0.1

Update risk's budget impact

Update risk's budget impact

path Parameters
RiskId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update risk's impacted schedule days

Update risk's impacted schedule days

path Parameters
RiskId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
integer <int32>

Responses

Request samples

Content type
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

Update risk's schedule impact

Update risk's schedule impact

path Parameters
RiskId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update risk's final product impact

Update risk's final product impact

path Parameters
RiskId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update risk's related schedule item

Update risk's related schedule item

path Parameters
RiskId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "value": "000000000000000000000000"
}

Response samples

Content type
application/json
"000000000000000000000000"

Update risk's owner

Update risk's owner

path Parameters
RiskId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

RiskCategory

Get all risk categories in organization

Get all risk categories in organization

query Parameters
object (Organization.BusinessLogic.RiskCategories.Commands.Read.All.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create risk category

Create risk category

Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "value": "string",
  • "id": "000000000000000000000000"
}

Get a specific risk category by its unique id

Get a specific risk category by its unique id

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "value": "string",
  • "id": "000000000000000000000000"
}

Update risk category

Update risk category

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "value": "string",
  • "id": "000000000000000000000000"
}

Delete risk category

Delete risk category

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

RiskImpact

Get all risk impacts in organization

Get all risk impacts in organization

query Parameters
object (Organization.BusinessLogic.RiskImpacts.Commands.Read.All.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create risk impact

Create risk impact

Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "scale": 0,
  • "name": "string"
}

Update risk impact's name

Update risk impact's name

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update risk impact's scale

Update risk impact's scale

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
integer <int32>

Responses

Request samples

Content type
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

Delete risk impact

Delete risk impact

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
query Parameters
ReplacementId
string <24-digit hex string> (ObjectId)
Example: ReplacementId=000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

RiskProbability

Get all risk probabilities in organization

Get all risk probabilities in organization

query Parameters
object (Organization.BusinessLogic.RiskProbabilities.Commands.Read.All.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create risk probability

Create risk probability

Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "scale": 0,
  • "name": "string"
}

Update risk probability's name

Update risk probability's name

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update risk probability's scale

Update risk probability's scale

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
integer <int32>

Responses

Request samples

Content type
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

Delete risk probability

Delete risk probability

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
query Parameters
ReplacementId
string <24-digit hex string> (ObjectId)
Example: ReplacementId=000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

RiskTemplate

Get a specific risk template from project template

Get a specific risk template from project template by its unique id

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
RiskTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "projectTemplateId": "000000000000000000000000",
  • "itemTemplateId": "000000000000000000000000",
  • "ownerId": "string",
  • "description": "string",
  • "probabilityId": "000000000000000000000000",
  • "impactId": "000000000000000000000000",
  • "categoryId": "000000000000000000000000",
  • "budgetImpactAmount": 0.1,
  • "budgetImpactDescription": "string",
  • "scheduleImpactDays": 0,
  • "scheduleImpactDescription": "string",
  • "finalProjectImpactDescription": "string",
  • "id": "000000000000000000000000",
  • "attachments": [
    ]
}

Update risk template

Update risk template

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
RiskTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
name
string or null
projectTemplateId
string <24-digit hex string> (ObjectId)
itemTemplateId
string <24-digit hex string> (ObjectId)
ownerId
string or null
description
string or null
probabilityId
string <24-digit hex string> (ObjectId)
impactId
string <24-digit hex string> (ObjectId)
categoryId
string <24-digit hex string> (ObjectId)
budgetImpactAmount
number <double>
budgetImpactDescription
string or null
scheduleImpactDays
integer <int32>
scheduleImpactDescription
string or null
finalProjectImpactDescription
string or null
Array of objects or null (Mongo.MongoFileInfo.Dto)

Responses

Request samples

Content type
{
  • "name": "string",
  • "projectTemplateId": "000000000000000000000000",
  • "itemTemplateId": "000000000000000000000000",
  • "ownerId": "string",
  • "description": "string",
  • "probabilityId": "000000000000000000000000",
  • "impactId": "000000000000000000000000",
  • "categoryId": "000000000000000000000000",
  • "budgetImpactAmount": 0.1,
  • "budgetImpactDescription": "string",
  • "scheduleImpactDays": 0,
  • "scheduleImpactDescription": "string",
  • "finalProjectImpactDescription": "string",
  • "attachments": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "projectTemplateId": "000000000000000000000000",
  • "itemTemplateId": "000000000000000000000000",
  • "ownerId": "string",
  • "description": "string",
  • "probabilityId": "000000000000000000000000",
  • "impactId": "000000000000000000000000",
  • "categoryId": "000000000000000000000000",
  • "budgetImpactAmount": 0.1,
  • "budgetImpactDescription": "string",
  • "scheduleImpactDays": 0,
  • "scheduleImpactDescription": "string",
  • "finalProjectImpactDescription": "string",
  • "id": "000000000000000000000000",
  • "attachments": [
    ]
}

Delete risk template

Delete risk template

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
RiskTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Get all risk templates from project template

Get all risk templates from project template

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create risk template

Create risk template

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
name
string or null
projectTemplateId
string <24-digit hex string> (ObjectId)
itemTemplateId
string <24-digit hex string> (ObjectId)
ownerId
string or null
description
string or null
probabilityId
string <24-digit hex string> (ObjectId)
impactId
string <24-digit hex string> (ObjectId)
categoryId
string <24-digit hex string> (ObjectId)
budgetImpactAmount
number <double>
budgetImpactDescription
string or null
scheduleImpactDays
integer <int32>
scheduleImpactDescription
string or null
finalProjectImpactDescription
string or null
Array of objects or null (Mongo.MongoFileInfo.CreateDto)

Responses

Request samples

Content type
{
  • "name": "string",
  • "projectTemplateId": "000000000000000000000000",
  • "itemTemplateId": "000000000000000000000000",
  • "ownerId": "string",
  • "description": "string",
  • "probabilityId": "000000000000000000000000",
  • "impactId": "000000000000000000000000",
  • "categoryId": "000000000000000000000000",
  • "budgetImpactAmount": 0.1,
  • "budgetImpactDescription": "string",
  • "scheduleImpactDays": 0,
  • "scheduleImpactDescription": "string",
  • "finalProjectImpactDescription": "string",
  • "attachments": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "projectTemplateId": "000000000000000000000000",
  • "itemTemplateId": "000000000000000000000000",
  • "ownerId": "string",
  • "description": "string",
  • "probabilityId": "000000000000000000000000",
  • "impactId": "000000000000000000000000",
  • "categoryId": "000000000000000000000000",
  • "budgetImpactAmount": 0.1,
  • "budgetImpactDescription": "string",
  • "scheduleImpactDays": 0,
  • "scheduleImpactDescription": "string",
  • "finalProjectImpactDescription": "string",
  • "id": "000000000000000000000000",
  • "attachments": [
    ]
}

ScheduleColumns

Get all schedule columns in organization

Get all schedule columns in organization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ScheduleItems

Get all schedule items from project

Get all schedule items from project

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create schedule item

Create schedule item

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
type
integer <int32> (ScheduleItemType)
Enum: 0 1 2
name
string or null
order
integer <int32>
parentId
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "type": 0,
  • "name": "string",
  • "order": 0,
  • "parentId": "000000000000000000000000"
}

Response samples

Content type
application/json
{
  • "type": 0,
  • "id": "000000000000000000000000",
  • "projectId": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "notifiedAt": "2019-08-24T14:15:22Z",
  • "order": 0,
  • "progress": 0,
  • "parentId": "000000000000000000000000",
  • "ownerIds": [
    ],
  • "departmentIds": [
    ],
  • "allocation": 0.1,
  • "itemTemplateId": 0,
  • "wbs": "string",
  • "index": 0,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "customColumnValues": [
    ],
  • "jiraIssueId": "string",
  • "workTime": 0,
  • "color": "string",
  • "backgroundColor": "string"
}

Get all schedule items with relations and related

Get all schedule items with relations and related risks, products and budget items from project

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "relations": [
    ],
  • "projectSchedule": {
    }
}

Get a specific schedule item from project by its u

Get a specific schedule item from project by its unique id

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
scheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "type": 0,
  • "id": "000000000000000000000000",
  • "projectId": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "notifiedAt": "2019-08-24T14:15:22Z",
  • "order": 0,
  • "progress": 0,
  • "parentId": "000000000000000000000000",
  • "ownerIds": [
    ],
  • "departmentIds": [
    ],
  • "allocation": 0.1,
  • "itemTemplateId": 0,
  • "wbs": "string",
  • "index": 0,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "customColumnValues": [
    ],
  • "jiraIssueId": "string",
  • "workTime": 0,
  • "color": "string",
  • "backgroundColor": "string",
  • "attachments": [
    ],
  • "comments": [
    ],
  • "risks": [
    ],
  • "products": [
    ],
  • "predecessors": [
    ],
  • "successors": [
    ],
  • "budgetLines": [
    ],
  • "watcherIds": [
    ]
}

Delete schedule item

Delete schedule item

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
scheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Create schedule item's clone

Create schedule item's clone

path Parameters
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "type": 0,
  • "id": "000000000000000000000000",
  • "projectId": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "notifiedAt": "2019-08-24T14:15:22Z",
  • "order": 0,
  • "progress": 0,
  • "parentId": "000000000000000000000000",
  • "ownerIds": [
    ],
  • "departmentIds": [
    ],
  • "allocation": 0.1,
  • "itemTemplateId": 0,
  • "wbs": "string",
  • "index": 0,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "customColumnValues": [
    ],
  • "jiraIssueId": "string",
  • "workTime": 0,
  • "color": "string",
  • "backgroundColor": "string"
}

Create schedule item's and its children clones

Create schedule item's and its children clones

path Parameters
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "type": 0,
  • "id": "000000000000000000000000",
  • "projectId": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "notifiedAt": "2019-08-24T14:15:22Z",
  • "order": 0,
  • "progress": 0,
  • "parentId": "000000000000000000000000",
  • "ownerIds": [
    ],
  • "departmentIds": [
    ],
  • "allocation": 0.1,
  • "itemTemplateId": 0,
  • "wbs": "string",
  • "index": 0,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "customColumnValues": [
    ],
  • "jiraIssueId": "string",
  • "workTime": 0,
  • "color": "string",
  • "backgroundColor": "string"
}

Update schedule item's name

Update schedule item's name

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
scheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update schedule item's background color

Update schedule item's background color

path Parameters
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update schedule item's progress

Update schedule item's progress

path Parameters
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
integer <int32>

Responses

Request samples

Content type
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

Adds owner to schedule item

Adds owner to schedule item

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
scheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Remove owner from schedule item

Remove owner from schedule item

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
scheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ownerId
required
string

Responses

Response samples

Content type
"string"

Adds department to schedule item

Adds department to schedule item

path Parameters
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "value": "000000000000000000000000"
}

Response samples

Content type
application/json
"000000000000000000000000"

Remove department from schedule item

Remove department from schedule item

path Parameters
DepartmentId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
"000000000000000000000000"

Update schedule item's allocation

Update schedule item's allocation

path Parameters
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
number or null <double>

Responses

Request samples

Content type
{
  • "value": 0.1
}

Response samples

Content type
application/json
0.1

Get schedule item's owner allocation

Get schedule item's owner allocation

path Parameters
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get schedule item's owner day allocation

Get schedule item's owner day allocation

path Parameters
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update schedule item's owner allocation

Update schedule item's owner allocation

path Parameters
OwnerId
required
string
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
number <double>

Responses

Request samples

Content type
{
  • "value": 0.1
}

Response samples

Content type
application/json
0.1

Update schedule item's owner day allocation

Update schedule item's owner day allocation

path Parameters
OwnerId
required
string
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
date
string <date-time>
allocation
number or null <double>

Responses

Request samples

Content type
{
  • "date": "2019-08-24T14:15:22Z",
  • "allocation": 0.1
}

Response samples

Content type
application/json
0.1

Get schedule item's department allocation

Get schedule item's department allocation

path Parameters
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get schedule item's department day allocation

Get schedule item's department day allocation

path Parameters
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update schedule item's department allocation

Update schedule item's department allocation

path Parameters
DepartmentId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
number <double>

Responses

Request samples

Content type
{
  • "value": 0.1
}

Response samples

Content type
application/json
0.1

Update schedule item's schedule days

Update schedule item's schedule days

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
scheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
object (Schedule.ScheduleDates)

Responses

Request samples

Content type
{
  • "value": { }
}

Response samples

Content type
application/json
{
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "duration": 0
}

Update schedule item's end day

Update schedule item's end day

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
scheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null <date-time>

Responses

Request samples

Content type
{
  • "value": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
"2019-08-24T14:15:22Z"

Update schedule item's start day

Update schedule item's start day

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
scheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string <date-time>

Responses

Request samples

Content type
{
  • "value": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
"2019-08-24T14:15:22Z"

Update schedule item's description

Update schedule item's description

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
scheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update schedule item's position

Update schedule item's position

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
scheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
parentId
string <24-digit hex string> (ObjectId)
order
integer <int32>

Responses

Request samples

Content type
{
  • "parentId": "000000000000000000000000",
  • "order": 0
}

Response samples

Content type
application/json
{
  • "parentId": "000000000000000000000000",
  • "order": 0
}

Update schedule item's type

Update schedule item's type

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
scheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
integer <int32> (ScheduleItemType)
Enum: 0 1 2

Responses

Request samples

Content type
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

Update schedule item's custom column value

Update schedule item's custom column value

path Parameters
CustomColumnId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
application/json
null

Update project's schedule dates

Update project's schedule dates

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
object (Schedule.ScheduleDates)

Responses

Request samples

Content type
{
  • "value": { }
}

Response samples

Content type
application/json
{
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "duration": 0
}

Update project's start date

Update project's start date

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
date
string or null <date-time>

Responses

Request samples

Content type
{
  • "date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
"2019-08-24T14:15:22Z"

Get schedule item's work items

Get schedule item's work items

path Parameters
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds work item to schedule item

Adds work item to schedule item

path Parameters
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
date
string <date-time>
minutes
integer <int32>
comment
string or null

Responses

Request samples

Content type
{
  • "date": "2019-08-24T14:15:22Z",
  • "minutes": 0,
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "projectId": "000000000000000000000000",
  • "itemId": "000000000000000000000000",
  • "date": "2019-08-24T14:15:22Z",
  • "minutes": 0,
  • "userId": "string",
  • "project": {
    },
  • "task": {
    },
  • "comment": "string"
}

Remove work item from schedule item

Remove work item from schedule item

path Parameters
WorkItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ScheduleItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Update owners for multiple schedule items

Update owners for multiple schedule items

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
ownerIds
Array of strings or null
itemIds
Array of strings or null <24-digit hex string> (ObjectId) [ items <24-digit hex string > ]

Responses

Request samples

Content type
{
  • "ownerIds": [
    ],
  • "itemIds": [
    ]
}

Response samples

Content type
application/json
{ }

Remove multiple schedule items

Remove multiple schedule items

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
itemIds
Array of strings or null <24-digit hex string> (ObjectId) [ items <24-digit hex string > ]

Responses

Request samples

Content type
{
  • "itemIds": [
    ]
}

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Get project's computed dates

Get project's computed dates

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
query Parameters
Start
string <date-time>
End
string <date-time>
Duration
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "duration": 0
}

Update custom column value for multiple schedule i

Update custom column value for multiple schedule items

path Parameters
CustomColumnId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null
itemIds
Array of strings or null <24-digit hex string> (ObjectId) [ items <24-digit hex string > ]

Responses

Request samples

Content type
{
  • "value": "string",
  • "itemIds": [
    ]
}

Response samples

Content type
application/json
null

Update dates for multiple schedule items

Update dates for multiple schedule items

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
itemIds
Array of strings or null <24-digit hex string> (ObjectId) [ items <24-digit hex string > ]
object (Schedule.ScheduleDates)

Responses

Request samples

Content type
{
  • "itemIds": [
    ],
  • "dates": { }
}

Response samples

Content type
application/json
{
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "duration": 0
}

Update departments for multiple schedule items

Update departments for multiple schedule items

path Parameters
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
departmentIds
Array of strings or null <24-digit hex string> (ObjectId) [ items <24-digit hex string > ]
itemIds
Array of strings or null <24-digit hex string> (ObjectId) [ items <24-digit hex string > ]

Responses

Request samples

Content type
{
  • "departmentIds": [
    ],
  • "itemIds": [
    ]
}

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

ScheduleRelations

Create relation for two schedule items

Create relation for two schedule items

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
predecessorId
string <24-digit hex string> (ObjectId)
successorId
string <24-digit hex string> (ObjectId)
lag
integer or null <int32>
type
integer <int32> (Schedule.ScheduleRelationType)
Enum: 0 1 2 3

Responses

Request samples

Content type
{
  • "predecessorId": "000000000000000000000000",
  • "successorId": "000000000000000000000000",
  • "lag": 0,
  • "type": 0
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "projectId": "000000000000000000000000",
  • "predecessorId": "000000000000000000000000",
  • "successorId": "000000000000000000000000",
  • "lag": 0,
  • "type": 0
}

Create schedule relation

Create schedule relation

path Parameters
ScheduleRelationId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
lag
integer or null <int32>
type
integer <int32> (Schedule.ScheduleRelationType)
Enum: 0 1 2 3

Responses

Request samples

Content type
{
  • "lag": 0,
  • "type": 0
}

Response samples

Content type
application/json
0
0

Delete schedule relation

Delete schedule relation

path Parameters
projectId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
scheduleRelationId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

ScheduleTemplate

Create schedule item template

Create schedule item template

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
type
integer <int32> (ScheduleItemType)
Enum: 0 1 2
name
string or null
order
integer <int32>
parentId
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "type": 0,
  • "name": "string",
  • "order": 0,
  • "parentId": "000000000000000000000000"
}

Response samples

Content type
application/json
{
  • "type": 0,
  • "id": "000000000000000000000000",
  • "wbs": "string",
  • "index": 0,
  • "name": "string",
  • "order": 0,
  • "allocation": 0.1,
  • "parentId": "000000000000000000000000",
  • "description": "string",
  • "ownerIds": [
    ],
  • "departmentIds": [
    ],
  • "predecessors": [
    ],
  • "successors": [
    ],
  • "budgetLines": [
    ],
  • "risks": [
    ],
  • "products": [
    ],
  • "attachments": [
    ],
  • "customColumnValues": [
    ]
}

Get all schedule item templates from project templ

Get all schedule item templates from project template

path Parameters
projectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "type": 0,
  • "id": "000000000000000000000000",
  • "wbs": "string",
  • "index": 0,
  • "name": "string",
  • "order": 0,
  • "allocation": 0.1,
  • "parentId": "000000000000000000000000",
  • "description": "string",
  • "ownerIds": [
    ],
  • "departmentIds": [
    ],
  • "predecessors": [
    ],
  • "successors": [
    ],
  • "budgetLines": [
    ],
  • "risks": [
    ],
  • "products": [
    ],
  • "attachments": [
    ],
  • "customColumnValues": [
    ]
}

Create schedule item template's clone

Create schedule item template's clone

path Parameters
projectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
itemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "type": 0,
  • "id": "000000000000000000000000",
  • "wbs": "string",
  • "index": 0,
  • "name": "string",
  • "order": 0,
  • "allocation": 0.1,
  • "parentId": "000000000000000000000000",
  • "description": "string",
  • "ownerIds": [
    ],
  • "departmentIds": [
    ],
  • "predecessors": [
    ],
  • "successors": [
    ],
  • "budgetLines": [
    ],
  • "risks": [
    ],
  • "products": [
    ],
  • "attachments": [
    ],
  • "customColumnValues": [
    ]
}

Create schedule item template's and its children's

Create schedule item template's and its children's clones

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "type": 0,
  • "id": "000000000000000000000000",
  • "wbs": "string",
  • "index": 0,
  • "name": "string",
  • "order": 0,
  • "allocation": 0.1,
  • "parentId": "000000000000000000000000",
  • "description": "string",
  • "ownerIds": [
    ],
  • "departmentIds": [
    ],
  • "predecessors": [
    ],
  • "successors": [
    ],
  • "budgetLines": [
    ],
  • "risks": [
    ],
  • "products": [
    ],
  • "attachments": [
    ],
  • "customColumnValues": [
    ]
}

Get a specific schedule item template from project

Get a specific schedule item template from project template by its unique id

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "type": 0,
  • "id": "000000000000000000000000",
  • "wbs": "string",
  • "index": 0,
  • "name": "string",
  • "order": 0,
  • "allocation": 0.1,
  • "parentId": "000000000000000000000000",
  • "description": "string",
  • "ownerIds": [
    ],
  • "departmentIds": [
    ],
  • "predecessors": [
    ],
  • "successors": [
    ],
  • "budgetLines": [
    ],
  • "risks": [
    ],
  • "products": [
    ],
  • "attachments": [
    ],
  • "customColumnValues": [
    ]
}

Delete schedule item template

Delete schedule item template

path Parameters
projectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
itemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Update schedule item template's name

Update schedule item template's name

path Parameters
projectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
itemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update schedule item template's description

Update schedule item template's description

path Parameters
projectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
itemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Update schedule item template's days

Update schedule item template's days

path Parameters
projectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
itemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
object (Templates.Schedule.ScheduleDays)

Responses

Request samples

Content type
{
  • "value": {
    }
}

Response samples

Content type
application/json
{
  • "end": 0,
  • "start": 0,
  • "duration": 0
}

Update schedule item template's end day

Update schedule item template's end day

path Parameters
projectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
itemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
integer or null <int32>

Responses

Request samples

Content type
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

Update schedule item template's start day

Update schedule item template's start day

path Parameters
projectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
itemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
integer <int32>

Responses

Request samples

Content type
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

Update schedule item template's position

Update schedule item template's position

path Parameters
projectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
itemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
order
integer <int32>
parentId
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "order": 0,
  • "parentId": "000000000000000000000000"
}

Response samples

Content type
application/json
{
  • "order": 0,
  • "parentId": "000000000000000000000000"
}

Adds owner to schedule item template

Adds owner to schedule item template

path Parameters
projectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
itemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Remove owner from schedule item template

Remove owner from schedule item template

path Parameters
projectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
itemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ownerId
required
string

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Adds department to schedule item template

Adds department to schedule item template

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string <24-digit hex string> (ObjectId)

Responses

Request samples

Content type
{
  • "value": "000000000000000000000000"
}

Response samples

Content type
application/json
"000000000000000000000000"

Remove department from schedule item template

Remove department from schedule item template

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
DepartmentId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Update schedule item template's allocation

Update schedule item template's allocation

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
number or null <double>

Responses

Request samples

Content type
{
  • "value": 0.1
}

Response samples

Content type
application/json
0.1

Update schedule item template's owner allocation

Update schedule item template's owner allocation

path Parameters
OwnerId
required
string
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
number <double>

Responses

Request samples

Content type
{
  • "value": 0.1
}

Response samples

Content type
application/json
{
  • "userId": "string",
  • "projectTemplateId": "000000000000000000000000",
  • "itemId": "000000000000000000000000",
  • "allocation": 0.1
}

Retrieve schedule item template's owner allocation

Retrieve schedule item template's owner allocation

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update schedule item template's department allocat

Update schedule item template's department allocation

path Parameters
DepartmentId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
number <double>

Responses

Request samples

Content type
{
  • "value": 0.1
}

Response samples

Content type
application/json
{
  • "departmentId": "000000000000000000000000",
  • "projectTemplateId": "000000000000000000000000",
  • "itemId": "000000000000000000000000",
  • "allocation": 0.1
}

Retrieve schedule item template's department alloc

Retrieve schedule item template's department allocation

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update schedule item template's custom column valu

Update schedule item template's custom column value

path Parameters
CustomColumnId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
application/json
null

Update schedule item template's type

Update schedule item template's type

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
integer <int32> (ScheduleItemType)
Enum: 0 1 2

Responses

Request samples

Content type
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

Update schedule item template's background color

Update schedule item template's background color

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

ScheduleTemplateRelation

Create relation between two schedule item template

Create relation between two schedule item templates

path Parameters
projectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
predecessorId
string <24-digit hex string> (ObjectId)
successorId
string <24-digit hex string> (ObjectId)
lag
integer or null <int32>
type
integer <int32> (Schedule.ScheduleRelationType)
Enum: 0 1 2 3

Responses

Request samples

Content type
{
  • "predecessorId": "000000000000000000000000",
  • "successorId": "000000000000000000000000",
  • "lag": 0,
  • "type": 0
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "predecessorId": "000000000000000000000000",
  • "successorId": "000000000000000000000000",
  • "lag": 0,
  • "type": 0
}

Update schedule template relation

Update schedule template relation

path Parameters
ProjectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
ItemTemplateRelationId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
lag
integer or null <int32>
type
integer <int32> (Schedule.ScheduleRelationType)
Enum: 0 1 2 3

Responses

Request samples

Content type
{
  • "lag": 0,
  • "type": 0
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "predecessorId": "000000000000000000000000",
  • "successorId": "000000000000000000000000",
  • "lag": 0,
  • "type": 0
}

Delete schedule template relation

Delete schedule template relation

path Parameters
projectTemplateId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
scheduleTemplateRelationId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Tenant

Get current tenant

Get current tenant

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "logoFileRepositoryItemId": "string",
  • "defaultLanguageCulture": "string",
  • "isMfaEnabled": true,
  • "id": "string",
  • "demoEndDate": "2019-08-24T14:15:22Z",
  • "budgetType": 0,
  • "currency": "string",
  • "budgetPrecision": 0,
  • "hasContract": true,
  • "isDemo": true,
  • "expirationDate": "2019-08-24T14:15:22Z"
}

User

Authenticates the user and returns an access token

Authenticates the user and returns an access token, refresh token, token metadata, and user-related information. If multi-factor authentication (MFA) is required, the response includes indicators such as MfaRequired and MfaSessionId, allowing the client to initiate the MFA verification process

Request Body schema:
clientId
string or null
clientSecret
string or null
grantType
string or null
username
string or null
password
string or null
refreshToken
string or null

Responses

Request samples

Content type
{
  • "clientId": "string",
  • "clientSecret": "string",
  • "grantType": "string",
  • "username": "string",
  • "password": "string",
  • "refreshToken": "string"
}

Response samples

Content type
{
  • "accessToken": "string",
  • "refreshToken": "string",
  • "tokenType": "string",
  • "selectedTenantId": "string",
  • "expires": 0,
  • "mfaRequired": true,
  • "mfaSessionId": "fbd3bea3-c0b0-4db3-9800-5933063c09b0",
  • "email": "string"
}

Verifies the user's MFA code and, if the code is v

Verifies the user's MFA code and, if the code is valid, completes the authentication process by returning an access token, refresh token, and additional authentication metadata

Request Body schema:
mfaSessionId
string <uuid>
code
string or null

Responses

Request samples

Content type
{
  • "mfaSessionId": "fbd3bea3-c0b0-4db3-9800-5933063c09b0",
  • "code": "string"
}

Response samples

Content type
{
  • "accessToken": "string",
  • "refreshToken": "string",
  • "tokenType": "string",
  • "selectedTenantId": "string",
  • "expires": 0,
  • "mfaRequired": true,
  • "mfaSessionId": "fbd3bea3-c0b0-4db3-9800-5933063c09b0",
  • "email": "string"
}

UserGroup

Get all user groups

Get all user groups

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create user group

Create user group

Request Body schema:
name
string or null
description
string or null
userIds
Array of strings or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "userIds": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "id": "000000000000000000000000",
  • "avatarFileRepositoryItemId": "string",
  • "permissions": {
    },
  • "userIds": [
    ]
}

Update user group

Update user group

Request Body schema:
name
string or null
description
string or null
id
string <24-digit hex string> (ObjectId)
avatarFileRepositoryItemId
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "id": "000000000000000000000000",
  • "avatarFileRepositoryItemId": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "id": "000000000000000000000000",
  • "avatarFileRepositoryItemId": "string",
  • "permissions": {
    },
  • "userIds": [
    ]
}

Get a user group by its unique id

Get a user group by its unique id

path Parameters
id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "id": "000000000000000000000000",
  • "avatarFileRepositoryItemId": "string",
  • "permissions": {
    },
  • "userIds": [
    ]
}

Delete user group

Delete user group

path Parameters
id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "id": "000000000000000000000000",
  • "avatarFileRepositoryItemId": "string",
  • "permissions": {
    },
  • "userIds": [
    ]
}

Get avatar of user group

Get avatar of user group

path Parameters
id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
"string"

Update user group's permissions

Update user group's permissions

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
Project
integer <int32> (Permissions.PermissionMode)
Enum: 0 1 2 3
Portfolio
integer <int32> (Permissions.PermissionMode)
Enum: 0 1 2 3
Review
integer <int32> (Permissions.PermissionMode)
Enum: 0 1 2 3
ScoringTemplate
integer <int32> (Permissions.PermissionMode)
Enum: 0 1 2 3
AcceptancePathTemplate
integer <int32> (Permissions.PermissionMode)
Enum: 0 1 2 3
Resource
integer <int32> (Permissions.PermissionMode)
Enum: 0 1 2 3
Query
integer <int32> (Permissions.PermissionMode)
Enum: 0 1 2 3
Strategy
integer <int32> (Permissions.PermissionMode)
Enum: 0 1 2 3
ProjectCharter
integer <int32> (Permissions.PermissionMode)
Enum: 0 1 2 3
WorkTime
integer <int32> (Permissions.PermissionMode)
Enum: 0 1 2 3
ProjectsProgram
integer <int32> (Permissions.PermissionMode)
Enum: 0 1 2 3
Administration
integer <int32> (Permissions.PermissionMode)
Enum: 0 1 2 3
BasicInfo
integer <int32> (Permissions.PermissionMode)
Enum: 0 1 2 3
PortfolioBasicInfo
integer <int32> (Permissions.PermissionMode)
Enum: 0 1 2 3
ProjectsProgramBasicInfo
integer <int32> (Permissions.PermissionMode)
Enum: 0 1 2 3

Responses

Request samples

Content type
{
  • "Project": 0,
  • "Portfolio": 0,
  • "Review": 0,
  • "ScoringTemplate": 0,
  • "AcceptancePathTemplate": 0,
  • "Resource": 0,
  • "Query": 0,
  • "Strategy": 0,
  • "ProjectCharter": 0,
  • "WorkTime": 0,
  • "ProjectsProgram": 0,
  • "Administration": 0,
  • "BasicInfo": 0,
  • "PortfolioBasicInfo": 0,
  • "ProjectsProgramBasicInfo": 0
}

Response samples

Content type
application/json
{
  • "property1": 0,
  • "property2": 0
}

Update user group's members

Update user group's members

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
application/json
[
  • "string"
]

UserManagement

Get a list of organization users

Get a list of organization users

query Parameters
object (BusinessLogic.UserManagement.Commands.Read.All.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a specific user by its unique id

Get a specific user by its unique id

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "userName": "string",
  • "fullName": "string",
  • "email": "user@example.com",
  • "avatarFileRepositoryItemId": "string",
  • "languageCulture": "string",
  • "selectedTenantId": "string",
  • "domainName": "string",
  • "webClientTheme": "string",
  • "webClientColor": "string",
  • "webClientScale": 0,
  • "lastLoginDate": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "isConfirmed": true,
  • "isAdmin": true,
  • "licenseType": 0,
  • "userGroupIds": [
    ],
  • "externalId": "string",
  • "managerId": "string",
  • "departmentId": "000000000000000000000000",
  • "status": 0,
  • "lastVisitedVersion": "string",
  • "isMfaEnabled": true,
  • "isMfaRequired": true,
  • "workspaceIds": [
    ]
}

Delete organization user

Delete organization user

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Get logged user

Get logged user

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "userName": "string",
  • "fullName": "string",
  • "email": "user@example.com",
  • "avatarFileRepositoryItemId": "string",
  • "languageCulture": "string",
  • "selectedTenantId": "string",
  • "domainName": "string",
  • "webClientTheme": "string",
  • "webClientColor": "string",
  • "webClientScale": 0,
  • "lastLoginDate": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "isConfirmed": true,
  • "isAdmin": true,
  • "licenseType": 0,
  • "userGroupIds": [
    ],
  • "externalId": "string",
  • "managerId": "string",
  • "departmentId": "000000000000000000000000",
  • "status": 0,
  • "lastVisitedVersion": "string",
  • "isMfaEnabled": true,
  • "isMfaRequired": true,
  • "workspaceIds": [
    ]
}

Get user's avatar

Get user's avatar

path Parameters
id
required
string

Responses

Response samples

Content type
"string"

Update the group membership of a specified user

Update the group membership of a specified user

path Parameters
id
required
string
Request Body schema:
value
Array of strings or null <24-digit hex string> (ObjectId) [ items <24-digit hex string > ]

Responses

Request samples

Content type
{
  • "value": [
    ]
}

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Create organization user

Create organization user

Request Body schema:
email
string or null
shouldSendInvitationEmail
boolean

Responses

Request samples

Content type
{
  • "email": "string",
  • "shouldSendInvitationEmail": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "userName": "string",
  • "fullName": "string",
  • "email": "user@example.com",
  • "avatarFileRepositoryItemId": "string",
  • "languageCulture": "string",
  • "selectedTenantId": "string",
  • "domainName": "string",
  • "webClientTheme": "string",
  • "webClientColor": "string",
  • "webClientScale": 0,
  • "lastLoginDate": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "isConfirmed": true,
  • "isAdmin": true,
  • "licenseType": 0,
  • "userGroupIds": [
    ],
  • "externalId": "string",
  • "managerId": "string",
  • "departmentId": "000000000000000000000000",
  • "status": 0,
  • "lastVisitedVersion": "string",
  • "isMfaEnabled": true,
  • "isMfaRequired": true,
  • "workspaceIds": [
    ]
}

Update organization user's IsAdmin status

Update organization user's IsAdmin status

path Parameters
Id
required
string
Request Body schema:
value
boolean

Responses

Request samples

Content type
{
  • "value": true
}

Response samples

Content type
application/json
true

Update organization user's license type

Update organization user's license type

path Parameters
Id
required
string
Request Body schema:
value
integer <int32> (Users.LicenseType)
Enum: 0 10 100

Responses

Request samples

Content type
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

Update organization user's manager

Update organization user's manager

path Parameters
Id
required
string
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Get organization user's global permissions

Get organization user's global permissions

path Parameters
id
required
string
query Parameters
Id
string

Responses

Response samples

Content type
application/json
{
  • "property1": 0,
  • "property2": 0
}

Update organization user's workspaces

Update organization user's workspaces

path Parameters
UserId
required
string
Request Body schema:
workspaceIds
Array of strings or null <24-digit hex string> (ObjectId) [ items <24-digit hex string > ]

Responses

Request samples

Content type
{
  • "workspaceIds": [
    ]
}

Response samples

Content type
application/json
[
  • "000000000000000000000000"
]

UserTasks

Create user task

Create user task

Request Body schema:
name
string or null

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "progress": 0,
  • "creatorId": "string",
  • "attachments": [
    ],
  • "comments": [
    ],
  • "createDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "dates": {
    },
  • "ownerIds": [
    ],
  • "watcherIds": [
    ],
  • "status": 0,
  • "recurrence": {
    },
  • "workTime": 0
}

Get a specific user task by its unique id

Get a specific user task by its unique id

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "progress": 0,
  • "creatorId": "string",
  • "attachments": [
    ],
  • "comments": [
    ],
  • "createDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "dates": {
    },
  • "ownerIds": [
    ],
  • "watcherIds": [
    ],
  • "status": 0,
  • "recurrence": {
    },
  • "workTime": 0
}

Delete user task

Delete user task

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Update user task's description

Update user task's description

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "progress": 0,
  • "creatorId": "string",
  • "attachments": [
    ],
  • "comments": [
    ],
  • "createDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "dates": {
    },
  • "ownerIds": [
    ],
  • "watcherIds": [
    ],
  • "status": 0,
  • "recurrence": {
    },
  • "workTime": 0
}

Update user task's name

Update user task's name

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "progress": 0,
  • "creatorId": "string",
  • "attachments": [
    ],
  • "comments": [
    ],
  • "createDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "dates": {
    },
  • "ownerIds": [
    ],
  • "watcherIds": [
    ],
  • "status": 0,
  • "recurrence": {
    },
  • "workTime": 0
}

Update user task's dates

Update user task's dates

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
object (Schedule.ScheduleDates)

Responses

Request samples

Content type
{
  • "value": { }
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "progress": 0,
  • "creatorId": "string",
  • "attachments": [
    ],
  • "comments": [
    ],
  • "createDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "dates": {
    },
  • "ownerIds": [
    ],
  • "watcherIds": [
    ],
  • "status": 0,
  • "recurrence": {
    },
  • "workTime": 0
}

Create clone of user task

Create clone of user task

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "progress": 0,
  • "creatorId": "string",
  • "attachments": [
    ],
  • "comments": [
    ],
  • "createDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "dates": {
    },
  • "ownerIds": [
    ],
  • "watcherIds": [
    ],
  • "status": 0,
  • "recurrence": {
    },
  • "workTime": 0
}

Update user task's progress

Update user task's progress

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
integer <int32>

Responses

Request samples

Content type
{
  • "value": 0
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "progress": 0,
  • "creatorId": "string",
  • "attachments": [
    ],
  • "comments": [
    ],
  • "createDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "dates": {
    },
  • "ownerIds": [
    ],
  • "watcherIds": [
    ],
  • "status": 0,
  • "recurrence": {
    },
  • "workTime": 0
}

Update user task's recurrence

Update user task's recurrence

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
object (UserTasks.Recurrence)

Responses

Request samples

Content type
{
  • "recurrence": {
    }
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "description": "string",
  • "progress": 0,
  • "creatorId": "string",
  • "attachments": [
    ],
  • "comments": [
    ],
  • "createDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "dates": {
    },
  • "ownerIds": [
    ],
  • "watcherIds": [
    ],
  • "status": 0,
  • "recurrence": {
    },
  • "workTime": 0
}

Adds user task's owner

Adds user task's owner

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
"string"

Remove user task's owner

Remove user task's owner

path Parameters
OwnerId
required
string
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Get work time registered at user task

Get work time registered at user task

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds work time to user task

Adds work time to user task

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
date
string <date-time>
minutes
integer <int32>
comment
string or null

Responses

Request samples

Content type
{
  • "date": "2019-08-24T14:15:22Z",
  • "minutes": 0,
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "projectId": "000000000000000000000000",
  • "itemId": "000000000000000000000000",
  • "date": "2019-08-24T14:15:22Z",
  • "minutes": 0,
  • "userId": "string",
  • "project": {
    },
  • "task": {
    },
  • "comment": "string"
}

Delete work time from user task

Delete work time from user task

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
WorkItemId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

WorkItems

Get work items for specified user

Get work items for specified user

path Parameters
UserId
required
string
query Parameters
FromDate
string <date-time>
ToDate
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete wor item

Delete wor item

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}

Update work item

Update work item

path Parameters
Id
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
date
string <date-time>
minutes
integer <int32>
comment
string or null

Responses

Request samples

Content type
{
  • "date": "2019-08-24T14:15:22Z",
  • "minutes": 0,
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "projectId": "000000000000000000000000",
  • "itemId": "000000000000000000000000",
  • "date": "2019-08-24T14:15:22Z",
  • "minutes": 0,
  • "userId": "string",
  • "project": {
    },
  • "task": {
    },
  • "comment": "string"
}

Workspace

Get all workspaces in organization

Get all workspaces in organization

query Parameters
object (Organization.BusinessLogic.Workspaces.Commands.Read.All.Request)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create workspace

Create workspace

Request Body schema:
name
string or null
color
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "color": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "color": "string"
}

Update workspace

Update workspace

path Parameters
WorkspaceId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
Request Body schema:
name
string or null
color
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "color": "string"
}

Response samples

Content type
application/json
{
  • "id": "000000000000000000000000",
  • "name": "string",
  • "color": "string"
}

Delete workspace

Delete workspace

path Parameters
WorkspaceId
required
string <24-digit hex string> (ObjectId)
Example: 000000000000000000000000
query Parameters
ReplacementWorkspaceId
string <24-digit hex string> (ObjectId)
Example: ReplacementWorkspaceId=000000000000000000000000

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "errorCode": "string",
  • "errorArguments": [
    ]
}