API docs by Redocly

standard public schema (12.2.12 (cd3cf9e))

Download OpenAPI specification:

PostgREST Documentation

Introspection

OpenAPI description (this document)

Responses

folderAssigneeTemplates

/folderAssigneeTemplates

query Parameters
folderTemplateId
string
userId
string
assigneeRoleId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/folderAssigneeTemplates

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

folderAssigneeTemplates

folderTemplateId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folderTemplates.id.

userId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to users.id.

assigneeRoleId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to assigneeRoles.id.

Responses

Request samples

Content type
{
  • "folderTemplateId": "fb81db22-0ba6-434c-a2b3-03ddd69524c1",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "assigneeRoleId": "0e6ac67b-c717-49f7-bfc0-373174d8464f"
}

/folderAssigneeTemplates

query Parameters
folderTemplateId
string
userId
string
assigneeRoleId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/folderAssigneeTemplates

query Parameters
folderTemplateId
string
userId
string
assigneeRoleId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

folderAssigneeTemplates

folderTemplateId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folderTemplates.id.

userId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to users.id.

assigneeRoleId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to assigneeRoles.id.

Responses

Request samples

Content type
{
  • "folderTemplateId": "fb81db22-0ba6-434c-a2b3-03ddd69524c1",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "assigneeRoleId": "0e6ac67b-c717-49f7-bfc0-373174d8464f"
}

payouts

/payouts

query Parameters
id
string
name
string
amount
string
paymentStatusId
string
note
string
startDate
string
endDate
string
userId
string
paymentReference
string
paymentDate
string
createdDate
string
updatedDate
string
authorId
string
referenceId
string
taxAmount
string
taxPercentage
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/payouts

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

payouts

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
amount
required
number <numeric>
paymentStatusId
required
string <uuid>

Note: This is a Foreign Key to paymentStatuses.id.

note
string <text>
startDate
required
string <timestamp with time zone>
endDate
required
string <timestamp with time zone>
userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

paymentReference
string <text>
paymentDate
string <timestamp with time zone>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
authorId
required
string <uuid>

Note: This is a Foreign Key to users.id.

referenceId
string <text>
taxAmount
required
number <numeric>
Default: 0
taxPercentage
required
number <numeric>
Default: 0

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "amount": 0,
  • "paymentStatusId": "38c13933-adca-4bac-9697-e1c6c8d5596d",
  • "note": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "paymentReference": "string",
  • "paymentDate": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  • "referenceId": "string",
  • "taxAmount": 0,
  • "taxPercentage": 0
}

/payouts

query Parameters
id
string
name
string
amount
string
paymentStatusId
string
note
string
startDate
string
endDate
string
userId
string
paymentReference
string
paymentDate
string
createdDate
string
updatedDate
string
authorId
string
referenceId
string
taxAmount
string
taxPercentage
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/payouts

query Parameters
id
string
name
string
amount
string
paymentStatusId
string
note
string
startDate
string
endDate
string
userId
string
paymentReference
string
paymentDate
string
createdDate
string
updatedDate
string
authorId
string
referenceId
string
taxAmount
string
taxPercentage
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

payouts

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
amount
required
number <numeric>
paymentStatusId
required
string <uuid>

Note: This is a Foreign Key to paymentStatuses.id.

note
string <text>
startDate
required
string <timestamp with time zone>
endDate
required
string <timestamp with time zone>
userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

paymentReference
string <text>
paymentDate
string <timestamp with time zone>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
authorId
required
string <uuid>

Note: This is a Foreign Key to users.id.

referenceId
string <text>
taxAmount
required
number <numeric>
Default: 0
taxPercentage
required
number <numeric>
Default: 0

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "amount": 0,
  • "paymentStatusId": "38c13933-adca-4bac-9697-e1c6c8d5596d",
  • "note": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "paymentReference": "string",
  • "paymentDate": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  • "referenceId": "string",
  • "taxAmount": 0,
  • "taxPercentage": 0
}

outputActionTemplates

/outputActionTemplates

query Parameters
outputTemplateId
string
actionId
string
statusIds
string
order
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/outputActionTemplates

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

outputActionTemplates

outputTemplateId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to outputTemplates.id.

actionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to actions.id.

statusIds
required
Array of strings
order
required
integer <integer>

Responses

Request samples

Content type
{
  • "outputTemplateId": "f14fd8ed-53d4-4582-b141-ef3b56c5117e",
  • "actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0",
  • "statusIds": [
    ],
  • "order": 0
}

/outputActionTemplates

query Parameters
outputTemplateId
string
actionId
string
statusIds
string
order
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outputActionTemplates

query Parameters
outputTemplateId
string
actionId
string
statusIds
string
order
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

outputActionTemplates

outputTemplateId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to outputTemplates.id.

actionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to actions.id.

statusIds
required
Array of strings
order
required
integer <integer>

Responses

Request samples

Content type
{
  • "outputTemplateId": "f14fd8ed-53d4-4582-b141-ef3b56c5117e",
  • "actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0",
  • "statusIds": [
    ],
  • "order": 0
}

jobInstances

/jobInstances

query Parameters
id
string
authorId
string
createdDate
string
updatedDate
string
finishedAt
string
contextId
string
contextType
string
status
string
result
string
messageData
string
traceback
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/jobInstances

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

jobInstances

id
required
string <uuid>

Note: This is a Primary Key.

authorId
required
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
finishedAt
string <timestamp with time zone>
contextId
string <uuid>
contextType
string <text>
status
string <text>
result
string <text>
messageData
any <jsonb>
traceback
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "finishedAt": "string",
  • "contextId": "84451116-c600-49e2-9c60-5b6b34fae0d6",
  • "contextType": "string",
  • "status": "string",
  • "result": "string",
  • "messageData": null,
  • "traceback": "string"
}

/jobInstances

query Parameters
id
string
authorId
string
createdDate
string
updatedDate
string
finishedAt
string
contextId
string
contextType
string
status
string
result
string
messageData
string
traceback
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/jobInstances

query Parameters
id
string
authorId
string
createdDate
string
updatedDate
string
finishedAt
string
contextId
string
contextType
string
status
string
result
string
messageData
string
traceback
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

jobInstances

id
required
string <uuid>

Note: This is a Primary Key.

authorId
required
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
finishedAt
string <timestamp with time zone>
contextId
string <uuid>
contextType
string <text>
status
string <text>
result
string <text>
messageData
any <jsonb>
traceback
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "finishedAt": "string",
  • "contextId": "84451116-c600-49e2-9c60-5b6b34fae0d6",
  • "contextType": "string",
  • "status": "string",
  • "result": "string",
  • "messageData": null,
  • "traceback": "string"
}

typeOutputTypes

/typeOutputTypes

query Parameters
outputTypeId
string
typeId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/typeOutputTypes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

typeOutputTypes

outputTypeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to outputTypes.id.

typeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to types.id.

Responses

Request samples

Content type
{
  • "outputTypeId": "eb4139aa-02ad-4d37-a296-30a4458db90e",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7"
}

/typeOutputTypes

query Parameters
outputTypeId
string
typeId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/typeOutputTypes

query Parameters
outputTypeId
string
typeId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

typeOutputTypes

outputTypeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to outputTypes.id.

typeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to types.id.

Responses

Request samples

Content type
{
  • "outputTypeId": "eb4139aa-02ad-4d37-a296-30a4458db90e",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7"
}

folder_paths

/folder_paths

query Parameters
folderId
string
folderPath
string
folderPathIds
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

users

/users

query Parameters
id
string
email
string
fullName
string
userName
string
emailConfirmedAt
string
rawAppMetaData
string
rawUserMetaData
string
createdAt
string
updatedAt
string
emailVerified
string
userVerified
string
securityRoleId
string
contractEnd
string
contractStart
string
hourlyRate
string
lunchEnd
string
lunchStart
string
workEndTime
string
workStartTime
string
phone
string
color
string
agreementType
string
businessName
string
businessNumber
string
country
string
employeeType
string
firstAddressLine
string
iban
string
identityNumber
string
ndaType
string
reference
string
secondAddressLine
string
bic
string
isAnonymous
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/users

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

users

id
required
string <uuid>

Note: This is a Primary Key.

email
required
string <text>
fullName
required
string <text>
userName
required
string <text>
emailConfirmedAt
string <timestamp with time zone>
rawAppMetaData
required
any <jsonb>
rawUserMetaData
required
any <jsonb>
createdAt
required
string <timestamp with time zone>
updatedAt
required
string <timestamp with time zone>
emailVerified
required
boolean <boolean>
Default: false
userVerified
required
boolean <boolean>
Default: false
securityRoleId
required
string <uuid>

Note: This is a Foreign Key to securityRoles.id.

contractEnd
string <timestamp with time zone>
contractStart
string <timestamp with time zone>
hourlyRate
number <numeric>
lunchEnd
string <interval>
lunchStart
string <interval>
workEndTime
string <interval>
workStartTime
string <interval>
phone
required
string <text>
Default: ""
color
string <text>
agreementType
integer <integer>
businessName
string <text>
businessNumber
string <text>
country
string <text>
employeeType
integer <integer>
firstAddressLine
string <text>
iban
string <text>
identityNumber
string <text>
ndaType
integer <integer>
reference
string <text>
secondAddressLine
string <text>
bic
string <text>
isAnonymous
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "string",
  • "fullName": "string",
  • "userName": "string",
  • "emailConfirmedAt": "string",
  • "rawAppMetaData": null,
  • "rawUserMetaData": null,
  • "createdAt": "string",
  • "updatedAt": "string",
  • "emailVerified": false,
  • "userVerified": false,
  • "securityRoleId": "098794d7-7cce-42c5-8c3e-45c3d491f4fc",
  • "contractEnd": "string",
  • "contractStart": "string",
  • "hourlyRate": 0,
  • "lunchEnd": "string",
  • "lunchStart": "string",
  • "workEndTime": "string",
  • "workStartTime": "string",
  • "phone": "",
  • "color": "string",
  • "agreementType": 0,
  • "businessName": "string",
  • "businessNumber": "string",
  • "country": "string",
  • "employeeType": 0,
  • "firstAddressLine": "string",
  • "iban": "string",
  • "identityNumber": "string",
  • "ndaType": 0,
  • "reference": "string",
  • "secondAddressLine": "string",
  • "bic": "string",
  • "isAnonymous": false
}

/users

query Parameters
id
string
email
string
fullName
string
userName
string
emailConfirmedAt
string
rawAppMetaData
string
rawUserMetaData
string
createdAt
string
updatedAt
string
emailVerified
string
userVerified
string
securityRoleId
string
contractEnd
string
contractStart
string
hourlyRate
string
lunchEnd
string
lunchStart
string
workEndTime
string
workStartTime
string
phone
string
color
string
agreementType
string
businessName
string
businessNumber
string
country
string
employeeType
string
firstAddressLine
string
iban
string
identityNumber
string
ndaType
string
reference
string
secondAddressLine
string
bic
string
isAnonymous
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/users

query Parameters
id
string
email
string
fullName
string
userName
string
emailConfirmedAt
string
rawAppMetaData
string
rawUserMetaData
string
createdAt
string
updatedAt
string
emailVerified
string
userVerified
string
securityRoleId
string
contractEnd
string
contractStart
string
hourlyRate
string
lunchEnd
string
lunchStart
string
workEndTime
string
workStartTime
string
phone
string
color
string
agreementType
string
businessName
string
businessNumber
string
country
string
employeeType
string
firstAddressLine
string
iban
string
identityNumber
string
ndaType
string
reference
string
secondAddressLine
string
bic
string
isAnonymous
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

users

id
required
string <uuid>

Note: This is a Primary Key.

email
required
string <text>
fullName
required
string <text>
userName
required
string <text>
emailConfirmedAt
string <timestamp with time zone>
rawAppMetaData
required
any <jsonb>
rawUserMetaData
required
any <jsonb>
createdAt
required
string <timestamp with time zone>
updatedAt
required
string <timestamp with time zone>
emailVerified
required
boolean <boolean>
Default: false
userVerified
required
boolean <boolean>
Default: false
securityRoleId
required
string <uuid>

Note: This is a Foreign Key to securityRoles.id.

contractEnd
string <timestamp with time zone>
contractStart
string <timestamp with time zone>
hourlyRate
number <numeric>
lunchEnd
string <interval>
lunchStart
string <interval>
workEndTime
string <interval>
workStartTime
string <interval>
phone
required
string <text>
Default: ""
color
string <text>
agreementType
integer <integer>
businessName
string <text>
businessNumber
string <text>
country
string <text>
employeeType
integer <integer>
firstAddressLine
string <text>
iban
string <text>
identityNumber
string <text>
ndaType
integer <integer>
reference
string <text>
secondAddressLine
string <text>
bic
string <text>
isAnonymous
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "string",
  • "fullName": "string",
  • "userName": "string",
  • "emailConfirmedAt": "string",
  • "rawAppMetaData": null,
  • "rawUserMetaData": null,
  • "createdAt": "string",
  • "updatedAt": "string",
  • "emailVerified": false,
  • "userVerified": false,
  • "securityRoleId": "098794d7-7cce-42c5-8c3e-45c3d491f4fc",
  • "contractEnd": "string",
  • "contractStart": "string",
  • "hourlyRate": 0,
  • "lunchEnd": "string",
  • "lunchStart": "string",
  • "workEndTime": "string",
  • "workStartTime": "string",
  • "phone": "",
  • "color": "string",
  • "agreementType": 0,
  • "businessName": "string",
  • "businessNumber": "string",
  • "country": "string",
  • "employeeType": 0,
  • "firstAddressLine": "string",
  • "iban": "string",
  • "identityNumber": "string",
  • "ndaType": 0,
  • "reference": "string",
  • "secondAddressLine": "string",
  • "bic": "string",
  • "isAnonymous": false
}

userTimeTrackers

/userTimeTrackers

query Parameters
id
string
folderId
string
description
string
startTime
string
endTime
string
isLive
string
userId
string
iterationId
string
userHourlyRate
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/userTimeTrackers

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

userTimeTrackers

id
required
string <uuid>

Note: This is a Primary Key.

folderId
required
string <uuid>

Note: This is a Foreign Key to folders.id.

description
string <text>
startTime
required
string <timestamp with time zone>
endTime
string <timestamp with time zone>
isLive
required
boolean <boolean>
userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

iterationId
string <uuid>

Note: This is a Foreign Key to iterations.id.

userHourlyRate
required
number <numeric>
Default: 0

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "description": "string",
  • "startTime": "string",
  • "endTime": "string",
  • "isLive": true,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "iterationId": "cef32958-0d52-40a5-b2b1-fbde92c0c066",
  • "userHourlyRate": 0
}

/userTimeTrackers

query Parameters
id
string
folderId
string
description
string
startTime
string
endTime
string
isLive
string
userId
string
iterationId
string
userHourlyRate
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/userTimeTrackers

query Parameters
id
string
folderId
string
description
string
startTime
string
endTime
string
isLive
string
userId
string
iterationId
string
userHourlyRate
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

userTimeTrackers

id
required
string <uuid>

Note: This is a Primary Key.

folderId
required
string <uuid>

Note: This is a Foreign Key to folders.id.

description
string <text>
startTime
required
string <timestamp with time zone>
endTime
string <timestamp with time zone>
isLive
required
boolean <boolean>
userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

iterationId
string <uuid>

Note: This is a Foreign Key to iterations.id.

userHourlyRate
required
number <numeric>
Default: 0

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "description": "string",
  • "startTime": "string",
  • "endTime": "string",
  • "isLive": true,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "iterationId": "cef32958-0d52-40a5-b2b1-fbde92c0c066",
  • "userHourlyRate": 0
}

integrationApplicationUsers

/integrationApplicationUsers

query Parameters
integrationApplicationId
string
userId
string
value
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/integrationApplicationUsers

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

integrationApplicationUsers

integrationApplicationId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to integrationApplications.id.

userId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to users.id.

value
required
string <text>

Responses

Request samples

Content type
{
  • "integrationApplicationId": "a12309a4-49ca-4426-bc07-7663bf57947a",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "value": "string"
}

/integrationApplicationUsers

query Parameters
integrationApplicationId
string
userId
string
value
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/integrationApplicationUsers

query Parameters
integrationApplicationId
string
userId
string
value
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

integrationApplicationUsers

integrationApplicationId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to integrationApplications.id.

userId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to users.id.

value
required
string <text>

Responses

Request samples

Content type
{
  • "integrationApplicationId": "a12309a4-49ca-4426-bc07-7663bf57947a",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "value": "string"
}

attachments

/attachments

query Parameters
id
string
fileName
string
contextType
string
contextId
string
authorId
string
createdDate
string
updatedDate
string
mimeType
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/attachments

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

attachments

id
required
string <uuid>

Note: This is a Primary Key.

fileName
required
string <character varying> <= 1024 characters
contextType
required
string <character varying> <= 128 characters
contextId
string <uuid>
authorId
required
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
mimeType
string <character varying> <= 128 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fileName": "string",
  • "contextType": "string",
  • "contextId": "84451116-c600-49e2-9c60-5b6b34fae0d6",
  • "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "mimeType": "string"
}

/attachments

query Parameters
id
string
fileName
string
contextType
string
contextId
string
authorId
string
createdDate
string
updatedDate
string
mimeType
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/attachments

query Parameters
id
string
fileName
string
contextType
string
contextId
string
authorId
string
createdDate
string
updatedDate
string
mimeType
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

attachments

id
required
string <uuid>

Note: This is a Primary Key.

fileName
required
string <character varying> <= 1024 characters
contextType
required
string <character varying> <= 128 characters
contextId
string <uuid>
authorId
required
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
mimeType
string <character varying> <= 128 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fileName": "string",
  • "contextType": "string",
  • "contextId": "84451116-c600-49e2-9c60-5b6b34fae0d6",
  • "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "mimeType": "string"
}

outgoingStatusMappings

/outgoingStatusMappings

query Parameters
id
string
outgoingFolderNewStatusId
string
outputVersionStatusId
string
projectDefinitionId
string
useOtherIncomingFolderStatuses
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/outgoingStatusMappings

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

outgoingStatusMappings

id
required
string <uuid>

Note: This is a Primary Key.

outgoingFolderNewStatusId
required
string <uuid>

Note: This is a Foreign Key to statuses.id.

outputVersionStatusId
required
string <uuid>

Note: This is a Foreign Key to statuses.id.

projectDefinitionId
required
string <uuid>

Note: This is a Foreign Key to projectDefinitions.id.

useOtherIncomingFolderStatuses
required
boolean <boolean>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "outgoingFolderNewStatusId": "65d59b4b-dbc0-48c4-b8bf-0d4e5a1a7067",
  • "outputVersionStatusId": "3bf597bb-305d-42e2-9fa8-6c94577e6ee1",
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "useOtherIncomingFolderStatuses": true
}

/outgoingStatusMappings

query Parameters
id
string
outgoingFolderNewStatusId
string
outputVersionStatusId
string
projectDefinitionId
string
useOtherIncomingFolderStatuses
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outgoingStatusMappings

query Parameters
id
string
outgoingFolderNewStatusId
string
outputVersionStatusId
string
projectDefinitionId
string
useOtherIncomingFolderStatuses
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

outgoingStatusMappings

id
required
string <uuid>

Note: This is a Primary Key.

outgoingFolderNewStatusId
required
string <uuid>

Note: This is a Foreign Key to statuses.id.

outputVersionStatusId
required
string <uuid>

Note: This is a Foreign Key to statuses.id.

projectDefinitionId
required
string <uuid>

Note: This is a Foreign Key to projectDefinitions.id.

useOtherIncomingFolderStatuses
required
boolean <boolean>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "outgoingFolderNewStatusId": "65d59b4b-dbc0-48c4-b8bf-0d4e5a1a7067",
  • "outputVersionStatusId": "3bf597bb-305d-42e2-9fa8-6c94577e6ee1",
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "useOtherIncomingFolderStatuses": true
}

payoutAttachments

/payoutAttachments

query Parameters
payoutId
string
attachmentId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/payoutAttachments

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

payoutAttachments

payoutId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to payouts.id.

attachmentId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to attachments.id.

Responses

Request samples

Content type
{
  • "payoutId": "c3d65312-6575-43de-b8ae-728d8d0a9371",
  • "attachmentId": "96b9bbac-86d3-4497-9e0c-1f8e3803eddb"
}

/payoutAttachments

query Parameters
payoutId
string
attachmentId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/payoutAttachments

query Parameters
payoutId
string
attachmentId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

payoutAttachments

payoutId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to payouts.id.

attachmentId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to attachments.id.

Responses

Request samples

Content type
{
  • "payoutId": "c3d65312-6575-43de-b8ae-728d8d0a9371",
  • "attachmentId": "96b9bbac-86d3-4497-9e0c-1f8e3803eddb"
}

playlistComponents

/playlistComponents

query Parameters
playlistId
string
componentId
string
order
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/playlistComponents

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

playlistComponents

playlistId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to playlists.id.

componentId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to components.id.

order
required
integer <integer>

Responses

Request samples

Content type
{
  • "playlistId": "51706b6b-25fe-486c-9055-84628f3b0cf0",
  • "componentId": "616ccd92-d666-4180-8349-8d125b269fac",
  • "order": 0
}

/playlistComponents

query Parameters
playlistId
string
componentId
string
order
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/playlistComponents

query Parameters
playlistId
string
componentId
string
order
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

playlistComponents

playlistId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to playlists.id.

componentId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to components.id.

order
required
integer <integer>

Responses

Request samples

Content type
{
  • "playlistId": "51706b6b-25fe-486c-9055-84628f3b0cf0",
  • "componentId": "616ccd92-d666-4180-8349-8d125b269fac",
  • "order": 0
}

statusMappings

/statusMappings

query Parameters
id
string
folderNewStatusId
string
outputVersionStatusId
string
projectDefinitionId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/statusMappings

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

statusMappings

id
required
string <uuid>

Note: This is a Primary Key.

folderNewStatusId
required
string <uuid>

Note: This is a Foreign Key to statuses.id.

outputVersionStatusId
required
string <uuid>

Note: This is a Foreign Key to statuses.id.

projectDefinitionId
required
string <uuid>

Note: This is a Foreign Key to projectDefinitions.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folderNewStatusId": "5fde0762-a5af-4816-af4d-72e8204e551b",
  • "outputVersionStatusId": "3bf597bb-305d-42e2-9fa8-6c94577e6ee1",
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3"
}

/statusMappings

query Parameters
id
string
folderNewStatusId
string
outputVersionStatusId
string
projectDefinitionId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/statusMappings

query Parameters
id
string
folderNewStatusId
string
outputVersionStatusId
string
projectDefinitionId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

statusMappings

id
required
string <uuid>

Note: This is a Primary Key.

folderNewStatusId
required
string <uuid>

Note: This is a Foreign Key to statuses.id.

outputVersionStatusId
required
string <uuid>

Note: This is a Foreign Key to statuses.id.

projectDefinitionId
required
string <uuid>

Note: This is a Foreign Key to projectDefinitions.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folderNewStatusId": "5fde0762-a5af-4816-af4d-72e8204e551b",
  • "outputVersionStatusId": "3bf597bb-305d-42e2-9fa8-6c94577e6ee1",
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3"
}

biddings

/biddings

query Parameters
id
string
data
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/biddings

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

biddings

id
required
string <uuid>

Note: This is a Primary Key.

data
any <jsonb>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "data": null
}

/biddings

query Parameters
id
string
data
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/biddings

query Parameters
id
string
data
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

biddings

id
required
string <uuid>

Note: This is a Primary Key.

data
any <jsonb>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "data": null
}

__EFMigrationsHistory

/__EFMigrationsHistory

query Parameters
migrationId
string
productVersion
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/__EFMigrationsHistory

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

__EFMigrationsHistory

migrationId
required
string <character varying> <= 150 characters

Note: This is a Primary Key.

productVersion
required
string <character varying> <= 32 characters

Responses

Request samples

Content type
{
  • "migrationId": "string",
  • "productVersion": "string"
}

/__EFMigrationsHistory

query Parameters
migrationId
string
productVersion
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/__EFMigrationsHistory

query Parameters
migrationId
string
productVersion
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

__EFMigrationsHistory

migrationId
required
string <character varying> <= 150 characters

Note: This is a Primary Key.

productVersion
required
string <character varying> <= 32 characters

Responses

Request samples

Content type
{
  • "migrationId": "string",
  • "productVersion": "string"
}

vacations

/vacations

query Parameters
id
string
vacationStartDate
string
vacationEndDate
string
userId
string
status
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/vacations

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

vacations

id
required
string <uuid>

Note: This is a Primary Key.

vacationStartDate
required
string <timestamp with time zone>
vacationEndDate
required
string <timestamp with time zone>
userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

status
required
string <text>
Default: ""

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vacationStartDate": "string",
  • "vacationEndDate": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "status": ""
}

/vacations

query Parameters
id
string
vacationStartDate
string
vacationEndDate
string
userId
string
status
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/vacations

query Parameters
id
string
vacationStartDate
string
vacationEndDate
string
userId
string
status
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

vacations

id
required
string <uuid>

Note: This is a Primary Key.

vacationStartDate
required
string <timestamp with time zone>
vacationEndDate
required
string <timestamp with time zone>
userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

status
required
string <text>
Default: ""

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vacationStartDate": "string",
  • "vacationEndDate": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "status": ""
}

types

/types

query Parameters
id
string
folderTypeId
string
name
string
shortName
string
codeName
string
icon
string
color
string
screenPriority
string
isCore
string
price
string
biddingId
string
url
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/types

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

types

id
required
string <uuid>

Note: This is a Primary Key.

folderTypeId
required
string <uuid>

Note: This is a Foreign Key to folderTypes.id.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
integer <integer>
isCore
required
boolean <boolean>
Default: false
price
number <real>
biddingId
string <uuid>

Note: This is a Foreign Key to biddings.id.

url
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folderTypeId": "71aced48-af8d-4945-986e-3673fa133f54",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "screenPriority": 0,
  • "isCore": false,
  • "price": 0,
  • "biddingId": "098cc7fb-eeca-4618-85e6-6d5275a1a72b",
  • "url": "string"
}

/types

query Parameters
id
string
folderTypeId
string
name
string
shortName
string
codeName
string
icon
string
color
string
screenPriority
string
isCore
string
price
string
biddingId
string
url
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/types

query Parameters
id
string
folderTypeId
string
name
string
shortName
string
codeName
string
icon
string
color
string
screenPriority
string
isCore
string
price
string
biddingId
string
url
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

types

id
required
string <uuid>

Note: This is a Primary Key.

folderTypeId
required
string <uuid>

Note: This is a Foreign Key to folderTypes.id.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
integer <integer>
isCore
required
boolean <boolean>
Default: false
price
number <real>
biddingId
string <uuid>

Note: This is a Foreign Key to biddings.id.

url
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folderTypeId": "71aced48-af8d-4945-986e-3673fa133f54",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "screenPriority": 0,
  • "isCore": false,
  • "price": 0,
  • "biddingId": "098cc7fb-eeca-4618-85e6-6d5275a1a72b",
  • "url": "string"
}

hourlyRates

/hourlyRates

query Parameters
id
string
userId
string
projectDefinitionId
string
value
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/hourlyRates

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

hourlyRates

id
required
string <uuid>

Note: This is a Primary Key.

userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

projectDefinitionId
required
string <uuid>

Note: This is a Foreign Key to projectDefinitions.id.

value
number <numeric>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "value": 0
}

/hourlyRates

query Parameters
id
string
userId
string
projectDefinitionId
string
value
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/hourlyRates

query Parameters
id
string
userId
string
projectDefinitionId
string
value
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

hourlyRates

id
required
string <uuid>

Note: This is a Primary Key.

userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

projectDefinitionId
required
string <uuid>

Note: This is a Foreign Key to projectDefinitions.id.

value
number <numeric>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "value": 0
}

userSkills

/userSkills

query Parameters
id
string
userId
string
typeId
string
skillLevel
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/userSkills

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

userSkills

id
required
string <uuid>

Note: This is a Primary Key.

userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

typeId
required
string <uuid>

Note: This is a Foreign Key to types.id.

skillLevel
required
integer <integer>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "skillLevel": 0
}

/userSkills

query Parameters
id
string
userId
string
typeId
string
skillLevel
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/userSkills

query Parameters
id
string
userId
string
typeId
string
skillLevel
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

userSkills

id
required
string <uuid>

Note: This is a Primary Key.

userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

typeId
required
string <uuid>

Note: This is a Foreign Key to types.id.

skillLevel
required
integer <integer>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "skillLevel": 0
}

projectDefinitionIntegrationSettings

/projectDefinitionIntegrationSettings

query Parameters
id
string
projectDefinitionId
string
name
string
description
string
version
string
source
string
data
string
createdDate
string
updatedDate
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/projectDefinitionIntegrationSettings

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

projectDefinitionIntegrationSettings

id
required
string <uuid>

Note: This is a Primary Key.

projectDefinitionId
required
string <uuid>

Note: This is a Foreign Key to projectDefinitions.id.

name
required
string <text>
description
string <text>
version
required
string <text>
source
required
string <text>
data
any <json>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "name": "string",
  • "description": "string",
  • "version": "string",
  • "source": "string",
  • "data": null,
  • "createdDate": "string",
  • "updatedDate": "string"
}

/projectDefinitionIntegrationSettings

query Parameters
id
string
projectDefinitionId
string
name
string
description
string
version
string
source
string
data
string
createdDate
string
updatedDate
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionIntegrationSettings

query Parameters
id
string
projectDefinitionId
string
name
string
description
string
version
string
source
string
data
string
createdDate
string
updatedDate
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projectDefinitionIntegrationSettings

id
required
string <uuid>

Note: This is a Primary Key.

projectDefinitionId
required
string <uuid>

Note: This is a Foreign Key to projectDefinitions.id.

name
required
string <text>
description
string <text>
version
required
string <text>
source
required
string <text>
data
any <json>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "name": "string",
  • "description": "string",
  • "version": "string",
  • "source": "string",
  • "data": null,
  • "createdDate": "string",
  • "updatedDate": "string"
}

customAttributeGroups

/customAttributeGroups

query Parameters
id
string
name
string
description
string
screenPriority
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/customAttributeGroups

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

customAttributeGroups

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
description
any <jsonb>
screenPriority
integer <integer>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": null,
  • "screenPriority": 0
}

/customAttributeGroups

query Parameters
id
string
name
string
description
string
screenPriority
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/customAttributeGroups

query Parameters
id
string
name
string
description
string
screenPriority
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

customAttributeGroups

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
description
any <jsonb>
screenPriority
integer <integer>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": null,
  • "screenPriority": 0
}

notifications

/notifications

query Parameters
id
string
userId
string
createdDate
string
updatedDate
string
seen
string
changes
string
authorId
string
contextId
string
contextType
string
objectId
string
objectType
string
action
string
notificationTypeId
string
data
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/notifications

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

notifications

id
required
string <uuid>

Note: This is a Primary Key.

userId
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
seen
required
boolean <boolean>
changes
any <jsonb>
authorId
string <uuid>
contextId
string <uuid>
contextType
string <character varying> <= 128 characters
objectId
string <uuid>
objectType
string <character varying> <= 128 characters
action
string <character varying> <= 128 characters
notificationTypeId
required
string <uuid>
Default: "00000000-0000-0000-0000-000000000000"

Note: This is a Foreign Key to notificationTypes.id.

data
any <jsonb>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "seen": true,
  • "changes": null,
  • "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  • "contextId": "84451116-c600-49e2-9c60-5b6b34fae0d6",
  • "contextType": "string",
  • "objectId": "e39ea5f2-2188-47f8-add0-f1976630af5e",
  • "objectType": "string",
  • "action": "string",
  • "notificationTypeId": "00000000-0000-0000-0000-000000000000",
  • "data": null
}

/notifications

query Parameters
id
string
userId
string
createdDate
string
updatedDate
string
seen
string
changes
string
authorId
string
contextId
string
contextType
string
objectId
string
objectType
string
action
string
notificationTypeId
string
data
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/notifications

query Parameters
id
string
userId
string
createdDate
string
updatedDate
string
seen
string
changes
string
authorId
string
contextId
string
contextType
string
objectId
string
objectType
string
action
string
notificationTypeId
string
data
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

notifications

id
required
string <uuid>

Note: This is a Primary Key.

userId
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
seen
required
boolean <boolean>
changes
any <jsonb>
authorId
string <uuid>
contextId
string <uuid>
contextType
string <character varying> <= 128 characters
objectId
string <uuid>
objectType
string <character varying> <= 128 characters
action
string <character varying> <= 128 characters
notificationTypeId
required
string <uuid>
Default: "00000000-0000-0000-0000-000000000000"

Note: This is a Foreign Key to notificationTypes.id.

data
any <jsonb>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "seen": true,
  • "changes": null,
  • "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  • "contextId": "84451116-c600-49e2-9c60-5b6b34fae0d6",
  • "contextType": "string",
  • "objectId": "e39ea5f2-2188-47f8-add0-f1976630af5e",
  • "objectType": "string",
  • "action": "string",
  • "notificationTypeId": "00000000-0000-0000-0000-000000000000",
  • "data": null
}

customAttributes

/customAttributes

query Parameters
id
string
customAttributeDefinitionId
string
projectId
string
folderId
string
value
string
inheritedValue
string
computedValue
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/customAttributes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

customAttributes

id
required
string <uuid>

Note: This is a Primary Key.

customAttributeDefinitionId
required
string <uuid>

Note: This is a Foreign Key to customAttributeDefinitions.id.

projectId
string <uuid>

Note: This is a Foreign Key to projects.id.

folderId
string <uuid>

Note: This is a Foreign Key to folders.id.

value
string <text>
inheritedValue
string <text>
computedValue
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customAttributeDefinitionId": "db2a8d0c-8342-432d-a485-ecf2557c6103",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "value": "string",
  • "inheritedValue": "string",
  • "computedValue": "string"
}

/customAttributes

query Parameters
id
string
customAttributeDefinitionId
string
projectId
string
folderId
string
value
string
inheritedValue
string
computedValue
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/customAttributes

query Parameters
id
string
customAttributeDefinitionId
string
projectId
string
folderId
string
value
string
inheritedValue
string
computedValue
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

customAttributes

id
required
string <uuid>

Note: This is a Primary Key.

customAttributeDefinitionId
required
string <uuid>

Note: This is a Foreign Key to customAttributeDefinitions.id.

projectId
string <uuid>

Note: This is a Foreign Key to projects.id.

folderId
string <uuid>

Note: This is a Foreign Key to folders.id.

value
string <text>
inheritedValue
string <text>
computedValue
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customAttributeDefinitionId": "db2a8d0c-8342-432d-a485-ecf2557c6103",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "value": "string",
  • "inheritedValue": "string",
  • "computedValue": "string"
}

schedulerViewFolderTypes

/schedulerViewFolderTypes

query Parameters
schedulerViewId
string
folderTypeId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/schedulerViewFolderTypes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

schedulerViewFolderTypes

schedulerViewId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to schedulerViews.id.

folderTypeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folderTypes.id.

Responses

Request samples

Content type
{
  • "schedulerViewId": "bf367752-019c-46e9-bcc1-28579f5edae3",
  • "folderTypeId": "71aced48-af8d-4945-986e-3673fa133f54"
}

/schedulerViewFolderTypes

query Parameters
schedulerViewId
string
folderTypeId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/schedulerViewFolderTypes

query Parameters
schedulerViewId
string
folderTypeId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

schedulerViewFolderTypes

schedulerViewId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to schedulerViews.id.

folderTypeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folderTypes.id.

Responses

Request samples

Content type
{
  • "schedulerViewId": "bf367752-019c-46e9-bcc1-28579f5edae3",
  • "folderTypeId": "71aced48-af8d-4945-986e-3673fa133f54"
}

advancePayments

/advancePayments

query Parameters
id
string
type
string
amount
string
note
string
projectId
string
userId
string
payoutId
string
createdDate
string
updatedDate
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/advancePayments

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

advancePayments

id
required
string <uuid>

Note: This is a Primary Key.

type
required
string <text>
amount
required
number <numeric>
note
required
string <text>
projectId
string <uuid>

Note: This is a Foreign Key to projects.id.

userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

payoutId
string <uuid>

Note: This is a Foreign Key to payouts.id.

createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "string",
  • "amount": 0,
  • "note": "string",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "payoutId": "c3d65312-6575-43de-b8ae-728d8d0a9371",
  • "createdDate": "string",
  • "updatedDate": "string"
}

/advancePayments

query Parameters
id
string
type
string
amount
string
note
string
projectId
string
userId
string
payoutId
string
createdDate
string
updatedDate
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/advancePayments

query Parameters
id
string
type
string
amount
string
note
string
projectId
string
userId
string
payoutId
string
createdDate
string
updatedDate
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

advancePayments

id
required
string <uuid>

Note: This is a Primary Key.

type
required
string <text>
amount
required
number <numeric>
note
required
string <text>
projectId
string <uuid>

Note: This is a Foreign Key to projects.id.

userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

payoutId
string <uuid>

Note: This is a Foreign Key to payouts.id.

createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "string",
  • "amount": 0,
  • "note": "string",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "payoutId": "c3d65312-6575-43de-b8ae-728d8d0a9371",
  • "createdDate": "string",
  • "updatedDate": "string"
}

workerFees

/workerFees

query Parameters
id
string
type
string
amount
string
paymentStatusId
string
note
string
folderId
string
projectId
string
userId
string
payoutId
string
color
string
isLocked
string
userTimeTrackerId
string
hourlyRate
string
spentHours
string
workingDuration
string
frameFee
string
createdDate
string
updatedDate
string
frameFeeMultiplier
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/workerFees

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

workerFees

id
required
string <uuid>

Note: This is a Primary Key.

type
required
string <text>
amount
required
number <numeric>
paymentStatusId
required
string <uuid>

Note: This is a Foreign Key to paymentStatuses.id.

note
required
string <text>
folderId
string <uuid>

Note: This is a Foreign Key to folders.id.

projectId
string <uuid>

Note: This is a Foreign Key to projects.id.

userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

payoutId
string <uuid>

Note: This is a Foreign Key to payouts.id.

color
required
string <text>
isLocked
required
boolean <boolean>
userTimeTrackerId
string <uuid>

Note: This is a Foreign Key to userTimeTrackers.id.

hourlyRate
number <numeric>
spentHours
number <numeric>
workingDuration
integer <integer>
frameFee
number <numeric>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
frameFeeMultiplier
number <numeric>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "string",
  • "amount": 0,
  • "paymentStatusId": "38c13933-adca-4bac-9697-e1c6c8d5596d",
  • "note": "string",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "payoutId": "c3d65312-6575-43de-b8ae-728d8d0a9371",
  • "color": "string",
  • "isLocked": true,
  • "userTimeTrackerId": "648d4829-de8b-4ab2-9b0f-83c95903fe98",
  • "hourlyRate": 0,
  • "spentHours": 0,
  • "workingDuration": 0,
  • "frameFee": 0,
  • "createdDate": "string",
  • "updatedDate": "string",
  • "frameFeeMultiplier": 0
}

/workerFees

query Parameters
id
string
type
string
amount
string
paymentStatusId
string
note
string
folderId
string
projectId
string
userId
string
payoutId
string
color
string
isLocked
string
userTimeTrackerId
string
hourlyRate
string
spentHours
string
workingDuration
string
frameFee
string
createdDate
string
updatedDate
string
frameFeeMultiplier
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/workerFees

query Parameters
id
string
type
string
amount
string
paymentStatusId
string
note
string
folderId
string
projectId
string
userId
string
payoutId
string
color
string
isLocked
string
userTimeTrackerId
string
hourlyRate
string
spentHours
string
workingDuration
string
frameFee
string
createdDate
string
updatedDate
string
frameFeeMultiplier
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

workerFees

id
required
string <uuid>

Note: This is a Primary Key.

type
required
string <text>
amount
required
number <numeric>
paymentStatusId
required
string <uuid>

Note: This is a Foreign Key to paymentStatuses.id.

note
required
string <text>
folderId
string <uuid>

Note: This is a Foreign Key to folders.id.

projectId
string <uuid>

Note: This is a Foreign Key to projects.id.

userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

payoutId
string <uuid>

Note: This is a Foreign Key to payouts.id.

color
required
string <text>
isLocked
required
boolean <boolean>
userTimeTrackerId
string <uuid>

Note: This is a Foreign Key to userTimeTrackers.id.

hourlyRate
number <numeric>
spentHours
number <numeric>
workingDuration
integer <integer>
frameFee
number <numeric>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
frameFeeMultiplier
number <numeric>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "string",
  • "amount": 0,
  • "paymentStatusId": "38c13933-adca-4bac-9697-e1c6c8d5596d",
  • "note": "string",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "payoutId": "c3d65312-6575-43de-b8ae-728d8d0a9371",
  • "color": "string",
  • "isLocked": true,
  • "userTimeTrackerId": "648d4829-de8b-4ab2-9b0f-83c95903fe98",
  • "hourlyRate": 0,
  • "spentHours": 0,
  • "workingDuration": 0,
  • "frameFee": 0,
  • "createdDate": "string",
  • "updatedDate": "string",
  • "frameFeeMultiplier": 0
}

schedulerViews

/schedulerViews

query Parameters
id
string
ownerId
string
isPublic
string
tableState
string
name
string
description
string
projectId
string
folderId
string
filter
string
pivotMode
string
viewGroupId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/schedulerViews

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

schedulerViews

id
required
string <uuid>

Note: This is a Primary Key.

ownerId
string <uuid>
isPublic
required
boolean <boolean>
tableState
any <jsonb>
name
required
string <text>
description
string <text>
projectId
string <uuid>
folderId
string <uuid>
filter
string <text>
pivotMode
required
boolean <boolean>
viewGroupId
string <uuid>

Note: This is a Foreign Key to viewGroups.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "isPublic": true,
  • "tableState": null,
  • "name": "string",
  • "description": "string",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "filter": "string",
  • "pivotMode": true,
  • "viewGroupId": "48a48f5a-0254-4b2d-9d67-3d59b4f210f9"
}

/schedulerViews

query Parameters
id
string
ownerId
string
isPublic
string
tableState
string
name
string
description
string
projectId
string
folderId
string
filter
string
pivotMode
string
viewGroupId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/schedulerViews

query Parameters
id
string
ownerId
string
isPublic
string
tableState
string
name
string
description
string
projectId
string
folderId
string
filter
string
pivotMode
string
viewGroupId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

schedulerViews

id
required
string <uuid>

Note: This is a Primary Key.

ownerId
string <uuid>
isPublic
required
boolean <boolean>
tableState
any <jsonb>
name
required
string <text>
description
string <text>
projectId
string <uuid>
folderId
string <uuid>
filter
string <text>
pivotMode
required
boolean <boolean>
viewGroupId
string <uuid>

Note: This is a Foreign Key to viewGroups.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "isPublic": true,
  • "tableState": null,
  • "name": "string",
  • "description": "string",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "filter": "string",
  • "pivotMode": true,
  • "viewGroupId": "48a48f5a-0254-4b2d-9d67-3d59b4f210f9"
}

storageRecords

/storageRecords

query Parameters
id
string
componentId
string
storageLocation
string
link
string
status
string
statusMessage
string
progress
string
linkExpiration
string
createdDate
string
updatedDate
string
userId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/storageRecords

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

storageRecords

id
required
string <uuid>

Note: This is a Primary Key.

componentId
required
string <uuid>

Note: This is a Foreign Key to components.id.

storageLocation
required
integer <smallint>
link
string <text>
status
integer <smallint>
statusMessage
string <text>
progress
integer <smallint>
linkExpiration
string <timestamp with time zone>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
userId
string <uuid>

Note: This is a Foreign Key to users.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "componentId": "616ccd92-d666-4180-8349-8d125b269fac",
  • "storageLocation": 0,
  • "link": "string",
  • "status": 0,
  • "statusMessage": "string",
  • "progress": 0,
  • "linkExpiration": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

/storageRecords

query Parameters
id
string
componentId
string
storageLocation
string
link
string
status
string
statusMessage
string
progress
string
linkExpiration
string
createdDate
string
updatedDate
string
userId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/storageRecords

query Parameters
id
string
componentId
string
storageLocation
string
link
string
status
string
statusMessage
string
progress
string
linkExpiration
string
createdDate
string
updatedDate
string
userId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

storageRecords

id
required
string <uuid>

Note: This is a Primary Key.

componentId
required
string <uuid>

Note: This is a Foreign Key to components.id.

storageLocation
required
integer <smallint>
link
string <text>
status
integer <smallint>
statusMessage
string <text>
progress
integer <smallint>
linkExpiration
string <timestamp with time zone>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
userId
string <uuid>

Note: This is a Foreign Key to users.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "componentId": "616ccd92-d666-4180-8349-8d125b269fac",
  • "storageLocation": 0,
  • "link": "string",
  • "status": 0,
  • "statusMessage": "string",
  • "progress": 0,
  • "linkExpiration": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

folderAssignees

/folderAssignees

query Parameters
folderId
string
userId
string
assigneeRoleId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/folderAssignees

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

folderAssignees

folderId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folders.id.

userId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to users.id.

assigneeRoleId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to assigneeRoles.id.

Responses

Request samples

Content type
{
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "assigneeRoleId": "0e6ac67b-c717-49f7-bfc0-373174d8464f"
}

/folderAssignees

query Parameters
folderId
string
userId
string
assigneeRoleId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/folderAssignees

query Parameters
folderId
string
userId
string
assigneeRoleId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

folderAssignees

folderId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folders.id.

userId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to users.id.

assigneeRoleId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to assigneeRoles.id.

Responses

Request samples

Content type
{
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "assigneeRoleId": "0e6ac67b-c717-49f7-bfc0-373174d8464f"
}

typeApplicationExcludes

/typeApplicationExcludes

query Parameters
typeId
string
applicationId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/typeApplicationExcludes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

typeApplicationExcludes

typeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to types.id.

applicationId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to applications.id.

Responses

Request samples

Content type
{
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5"
}

/typeApplicationExcludes

query Parameters
typeId
string
applicationId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/typeApplicationExcludes

query Parameters
typeId
string
applicationId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

typeApplicationExcludes

typeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to types.id.

applicationId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to applications.id.

Responses

Request samples

Content type
{
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5"
}

apiKeys

/apiKeys

query Parameters
id
string
userId
string
token
string
createdAt
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/apiKeys

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

apiKeys

id
required
string <uuid>

Note: This is a Primary Key.

userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

token
required
string <text>
Default: "public.generate_api_token()"
createdAt
required
string <timestamp with time zone>
Default: "timezone('UTC'::text, now())"

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "token": "public.generate_api_token()",
  • "createdAt": "timezone('UTC'::text, now())"
}

/apiKeys

query Parameters
id
string
userId
string
token
string
createdAt
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/apiKeys

query Parameters
id
string
userId
string
token
string
createdAt
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

apiKeys

id
required
string <uuid>

Note: This is a Primary Key.

userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

token
required
string <text>
Default: "public.generate_api_token()"
createdAt
required
string <timestamp with time zone>
Default: "timezone('UTC'::text, now())"

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "token": "public.generate_api_token()",
  • "createdAt": "timezone('UTC'::text, now())"
}

outputTemplates

/outputTemplates

query Parameters
id
string
outputTypeId
string
suffix
string
hiddenInOutgoing
string
isExternal
string
folderTemplateId
string
tagId
string
name
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/outputTemplates

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

outputTemplates

id
required
string <uuid>

Note: This is a Primary Key.

outputTypeId
required
string <uuid>

Note: This is a Foreign Key to outputTypes.id.

suffix
string <character varying> <= 128 characters
hiddenInOutgoing
required
boolean <boolean>
isExternal
required
boolean <boolean>
folderTemplateId
required
string <uuid>

Note: This is a Foreign Key to folderTemplates.id.

tagId
string <uuid>

Note: This is a Foreign Key to tags.id.

name
required
string <character varying> <= 128 characters
Default: ""

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "outputTypeId": "eb4139aa-02ad-4d37-a296-30a4458db90e",
  • "suffix": "string",
  • "hiddenInOutgoing": true,
  • "isExternal": true,
  • "folderTemplateId": "fb81db22-0ba6-434c-a2b3-03ddd69524c1",
  • "tagId": "f69eb9f1-ae9f-4086-b25c-c39758a43fb3",
  • "name": ""
}

/outputTemplates

query Parameters
id
string
outputTypeId
string
suffix
string
hiddenInOutgoing
string
isExternal
string
folderTemplateId
string
tagId
string
name
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outputTemplates

query Parameters
id
string
outputTypeId
string
suffix
string
hiddenInOutgoing
string
isExternal
string
folderTemplateId
string
tagId
string
name
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

outputTemplates

id
required
string <uuid>

Note: This is a Primary Key.

outputTypeId
required
string <uuid>

Note: This is a Foreign Key to outputTypes.id.

suffix
string <character varying> <= 128 characters
hiddenInOutgoing
required
boolean <boolean>
isExternal
required
boolean <boolean>
folderTemplateId
required
string <uuid>

Note: This is a Foreign Key to folderTemplates.id.

tagId
string <uuid>

Note: This is a Foreign Key to tags.id.

name
required
string <character varying> <= 128 characters
Default: ""

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "outputTypeId": "eb4139aa-02ad-4d37-a296-30a4458db90e",
  • "suffix": "string",
  • "hiddenInOutgoing": true,
  • "isExternal": true,
  • "folderTemplateId": "fb81db22-0ba6-434c-a2b3-03ddd69524c1",
  • "tagId": "f69eb9f1-ae9f-4086-b25c-c39758a43fb3",
  • "name": ""
}

pg_all_foreign_keys

/pg_all_foreign_keys

query Parameters
fk_schema_name
string
fk_table_name
string
fk_constraint_name
string
fk_table_oid
string
fk_columns
string
pk_schema_name
string
pk_table_name
string
pk_constraint_name
string
pk_table_oid
string
pk_index_name
string
pk_columns
string
match_type
string
on_delete
string
on_update
string
is_deferrable
string
is_deferred
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

cloudPlaces

/cloudPlaces

query Parameters
id
string
cloudApplicationId
string
componentStateId
string
componentId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/cloudPlaces

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

cloudPlaces

id
required
string <uuid>

Note: This is a Primary Key.

cloudApplicationId
string <uuid>

Note: This is a Foreign Key to cloudApplications.id.

componentStateId
string <uuid>
componentId
string <uuid>

Note: This is a Foreign Key to components.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "cloudApplicationId": "f1f15977-f2d0-4460-b28f-e48ddb5a9281",
  • "componentStateId": "486f8683-2756-47a7-bf0e-28d14f9bb77d",
  • "componentId": "616ccd92-d666-4180-8349-8d125b269fac"
}

/cloudPlaces

query Parameters
id
string
cloudApplicationId
string
componentStateId
string
componentId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/cloudPlaces

query Parameters
id
string
cloudApplicationId
string
componentStateId
string
componentId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

cloudPlaces

id
required
string <uuid>

Note: This is a Primary Key.

cloudApplicationId
string <uuid>

Note: This is a Foreign Key to cloudApplications.id.

componentStateId
string <uuid>
componentId
string <uuid>

Note: This is a Foreign Key to components.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "cloudApplicationId": "f1f15977-f2d0-4460-b28f-e48ddb5a9281",
  • "componentStateId": "486f8683-2756-47a7-bf0e-28d14f9bb77d",
  • "componentId": "616ccd92-d666-4180-8349-8d125b269fac"
}

applications

/applications

query Parameters
id
string
name
string
isActive
string
isSoftware
string
arguments
string
isCore
string
environment
string
family
string
executables
string
label
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/applications

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

applications

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
isActive
required
boolean <boolean>
Default: true
isSoftware
required
boolean <boolean>
Default: true
arguments
any <jsonb>
isCore
required
boolean <boolean>
Default: false
environment
any <jsonb>
family
required
string <character varying> <= 128 characters
Default: ""
executables
any <jsonb>
label
string <character varying> <= 128 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "isActive": true,
  • "isSoftware": true,
  • "arguments": null,
  • "isCore": false,
  • "environment": null,
  • "family": "",
  • "executables": null,
  • "label": "string"
}

/applications

query Parameters
id
string
name
string
isActive
string
isSoftware
string
arguments
string
isCore
string
environment
string
family
string
executables
string
label
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/applications

query Parameters
id
string
name
string
isActive
string
isSoftware
string
arguments
string
isCore
string
environment
string
family
string
executables
string
label
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

applications

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
isActive
required
boolean <boolean>
Default: true
isSoftware
required
boolean <boolean>
Default: true
arguments
any <jsonb>
isCore
required
boolean <boolean>
Default: false
environment
any <jsonb>
family
required
string <character varying> <= 128 characters
Default: ""
executables
any <jsonb>
label
string <character varying> <= 128 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "isActive": true,
  • "isSoftware": true,
  • "arguments": null,
  • "isCore": false,
  • "environment": null,
  • "family": "",
  • "executables": null,
  • "label": "string"
}

active_locks

/active_locks

query Parameters
schemaname
string
relname
string
locktype
string
page
string
virtualtransaction
string
pid
string
mode
string
granted
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

folderTypes

/folderTypes

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
isTaskable
string
isTypeable
string
isTodoable
string
isCore
string
isHiddenable
string
screenPriority
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/folderTypes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

folderTypes

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
isTaskable
required
boolean <boolean>
isTypeable
required
boolean <boolean>
Default: false
isTodoable
required
boolean <boolean>
Default: false
isCore
required
boolean <boolean>
isHiddenable
required
boolean <boolean>
Default: false
screenPriority
integer <integer>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "isTaskable": true,
  • "isTypeable": false,
  • "isTodoable": false,
  • "isCore": true,
  • "isHiddenable": false,
  • "screenPriority": 0
}

/folderTypes

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
isTaskable
string
isTypeable
string
isTodoable
string
isCore
string
isHiddenable
string
screenPriority
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/folderTypes

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
isTaskable
string
isTypeable
string
isTodoable
string
isCore
string
isHiddenable
string
screenPriority
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

folderTypes

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
isTaskable
required
boolean <boolean>
isTypeable
required
boolean <boolean>
Default: false
isTodoable
required
boolean <boolean>
Default: false
isCore
required
boolean <boolean>
isHiddenable
required
boolean <boolean>
Default: false
screenPriority
integer <integer>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "isTaskable": true,
  • "isTypeable": false,
  • "isTodoable": false,
  • "isCore": true,
  • "isHiddenable": false,
  • "screenPriority": 0
}

outgoingStatusMappingTags

/outgoingStatusMappingTags

query Parameters
outgoingStatusMappingId
string
tagId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/outgoingStatusMappingTags

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

outgoingStatusMappingTags

outgoingStatusMappingId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to outgoingStatusMappings.id.

tagId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to tags.id.

Responses

Request samples

Content type
{
  • "outgoingStatusMappingId": "354091a2-c1fe-420a-a7d2-d75b8fa41db5",
  • "tagId": "f69eb9f1-ae9f-4086-b25c-c39758a43fb3"
}

/outgoingStatusMappingTags

query Parameters
outgoingStatusMappingId
string
tagId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outgoingStatusMappingTags

query Parameters
outgoingStatusMappingId
string
tagId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

outgoingStatusMappingTags

outgoingStatusMappingId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to outgoingStatusMappings.id.

tagId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to tags.id.

Responses

Request samples

Content type
{
  • "outgoingStatusMappingId": "354091a2-c1fe-420a-a7d2-d75b8fa41db5",
  • "tagId": "f69eb9f1-ae9f-4086-b25c-c39758a43fb3"
}

outputTypes

/outputTypes

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
screenPriority
string
isCore
string
ayonProductTypeId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/outputTypes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

outputTypes

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
integer <integer>
isCore
required
boolean <boolean>
Default: false
ayonProductTypeId
string <uuid>

Note: This is a Foreign Key to ayonProductTypes.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "screenPriority": 0,
  • "isCore": false,
  • "ayonProductTypeId": "c7beeac2-248d-479b-bcf9-ef404da442fe"
}

/outputTypes

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
screenPriority
string
isCore
string
ayonProductTypeId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outputTypes

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
screenPriority
string
isCore
string
ayonProductTypeId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

outputTypes

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
integer <integer>
isCore
required
boolean <boolean>
Default: false
ayonProductTypeId
string <uuid>

Note: This is a Foreign Key to ayonProductTypes.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "screenPriority": 0,
  • "isCore": false,
  • "ayonProductTypeId": "c7beeac2-248d-479b-bcf9-ef404da442fe"
}

customAttributeDefinitionPermissions

/customAttributeDefinitionPermissions

query Parameters
customAttributeDefinitionId
string
securityRoleId
string
canRead
string
canWrite
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/customAttributeDefinitionPermissions

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

customAttributeDefinitionPermissions

customAttributeDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to customAttributeDefinitions.id.

securityRoleId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to securityRoles.id.

canRead
required
boolean <boolean>
canWrite
required
boolean <boolean>

Responses

Request samples

Content type
{
  • "customAttributeDefinitionId": "db2a8d0c-8342-432d-a485-ecf2557c6103",
  • "securityRoleId": "098794d7-7cce-42c5-8c3e-45c3d491f4fc",
  • "canRead": true,
  • "canWrite": true
}

/customAttributeDefinitionPermissions

query Parameters
customAttributeDefinitionId
string
securityRoleId
string
canRead
string
canWrite
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/customAttributeDefinitionPermissions

query Parameters
customAttributeDefinitionId
string
securityRoleId
string
canRead
string
canWrite
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

customAttributeDefinitionPermissions

customAttributeDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to customAttributeDefinitions.id.

securityRoleId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to securityRoles.id.

canRead
required
boolean <boolean>
canWrite
required
boolean <boolean>

Responses

Request samples

Content type
{
  • "customAttributeDefinitionId": "db2a8d0c-8342-432d-a485-ecf2557c6103",
  • "securityRoleId": "098794d7-7cce-42c5-8c3e-45c3d491f4fc",
  • "canRead": true,
  • "canWrite": true
}

projectDefinitionFolderStatuses

/projectDefinitionFolderStatuses

query Parameters
projectDefinitionId
string
statusId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/projectDefinitionFolderStatuses

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

projectDefinitionFolderStatuses

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

statusId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to statuses.id.

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645"
}

/projectDefinitionFolderStatuses

query Parameters
projectDefinitionId
string
statusId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionFolderStatuses

query Parameters
projectDefinitionId
string
statusId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projectDefinitionFolderStatuses

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

statusId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to statuses.id.

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645"
}

help

/help

query Parameters
id
string
helpStructure
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/help

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

help

id
required
string <uuid>

Note: This is a Primary Key.

helpStructure
any <jsonb>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "helpStructure": null
}

/help

query Parameters
id
string
helpStructure
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/help

query Parameters
id
string
helpStructure
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

help

id
required
string <uuid>

Note: This is a Primary Key.

helpStructure
any <jsonb>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "helpStructure": null
}

frameFeeRates

/frameFeeRates

query Parameters
id
string
userId
string
projectDefinitionId
string
typeId
string
value
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/frameFeeRates

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

frameFeeRates

id
required
string <uuid>

Note: This is a Primary Key.

userId
string <uuid>

Note: This is a Foreign Key to users.id.

projectDefinitionId
required
string <uuid>

Note: This is a Foreign Key to projectDefinitions.id.

typeId
required
string <uuid>
Default: "00000000-0000-0000-0000-000000000000"

Note: This is a Foreign Key to types.id.

value
number <numeric>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "typeId": "00000000-0000-0000-0000-000000000000",
  • "value": 0
}

/frameFeeRates

query Parameters
id
string
userId
string
projectDefinitionId
string
typeId
string
value
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/frameFeeRates

query Parameters
id
string
userId
string
projectDefinitionId
string
typeId
string
value
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

frameFeeRates

id
required
string <uuid>

Note: This is a Primary Key.

userId
string <uuid>

Note: This is a Foreign Key to users.id.

projectDefinitionId
required
string <uuid>

Note: This is a Foreign Key to projectDefinitions.id.

typeId
required
string <uuid>
Default: "00000000-0000-0000-0000-000000000000"

Note: This is a Foreign Key to types.id.

value
number <numeric>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "typeId": "00000000-0000-0000-0000-000000000000",
  • "value": 0
}

securityRoles

/securityRoles

query Parameters
id
string
name
string
color
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/securityRoles

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

securityRoles

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
color
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "color": "string"
}

/securityRoles

query Parameters
id
string
name
string
color
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/securityRoles

query Parameters
id
string
name
string
color
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

securityRoles

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
color
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "color": "string"
}

componentStates

/componentStates

query Parameters
id
string
state
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/componentStates

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

componentStates

id
required
string <uuid>

Note: This is a Primary Key.

state
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "string"
}

/componentStates

query Parameters
id
string
state
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/componentStates

query Parameters
id
string
state
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

componentStates

id
required
string <uuid>

Note: This is a Primary Key.

state
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "string"
}

noteCategories

/noteCategories

query Parameters
id
string
name
string
color
string
isCore
string
screenPriority
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/noteCategories

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

noteCategories

id
required
string <uuid>

Note: This is a Primary Key.

name
string <text>
color
string <text>
isCore
required
boolean <boolean>
Default: false
screenPriority
integer <integer>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "color": "string",
  • "isCore": false,
  • "screenPriority": 0
}

/noteCategories

query Parameters
id
string
name
string
color
string
isCore
string
screenPriority
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/noteCategories

query Parameters
id
string
name
string
color
string
isCore
string
screenPriority
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

noteCategories

id
required
string <uuid>

Note: This is a Primary Key.

name
string <text>
color
string <text>
isCore
required
boolean <boolean>
Default: false
screenPriority
integer <integer>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "color": "string",
  • "isCore": false,
  • "screenPriority": 0
}

documents

/documents

query Parameters
id
string
content
string
folderId
string
createdDate
string
updatedDate
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/documents

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

documents

id
required
string <uuid>

Note: This is a Primary Key.

content
any <jsonb>
folderId
required
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "content": null,
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "createdDate": "string",
  • "updatedDate": "string"
}

/documents

query Parameters
id
string
content
string
folderId
string
createdDate
string
updatedDate
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/documents

query Parameters
id
string
content
string
folderId
string
createdDate
string
updatedDate
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

documents

id
required
string <uuid>

Note: This is a Primary Key.

content
any <jsonb>
folderId
required
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "content": null,
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "createdDate": "string",
  • "updatedDate": "string"
}

customAttributeDefinitions

/customAttributeDefinitions

query Parameters
id
string
customAttributeBaseTypeId
string
customAttributeGroupId
string
name
string
isCore
string
isInheritable
string
isPinned
string
isHidden
string
defaultValue
string
values
string
screenPriority
string
codeName
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/customAttributeDefinitions

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

customAttributeDefinitions

id
required
string <uuid>

Note: This is a Primary Key.

customAttributeBaseTypeId
required
string <uuid>

Note: This is a Foreign Key to customAttributeBaseTypes.id.

customAttributeGroupId
string <uuid>

Note: This is a Foreign Key to customAttributeGroups.id.

name
required
string <character varying> <= 128 characters
isCore
required
boolean <boolean>
isInheritable
required
boolean <boolean>
isPinned
required
boolean <boolean>
isHidden
required
boolean <boolean>
defaultValue
string <text>
values
any <jsonb>
screenPriority
integer <integer>
codeName
required
string <character varying> <= 128 characters
Default: ""

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customAttributeBaseTypeId": "5b188e68-89f3-4fbf-a94c-c6a1ad61276d",
  • "customAttributeGroupId": "e94e66c0-6906-4014-9d15-f64be6855702",
  • "name": "string",
  • "isCore": true,
  • "isInheritable": true,
  • "isPinned": true,
  • "isHidden": true,
  • "defaultValue": "string",
  • "values": null,
  • "screenPriority": 0,
  • "codeName": ""
}

/customAttributeDefinitions

query Parameters
id
string
customAttributeBaseTypeId
string
customAttributeGroupId
string
name
string
isCore
string
isInheritable
string
isPinned
string
isHidden
string
defaultValue
string
values
string
screenPriority
string
codeName
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/customAttributeDefinitions

query Parameters
id
string
customAttributeBaseTypeId
string
customAttributeGroupId
string
name
string
isCore
string
isInheritable
string
isPinned
string
isHidden
string
defaultValue
string
values
string
screenPriority
string
codeName
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

customAttributeDefinitions

id
required
string <uuid>

Note: This is a Primary Key.

customAttributeBaseTypeId
required
string <uuid>

Note: This is a Foreign Key to customAttributeBaseTypes.id.

customAttributeGroupId
string <uuid>

Note: This is a Foreign Key to customAttributeGroups.id.

name
required
string <character varying> <= 128 characters
isCore
required
boolean <boolean>
isInheritable
required
boolean <boolean>
isPinned
required
boolean <boolean>
isHidden
required
boolean <boolean>
defaultValue
string <text>
values
any <jsonb>
screenPriority
integer <integer>
codeName
required
string <character varying> <= 128 characters
Default: ""

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customAttributeBaseTypeId": "5b188e68-89f3-4fbf-a94c-c6a1ad61276d",
  • "customAttributeGroupId": "e94e66c0-6906-4014-9d15-f64be6855702",
  • "name": "string",
  • "isCore": true,
  • "isInheritable": true,
  • "isPinned": true,
  • "isHidden": true,
  • "defaultValue": "string",
  • "values": null,
  • "screenPriority": 0,
  • "codeName": ""
}

uploadRecords

/uploadRecords

query Parameters
id
string
jobId
string
status
string
fileName
string
path
string
traceback
string
createdDate
string
updatedDate
string
authorId
string
progress
string
total
string
retries
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/uploadRecords

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

uploadRecords

id
required
string <uuid>

Note: This is a Primary Key.

jobId
string <uuid>
status
required
string <character varying> <= 20 characters
fileName
required
string <character varying> <= 4096 characters
path
required
string <character varying> <= 4096 characters
traceback
required
string <character varying> <= 4096 characters
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
authorId
required
string <uuid>
progress
required
number <double precision>
total
required
integer <integer>
retries
required
integer <integer>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "status": "string",
  • "fileName": "string",
  • "path": "string",
  • "traceback": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  • "progress": 0,
  • "total": 0,
  • "retries": 0
}

/uploadRecords

query Parameters
id
string
jobId
string
status
string
fileName
string
path
string
traceback
string
createdDate
string
updatedDate
string
authorId
string
progress
string
total
string
retries
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/uploadRecords

query Parameters
id
string
jobId
string
status
string
fileName
string
path
string
traceback
string
createdDate
string
updatedDate
string
authorId
string
progress
string
total
string
retries
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

uploadRecords

id
required
string <uuid>

Note: This is a Primary Key.

jobId
string <uuid>
status
required
string <character varying> <= 20 characters
fileName
required
string <character varying> <= 4096 characters
path
required
string <character varying> <= 4096 characters
traceback
required
string <character varying> <= 4096 characters
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
authorId
required
string <uuid>
progress
required
number <double precision>
total
required
integer <integer>
retries
required
integer <integer>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "status": "string",
  • "fileName": "string",
  • "path": "string",
  • "traceback": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  • "progress": 0,
  • "total": 0,
  • "retries": 0
}

settings

/settings

query Parameters
id
string
key
string
value
string
type
string
isCore
string
isSecret
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/settings

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

settings

id
required
string <uuid>

Note: This is a Primary Key.

key
required
string <text>
value
required
string <text>
type
required
integer <integer>
isCore
required
boolean <boolean>
isSecret
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "key": "string",
  • "value": "string",
  • "type": 0,
  • "isCore": true,
  • "isSecret": false
}

/settings

query Parameters
id
string
key
string
value
string
type
string
isCore
string
isSecret
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/settings

query Parameters
id
string
key
string
value
string
type
string
isCore
string
isSecret
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

settings

id
required
string <uuid>

Note: This is a Primary Key.

key
required
string <text>
value
required
string <text>
type
required
integer <integer>
isCore
required
boolean <boolean>
isSecret
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "key": "string",
  • "value": "string",
  • "type": 0,
  • "isCore": true,
  • "isSecret": false
}

urls

/urls

query Parameters
id
string
shortCode
string
longUrl
string
name
string
createdDate
string
updatedDate
string
allowDownload
string
data
string
expiresAt
string
hasPassword
string
isActive
string
isPublic
string
password
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/urls

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

urls

id
required
string <uuid>

Note: This is a Primary Key.

shortCode
required
string <text>
longUrl
string <text>
name
string <text>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
allowDownload
required
boolean <boolean>
Default: true
data
any <jsonb>
expiresAt
string <timestamp with time zone>
hasPassword
required
boolean <boolean>
Default: false
isActive
required
boolean <boolean>
Default: true
isPublic
required
boolean <boolean>
Default: true
password
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "shortCode": "string",
  • "longUrl": "string",
  • "name": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "allowDownload": true,
  • "data": null,
  • "expiresAt": "string",
  • "hasPassword": false,
  • "isActive": true,
  • "isPublic": true,
  • "password": "string"
}

/urls

query Parameters
id
string
shortCode
string
longUrl
string
name
string
createdDate
string
updatedDate
string
allowDownload
string
data
string
expiresAt
string
hasPassword
string
isActive
string
isPublic
string
password
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/urls

query Parameters
id
string
shortCode
string
longUrl
string
name
string
createdDate
string
updatedDate
string
allowDownload
string
data
string
expiresAt
string
hasPassword
string
isActive
string
isPublic
string
password
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

urls

id
required
string <uuid>

Note: This is a Primary Key.

shortCode
required
string <text>
longUrl
string <text>
name
string <text>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
allowDownload
required
boolean <boolean>
Default: true
data
any <jsonb>
expiresAt
string <timestamp with time zone>
hasPassword
required
boolean <boolean>
Default: false
isActive
required
boolean <boolean>
Default: true
isPublic
required
boolean <boolean>
Default: true
password
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "shortCode": "string",
  • "longUrl": "string",
  • "name": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "allowDownload": true,
  • "data": null,
  • "expiresAt": "string",
  • "hasPassword": false,
  • "isActive": true,
  • "isPublic": true,
  • "password": "string"
}

outputVersionTags

/outputVersionTags

query Parameters
outputVersionId
string
tagId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/outputVersionTags

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

outputVersionTags

outputVersionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to outputVersions.id.

tagId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to tags.id.

Responses

Request samples

Content type
{
  • "outputVersionId": "45414408-e045-450b-939c-cf42e5d6e489",
  • "tagId": "f69eb9f1-ae9f-4086-b25c-c39758a43fb3"
}

/outputVersionTags

query Parameters
outputVersionId
string
tagId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outputVersionTags

query Parameters
outputVersionId
string
tagId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

outputVersionTags

outputVersionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to outputVersions.id.

tagId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to tags.id.

Responses

Request samples

Content type
{
  • "outputVersionId": "45414408-e045-450b-939c-cf42e5d6e489",
  • "tagId": "f69eb9f1-ae9f-4086-b25c-c39758a43fb3"
}

documentationOverrides

/documentationOverrides

query Parameters
id
string
entityId
string
url
string
entityName
string
projectDefinitionId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/documentationOverrides

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

documentationOverrides

id
required
string <uuid>

Note: This is a Primary Key.

entityId
required
string <uuid>
url
required
string <text>
entityName
required
string <text>
projectDefinitionId
required
string <uuid>

Note: This is a Foreign Key to projectDefinitions.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
  • "url": "string",
  • "entityName": "string",
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3"
}

/documentationOverrides

query Parameters
id
string
entityId
string
url
string
entityName
string
projectDefinitionId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/documentationOverrides

query Parameters
id
string
entityId
string
url
string
entityName
string
projectDefinitionId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

documentationOverrides

id
required
string <uuid>

Note: This is a Primary Key.

entityId
required
string <uuid>
url
required
string <text>
entityName
required
string <text>
projectDefinitionId
required
string <uuid>

Note: This is a Foreign Key to projectDefinitions.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
  • "url": "string",
  • "entityName": "string",
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3"
}

notes

/notes

query Parameters
id
string
folderId
string
noteCategoryId
string
outputVersionId
string
parentId
string
authorId
string
content
string
createdDate
string
updatedDate
string
isAutogenerated
string
isPinned
string
frame
string
reviewData
string
componentId
string
statusAuthorId
string
statusId
string
statusUpdatedDate
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/notes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

notes

id
required
string <uuid>

Note: This is a Primary Key.

folderId
required
string <uuid>

Note: This is a Foreign Key to folders.id.

noteCategoryId
required
string <uuid>

Note: This is a Foreign Key to noteCategories.id.

outputVersionId
string <uuid>

Note: This is a Foreign Key to outputVersions.id.

parentId
string <uuid>

Note: This is a Foreign Key to notes.id.

authorId
required
string <uuid>

Note: This is a Foreign Key to users.id.

content
required
string <text>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
isAutogenerated
boolean <boolean>
isPinned
boolean <boolean>
frame
integer <integer>
reviewData
any <json>
componentId
string <uuid>

Note: This is a Foreign Key to components.id.

statusAuthorId
string <uuid>

Note: This is a Foreign Key to users.id.

statusId
string <uuid>

Note: This is a Foreign Key to statuses.id.

statusUpdatedDate
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "noteCategoryId": "13541544-e4ad-4ff3-a05d-037633a69751",
  • "outputVersionId": "45414408-e045-450b-939c-cf42e5d6e489",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  • "content": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "isAutogenerated": true,
  • "isPinned": true,
  • "frame": 0,
  • "reviewData": null,
  • "componentId": "616ccd92-d666-4180-8349-8d125b269fac",
  • "statusAuthorId": "63578153-968f-4679-93d8-d75e686e85c9",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
  • "statusUpdatedDate": "string"
}

/notes

query Parameters
id
string
folderId
string
noteCategoryId
string
outputVersionId
string
parentId
string
authorId
string
content
string
createdDate
string
updatedDate
string
isAutogenerated
string
isPinned
string
frame
string
reviewData
string
componentId
string
statusAuthorId
string
statusId
string
statusUpdatedDate
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/notes

query Parameters
id
string
folderId
string
noteCategoryId
string
outputVersionId
string
parentId
string
authorId
string
content
string
createdDate
string
updatedDate
string
isAutogenerated
string
isPinned
string
frame
string
reviewData
string
componentId
string
statusAuthorId
string
statusId
string
statusUpdatedDate
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

notes

id
required
string <uuid>

Note: This is a Primary Key.

folderId
required
string <uuid>

Note: This is a Foreign Key to folders.id.

noteCategoryId
required
string <uuid>

Note: This is a Foreign Key to noteCategories.id.

outputVersionId
string <uuid>

Note: This is a Foreign Key to outputVersions.id.

parentId
string <uuid>

Note: This is a Foreign Key to notes.id.

authorId
required
string <uuid>

Note: This is a Foreign Key to users.id.

content
required
string <text>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
isAutogenerated
boolean <boolean>
isPinned
boolean <boolean>
frame
integer <integer>
reviewData
any <json>
componentId
string <uuid>

Note: This is a Foreign Key to components.id.

statusAuthorId
string <uuid>

Note: This is a Foreign Key to users.id.

statusId
string <uuid>

Note: This is a Foreign Key to statuses.id.

statusUpdatedDate
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "noteCategoryId": "13541544-e4ad-4ff3-a05d-037633a69751",
  • "outputVersionId": "45414408-e045-450b-939c-cf42e5d6e489",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  • "content": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "isAutogenerated": true,
  • "isPinned": true,
  • "frame": 0,
  • "reviewData": null,
  • "componentId": "616ccd92-d666-4180-8349-8d125b269fac",
  • "statusAuthorId": "63578153-968f-4679-93d8-d75e686e85c9",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
  • "statusUpdatedDate": "string"
}

customAttributeBaseTypes

/customAttributeBaseTypes

query Parameters
id
string
attributeType
string
name
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/customAttributeBaseTypes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

customAttributeBaseTypes

id
required
string <uuid>

Note: This is a Primary Key.

attributeType
required
string <character varying> <= 128 characters
name
required
string <character varying> <= 128 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "attributeType": "string",
  • "name": "string"
}

/customAttributeBaseTypes

query Parameters
id
string
attributeType
string
name
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/customAttributeBaseTypes

query Parameters
id
string
attributeType
string
name
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

customAttributeBaseTypes

id
required
string <uuid>

Note: This is a Primary Key.

attributeType
required
string <character varying> <= 128 characters
name
required
string <character varying> <= 128 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "attributeType": "string",
  • "name": "string"
}

playlists

/playlists

query Parameters
id
string
name
string
description
string
authorId
string
projectId
string
link
string
externalLink
string
createdDate
string
updatedDate
string
properties
string
isActive
string
isPrivate
string
isClient
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/playlists

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

playlists

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 256 characters
description
string <text>
authorId
required
string <uuid>

Note: This is a Foreign Key to users.id.

projectId
required
string <uuid>

Note: This is a Foreign Key to projects.id.

link
string <character varying> <= 4096 characters
externalLink
string <character varying> <= 4096 characters
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
properties
any <jsonb>
isActive
required
boolean <boolean>
isPrivate
required
boolean <boolean>
isClient
required
boolean <boolean>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "link": "string",
  • "externalLink": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "properties": null,
  • "isActive": true,
  • "isPrivate": true,
  • "isClient": true
}

/playlists

query Parameters
id
string
name
string
description
string
authorId
string
projectId
string
link
string
externalLink
string
createdDate
string
updatedDate
string
properties
string
isActive
string
isPrivate
string
isClient
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/playlists

query Parameters
id
string
name
string
description
string
authorId
string
projectId
string
link
string
externalLink
string
createdDate
string
updatedDate
string
properties
string
isActive
string
isPrivate
string
isClient
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

playlists

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 256 characters
description
string <text>
authorId
required
string <uuid>

Note: This is a Foreign Key to users.id.

projectId
required
string <uuid>

Note: This is a Foreign Key to projects.id.

link
string <character varying> <= 4096 characters
externalLink
string <character varying> <= 4096 characters
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
properties
any <jsonb>
isActive
required
boolean <boolean>
isPrivate
required
boolean <boolean>
isClient
required
boolean <boolean>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "link": "string",
  • "externalLink": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "properties": null,
  • "isActive": true,
  • "isPrivate": true,
  • "isClient": true
}

outputVersions

/outputVersions

query Parameters
id
string
outputId
string
statusId
string
authorId
string
versionNumber
string
comment
string
createdDate
string
updatedDate
string
isMain
string
isClientVersion
string
isAutogenerated
string
properties
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/outputVersions

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

outputVersions

id
required
string <uuid>

Note: This is a Primary Key.

outputId
required
string <uuid>

Note: This is a Foreign Key to outputs.id.

statusId
required
string <uuid>

Note: This is a Foreign Key to statuses.id.

authorId
required
string <uuid>

Note: This is a Foreign Key to users.id.

versionNumber
required
integer <smallint>
comment
string <character varying> <= 4096 characters
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
isMain
boolean <boolean>
isClientVersion
boolean <boolean>
isAutogenerated
boolean <boolean>
properties
any <jsonb>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "outputId": "fb9e8b67-f081-4d70-9c57-87248d395a66",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
  • "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  • "versionNumber": 0,
  • "comment": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "isMain": true,
  • "isClientVersion": true,
  • "isAutogenerated": true,
  • "properties": null
}

/outputVersions

query Parameters
id
string
outputId
string
statusId
string
authorId
string
versionNumber
string
comment
string
createdDate
string
updatedDate
string
isMain
string
isClientVersion
string
isAutogenerated
string
properties
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outputVersions

query Parameters
id
string
outputId
string
statusId
string
authorId
string
versionNumber
string
comment
string
createdDate
string
updatedDate
string
isMain
string
isClientVersion
string
isAutogenerated
string
properties
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

outputVersions

id
required
string <uuid>

Note: This is a Primary Key.

outputId
required
string <uuid>

Note: This is a Foreign Key to outputs.id.

statusId
required
string <uuid>

Note: This is a Foreign Key to statuses.id.

authorId
required
string <uuid>

Note: This is a Foreign Key to users.id.

versionNumber
required
integer <smallint>
comment
string <character varying> <= 4096 characters
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
isMain
boolean <boolean>
isClientVersion
boolean <boolean>
isAutogenerated
boolean <boolean>
properties
any <jsonb>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "outputId": "fb9e8b67-f081-4d70-9c57-87248d395a66",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
  • "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  • "versionNumber": 0,
  • "comment": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "isMain": true,
  • "isClientVersion": true,
  • "isAutogenerated": true,
  • "properties": null
}

events

/events

query Parameters
id
string
authorId
string
payload
string
status
string
topic
string
description
string
sender
string
createdDate
string
updatedDate
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/events

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

events

id
required
string <uuid>

Note: This is a Primary Key.

authorId
required
string <uuid>

Note: This is a Foreign Key to users.id.

payload
any <jsonb>
status
required
string <character varying> <= 128 characters
Default: "finished"
topic
required
string <text>
description
string <text>
sender
string <text>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  • "payload": null,
  • "status": "finished",
  • "topic": "string",
  • "description": "string",
  • "sender": "string",
  • "createdDate": "string",
  • "updatedDate": "string"
}

/events

query Parameters
id
string
authorId
string
payload
string
status
string
topic
string
description
string
sender
string
createdDate
string
updatedDate
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/events

query Parameters
id
string
authorId
string
payload
string
status
string
topic
string
description
string
sender
string
createdDate
string
updatedDate
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

events

id
required
string <uuid>

Note: This is a Primary Key.

authorId
required
string <uuid>

Note: This is a Foreign Key to users.id.

payload
any <jsonb>
status
required
string <character varying> <= 128 characters
Default: "finished"
topic
required
string <text>
description
string <text>
sender
string <text>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  • "payload": null,
  • "status": "finished",
  • "topic": "string",
  • "description": "string",
  • "sender": "string",
  • "createdDate": "string",
  • "updatedDate": "string"
}

assigneeRoles

/assigneeRoles

query Parameters
id
string
name
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/assigneeRoles

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

assigneeRoles

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

/assigneeRoles

query Parameters
id
string
name
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/assigneeRoles

query Parameters
id
string
name
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

assigneeRoles

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

publicHolidays

/publicHolidays

query Parameters
id
string
name
string
date
string
countryCode
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/publicHolidays

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

publicHolidays

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
date
required
string <text>
countryCode
required
string <text>
Default: ""

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "date": "string",
  • "countryCode": ""
}

/publicHolidays

query Parameters
id
string
name
string
date
string
countryCode
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/publicHolidays

query Parameters
id
string
name
string
date
string
countryCode
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

publicHolidays

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
date
required
string <text>
countryCode
required
string <text>
Default: ""

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "date": "string",
  • "countryCode": ""
}

documentations

/documentations

query Parameters
id
string
entityId
string
url
string
entityName
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/documentations

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

documentations

id
required
string <uuid>

Note: This is a Primary Key.

entityId
required
string <uuid>
url
required
string <text>
entityName
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
  • "url": "string",
  • "entityName": "string"
}

/documentations

query Parameters
id
string
entityId
string
url
string
entityName
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/documentations

query Parameters
id
string
entityId
string
url
string
entityName
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

documentations

id
required
string <uuid>

Note: This is a Primary Key.

entityId
required
string <uuid>
url
required
string <text>
entityName
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
  • "url": "string",
  • "entityName": "string"
}

statusMappingTags

/statusMappingTags

query Parameters
statusMappingId
string
tagId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/statusMappingTags

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

statusMappingTags

statusMappingId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to statusMappings.id.

tagId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to tags.id.

Responses

Request samples

Content type
{
  • "statusMappingId": "3d7b2661-580e-464d-81b8-6fa2053a5f90",
  • "tagId": "f69eb9f1-ae9f-4086-b25c-c39758a43fb3"
}

/statusMappingTags

query Parameters
statusMappingId
string
tagId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/statusMappingTags

query Parameters
statusMappingId
string
tagId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

statusMappingTags

statusMappingId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to statusMappings.id.

tagId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to tags.id.

Responses

Request samples

Content type
{
  • "statusMappingId": "3d7b2661-580e-464d-81b8-6fa2053a5f90",
  • "tagId": "f69eb9f1-ae9f-4086-b25c-c39758a43fb3"
}

outputFileTypes

/outputFileTypes

query Parameters
outputId
string
fileTypeId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/outputFileTypes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

outputFileTypes

outputId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to outputs.id.

fileTypeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to fileTypes.id.

Responses

Request samples

Content type
{
  • "outputId": "fb9e8b67-f081-4d70-9c57-87248d395a66",
  • "fileTypeId": "4e54faea-5a86-4e82-9bdd-545d4e485d6f"
}

/outputFileTypes

query Parameters
outputId
string
fileTypeId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outputFileTypes

query Parameters
outputId
string
fileTypeId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

outputFileTypes

outputId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to outputs.id.

fileTypeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to fileTypes.id.

Responses

Request samples

Content type
{
  • "outputId": "fb9e8b67-f081-4d70-9c57-87248d395a66",
  • "fileTypeId": "4e54faea-5a86-4e82-9bdd-545d4e485d6f"
}

projectAssignees

/projectAssignees

query Parameters
projectId
string
userId
string
assigneeRoleId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/projectAssignees

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

projectAssignees

projectId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projects.id.

userId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to users.id.

assigneeRoleId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to assigneeRoles.id.

Responses

Request samples

Content type
{
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "assigneeRoleId": "0e6ac67b-c717-49f7-bfc0-373174d8464f"
}

/projectAssignees

query Parameters
projectId
string
userId
string
assigneeRoleId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectAssignees

query Parameters
projectId
string
userId
string
assigneeRoleId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projectAssignees

projectId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projects.id.

userId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to users.id.

assigneeRoleId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to assigneeRoles.id.

Responses

Request samples

Content type
{
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "assigneeRoleId": "0e6ac67b-c717-49f7-bfc0-373174d8464f"
}

projectDefinitionPriorities

/projectDefinitionPriorities

query Parameters
projectDefinitionId
string
priorityId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/projectDefinitionPriorities

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

projectDefinitionPriorities

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

priorityId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to priorities.id.

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "priorityId": "a57eab25-838b-40cc-a576-57e4056f1d6c"
}

/projectDefinitionPriorities

query Parameters
projectDefinitionId
string
priorityId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionPriorities

query Parameters
projectDefinitionId
string
priorityId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projectDefinitionPriorities

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

priorityId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to priorities.id.

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "priorityId": "a57eab25-838b-40cc-a576-57e4056f1d6c"
}

applicationFileTypes

/applicationFileTypes

query Parameters
applicationId
string
fileTypeId
string
screenPriority
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/applicationFileTypes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

applicationFileTypes

applicationId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to applications.id.

fileTypeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to fileTypes.id.

screenPriority
integer <integer>

Responses

Request samples

Content type
{
  • "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
  • "fileTypeId": "4e54faea-5a86-4e82-9bdd-545d4e485d6f",
  • "screenPriority": 0
}

/applicationFileTypes

query Parameters
applicationId
string
fileTypeId
string
screenPriority
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/applicationFileTypes

query Parameters
applicationId
string
fileTypeId
string
screenPriority
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

applicationFileTypes

applicationId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to applications.id.

fileTypeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to fileTypes.id.

screenPriority
integer <integer>

Responses

Request samples

Content type
{
  • "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
  • "fileTypeId": "4e54faea-5a86-4e82-9bdd-545d4e485d6f",
  • "screenPriority": 0
}

projectDefinitionActivityTypes

/projectDefinitionActivityTypes

query Parameters
projectDefinitionId
string
activityTypeId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/projectDefinitionActivityTypes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

projectDefinitionActivityTypes

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

activityTypeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to activityTypes.id.

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "activityTypeId": "327e8847-07f0-4581-84bf-4b7ae3174603"
}

/projectDefinitionActivityTypes

query Parameters
projectDefinitionId
string
activityTypeId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionActivityTypes

query Parameters
projectDefinitionId
string
activityTypeId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projectDefinitionActivityTypes

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

activityTypeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to activityTypes.id.

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "activityTypeId": "327e8847-07f0-4581-84bf-4b7ae3174603"
}

activities

/activities

query Parameters
id
string
folderId
string
activityTypeId
string
authorId
string
createdDate
string
updatedDate
string
action
string
changes
string
contextType
string
data
string
contextId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/activities

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

activities

id
required
string <uuid>

Note: This is a Primary Key.

folderId
required
string <uuid>

Note: This is a Foreign Key to folders.id.

activityTypeId
required
string <uuid>

Note: This is a Foreign Key to activityTypes.id.

authorId
required
string <uuid>
Default: "00000000-0000-0000-0000-000000000000"

Note: This is a Foreign Key to users.id.

createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
action
string <character varying> <= 128 characters
changes
any <jsonb>
contextType
string <character varying> <= 128 characters
data
any <jsonb>
contextId
string <uuid>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "activityTypeId": "327e8847-07f0-4581-84bf-4b7ae3174603",
  • "authorId": "00000000-0000-0000-0000-000000000000",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "action": "string",
  • "changes": null,
  • "contextType": "string",
  • "data": null,
  • "contextId": "84451116-c600-49e2-9c60-5b6b34fae0d6"
}

/activities

query Parameters
id
string
folderId
string
activityTypeId
string
authorId
string
createdDate
string
updatedDate
string
action
string
changes
string
contextType
string
data
string
contextId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/activities

query Parameters
id
string
folderId
string
activityTypeId
string
authorId
string
createdDate
string
updatedDate
string
action
string
changes
string
contextType
string
data
string
contextId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

activities

id
required
string <uuid>

Note: This is a Primary Key.

folderId
required
string <uuid>

Note: This is a Foreign Key to folders.id.

activityTypeId
required
string <uuid>

Note: This is a Foreign Key to activityTypes.id.

authorId
required
string <uuid>
Default: "00000000-0000-0000-0000-000000000000"

Note: This is a Foreign Key to users.id.

createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
action
string <character varying> <= 128 characters
changes
any <jsonb>
contextType
string <character varying> <= 128 characters
data
any <jsonb>
contextId
string <uuid>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "activityTypeId": "327e8847-07f0-4581-84bf-4b7ae3174603",
  • "authorId": "00000000-0000-0000-0000-000000000000",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "action": "string",
  • "changes": null,
  • "contextType": "string",
  • "data": null,
  • "contextId": "84451116-c600-49e2-9c60-5b6b34fae0d6"
}

userWeekDays

/userWeekDays

query Parameters
userId
string
weekDayId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/userWeekDays

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

userWeekDays

userId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to users.id.

weekDayId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to weekDays.id.

Responses

Request samples

Content type
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "weekDayId": "a972f9bd-e527-425b-a04c-dec3932e281e"
}

/userWeekDays

query Parameters
userId
string
weekDayId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/userWeekDays

query Parameters
userId
string
weekDayId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

userWeekDays

userId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to users.id.

weekDayId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to weekDays.id.

Responses

Request samples

Content type
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "weekDayId": "a972f9bd-e527-425b-a04c-dec3932e281e"
}

statuses

/statuses

query Parameters
id
string
stateId
string
name
string
shortName
string
codeName
string
icon
string
color
string
canBeUsedForFolder
string
canBeUsedForOutput
string
screenPriority
string
isCore
string
frameIOLabelId
string
ftrackStatusId
string
canBeUsedForNote
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/statuses

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

statuses

id
required
string <uuid>

Note: This is a Primary Key.

stateId
required
string <uuid>

Note: This is a Foreign Key to states.id.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
canBeUsedForFolder
required
boolean <boolean>
canBeUsedForOutput
required
boolean <boolean>
screenPriority
integer <integer>
isCore
required
boolean <boolean>
Default: false
frameIOLabelId
string <uuid>

Note: This is a Foreign Key to frameIOLabels.id.

ftrackStatusId
string <uuid>
canBeUsedForNote
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "stateId": "871bb69c-5872-42b2-88b0-72e9da663aaa",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "canBeUsedForFolder": true,
  • "canBeUsedForOutput": true,
  • "screenPriority": 0,
  • "isCore": false,
  • "frameIOLabelId": "e3a52328-fbdd-42a8-bdee-0b9f31b9f5b2",
  • "ftrackStatusId": "188e2506-369c-4d23-a2c4-4b0ace88078d",
  • "canBeUsedForNote": false
}

/statuses

query Parameters
id
string
stateId
string
name
string
shortName
string
codeName
string
icon
string
color
string
canBeUsedForFolder
string
canBeUsedForOutput
string
screenPriority
string
isCore
string
frameIOLabelId
string
ftrackStatusId
string
canBeUsedForNote
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/statuses

query Parameters
id
string
stateId
string
name
string
shortName
string
codeName
string
icon
string
color
string
canBeUsedForFolder
string
canBeUsedForOutput
string
screenPriority
string
isCore
string
frameIOLabelId
string
ftrackStatusId
string
canBeUsedForNote
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

statuses

id
required
string <uuid>

Note: This is a Primary Key.

stateId
required
string <uuid>

Note: This is a Foreign Key to states.id.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
canBeUsedForFolder
required
boolean <boolean>
canBeUsedForOutput
required
boolean <boolean>
screenPriority
integer <integer>
isCore
required
boolean <boolean>
Default: false
frameIOLabelId
string <uuid>

Note: This is a Foreign Key to frameIOLabels.id.

ftrackStatusId
string <uuid>
canBeUsedForNote
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "stateId": "871bb69c-5872-42b2-88b0-72e9da663aaa",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "canBeUsedForFolder": true,
  • "canBeUsedForOutput": true,
  • "screenPriority": 0,
  • "isCore": false,
  • "frameIOLabelId": "e3a52328-fbdd-42a8-bdee-0b9f31b9f5b2",
  • "ftrackStatusId": "188e2506-369c-4d23-a2c4-4b0ace88078d",
  • "canBeUsedForNote": false
}

outputActions

/outputActions

query Parameters
outputId
string
actionId
string
statusIds
string
order
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/outputActions

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

outputActions

outputId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to outputs.id.

actionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to actions.id.

statusIds
required
Array of strings
order
required
integer <integer>

Responses

Request samples

Content type
{
  • "outputId": "fb9e8b67-f081-4d70-9c57-87248d395a66",
  • "actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0",
  • "statusIds": [
    ],
  • "order": 0
}

/outputActions

query Parameters
outputId
string
actionId
string
statusIds
string
order
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outputActions

query Parameters
outputId
string
actionId
string
statusIds
string
order
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

outputActions

outputId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to outputs.id.

actionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to actions.id.

statusIds
required
Array of strings
order
required
integer <integer>

Responses

Request samples

Content type
{
  • "outputId": "fb9e8b67-f081-4d70-9c57-87248d395a66",
  • "actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0",
  • "statusIds": [
    ],
  • "order": 0
}

actions

/actions

query Parameters
id
string
name
string
runLocal
string
isAutomatic
string
data
string
description
string
group
string
icon
string
label
string
version
string
outputTemplateId
string
isQuickMenuAction
string
screenPriority
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/actions

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

actions

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
runLocal
required
boolean <boolean>
isAutomatic
required
boolean <boolean>
data
any <jsonb>
description
string <character varying> <= 4096 characters
group
string <text>
icon
required
string <character varying> <= 128 characters
Default: ""
label
string <text>
version
required
string <character varying> <= 128 characters
Default: ""
outputTemplateId
string <uuid>

Note: This is a Foreign Key to outputTemplates.id.

isQuickMenuAction
required
boolean <boolean>
Default: false
screenPriority
integer <integer>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "runLocal": true,
  • "isAutomatic": true,
  • "data": null,
  • "description": "string",
  • "group": "string",
  • "icon": "",
  • "label": "string",
  • "version": "",
  • "outputTemplateId": "f14fd8ed-53d4-4582-b141-ef3b56c5117e",
  • "isQuickMenuAction": false,
  • "screenPriority": 0
}

/actions

query Parameters
id
string
name
string
runLocal
string
isAutomatic
string
data
string
description
string
group
string
icon
string
label
string
version
string
outputTemplateId
string
isQuickMenuAction
string
screenPriority
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/actions

query Parameters
id
string
name
string
runLocal
string
isAutomatic
string
data
string
description
string
group
string
icon
string
label
string
version
string
outputTemplateId
string
isQuickMenuAction
string
screenPriority
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

actions

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
runLocal
required
boolean <boolean>
isAutomatic
required
boolean <boolean>
data
any <jsonb>
description
string <character varying> <= 4096 characters
group
string <text>
icon
required
string <character varying> <= 128 characters
Default: ""
label
string <text>
version
required
string <character varying> <= 128 characters
Default: ""
outputTemplateId
string <uuid>

Note: This is a Foreign Key to outputTemplates.id.

isQuickMenuAction
required
boolean <boolean>
Default: false
screenPriority
integer <integer>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "runLocal": true,
  • "isAutomatic": true,
  • "data": null,
  • "description": "string",
  • "group": "string",
  • "icon": "",
  • "label": "string",
  • "version": "",
  • "outputTemplateId": "f14fd8ed-53d4-4582-b141-ef3b56c5117e",
  • "isQuickMenuAction": false,
  • "screenPriority": 0
}

noteAttachments

/noteAttachments

query Parameters
noteId
string
attachmentId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/noteAttachments

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

noteAttachments

noteId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to notes.id.

attachmentId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to attachments.id.

Responses

Request samples

Content type
{
  • "noteId": "11bee8fe-2793-4911-9b27-a6f8473a2ccf",
  • "attachmentId": "96b9bbac-86d3-4497-9e0c-1f8e3803eddb"
}

/noteAttachments

query Parameters
noteId
string
attachmentId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/noteAttachments

query Parameters
noteId
string
attachmentId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

noteAttachments

noteId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to notes.id.

attachmentId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to attachments.id.

Responses

Request samples

Content type
{
  • "noteId": "11bee8fe-2793-4911-9b27-a6f8473a2ccf",
  • "attachmentId": "96b9bbac-86d3-4497-9e0c-1f8e3803eddb"
}

/cloudLinks

query Parameters
id
string
cloudApplicationId
string
componentId
string
link
string
originalId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/cloudLinks

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

cloudLinks

id
required
string <uuid>

Note: This is a Primary Key.

cloudApplicationId
string <uuid>
componentId
required
string <uuid>

Note: This is a Foreign Key to components.id.

link
string <character varying> <= 4096 characters
originalId
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "cloudApplicationId": "f1f15977-f2d0-4460-b28f-e48ddb5a9281",
  • "componentId": "616ccd92-d666-4180-8349-8d125b269fac",
  • "link": "string",
  • "originalId": "string"
}

/cloudLinks

query Parameters
id
string
cloudApplicationId
string
componentId
string
link
string
originalId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/cloudLinks

query Parameters
id
string
cloudApplicationId
string
componentId
string
link
string
originalId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

cloudLinks

id
required
string <uuid>

Note: This is a Primary Key.

cloudApplicationId
string <uuid>
componentId
required
string <uuid>

Note: This is a Foreign Key to components.id.

link
string <character varying> <= 4096 characters
originalId
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "cloudApplicationId": "f1f15977-f2d0-4460-b28f-e48ddb5a9281",
  • "componentId": "616ccd92-d666-4180-8349-8d125b269fac",
  • "link": "string",
  • "originalId": "string"
}

applicationVersions

/applicationVersions

query Parameters
id
string
applicationId
string
version
string
isActive
string
arguments
string
environment
string
executables
string
versionLabel
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/applicationVersions

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

applicationVersions

id
required
string <uuid>

Note: This is a Primary Key.

applicationId
required
string <uuid>

Note: This is a Foreign Key to applications.id.

version
string <character varying> <= 128 characters
isActive
required
boolean <boolean>
Default: true
arguments
any <jsonb>
environment
any <jsonb>
executables
any <jsonb>
versionLabel
string <character varying> <= 128 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
  • "version": "string",
  • "isActive": true,
  • "arguments": null,
  • "environment": null,
  • "executables": null,
  • "versionLabel": "string"
}

/applicationVersions

query Parameters
id
string
applicationId
string
version
string
isActive
string
arguments
string
environment
string
executables
string
versionLabel
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/applicationVersions

query Parameters
id
string
applicationId
string
version
string
isActive
string
arguments
string
environment
string
executables
string
versionLabel
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

applicationVersions

id
required
string <uuid>

Note: This is a Primary Key.

applicationId
required
string <uuid>

Note: This is a Foreign Key to applications.id.

version
string <character varying> <= 128 characters
isActive
required
boolean <boolean>
Default: true
arguments
any <jsonb>
environment
any <jsonb>
executables
any <jsonb>
versionLabel
string <character varying> <= 128 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
  • "version": "string",
  • "isActive": true,
  • "arguments": null,
  • "environment": null,
  • "executables": null,
  • "versionLabel": "string"
}

projectScenarios

/projectScenarios

query Parameters
id
string
projectId
string
name
string
structure
string
createdDate
string
updatedDate
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/projectScenarios

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

projectScenarios

id
required
string <uuid>

Note: This is a Primary Key.

projectId
string <uuid>

Note: This is a Foreign Key to projects.id.

name
required
string <character varying> <= 128 characters
structure
required
any <jsonb>
createdDate
string <timestamp with time zone>
Default: "now()"
updatedDate
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "name": "string",
  • "structure": null,
  • "createdDate": "now()",
  • "updatedDate": "string"
}

/projectScenarios

query Parameters
id
string
projectId
string
name
string
structure
string
createdDate
string
updatedDate
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectScenarios

query Parameters
id
string
projectId
string
name
string
structure
string
createdDate
string
updatedDate
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projectScenarios

id
required
string <uuid>

Note: This is a Primary Key.

projectId
string <uuid>

Note: This is a Foreign Key to projects.id.

name
required
string <character varying> <= 128 characters
structure
required
any <jsonb>
createdDate
string <timestamp with time zone>
Default: "now()"
updatedDate
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "name": "string",
  • "structure": null,
  • "createdDate": "now()",
  • "updatedDate": "string"
}

clients

/clients

query Parameters
id
string
name
string
description
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/clients

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

clients

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
description
string <character varying> <= 4096 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string"
}

/clients

query Parameters
id
string
name
string
description
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/clients

query Parameters
id
string
name
string
description
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

clients

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
description
string <character varying> <= 4096 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string"
}

projectDefinitionFolderTemplates

/projectDefinitionFolderTemplates

query Parameters
projectDefinitionId
string
folderTemplateId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/projectDefinitionFolderTemplates

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

projectDefinitionFolderTemplates

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

folderTemplateId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folderTemplates.id.

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "folderTemplateId": "fb81db22-0ba6-434c-a2b3-03ddd69524c1"
}

/projectDefinitionFolderTemplates

query Parameters
projectDefinitionId
string
folderTemplateId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionFolderTemplates

query Parameters
projectDefinitionId
string
folderTemplateId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projectDefinitionFolderTemplates

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

folderTemplateId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folderTemplates.id.

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "folderTemplateId": "fb81db22-0ba6-434c-a2b3-03ddd69524c1"
}

documentTemplates

/documentTemplates

query Parameters
id
string
ownerId
string
isPublic
string
content
string
name
string
description
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/documentTemplates

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

documentTemplates

id
required
string <uuid>

Note: This is a Primary Key.

ownerId
string <uuid>
isPublic
required
boolean <boolean>
content
required
any <jsonb>
name
required
string <text>
description
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "isPublic": true,
  • "content": null,
  • "name": "string",
  • "description": "string"
}

/documentTemplates

query Parameters
id
string
ownerId
string
isPublic
string
content
string
name
string
description
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/documentTemplates

query Parameters
id
string
ownerId
string
isPublic
string
content
string
name
string
description
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

documentTemplates

id
required
string <uuid>

Note: This is a Primary Key.

ownerId
string <uuid>
isPublic
required
boolean <boolean>
content
required
any <jsonb>
name
required
string <text>
description
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "isPublic": true,
  • "content": null,
  • "name": "string",
  • "description": "string"
}

folderTemplateFolderTemplates

/folderTemplateFolderTemplates

query Parameters
inputFolderTemplateId
string
outputFolderTemplateId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/folderTemplateFolderTemplates

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

folderTemplateFolderTemplates

inputFolderTemplateId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folderTemplates.id.

outputFolderTemplateId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folderTemplates.id.

Responses

Request samples

Content type
{
  • "inputFolderTemplateId": "f39a2753-96a0-4812-9a5a-e7edfff303fe",
  • "outputFolderTemplateId": "5c701b66-5961-4d78-bd8c-c5f173e83a4a"
}

/folderTemplateFolderTemplates

query Parameters
inputFolderTemplateId
string
outputFolderTemplateId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/folderTemplateFolderTemplates

query Parameters
inputFolderTemplateId
string
outputFolderTemplateId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

folderTemplateFolderTemplates

inputFolderTemplateId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folderTemplates.id.

outputFolderTemplateId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folderTemplates.id.

Responses

Request samples

Content type
{
  • "inputFolderTemplateId": "f39a2753-96a0-4812-9a5a-e7edfff303fe",
  • "outputFolderTemplateId": "5c701b66-5961-4d78-bd8c-c5f173e83a4a"
}

tap_funky

/tap_funky

query Parameters
oid
string
schema
string
name
string
owner
string
args
string
returns
string
langoid
string
is_strict
string
kind
string
is_definer
string
returns_set
string
volatility
string
is_visible
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

projectDefinitionTypes

/projectDefinitionTypes

query Parameters
projectDefinitionId
string
typeId
string
price
string
url
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/projectDefinitionTypes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

projectDefinitionTypes

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

typeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to types.id.

price
number <real>
Default: 0
url
string <text>

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "price": 0,
  • "url": "string"
}

/projectDefinitionTypes

query Parameters
projectDefinitionId
string
typeId
string
price
string
url
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionTypes

query Parameters
projectDefinitionId
string
typeId
string
price
string
url
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projectDefinitionTypes

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

typeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to types.id.

price
number <real>
Default: 0
url
string <text>

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "price": 0,
  • "url": "string"
}

projectDefinitions

/projectDefinitions

query Parameters
id
string
name
string
isActive
string
hasBasicFolderStructure
string
directoryStructureSettings
string
templates
string
defaultActivityTypeId
string
defaultFolderStatusId
string
defaultFolderTypeId
string
defaultNoteCategoryId
string
defaultOutputStatusId
string
defaultOutputTypeId
string
defaultPriorityId
string
defaultTypeId
string
roots
string
isDefault
string
outputNameSettings
string
templateNameProfiles
string
taskLinkPatterns
string
defaultTypePrice
string
createdDate
string
defaultNoteStatusId
string
updatedDate
string
defaultFolderTemplateId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/projectDefinitions

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

projectDefinitions

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
isActive
required
boolean <boolean>
hasBasicFolderStructure
required
boolean <boolean>
directoryStructureSettings
any <jsonb>
templates
any <jsonb>
defaultActivityTypeId
string <uuid>

Note: This is a Foreign Key to activityTypes.id.

defaultFolderStatusId
string <uuid>

Note: This is a Foreign Key to statuses.id.

defaultFolderTypeId
string <uuid>

Note: This is a Foreign Key to folderTypes.id.

defaultNoteCategoryId
string <uuid>

Note: This is a Foreign Key to noteCategories.id.

defaultOutputStatusId
string <uuid>

Note: This is a Foreign Key to statuses.id.

defaultOutputTypeId
string <uuid>

Note: This is a Foreign Key to outputTypes.id.

defaultPriorityId
string <uuid>

Note: This is a Foreign Key to priorities.id.

defaultTypeId
string <uuid>

Note: This is a Foreign Key to types.id.

roots
any <jsonb>
isDefault
required
boolean <boolean>
Default: false
outputNameSettings
any <jsonb>
templateNameProfiles
any <jsonb>
taskLinkPatterns
any <json>
defaultTypePrice
number <real>
createdDate
string <timestamp with time zone>
defaultNoteStatusId
string <uuid>

Note: This is a Foreign Key to statuses.id.

updatedDate
string <timestamp with time zone>
defaultFolderTemplateId
string <uuid>

Note: This is a Foreign Key to folderTemplates.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "isActive": true,
  • "hasBasicFolderStructure": true,
  • "directoryStructureSettings": null,
  • "templates": null,
  • "defaultActivityTypeId": "00291fa0-78e2-4d5a-acd2-b42448143822",
  • "defaultFolderStatusId": "1dc98437-74d9-4687-914d-15250e749a55",
  • "defaultFolderTypeId": "4cc025ef-5c65-4454-bce8-bed5427ac7f6",
  • "defaultNoteCategoryId": "cb4f3e51-9e91-4ab5-81e0-6282711794cb",
  • "defaultOutputStatusId": "21d4130a-6b06-4bbe-8044-8d6fbb92be95",
  • "defaultOutputTypeId": "2e035f64-f60a-487a-9f5d-0fb29ab8e7cb",
  • "defaultPriorityId": "75b6a5d9-61b4-42de-97f4-967eb0ed3cba",
  • "defaultTypeId": "43c48101-2d21-416e-9a52-aadf6c0be508",
  • "roots": null,
  • "isDefault": false,
  • "outputNameSettings": null,
  • "templateNameProfiles": null,
  • "taskLinkPatterns": null,
  • "defaultTypePrice": 0,
  • "createdDate": "string",
  • "defaultNoteStatusId": "05cd3b67-41e3-4de1-81c2-34a3cba85f4b",
  • "updatedDate": "string",
  • "defaultFolderTemplateId": "9e72dba2-7b63-4262-b419-bc60ccaac6be"
}

/projectDefinitions

query Parameters
id
string
name
string
isActive
string
hasBasicFolderStructure
string
directoryStructureSettings
string
templates
string
defaultActivityTypeId
string
defaultFolderStatusId
string
defaultFolderTypeId
string
defaultNoteCategoryId
string
defaultOutputStatusId
string
defaultOutputTypeId
string
defaultPriorityId
string
defaultTypeId
string
roots
string
isDefault
string
outputNameSettings
string
templateNameProfiles
string
taskLinkPatterns
string
defaultTypePrice
string
createdDate
string
defaultNoteStatusId
string
updatedDate
string
defaultFolderTemplateId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitions

query Parameters
id
string
name
string
isActive
string
hasBasicFolderStructure
string
directoryStructureSettings
string
templates
string
defaultActivityTypeId
string
defaultFolderStatusId
string
defaultFolderTypeId
string
defaultNoteCategoryId
string
defaultOutputStatusId
string
defaultOutputTypeId
string
defaultPriorityId
string
defaultTypeId
string
roots
string
isDefault
string
outputNameSettings
string
templateNameProfiles
string
taskLinkPatterns
string
defaultTypePrice
string
createdDate
string
defaultNoteStatusId
string
updatedDate
string
defaultFolderTemplateId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projectDefinitions

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
isActive
required
boolean <boolean>
hasBasicFolderStructure
required
boolean <boolean>
directoryStructureSettings
any <jsonb>
templates
any <jsonb>
defaultActivityTypeId
string <uuid>

Note: This is a Foreign Key to activityTypes.id.

defaultFolderStatusId
string <uuid>

Note: This is a Foreign Key to statuses.id.

defaultFolderTypeId
string <uuid>

Note: This is a Foreign Key to folderTypes.id.

defaultNoteCategoryId
string <uuid>

Note: This is a Foreign Key to noteCategories.id.

defaultOutputStatusId
string <uuid>

Note: This is a Foreign Key to statuses.id.

defaultOutputTypeId
string <uuid>

Note: This is a Foreign Key to outputTypes.id.

defaultPriorityId
string <uuid>

Note: This is a Foreign Key to priorities.id.

defaultTypeId
string <uuid>

Note: This is a Foreign Key to types.id.

roots
any <jsonb>
isDefault
required
boolean <boolean>
Default: false
outputNameSettings
any <jsonb>
templateNameProfiles
any <jsonb>
taskLinkPatterns
any <json>
defaultTypePrice
number <real>
createdDate
string <timestamp with time zone>
defaultNoteStatusId
string <uuid>

Note: This is a Foreign Key to statuses.id.

updatedDate
string <timestamp with time zone>
defaultFolderTemplateId
string <uuid>

Note: This is a Foreign Key to folderTemplates.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "isActive": true,
  • "hasBasicFolderStructure": true,
  • "directoryStructureSettings": null,
  • "templates": null,
  • "defaultActivityTypeId": "00291fa0-78e2-4d5a-acd2-b42448143822",
  • "defaultFolderStatusId": "1dc98437-74d9-4687-914d-15250e749a55",
  • "defaultFolderTypeId": "4cc025ef-5c65-4454-bce8-bed5427ac7f6",
  • "defaultNoteCategoryId": "cb4f3e51-9e91-4ab5-81e0-6282711794cb",
  • "defaultOutputStatusId": "21d4130a-6b06-4bbe-8044-8d6fbb92be95",
  • "defaultOutputTypeId": "2e035f64-f60a-487a-9f5d-0fb29ab8e7cb",
  • "defaultPriorityId": "75b6a5d9-61b4-42de-97f4-967eb0ed3cba",
  • "defaultTypeId": "43c48101-2d21-416e-9a52-aadf6c0be508",
  • "roots": null,
  • "isDefault": false,
  • "outputNameSettings": null,
  • "templateNameProfiles": null,
  • "taskLinkPatterns": null,
  • "defaultTypePrice": 0,
  • "createdDate": "string",
  • "defaultNoteStatusId": "05cd3b67-41e3-4de1-81c2-34a3cba85f4b",
  • "updatedDate": "string",
  • "defaultFolderTemplateId": "9e72dba2-7b63-4262-b419-bc60ccaac6be"
}

frameIOLabels

/frameIOLabels

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
isCore
string
statusId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/frameIOLabels

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

frameIOLabels

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
isCore
required
boolean <boolean>
statusId
string <uuid>

Note: This is a Foreign Key to statuses.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "isCore": true,
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645"
}

/frameIOLabels

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
isCore
string
statusId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/frameIOLabels

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
isCore
string
statusId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

frameIOLabels

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
isCore
required
boolean <boolean>
statusId
string <uuid>

Note: This is a Foreign Key to statuses.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "isCore": true,
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645"
}

projectDefinitionCustomAttributeDefinitions

/projectDefinitionCustomAttributeDefinitions

query Parameters
customAttributeDefinitionId
string
projectDefinitionId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/projectDefinitionCustomAttributeDefinitions

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

projectDefinitionCustomAttributeDefinitions

customAttributeDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to customAttributeDefinitions.id.

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

Responses

Request samples

Content type
{
  • "customAttributeDefinitionId": "db2a8d0c-8342-432d-a485-ecf2557c6103",
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3"
}

/projectDefinitionCustomAttributeDefinitions

query Parameters
customAttributeDefinitionId
string
projectDefinitionId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionCustomAttributeDefinitions

query Parameters
customAttributeDefinitionId
string
projectDefinitionId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projectDefinitionCustomAttributeDefinitions

customAttributeDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to customAttributeDefinitions.id.

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

Responses

Request samples

Content type
{
  • "customAttributeDefinitionId": "db2a8d0c-8342-432d-a485-ecf2557c6103",
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3"
}

notificationTypes

/notificationTypes

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
description
string
isCore
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/notificationTypes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

notificationTypes

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
description
string <text>
isCore
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "description": "string",
  • "isCore": false
}

/notificationTypes

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
description
string
isCore
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/notificationTypes

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
description
string
isCore
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

notificationTypes

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
description
string <text>
isCore
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "description": "string",
  • "isCore": false
}

views

/views

query Parameters
id
string
ownerId
string
isPublic
string
tableState
string
name
string
description
string
isForProjectView
string
isForVersionView
string
isForManagerView
string
folderTypeId
string
filter
string
viewGroupId
string
pivotMode
string
externalURL
string
folderId
string
projectId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/views

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

views

id
required
string <uuid>

Note: This is a Primary Key.

ownerId
string <uuid>
isPublic
required
boolean <boolean>
tableState
any <jsonb>
name
required
string <text>
description
string <text>
isForProjectView
required
boolean <boolean>
isForVersionView
required
boolean <boolean>
isForManagerView
required
boolean <boolean>
folderTypeId
string <uuid>
filter
string <text>
viewGroupId
string <uuid>

Note: This is a Foreign Key to viewGroups.id.

pivotMode
required
boolean <boolean>
Default: false
externalURL
string <text>
folderId
string <uuid>
projectId
string <uuid>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "isPublic": true,
  • "tableState": null,
  • "name": "string",
  • "description": "string",
  • "isForProjectView": true,
  • "isForVersionView": true,
  • "isForManagerView": true,
  • "folderTypeId": "71aced48-af8d-4945-986e-3673fa133f54",
  • "filter": "string",
  • "viewGroupId": "48a48f5a-0254-4b2d-9d67-3d59b4f210f9",
  • "pivotMode": false,
  • "externalURL": "string",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

/views

query Parameters
id
string
ownerId
string
isPublic
string
tableState
string
name
string
description
string
isForProjectView
string
isForVersionView
string
isForManagerView
string
folderTypeId
string
filter
string
viewGroupId
string
pivotMode
string
externalURL
string
folderId
string
projectId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/views

query Parameters
id
string
ownerId
string
isPublic
string
tableState
string
name
string
description
string
isForProjectView
string
isForVersionView
string
isForManagerView
string
folderTypeId
string
filter
string
viewGroupId
string
pivotMode
string
externalURL
string
folderId
string
projectId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

views

id
required
string <uuid>

Note: This is a Primary Key.

ownerId
string <uuid>
isPublic
required
boolean <boolean>
tableState
any <jsonb>
name
required
string <text>
description
string <text>
isForProjectView
required
boolean <boolean>
isForVersionView
required
boolean <boolean>
isForManagerView
required
boolean <boolean>
folderTypeId
string <uuid>
filter
string <text>
viewGroupId
string <uuid>

Note: This is a Foreign Key to viewGroups.id.

pivotMode
required
boolean <boolean>
Default: false
externalURL
string <text>
folderId
string <uuid>
projectId
string <uuid>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "isPublic": true,
  • "tableState": null,
  • "name": "string",
  • "description": "string",
  • "isForProjectView": true,
  • "isForVersionView": true,
  • "isForManagerView": true,
  • "folderTypeId": "71aced48-af8d-4945-986e-3673fa133f54",
  • "filter": "string",
  • "viewGroupId": "48a48f5a-0254-4b2d-9d67-3d59b4f210f9",
  • "pivotMode": false,
  • "externalURL": "string",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

serverInfo

/serverInfo

query Parameters
id
string
version
string
createdDate
string
updatedDate
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/serverInfo

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

serverInfo

id
required
integer <integer>

Note: This is a Primary Key.

version
required
string <text>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "id": 0,
  • "version": "string",
  • "createdDate": "string",
  • "updatedDate": "string"
}

/serverInfo

query Parameters
id
string
version
string
createdDate
string
updatedDate
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/serverInfo

query Parameters
id
string
version
string
createdDate
string
updatedDate
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

serverInfo

id
required
integer <integer>

Note: This is a Primary Key.

version
required
string <text>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "id": 0,
  • "version": "string",
  • "createdDate": "string",
  • "updatedDate": "string"
}

projectDefinitionNoteStatuses

/projectDefinitionNoteStatuses

query Parameters
projectDefinitionId
string
statusId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/projectDefinitionNoteStatuses

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

projectDefinitionNoteStatuses

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

statusId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to statuses.id.

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645"
}

/projectDefinitionNoteStatuses

query Parameters
projectDefinitionId
string
statusId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionNoteStatuses

query Parameters
projectDefinitionId
string
statusId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projectDefinitionNoteStatuses

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

statusId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to statuses.id.

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645"
}

folderTemplates

/folderTemplates

query Parameters
id
string
folderTypeId
string
typeId
string
parentId
string
statusId
string
name
string
shortName
string
codeName
string
icon
string
color
string
folderTemplateName
string
folderTemplateCodeName
string
description
string
plannedHours
string
priorityId
string
biddingOverrideId
string
folderTemplateDescription
string
creationOrder
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/folderTemplates

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

folderTemplates

id
required
string <uuid>

Note: This is a Primary Key.

folderTypeId
string <uuid>

Note: This is a Foreign Key to folderTypes.id.

typeId
string <uuid>

Note: This is a Foreign Key to types.id.

parentId
string <uuid>

Note: This is a Foreign Key to folderTemplates.id.

statusId
string <uuid>

Note: This is a Foreign Key to statuses.id.

name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
folderTemplateName
string <character varying> <= 128 characters
folderTemplateCodeName
string <character varying> <= 128 characters
description
string <character varying> <= 4096 characters
plannedHours
number <numeric>
priorityId
string <uuid>

Note: This is a Foreign Key to priorities.id.

biddingOverrideId
string <uuid>

Note: This is a Foreign Key to biddingOverrides.id.

folderTemplateDescription
string <text>
creationOrder
required
integer <integer>
Default: 0

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folderTypeId": "71aced48-af8d-4945-986e-3673fa133f54",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "folderTemplateName": "string",
  • "folderTemplateCodeName": "string",
  • "description": "string",
  • "plannedHours": 0,
  • "priorityId": "a57eab25-838b-40cc-a576-57e4056f1d6c",
  • "biddingOverrideId": "5f805e68-03a5-48f5-8582-a5bd33940521",
  • "folderTemplateDescription": "string",
  • "creationOrder": 0
}

/folderTemplates

query Parameters
id
string
folderTypeId
string
typeId
string
parentId
string
statusId
string
name
string
shortName
string
codeName
string
icon
string
color
string
folderTemplateName
string
folderTemplateCodeName
string
description
string
plannedHours
string
priorityId
string
biddingOverrideId
string
folderTemplateDescription
string
creationOrder
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/folderTemplates

query Parameters
id
string
folderTypeId
string
typeId
string
parentId
string
statusId
string
name
string
shortName
string
codeName
string
icon
string
color
string
folderTemplateName
string
folderTemplateCodeName
string
description
string
plannedHours
string
priorityId
string
biddingOverrideId
string
folderTemplateDescription
string
creationOrder
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

folderTemplates

id
required
string <uuid>

Note: This is a Primary Key.

folderTypeId
string <uuid>

Note: This is a Foreign Key to folderTypes.id.

typeId
string <uuid>

Note: This is a Foreign Key to types.id.

parentId
string <uuid>

Note: This is a Foreign Key to folderTemplates.id.

statusId
string <uuid>

Note: This is a Foreign Key to statuses.id.

name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
folderTemplateName
string <character varying> <= 128 characters
folderTemplateCodeName
string <character varying> <= 128 characters
description
string <character varying> <= 4096 characters
plannedHours
number <numeric>
priorityId
string <uuid>

Note: This is a Foreign Key to priorities.id.

biddingOverrideId
string <uuid>

Note: This is a Foreign Key to biddingOverrides.id.

folderTemplateDescription
string <text>
creationOrder
required
integer <integer>
Default: 0

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folderTypeId": "71aced48-af8d-4945-986e-3673fa133f54",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "folderTemplateName": "string",
  • "folderTemplateCodeName": "string",
  • "description": "string",
  • "plannedHours": 0,
  • "priorityId": "a57eab25-838b-40cc-a576-57e4056f1d6c",
  • "biddingOverrideId": "5f805e68-03a5-48f5-8582-a5bd33940521",
  • "folderTemplateDescription": "string",
  • "creationOrder": 0
}

statusMappingStatuses

/statusMappingStatuses

query Parameters
statusMappingId
string
statusId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/statusMappingStatuses

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

statusMappingStatuses

statusMappingId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to statusMappings.id.

statusId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to statuses.id.

Responses

Request samples

Content type
{
  • "statusMappingId": "3d7b2661-580e-464d-81b8-6fa2053a5f90",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645"
}

/statusMappingStatuses

query Parameters
statusMappingId
string
statusId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/statusMappingStatuses

query Parameters
statusMappingId
string
statusId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

statusMappingStatuses

statusMappingId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to statusMappings.id.

statusId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to statuses.id.

Responses

Request samples

Content type
{
  • "statusMappingId": "3d7b2661-580e-464d-81b8-6fa2053a5f90",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645"
}

folderFolders

/folderFolders

query Parameters
inputFolderId
string
outputFolderId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/folderFolders

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

folderFolders

inputFolderId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folders.id.

outputFolderId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folders.id.

Responses

Request samples

Content type
{
  • "inputFolderId": "a7651ddc-f867-430f-8005-d9e32691c64d",
  • "outputFolderId": "4b981e32-0ac7-4f28-b1b6-c3e6c3e77d95"
}

/folderFolders

query Parameters
inputFolderId
string
outputFolderId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/folderFolders

query Parameters
inputFolderId
string
outputFolderId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

folderFolders

inputFolderId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folders.id.

outputFolderId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folders.id.

Responses

Request samples

Content type
{
  • "inputFolderId": "a7651ddc-f867-430f-8005-d9e32691c64d",
  • "outputFolderId": "4b981e32-0ac7-4f28-b1b6-c3e6c3e77d95"
}

paymentStatuses

/paymentStatuses

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
screenPriority
string
locksEditing
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/paymentStatuses

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

paymentStatuses

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
integer <integer>
locksEditing
required
boolean <boolean>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "screenPriority": 0,
  • "locksEditing": true
}

/paymentStatuses

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
screenPriority
string
locksEditing
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/paymentStatuses

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
screenPriority
string
locksEditing
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

paymentStatuses

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
integer <integer>
locksEditing
required
boolean <boolean>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "screenPriority": 0,
  • "locksEditing": true
}

priorities

/priorities

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
value
string
screenPriority
string
isCore
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/priorities

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

priorities

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
value
integer <smallint>
screenPriority
integer <integer>
isCore
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "value": 0,
  • "screenPriority": 0,
  • "isCore": false
}

/priorities

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
value
string
screenPriority
string
isCore
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/priorities

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
value
string
screenPriority
string
isCore
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

priorities

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
value
integer <smallint>
screenPriority
integer <integer>
isCore
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "value": 0,
  • "screenPriority": 0,
  • "isCore": false
}

viewGroups

/viewGroups

query Parameters
id
string
name
string
screenPriority
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/viewGroups

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

viewGroups

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
screenPriority
integer <integer>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "screenPriority": 0
}

/viewGroups

query Parameters
id
string
name
string
screenPriority
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/viewGroups

query Parameters
id
string
name
string
screenPriority
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

viewGroups

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
screenPriority
integer <integer>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "screenPriority": 0
}

userAvailabilities

/userAvailabilities

query Parameters
id
string
userId
string
weekDayId
string
workTimeStart
string
workTimeEnd
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/userAvailabilities

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

userAvailabilities

id
required
string <uuid>

Note: This is a Primary Key.

userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

weekDayId
required
string <uuid>

Note: This is a Foreign Key to weekDays.id.

workTimeStart
required
string <interval>
workTimeEnd
required
string <interval>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "weekDayId": "a972f9bd-e527-425b-a04c-dec3932e281e",
  • "workTimeStart": "string",
  • "workTimeEnd": "string"
}

/userAvailabilities

query Parameters
id
string
userId
string
weekDayId
string
workTimeStart
string
workTimeEnd
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/userAvailabilities

query Parameters
id
string
userId
string
weekDayId
string
workTimeStart
string
workTimeEnd
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

userAvailabilities

id
required
string <uuid>

Note: This is a Primary Key.

userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

weekDayId
required
string <uuid>

Note: This is a Foreign Key to weekDays.id.

workTimeStart
required
string <interval>
workTimeEnd
required
string <interval>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "weekDayId": "a972f9bd-e527-425b-a04c-dec3932e281e",
  • "workTimeStart": "string",
  • "workTimeEnd": "string"
}

projectDefinitionFolderTypes

/projectDefinitionFolderTypes

query Parameters
projectDefinitionId
string
folderTypeId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/projectDefinitionFolderTypes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

projectDefinitionFolderTypes

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

folderTypeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folderTypes.id.

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "folderTypeId": "71aced48-af8d-4945-986e-3673fa133f54"
}

/projectDefinitionFolderTypes

query Parameters
projectDefinitionId
string
folderTypeId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionFolderTypes

query Parameters
projectDefinitionId
string
folderTypeId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projectDefinitionFolderTypes

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

folderTypeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folderTypes.id.

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "folderTypeId": "71aced48-af8d-4945-986e-3673fa133f54"
}

folders

/folders

query Parameters
id
string
projectId
string
folderTypeId
string
priorityId
string
statusId
string
typeId
string
parentId
string
name
string
shortName
string
codeName
string
icon
string
color
string
isHiddenable
string
description
string
startDate
string
endDate
string
createdDate
string
updatedDate
string
plannedHours
string
bidPrice
string
usedHours
string
codaioPageId
string
codaioBrowserLink
string
bidHours
string
availableToStartConflict
string
invoiceNo
string
invoicedHours
string
availableToStart
string
deadline
string
importanceNo
string
downstreamHoursTotal
string
latestDeadline
string
latestAvailableToStart
string
mustStartOn
string
soonestAvailableToStart
string
preferredAssignee
string
value
string
softAssigneeId
string
upstreamHoursCritical
string
deadlineConflict
string
spentHoursDiffecence
string
qnote
string
lastTask
string
sprint
string
properties
string
downstreamHoursCritical
string
downstreamHoursDirect
string
lastClientNoteDate
string
lastNoteDate
string
fixPrice
string
sourceFolderTemplateId
string
sourceFolderTemplateItemId
string
billPrice
string
laborCost
string
creationOrder
string
deletedDate
string
isDeleted
string
documentId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/folders

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

folders

id
required
string <uuid>

Note: This is a Primary Key.

projectId
required
string <uuid>

Note: This is a Foreign Key to projects.id.

folderTypeId
string <uuid>

Note: This is a Foreign Key to folderTypes.id.

priorityId
required
string <uuid>

Note: This is a Foreign Key to priorities.id.

statusId
required
string <uuid>

Note: This is a Foreign Key to statuses.id.

typeId
string <uuid>

Note: This is a Foreign Key to types.id.

parentId
string <uuid>

Note: This is a Foreign Key to folders.id.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
isHiddenable
boolean <boolean>
description
string <character varying> <= 4096 characters
startDate
string <timestamp with time zone>
endDate
string <timestamp with time zone>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
plannedHours
number <numeric>
bidPrice
number <numeric>
usedHours
number <numeric>
codaioPageId
string <text>
codaioBrowserLink
string <text>
bidHours
number <real>
availableToStartConflict
boolean <boolean>
invoiceNo
string <text>
invoicedHours
number <real>
availableToStart
string <timestamp with time zone>
deadline
string <timestamp with time zone>
importanceNo
integer <integer>
downstreamHoursTotal
number <real>
latestDeadline
string <timestamp with time zone>
latestAvailableToStart
string <timestamp with time zone>
mustStartOn
string <timestamp with time zone>
soonestAvailableToStart
string <timestamp with time zone>
preferredAssignee
string <uuid>
value
number <real>
softAssigneeId
string <uuid>

Note: This is a Foreign Key to users.id.

upstreamHoursCritical
number <real>
deadlineConflict
boolean <boolean>
spentHoursDiffecence
number <real>
qnote
string <text>
lastTask
string <text>
sprint
string <text>
properties
any <jsonb>
downstreamHoursCritical
number <real>
downstreamHoursDirect
number <real>
lastClientNoteDate
string <timestamp with time zone>
lastNoteDate
string <timestamp with time zone>
fixPrice
number <numeric>
sourceFolderTemplateId
string <uuid>

Note: This is a Foreign Key to folderTemplates.id.

sourceFolderTemplateItemId
string <uuid>

Note: This is a Foreign Key to folderTemplates.id.

billPrice
number <numeric>
laborCost
number <numeric>
creationOrder
required
integer <integer>
deletedDate
string <timestamp with time zone>
isDeleted
required
boolean <boolean>
Default: false
documentId
string <uuid>

Note: This is a Foreign Key to documents.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "folderTypeId": "71aced48-af8d-4945-986e-3673fa133f54",
  • "priorityId": "a57eab25-838b-40cc-a576-57e4056f1d6c",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "isHiddenable": true,
  • "description": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "plannedHours": 0,
  • "bidPrice": 0,
  • "usedHours": 0,
  • "codaioPageId": "string",
  • "codaioBrowserLink": "string",
  • "bidHours": 0,
  • "availableToStartConflict": true,
  • "invoiceNo": "string",
  • "invoicedHours": 0,
  • "availableToStart": "string",
  • "deadline": "string",
  • "importanceNo": 0,
  • "downstreamHoursTotal": 0,
  • "latestDeadline": "string",
  • "latestAvailableToStart": "string",
  • "mustStartOn": "string",
  • "soonestAvailableToStart": "string",
  • "preferredAssignee": "a8ac3f50-5cca-4ac9-b099-093e1904ac00",
  • "value": 0,
  • "softAssigneeId": "9dd2ab54-eda7-4736-b231-3f621dc84e14",
  • "upstreamHoursCritical": 0,
  • "deadlineConflict": true,
  • "spentHoursDiffecence": 0,
  • "qnote": "string",
  • "lastTask": "string",
  • "sprint": "string",
  • "properties": null,
  • "downstreamHoursCritical": 0,
  • "downstreamHoursDirect": 0,
  • "lastClientNoteDate": "string",
  • "lastNoteDate": "string",
  • "fixPrice": 0,
  • "sourceFolderTemplateId": "05571189-246b-40ad-a78a-23ad25f6b5cf",
  • "sourceFolderTemplateItemId": "93ff0f03-b857-416d-9eb5-348c46465b44",
  • "billPrice": 0,
  • "laborCost": 0,
  • "creationOrder": 0,
  • "deletedDate": "string",
  • "isDeleted": false,
  • "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052"
}

/folders

query Parameters
id
string
projectId
string
folderTypeId
string
priorityId
string
statusId
string
typeId
string
parentId
string
name
string
shortName
string
codeName
string
icon
string
color
string
isHiddenable
string
description
string
startDate
string
endDate
string
createdDate
string
updatedDate
string
plannedHours
string
bidPrice
string
usedHours
string
codaioPageId
string
codaioBrowserLink
string
bidHours
string
availableToStartConflict
string
invoiceNo
string
invoicedHours
string
availableToStart
string
deadline
string
importanceNo
string
downstreamHoursTotal
string
latestDeadline
string
latestAvailableToStart
string
mustStartOn
string
soonestAvailableToStart
string
preferredAssignee
string
value
string
softAssigneeId
string
upstreamHoursCritical
string
deadlineConflict
string
spentHoursDiffecence
string
qnote
string
lastTask
string
sprint
string
properties
string
downstreamHoursCritical
string
downstreamHoursDirect
string
lastClientNoteDate
string
lastNoteDate
string
fixPrice
string
sourceFolderTemplateId
string
sourceFolderTemplateItemId
string
billPrice
string
laborCost
string
creationOrder
string
deletedDate
string
isDeleted
string
documentId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/folders

query Parameters
id
string
projectId
string
folderTypeId
string
priorityId
string
statusId
string
typeId
string
parentId
string
name
string
shortName
string
codeName
string
icon
string
color
string
isHiddenable
string
description
string
startDate
string
endDate
string
createdDate
string
updatedDate
string
plannedHours
string
bidPrice
string
usedHours
string
codaioPageId
string
codaioBrowserLink
string
bidHours
string
availableToStartConflict
string
invoiceNo
string
invoicedHours
string
availableToStart
string
deadline
string
importanceNo
string
downstreamHoursTotal
string
latestDeadline
string
latestAvailableToStart
string
mustStartOn
string
soonestAvailableToStart
string
preferredAssignee
string
value
string
softAssigneeId
string
upstreamHoursCritical
string
deadlineConflict
string
spentHoursDiffecence
string
qnote
string
lastTask
string
sprint
string
properties
string
downstreamHoursCritical
string
downstreamHoursDirect
string
lastClientNoteDate
string
lastNoteDate
string
fixPrice
string
sourceFolderTemplateId
string
sourceFolderTemplateItemId
string
billPrice
string
laborCost
string
creationOrder
string
deletedDate
string
isDeleted
string
documentId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

folders

id
required
string <uuid>

Note: This is a Primary Key.

projectId
required
string <uuid>

Note: This is a Foreign Key to projects.id.

folderTypeId
string <uuid>

Note: This is a Foreign Key to folderTypes.id.

priorityId
required
string <uuid>

Note: This is a Foreign Key to priorities.id.

statusId
required
string <uuid>

Note: This is a Foreign Key to statuses.id.

typeId
string <uuid>

Note: This is a Foreign Key to types.id.

parentId
string <uuid>

Note: This is a Foreign Key to folders.id.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
isHiddenable
boolean <boolean>
description
string <character varying> <= 4096 characters
startDate
string <timestamp with time zone>
endDate
string <timestamp with time zone>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
plannedHours
number <numeric>
bidPrice
number <numeric>
usedHours
number <numeric>
codaioPageId
string <text>
codaioBrowserLink
string <text>
bidHours
number <real>
availableToStartConflict
boolean <boolean>
invoiceNo
string <text>
invoicedHours
number <real>
availableToStart
string <timestamp with time zone>
deadline
string <timestamp with time zone>
importanceNo
integer <integer>
downstreamHoursTotal
number <real>
latestDeadline
string <timestamp with time zone>
latestAvailableToStart
string <timestamp with time zone>
mustStartOn
string <timestamp with time zone>
soonestAvailableToStart
string <timestamp with time zone>
preferredAssignee
string <uuid>
value
number <real>
softAssigneeId
string <uuid>

Note: This is a Foreign Key to users.id.

upstreamHoursCritical
number <real>
deadlineConflict
boolean <boolean>
spentHoursDiffecence
number <real>
qnote
string <text>
lastTask
string <text>
sprint
string <text>
properties
any <jsonb>
downstreamHoursCritical
number <real>
downstreamHoursDirect
number <real>
lastClientNoteDate
string <timestamp with time zone>
lastNoteDate
string <timestamp with time zone>
fixPrice
number <numeric>
sourceFolderTemplateId
string <uuid>

Note: This is a Foreign Key to folderTemplates.id.

sourceFolderTemplateItemId
string <uuid>

Note: This is a Foreign Key to folderTemplates.id.

billPrice
number <numeric>
laborCost
number <numeric>
creationOrder
required
integer <integer>
deletedDate
string <timestamp with time zone>
isDeleted
required
boolean <boolean>
Default: false
documentId
string <uuid>

Note: This is a Foreign Key to documents.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "folderTypeId": "71aced48-af8d-4945-986e-3673fa133f54",
  • "priorityId": "a57eab25-838b-40cc-a576-57e4056f1d6c",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "isHiddenable": true,
  • "description": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "plannedHours": 0,
  • "bidPrice": 0,
  • "usedHours": 0,
  • "codaioPageId": "string",
  • "codaioBrowserLink": "string",
  • "bidHours": 0,
  • "availableToStartConflict": true,
  • "invoiceNo": "string",
  • "invoicedHours": 0,
  • "availableToStart": "string",
  • "deadline": "string",
  • "importanceNo": 0,
  • "downstreamHoursTotal": 0,
  • "latestDeadline": "string",
  • "latestAvailableToStart": "string",
  • "mustStartOn": "string",
  • "soonestAvailableToStart": "string",
  • "preferredAssignee": "a8ac3f50-5cca-4ac9-b099-093e1904ac00",
  • "value": 0,
  • "softAssigneeId": "9dd2ab54-eda7-4736-b231-3f621dc84e14",
  • "upstreamHoursCritical": 0,
  • "deadlineConflict": true,
  • "spentHoursDiffecence": 0,
  • "qnote": "string",
  • "lastTask": "string",
  • "sprint": "string",
  • "properties": null,
  • "downstreamHoursCritical": 0,
  • "downstreamHoursDirect": 0,
  • "lastClientNoteDate": "string",
  • "lastNoteDate": "string",
  • "fixPrice": 0,
  • "sourceFolderTemplateId": "05571189-246b-40ad-a78a-23ad25f6b5cf",
  • "sourceFolderTemplateItemId": "93ff0f03-b857-416d-9eb5-348c46465b44",
  • "billPrice": 0,
  • "laborCost": 0,
  • "creationOrder": 0,
  • "deletedDate": "string",
  • "isDeleted": false,
  • "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052"
}

biddingOverrides

/biddingOverrides

query Parameters
id
string
data
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/biddingOverrides

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

biddingOverrides

id
required
string <uuid>

Note: This is a Primary Key.

data
any <jsonb>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "data": null
}

/biddingOverrides

query Parameters
id
string
data
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/biddingOverrides

query Parameters
id
string
data
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

biddingOverrides

id
required
string <uuid>

Note: This is a Primary Key.

data
any <jsonb>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "data": null
}

customAttributeDefinitionFolderTypes

/customAttributeDefinitionFolderTypes

query Parameters
id
string
customAttributeDefinitionId
string
folderTypeId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/customAttributeDefinitionFolderTypes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

customAttributeDefinitionFolderTypes

id
required
string <uuid>

Note: This is a Primary Key.

customAttributeDefinitionId
required
string <uuid>

Note: This is a Foreign Key to customAttributeDefinitions.id.

folderTypeId
string <uuid>

Note: This is a Foreign Key to folderTypes.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customAttributeDefinitionId": "db2a8d0c-8342-432d-a485-ecf2557c6103",
  • "folderTypeId": "71aced48-af8d-4945-986e-3673fa133f54"
}

/customAttributeDefinitionFolderTypes

query Parameters
id
string
customAttributeDefinitionId
string
folderTypeId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/customAttributeDefinitionFolderTypes

query Parameters
id
string
customAttributeDefinitionId
string
folderTypeId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

customAttributeDefinitionFolderTypes

id
required
string <uuid>

Note: This is a Primary Key.

customAttributeDefinitionId
required
string <uuid>

Note: This is a Foreign Key to customAttributeDefinitions.id.

folderTypeId
string <uuid>

Note: This is a Foreign Key to folderTypes.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customAttributeDefinitionId": "db2a8d0c-8342-432d-a485-ecf2557c6103",
  • "folderTypeId": "71aced48-af8d-4945-986e-3673fa133f54"
}

states

/states

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
screenPriority
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/states

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

states

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
integer <integer>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "screenPriority": 0
}

/states

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
screenPriority
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/states

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
screenPriority
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

states

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
integer <integer>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string",
  • "screenPriority": 0
}

integrationApplications

/integrationApplications

query Parameters
id
string
name
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/integrationApplications

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

integrationApplications

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

/integrationApplications

query Parameters
id
string
name
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/integrationApplications

query Parameters
id
string
name
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

integrationApplications

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

outputs

/outputs

query Parameters
id
string
folderId
string
outputTypeId
string
name
string
suffix
string
hiddenInOutgoing
string
isExternal
string
tagId
string
fileTypeLogicalOperator
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/outputs

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

outputs

id
required
string <uuid>

Note: This is a Primary Key.

folderId
required
string <uuid>

Note: This is a Foreign Key to folders.id.

outputTypeId
required
string <uuid>

Note: This is a Foreign Key to outputTypes.id.

name
required
string <character varying> <= 128 characters
suffix
string <character varying> <= 128 characters
Default: ""
hiddenInOutgoing
required
boolean <boolean>
isExternal
required
boolean <boolean>
tagId
string <uuid>

Note: This is a Foreign Key to tags.id.

fileTypeLogicalOperator
required
integer <integer>
Default: 1

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "outputTypeId": "eb4139aa-02ad-4d37-a296-30a4458db90e",
  • "name": "string",
  • "suffix": "",
  • "hiddenInOutgoing": true,
  • "isExternal": true,
  • "tagId": "f69eb9f1-ae9f-4086-b25c-c39758a43fb3",
  • "fileTypeLogicalOperator": 1
}

/outputs

query Parameters
id
string
folderId
string
outputTypeId
string
name
string
suffix
string
hiddenInOutgoing
string
isExternal
string
tagId
string
fileTypeLogicalOperator
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outputs

query Parameters
id
string
folderId
string
outputTypeId
string
name
string
suffix
string
hiddenInOutgoing
string
isExternal
string
tagId
string
fileTypeLogicalOperator
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

outputs

id
required
string <uuid>

Note: This is a Primary Key.

folderId
required
string <uuid>

Note: This is a Foreign Key to folders.id.

outputTypeId
required
string <uuid>

Note: This is a Foreign Key to outputTypes.id.

name
required
string <character varying> <= 128 characters
suffix
string <character varying> <= 128 characters
Default: ""
hiddenInOutgoing
required
boolean <boolean>
isExternal
required
boolean <boolean>
tagId
string <uuid>

Note: This is a Foreign Key to tags.id.

fileTypeLogicalOperator
required
integer <integer>
Default: 1

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "outputTypeId": "eb4139aa-02ad-4d37-a296-30a4458db90e",
  • "name": "string",
  • "suffix": "",
  • "hiddenInOutgoing": true,
  • "isExternal": true,
  • "tagId": "f69eb9f1-ae9f-4086-b25c-c39758a43fb3",
  • "fileTypeLogicalOperator": 1
}

projectDefinitionOutputTypes

/projectDefinitionOutputTypes

query Parameters
projectDefinitionId
string
outputTypeId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/projectDefinitionOutputTypes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

projectDefinitionOutputTypes

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

outputTypeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to outputTypes.id.

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "outputTypeId": "eb4139aa-02ad-4d37-a296-30a4458db90e"
}

/projectDefinitionOutputTypes

query Parameters
projectDefinitionId
string
outputTypeId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionOutputTypes

query Parameters
projectDefinitionId
string
outputTypeId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projectDefinitionOutputTypes

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

outputTypeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to outputTypes.id.

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "outputTypeId": "eb4139aa-02ad-4d37-a296-30a4458db90e"
}

holidays

/holidays

query Parameters
id
string
holidayStartDate
string
holidayEndDate
string
holidayType
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/holidays

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

holidays

id
required
string <uuid>

Note: This is a Primary Key.

holidayStartDate
required
string <timestamp with time zone>
holidayEndDate
required
string <timestamp with time zone>
holidayType
required
integer <integer>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "holidayStartDate": "string",
  • "holidayEndDate": "string",
  • "holidayType": 0
}

/holidays

query Parameters
id
string
holidayStartDate
string
holidayEndDate
string
holidayType
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/holidays

query Parameters
id
string
holidayStartDate
string
holidayEndDate
string
holidayType
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

holidays

id
required
string <uuid>

Note: This is a Primary Key.

holidayStartDate
required
string <timestamp with time zone>
holidayEndDate
required
string <timestamp with time zone>
holidayType
required
integer <integer>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "holidayStartDate": "string",
  • "holidayEndDate": "string",
  • "holidayType": 0
}

projectDefinitionTags

/projectDefinitionTags

query Parameters
projectDefinitionId
string
tagId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/projectDefinitionTags

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

projectDefinitionTags

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

tagId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to tags.id.

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "tagId": "f69eb9f1-ae9f-4086-b25c-c39758a43fb3"
}

/projectDefinitionTags

query Parameters
projectDefinitionId
string
tagId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionTags

query Parameters
projectDefinitionId
string
tagId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projectDefinitionTags

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

tagId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to tags.id.

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "tagId": "f69eb9f1-ae9f-4086-b25c-c39758a43fb3"
}

outgoingStatusMappingIncomingStatuses

/outgoingStatusMappingIncomingStatuses

query Parameters
outgoingStatusMappingId
string
statusId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/outgoingStatusMappingIncomingStatuses

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

outgoingStatusMappingIncomingStatuses

outgoingStatusMappingId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to outgoingStatusMappings.id.

statusId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to statuses.id.

Responses

Request samples

Content type
{
  • "outgoingStatusMappingId": "354091a2-c1fe-420a-a7d2-d75b8fa41db5",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645"
}

/outgoingStatusMappingIncomingStatuses

query Parameters
outgoingStatusMappingId
string
statusId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outgoingStatusMappingIncomingStatuses

query Parameters
outgoingStatusMappingId
string
statusId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

outgoingStatusMappingIncomingStatuses

outgoingStatusMappingId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to outgoingStatusMappings.id.

statusId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to statuses.id.

Responses

Request samples

Content type
{
  • "outgoingStatusMappingId": "354091a2-c1fe-420a-a7d2-d75b8fa41db5",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645"
}

projectDefinitionNoteCategories

/projectDefinitionNoteCategories

query Parameters
projectDefinitionId
string
noteCategoryId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/projectDefinitionNoteCategories

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

projectDefinitionNoteCategories

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

noteCategoryId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to noteCategories.id.

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "noteCategoryId": "13541544-e4ad-4ff3-a05d-037633a69751"
}

/projectDefinitionNoteCategories

query Parameters
projectDefinitionId
string
noteCategoryId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionNoteCategories

query Parameters
projectDefinitionId
string
noteCategoryId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projectDefinitionNoteCategories

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

noteCategoryId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to noteCategories.id.

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "noteCategoryId": "13541544-e4ad-4ff3-a05d-037633a69751"
}

cloudApplications

/cloudApplications

query Parameters
id
string
name
string
icon
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/cloudApplications

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

cloudApplications

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
icon
required
string <character varying> <= 128 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "icon": "string"
}

/cloudApplications

query Parameters
id
string
name
string
icon
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/cloudApplications

query Parameters
id
string
name
string
icon
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

cloudApplications

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
icon
required
string <character varying> <= 128 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "icon": "string"
}

todoTemplates

/todoTemplates

query Parameters
id
string
isDone
string
text
string
color
string
createdDate
string
updatedDate
string
doneDate
string
folderTemplateId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/todoTemplates

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

todoTemplates

id
required
string <uuid>

Note: This is a Primary Key.

isDone
required
boolean <boolean>
text
required
string <character varying> <= 4096 characters
color
required
string <character> <= 7 characters
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
doneDate
string <timestamp with time zone>
folderTemplateId
required
string <uuid>

Note: This is a Foreign Key to folderTemplates.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "isDone": true,
  • "text": "string",
  • "color": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "doneDate": "string",
  • "folderTemplateId": "fb81db22-0ba6-434c-a2b3-03ddd69524c1"
}

/todoTemplates

query Parameters
id
string
isDone
string
text
string
color
string
createdDate
string
updatedDate
string
doneDate
string
folderTemplateId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/todoTemplates

query Parameters
id
string
isDone
string
text
string
color
string
createdDate
string
updatedDate
string
doneDate
string
folderTemplateId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

todoTemplates

id
required
string <uuid>

Note: This is a Primary Key.

isDone
required
boolean <boolean>
text
required
string <character varying> <= 4096 characters
color
required
string <character> <= 7 characters
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
doneDate
string <timestamp with time zone>
folderTemplateId
required
string <uuid>

Note: This is a Foreign Key to folderTemplates.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "isDone": true,
  • "text": "string",
  • "color": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "doneDate": "string",
  • "folderTemplateId": "fb81db22-0ba6-434c-a2b3-03ddd69524c1"
}

folderTags

/folderTags

query Parameters
folderId
string
tagId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/folderTags

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

folderTags

folderId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folders.id.

tagId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to tags.id.

Responses

Request samples

Content type
{
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "tagId": "f69eb9f1-ae9f-4086-b25c-c39758a43fb3"
}

/folderTags

query Parameters
folderId
string
tagId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/folderTags

query Parameters
folderId
string
tagId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

folderTags

folderId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to folders.id.

tagId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to tags.id.

Responses

Request samples

Content type
{
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "tagId": "f69eb9f1-ae9f-4086-b25c-c39758a43fb3"
}

projects

/projects

query Parameters
id
string
projectDefinitionId
string
projectStatusId
string
clientId
string
name
string
startDate
string
endDate
string
createdDate
string
updatedDate
string
description
string
shortName
string
icon
string
codeName
string
color
string
deletedDate
string
isDeleted
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/projects

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

projects

id
required
string <uuid>

Note: This is a Primary Key.

projectDefinitionId
required
string <uuid>

Note: This is a Foreign Key to projectDefinitions.id.

projectStatusId
required
string <uuid>

Note: This is a Foreign Key to projectStatuses.id.

clientId
string <uuid>

Note: This is a Foreign Key to clients.id.

name
required
string <text>
startDate
string <timestamp with time zone>
endDate
string <timestamp with time zone>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
description
string <character varying> <= 4096 characters
shortName
string <text>
icon
string <text>
codeName
string <text>
color
string <text>
deletedDate
string <timestamp with time zone>
isDeleted
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "projectStatusId": "64b98b3a-f398-40fa-b007-f5d11400b81c",
  • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
  • "name": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "description": "string",
  • "shortName": "string",
  • "icon": "string",
  • "codeName": "string",
  • "color": "string",
  • "deletedDate": "string",
  • "isDeleted": false
}

/projects

query Parameters
id
string
projectDefinitionId
string
projectStatusId
string
clientId
string
name
string
startDate
string
endDate
string
createdDate
string
updatedDate
string
description
string
shortName
string
icon
string
codeName
string
color
string
deletedDate
string
isDeleted
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projects

query Parameters
id
string
projectDefinitionId
string
projectStatusId
string
clientId
string
name
string
startDate
string
endDate
string
createdDate
string
updatedDate
string
description
string
shortName
string
icon
string
codeName
string
color
string
deletedDate
string
isDeleted
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projects

id
required
string <uuid>

Note: This is a Primary Key.

projectDefinitionId
required
string <uuid>

Note: This is a Foreign Key to projectDefinitions.id.

projectStatusId
required
string <uuid>

Note: This is a Foreign Key to projectStatuses.id.

clientId
string <uuid>

Note: This is a Foreign Key to clients.id.

name
required
string <text>
startDate
string <timestamp with time zone>
endDate
string <timestamp with time zone>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
description
string <character varying> <= 4096 characters
shortName
string <text>
icon
string <text>
codeName
string <text>
color
string <text>
deletedDate
string <timestamp with time zone>
isDeleted
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "projectStatusId": "64b98b3a-f398-40fa-b007-f5d11400b81c",
  • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
  • "name": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "description": "string",
  • "shortName": "string",
  • "icon": "string",
  • "codeName": "string",
  • "color": "string",
  • "deletedDate": "string",
  • "isDeleted": false
}

userAssigneeRoleNotificationTypeOverrides

/userAssigneeRoleNotificationTypeOverrides

query Parameters
assigneeRoleId
string
notificationTypeId
string
userId
string
enabled
string
emailEnabled
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/userAssigneeRoleNotificationTypeOverrides

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

userAssigneeRoleNotificationTypeOverrides

assigneeRoleId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to assigneeRoles.id.

notificationTypeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to notificationTypes.id.

userId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to users.id.

enabled
required
boolean <boolean>
emailEnabled
required
boolean <boolean>

Responses

Request samples

Content type
{
  • "assigneeRoleId": "0e6ac67b-c717-49f7-bfc0-373174d8464f",
  • "notificationTypeId": "1bf60995-5071-4f6a-92ca-80806f2f0d7a",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "enabled": true,
  • "emailEnabled": true
}

/userAssigneeRoleNotificationTypeOverrides

query Parameters
assigneeRoleId
string
notificationTypeId
string
userId
string
enabled
string
emailEnabled
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/userAssigneeRoleNotificationTypeOverrides

query Parameters
assigneeRoleId
string
notificationTypeId
string
userId
string
enabled
string
emailEnabled
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

userAssigneeRoleNotificationTypeOverrides

assigneeRoleId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to assigneeRoles.id.

notificationTypeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to notificationTypes.id.

userId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to users.id.

enabled
required
boolean <boolean>
emailEnabled
required
boolean <boolean>

Responses

Request samples

Content type
{
  • "assigneeRoleId": "0e6ac67b-c717-49f7-bfc0-373174d8464f",
  • "notificationTypeId": "1bf60995-5071-4f6a-92ca-80806f2f0d7a",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "enabled": true,
  • "emailEnabled": true
}

userTags

/userTags

query Parameters
id
string
icon
string
note
string
color
string
userId
string
folderId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/userTags

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

userTags

id
required
string <uuid>

Note: This is a Primary Key.

icon
required
string <character varying> <= 128 characters
note
string <character varying> <= 4096 characters
color
string <character> <= 7 characters
userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

folderId
required
string <uuid>

Note: This is a Foreign Key to folders.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "icon": "string",
  • "note": "string",
  • "color": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e"
}

/userTags

query Parameters
id
string
icon
string
note
string
color
string
userId
string
folderId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/userTags

query Parameters
id
string
icon
string
note
string
color
string
userId
string
folderId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

userTags

id
required
string <uuid>

Note: This is a Primary Key.

icon
required
string <character varying> <= 128 characters
note
string <character varying> <= 4096 characters
color
string <character> <= 7 characters
userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

folderId
required
string <uuid>

Note: This is a Foreign Key to folders.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "icon": "string",
  • "note": "string",
  • "color": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e"
}

noteAssignees

/noteAssignees

query Parameters
id
string
noteId
string
userId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/noteAssignees

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

noteAssignees

id
required
string <uuid>

Note: This is a Primary Key.

noteId
required
string <uuid>

Note: This is a Foreign Key to notes.id.

userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "noteId": "11bee8fe-2793-4911-9b27-a6f8473a2ccf",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

/noteAssignees

query Parameters
id
string
noteId
string
userId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/noteAssignees

query Parameters
id
string
noteId
string
userId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

noteAssignees

id
required
string <uuid>

Note: This is a Primary Key.

noteId
required
string <uuid>

Note: This is a Foreign Key to notes.id.

userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "noteId": "11bee8fe-2793-4911-9b27-a6f8473a2ccf",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

chartDatas

/chartDatas

query Parameters
id
string
stateId
string
typeId
string
projectId
string
hours
string
count
string
date
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/chartDatas

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

chartDatas

id
required
string <uuid>

Note: This is a Primary Key.

stateId
required
string <uuid>
typeId
required
string <uuid>
projectId
required
string <uuid>
hours
required
number <numeric>
count
required
integer <integer>
date
required
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "stateId": "871bb69c-5872-42b2-88b0-72e9da663aaa",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "hours": 0,
  • "count": 0,
  • "date": "string"
}

/chartDatas

query Parameters
id
string
stateId
string
typeId
string
projectId
string
hours
string
count
string
date
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/chartDatas

query Parameters
id
string
stateId
string
typeId
string
projectId
string
hours
string
count
string
date
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

chartDatas

id
required
string <uuid>

Note: This is a Primary Key.

stateId
required
string <uuid>
typeId
required
string <uuid>
projectId
required
string <uuid>
hours
required
number <numeric>
count
required
integer <integer>
date
required
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "stateId": "871bb69c-5872-42b2-88b0-72e9da663aaa",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "hours": 0,
  • "count": 0,
  • "date": "string"
}

permissions

/permissions

query Parameters
id
string
name
string
description
string
scope
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/permissions

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

permissions

id
required
string <uuid>

Note: This is a Primary Key.

name
string <character varying> <= 4096 characters
description
string <character varying> <= 4096 characters
scope
string <character varying> <= 4096 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "scope": "string"
}

/permissions

query Parameters
id
string
name
string
description
string
scope
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/permissions

query Parameters
id
string
name
string
description
string
scope
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

permissions

id
required
string <uuid>

Note: This is a Primary Key.

name
string <character varying> <= 4096 characters
description
string <character varying> <= 4096 characters
scope
string <character varying> <= 4096 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "scope": "string"
}

weekDays

/weekDays

query Parameters
id
string
name
string
abbreviation
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/weekDays

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

weekDays

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
abbreviation
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "abbreviation": "string"
}

/weekDays

query Parameters
id
string
name
string
abbreviation
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/weekDays

query Parameters
id
string
name
string
abbreviation
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

weekDays

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
abbreviation
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "abbreviation": "string"
}

projectDefinitionOutputStatuses

/projectDefinitionOutputStatuses

query Parameters
projectDefinitionId
string
statusId
string
isClientReviewable
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/projectDefinitionOutputStatuses

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

projectDefinitionOutputStatuses

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

statusId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to statuses.id.

isClientReviewable
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
  • "isClientReviewable": false
}

/projectDefinitionOutputStatuses

query Parameters
projectDefinitionId
string
statusId
string
isClientReviewable
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionOutputStatuses

query Parameters
projectDefinitionId
string
statusId
string
isClientReviewable
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projectDefinitionOutputStatuses

projectDefinitionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to projectDefinitions.id.

statusId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to statuses.id.

isClientReviewable
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
  • "isClientReviewable": false
}

userSharedComponents

/userSharedComponents

query Parameters
userId
string
componentId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/userSharedComponents

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

userSharedComponents

userId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to users.id.

componentId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to components.id.

Responses

Request samples

Content type
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "componentId": "616ccd92-d666-4180-8349-8d125b269fac"
}

/userSharedComponents

query Parameters
userId
string
componentId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/userSharedComponents

query Parameters
userId
string
componentId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

userSharedComponents

userId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to users.id.

componentId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to components.id.

Responses

Request samples

Content type
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "componentId": "616ccd92-d666-4180-8349-8d125b269fac"
}

tags

/tags

query Parameters
id
string
description
string
color
string
isCore
string
isHidden
string
canBeUsedForFolder
string
canBeUsedForOutput
string
canBeUsedForOutputVersion
string
codeName
string
icon
string
name
string
shortName
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/tags

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

tags

id
required
string <uuid>

Note: This is a Primary Key.

description
string <character varying> <= 4096 characters
color
string <text>
isCore
required
boolean <boolean>
isHidden
required
boolean <boolean>
canBeUsedForFolder
required
boolean <boolean>
canBeUsedForOutput
required
boolean <boolean>
canBeUsedForOutputVersion
required
boolean <boolean>
codeName
string <text>
icon
string <text>
name
required
string <text>
Default: ""
shortName
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string",
  • "color": "string",
  • "isCore": true,
  • "isHidden": true,
  • "canBeUsedForFolder": true,
  • "canBeUsedForOutput": true,
  • "canBeUsedForOutputVersion": true,
  • "codeName": "string",
  • "icon": "string",
  • "name": "",
  • "shortName": "string"
}

/tags

query Parameters
id
string
description
string
color
string
isCore
string
isHidden
string
canBeUsedForFolder
string
canBeUsedForOutput
string
canBeUsedForOutputVersion
string
codeName
string
icon
string
name
string
shortName
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/tags

query Parameters
id
string
description
string
color
string
isCore
string
isHidden
string
canBeUsedForFolder
string
canBeUsedForOutput
string
canBeUsedForOutputVersion
string
codeName
string
icon
string
name
string
shortName
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

tags

id
required
string <uuid>

Note: This is a Primary Key.

description
string <character varying> <= 4096 characters
color
string <text>
isCore
required
boolean <boolean>
isHidden
required
boolean <boolean>
canBeUsedForFolder
required
boolean <boolean>
canBeUsedForOutput
required
boolean <boolean>
canBeUsedForOutputVersion
required
boolean <boolean>
codeName
string <text>
icon
string <text>
name
required
string <text>
Default: ""
shortName
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string",
  • "color": "string",
  • "isCore": true,
  • "isHidden": true,
  • "canBeUsedForFolder": true,
  • "canBeUsedForOutput": true,
  • "canBeUsedForOutputVersion": true,
  • "codeName": "string",
  • "icon": "string",
  • "name": "",
  • "shortName": "string"
}

components

/components

query Parameters
id
string
outputVersionId
string
fileTypeId
string
componentStateId
string
relativePath
string
isAutogenerated
string
createdDate
string
updatedDate
string
publisherOs
string
data
string
projectId
string
isReviewable
string
isWebComponent
string
webLink
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/components

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

components

id
required
string <uuid>

Note: This is a Primary Key.

outputVersionId
required
string <uuid>

Note: This is a Foreign Key to outputVersions.id.

fileTypeId
required
string <uuid>

Note: This is a Foreign Key to fileTypes.id.

componentStateId
string <uuid>
relativePath
required
string <character varying> <= 4096 characters
isAutogenerated
required
boolean <boolean>
Default: false
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
publisherOs
string <text>
data
any <jsonb>
projectId
required
string <uuid>

Note: This is a Foreign Key to projects.id.

isReviewable
required
boolean <boolean>
Default: false
isWebComponent
required
boolean <boolean>
Default: false
webLink
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "outputVersionId": "45414408-e045-450b-939c-cf42e5d6e489",
  • "fileTypeId": "4e54faea-5a86-4e82-9bdd-545d4e485d6f",
  • "componentStateId": "486f8683-2756-47a7-bf0e-28d14f9bb77d",
  • "relativePath": "string",
  • "isAutogenerated": false,
  • "createdDate": "string",
  • "updatedDate": "string",
  • "publisherOs": "string",
  • "data": null,
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "isReviewable": false,
  • "isWebComponent": false,
  • "webLink": "string"
}

/components

query Parameters
id
string
outputVersionId
string
fileTypeId
string
componentStateId
string
relativePath
string
isAutogenerated
string
createdDate
string
updatedDate
string
publisherOs
string
data
string
projectId
string
isReviewable
string
isWebComponent
string
webLink
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/components

query Parameters
id
string
outputVersionId
string
fileTypeId
string
componentStateId
string
relativePath
string
isAutogenerated
string
createdDate
string
updatedDate
string
publisherOs
string
data
string
projectId
string
isReviewable
string
isWebComponent
string
webLink
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

components

id
required
string <uuid>

Note: This is a Primary Key.

outputVersionId
required
string <uuid>

Note: This is a Foreign Key to outputVersions.id.

fileTypeId
required
string <uuid>

Note: This is a Foreign Key to fileTypes.id.

componentStateId
string <uuid>
relativePath
required
string <character varying> <= 4096 characters
isAutogenerated
required
boolean <boolean>
Default: false
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
publisherOs
string <text>
data
any <jsonb>
projectId
required
string <uuid>

Note: This is a Foreign Key to projects.id.

isReviewable
required
boolean <boolean>
Default: false
isWebComponent
required
boolean <boolean>
Default: false
webLink
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "outputVersionId": "45414408-e045-450b-939c-cf42e5d6e489",
  • "fileTypeId": "4e54faea-5a86-4e82-9bdd-545d4e485d6f",
  • "componentStateId": "486f8683-2756-47a7-bf0e-28d14f9bb77d",
  • "relativePath": "string",
  • "isAutogenerated": false,
  • "createdDate": "string",
  • "updatedDate": "string",
  • "publisherOs": "string",
  • "data": null,
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "isReviewable": false,
  • "isWebComponent": false,
  • "webLink": "string"
}

assigneeRoleNotificationTypes

/assigneeRoleNotificationTypes

query Parameters
assigneeRoleId
string
notificationTypeId
string
state
string
defaultEnabled
string
defaultEmailEnabled
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/assigneeRoleNotificationTypes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

assigneeRoleNotificationTypes

assigneeRoleId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to assigneeRoles.id.

notificationTypeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to notificationTypes.id.

state
required
integer <integer>
defaultEnabled
required
boolean <boolean>
defaultEmailEnabled
required
boolean <boolean>

Responses

Request samples

Content type
{
  • "assigneeRoleId": "0e6ac67b-c717-49f7-bfc0-373174d8464f",
  • "notificationTypeId": "1bf60995-5071-4f6a-92ca-80806f2f0d7a",
  • "state": 0,
  • "defaultEnabled": true,
  • "defaultEmailEnabled": true
}

/assigneeRoleNotificationTypes

query Parameters
assigneeRoleId
string
notificationTypeId
string
state
string
defaultEnabled
string
defaultEmailEnabled
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/assigneeRoleNotificationTypes

query Parameters
assigneeRoleId
string
notificationTypeId
string
state
string
defaultEnabled
string
defaultEmailEnabled
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

assigneeRoleNotificationTypes

assigneeRoleId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to assigneeRoles.id.

notificationTypeId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to notificationTypes.id.

state
required
integer <integer>
defaultEnabled
required
boolean <boolean>
defaultEmailEnabled
required
boolean <boolean>

Responses

Request samples

Content type
{
  • "assigneeRoleId": "0e6ac67b-c717-49f7-bfc0-373174d8464f",
  • "notificationTypeId": "1bf60995-5071-4f6a-92ca-80806f2f0d7a",
  • "state": 0,
  • "defaultEnabled": true,
  • "defaultEmailEnabled": true
}

activityTypes

/activityTypes

query Parameters
id
string
name
string
displayText
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/activityTypes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

activityTypes

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
displayText
required
string <character varying> <= 4096 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "displayText": "string"
}

/activityTypes

query Parameters
id
string
name
string
displayText
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/activityTypes

query Parameters
id
string
name
string
displayText
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

activityTypes

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
displayText
required
string <character varying> <= 4096 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "displayText": "string"
}

securityRolePermissions

/securityRolePermissions

query Parameters
securityRoleId
string
permissionId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/securityRolePermissions

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

securityRolePermissions

securityRoleId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to securityRoles.id.

permissionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to permissions.id.

Responses

Request samples

Content type
{
  • "securityRoleId": "098794d7-7cce-42c5-8c3e-45c3d491f4fc",
  • "permissionId": "d5850203-7a23-4b4d-8f1b-99d510b781d3"
}

/securityRolePermissions

query Parameters
securityRoleId
string
permissionId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/securityRolePermissions

query Parameters
securityRoleId
string
permissionId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

securityRolePermissions

securityRoleId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to securityRoles.id.

permissionId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to permissions.id.

Responses

Request samples

Content type
{
  • "securityRoleId": "098794d7-7cce-42c5-8c3e-45c3d491f4fc",
  • "permissionId": "d5850203-7a23-4b4d-8f1b-99d510b781d3"
}

iterations

/iterations

query Parameters
id
string
number
string
isDone
string
folderId
string
name
string
availableToStart
string
deadline
string
plannedHours
string
startDate
string
endDate
string
softAssigneeId
string
assigneeId
string
description
string
usedHours
string
isIndependent
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/iterations

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

iterations

id
required
string <uuid>

Note: This is a Primary Key.

number
required
integer <smallint>
isDone
required
boolean <boolean>
folderId
required
string <uuid>

Note: This is a Foreign Key to folders.id.

name
required
string <text>
availableToStart
string <timestamp with time zone>
deadline
string <timestamp with time zone>
plannedHours
number <numeric>
startDate
string <timestamp with time zone>
endDate
string <timestamp with time zone>
softAssigneeId
string <uuid>

Note: This is a Foreign Key to users.id.

assigneeId
string <uuid>

Note: This is a Foreign Key to users.id.

description
string <character varying> <= 4096 characters
usedHours
number <numeric>
isIndependent
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "number": 0,
  • "isDone": true,
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "name": "string",
  • "availableToStart": "string",
  • "deadline": "string",
  • "plannedHours": 0,
  • "startDate": "string",
  • "endDate": "string",
  • "softAssigneeId": "9dd2ab54-eda7-4736-b231-3f621dc84e14",
  • "assigneeId": "665a9750-71bd-4b96-bacd-9efa4ae022dd",
  • "description": "string",
  • "usedHours": 0,
  • "isIndependent": false
}

/iterations

query Parameters
id
string
number
string
isDone
string
folderId
string
name
string
availableToStart
string
deadline
string
plannedHours
string
startDate
string
endDate
string
softAssigneeId
string
assigneeId
string
description
string
usedHours
string
isIndependent
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/iterations

query Parameters
id
string
number
string
isDone
string
folderId
string
name
string
availableToStart
string
deadline
string
plannedHours
string
startDate
string
endDate
string
softAssigneeId
string
assigneeId
string
description
string
usedHours
string
isIndependent
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

iterations

id
required
string <uuid>

Note: This is a Primary Key.

number
required
integer <smallint>
isDone
required
boolean <boolean>
folderId
required
string <uuid>

Note: This is a Foreign Key to folders.id.

name
required
string <text>
availableToStart
string <timestamp with time zone>
deadline
string <timestamp with time zone>
plannedHours
number <numeric>
startDate
string <timestamp with time zone>
endDate
string <timestamp with time zone>
softAssigneeId
string <uuid>

Note: This is a Foreign Key to users.id.

assigneeId
string <uuid>

Note: This is a Foreign Key to users.id.

description
string <character varying> <= 4096 characters
usedHours
number <numeric>
isIndependent
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "number": 0,
  • "isDone": true,
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "name": "string",
  • "availableToStart": "string",
  • "deadline": "string",
  • "plannedHours": 0,
  • "startDate": "string",
  • "endDate": "string",
  • "softAssigneeId": "9dd2ab54-eda7-4736-b231-3f621dc84e14",
  • "assigneeId": "665a9750-71bd-4b96-bacd-9efa4ae022dd",
  • "description": "string",
  • "usedHours": 0,
  • "isIndependent": false
}

outgoingStatusMappingCurrentStatuses

/outgoingStatusMappingCurrentStatuses

query Parameters
outgoingStatusMappingId
string
statusId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/outgoingStatusMappingCurrentStatuses

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

outgoingStatusMappingCurrentStatuses

outgoingStatusMappingId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to outgoingStatusMappings.id.

statusId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to statuses.id.

Responses

Request samples

Content type
{
  • "outgoingStatusMappingId": "354091a2-c1fe-420a-a7d2-d75b8fa41db5",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645"
}

/outgoingStatusMappingCurrentStatuses

query Parameters
outgoingStatusMappingId
string
statusId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outgoingStatusMappingCurrentStatuses

query Parameters
outgoingStatusMappingId
string
statusId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

outgoingStatusMappingCurrentStatuses

outgoingStatusMappingId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to outgoingStatusMappings.id.

statusId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to statuses.id.

Responses

Request samples

Content type
{
  • "outgoingStatusMappingId": "354091a2-c1fe-420a-a7d2-d75b8fa41db5",
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645"
}

fileTypes

/fileTypes

query Parameters
id
string
name
string
fileExtension
string
isCore
string
isOpenable
string
isPlayable
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/fileTypes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

fileTypes

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
fileExtension
required
string <character varying> <= 10 characters
isCore
required
boolean <boolean>
isOpenable
required
boolean <boolean>
Default: false
isPlayable
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "fileExtension": "string",
  • "isCore": true,
  • "isOpenable": false,
  • "isPlayable": false
}

/fileTypes

query Parameters
id
string
name
string
fileExtension
string
isCore
string
isOpenable
string
isPlayable
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/fileTypes

query Parameters
id
string
name
string
fileExtension
string
isCore
string
isOpenable
string
isPlayable
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

fileTypes

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <character varying> <= 128 characters
fileExtension
required
string <character varying> <= 10 characters
isCore
required
boolean <boolean>
isOpenable
required
boolean <boolean>
Default: false
isPlayable
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "fileExtension": "string",
  • "isCore": true,
  • "isOpenable": false,
  • "isPlayable": false
}

defaultViews

/defaultViews

query Parameters
projectId
string
userId
string
viewId
string
id
string
isForProjectView
string
isForVersionView
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/defaultViews

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

defaultViews

projectId
required
string <uuid>

Note: This is a Foreign Key to projects.id.

userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

viewId
required
string <uuid>

Note: This is a Foreign Key to views.id.

id
required
string <uuid>

Note: This is a Primary Key.

isForProjectView
required
boolean <boolean>
Default: false
isForVersionView
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "viewId": "5aa272a5-73e4-4f9c-8123-4bac998fdb73",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "isForProjectView": false,
  • "isForVersionView": false
}

/defaultViews

query Parameters
projectId
string
userId
string
viewId
string
id
string
isForProjectView
string
isForVersionView
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/defaultViews

query Parameters
projectId
string
userId
string
viewId
string
id
string
isForProjectView
string
isForVersionView
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

defaultViews

projectId
required
string <uuid>

Note: This is a Foreign Key to projects.id.

userId
required
string <uuid>

Note: This is a Foreign Key to users.id.

viewId
required
string <uuid>

Note: This is a Foreign Key to views.id.

id
required
string <uuid>

Note: This is a Primary Key.

isForProjectView
required
boolean <boolean>
Default: false
isForVersionView
required
boolean <boolean>
Default: false

Responses

Request samples

Content type
{
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "viewId": "5aa272a5-73e4-4f9c-8123-4bac998fdb73",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "isForProjectView": false,
  • "isForVersionView": false
}

ayonProductTypes

/ayonProductTypes

query Parameters
id
string
name
string
screenPriority
string
isCore
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/ayonProductTypes

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

ayonProductTypes

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
screenPriority
integer <integer>
isCore
required
boolean <boolean>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "screenPriority": 0,
  • "isCore": true
}

/ayonProductTypes

query Parameters
id
string
name
string
screenPriority
string
isCore
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/ayonProductTypes

query Parameters
id
string
name
string
screenPriority
string
isCore
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

ayonProductTypes

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
screenPriority
integer <integer>
isCore
required
boolean <boolean>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "screenPriority": 0,
  • "isCore": true
}

projectStatuses

/projectStatuses

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/projectStatuses

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

projectStatuses

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string"
}

/projectStatuses

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectStatuses

query Parameters
id
string
name
string
shortName
string
codeName
string
icon
string
color
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projectStatuses

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "shortName": "string",
  • "codeName": "string",
  • "icon": "string",
  • "color": "string"
}

bankAccounts

/bankAccounts

query Parameters
id
string
name
string
iban
string
bic
string
companyName
string
addressLine1
string
addressLine2
string
transactionReferencePattern
string
countryCode
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/bankAccounts

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

bankAccounts

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
iban
required
string <text>
bic
required
string <text>
companyName
required
string <text>
addressLine1
required
string <text>
addressLine2
required
string <text>
transactionReferencePattern
required
string <text>
countryCode
required
string <character varying> <= 2 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "iban": "string",
  • "bic": "string",
  • "companyName": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "transactionReferencePattern": "string",
  • "countryCode": "st"
}

/bankAccounts

query Parameters
id
string
name
string
iban
string
bic
string
companyName
string
addressLine1
string
addressLine2
string
transactionReferencePattern
string
countryCode
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/bankAccounts

query Parameters
id
string
name
string
iban
string
bic
string
companyName
string
addressLine1
string
addressLine2
string
transactionReferencePattern
string
countryCode
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

bankAccounts

id
required
string <uuid>

Note: This is a Primary Key.

name
required
string <text>
iban
required
string <text>
bic
required
string <text>
companyName
required
string <text>
addressLine1
required
string <text>
addressLine2
required
string <text>
transactionReferencePattern
required
string <text>
countryCode
required
string <character varying> <= 2 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "iban": "string",
  • "bic": "string",
  • "companyName": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "transactionReferencePattern": "string",
  • "countryCode": "st"
}

typeUser

/typeUser

query Parameters
skilledUserId
string
skillsId
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/typeUser

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

typeUser

skilledUserId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to users.id.

skillsId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to types.id.

Responses

Request samples

Content type
{
  • "skilledUserId": "9fe34032-e883-4812-879d-5a4d7f71bb60",
  • "skillsId": "1d91c213-fce6-4f77-855a-25c7ad381fa5"
}

/typeUser

query Parameters
skilledUserId
string
skillsId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/typeUser

query Parameters
skilledUserId
string
skillsId
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

typeUser

skilledUserId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to users.id.

skillsId
required
string <uuid>

Note: This is a Primary Key. This is a Foreign Key to types.id.

Responses

Request samples

Content type
{
  • "skilledUserId": "9fe34032-e883-4812-879d-5a4d7f71bb60",
  • "skillsId": "1d91c213-fce6-4f77-855a-25c7ad381fa5"
}

todos

/todos

query Parameters
id
string
folderId
string
isDone
string
text
string
color
string
createdDate
string
updatedDate
string
doneDate
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/todos

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

todos

id
required
string <uuid>

Note: This is a Primary Key.

folderId
required
string <uuid>

Note: This is a Foreign Key to folders.id.

isDone
required
boolean <boolean>
text
required
string <character varying> <= 4096 characters
color
required
string <character> <= 7 characters
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
doneDate
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "isDone": true,
  • "text": "string",
  • "color": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "doneDate": "string"
}

/todos

query Parameters
id
string
folderId
string
isDone
string
text
string
color
string
createdDate
string
updatedDate
string
doneDate
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/todos

query Parameters
id
string
folderId
string
isDone
string
text
string
color
string
createdDate
string
updatedDate
string
doneDate
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

todos

id
required
string <uuid>

Note: This is a Primary Key.

folderId
required
string <uuid>

Note: This is a Foreign Key to folders.id.

isDone
required
boolean <boolean>
text
required
string <character varying> <= 4096 characters
color
required
string <character> <= 7 characters
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
doneDate
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "isDone": true,
  • "text": "string",
  • "color": "string",
  • "createdDate": "string",
  • "updatedDate": "string",
  • "doneDate": "string"
}

(rpc) create_folder_many

/rpc/create_folder_many

query Parameters
changes
required
string <jsonb>
conflict_strategy
string <public.folder_conflict_strategy>
continue_on_error
boolean <boolean>

Responses

/rpc/create_folder_many

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
changes
required
any <jsonb>
conflict_strategy
string <public.folder_conflict_strategy>
continue_on_error
boolean <boolean>

Responses

Request samples

Content type
{
  • "changes": null,
  • "conflict_strategy": "string",
  • "continue_on_error": true
}

(rpc) pass

/rpc/pass

query Parameters
required
string <text>

Responses

/rpc/pass

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) delete_folder_assignee_templates

/rpc/delete_folder_assignee_templates

query Parameters
user_ids
required
string <uuid[]>
folder_template_ids
required
string <uuid[]>
assignee_role_id
required
string <uuid>

Responses

/rpc/delete_folder_assignee_templates

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
assignee_role_id
required
string <uuid>
folder_template_ids
required
Array of strings
user_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "assignee_role_id": "34743d2e-11bd-4d73-b9ee-e25f97b48f81",
  • "folder_template_ids": [
    ],
  • "user_ids": [
    ]
}

(rpc) get_notes

/rpc/get_notes

query Parameters
ids
string <uuid[]>
project_ids
string <uuid[]>
folder_ids
string <uuid[]>
note_category_ids
string <uuid[]>
output_version_ids
string <uuid[]>
component_ids
string <uuid[]>
parent_ids
string <uuid[]>
author_ids
string <uuid[]>
created_from
string <timestamp with time zone>
created_to
string <timestamp with time zone>
updated_from
string <timestamp with time zone>
updated_to
string <timestamp with time zone>
is_autogenerated
boolean <boolean>
frame_from
integer <integer>
frame_to
integer <integer>
is_pinned
boolean <boolean>

Responses

/rpc/get_notes

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
author_ids
Array of strings
component_ids
Array of strings
created_from
string <timestamp with time zone>
created_to
string <timestamp with time zone>
folder_ids
Array of strings
frame_from
integer <integer>
frame_to
integer <integer>
ids
Array of strings
is_autogenerated
boolean <boolean>
is_pinned
boolean <boolean>
note_category_ids
Array of strings
output_version_ids
Array of strings
parent_ids
Array of strings
project_ids
Array of strings
updated_from
string <timestamp with time zone>
updated_to
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "author_ids": [
    ],
  • "component_ids": [
    ],
  • "created_from": "string",
  • "created_to": "string",
  • "folder_ids": [
    ],
  • "frame_from": 0,
  • "frame_to": 0,
  • "ids": [
    ],
  • "is_autogenerated": true,
  • "is_pinned": true,
  • "note_category_ids": [
    ],
  • "output_version_ids": [
    ],
  • "parent_ids": [
    ],
  • "project_ids": [
    ],
  • "updated_from": "string",
  • "updated_to": "string"
}

(rpc) get_custom_attributes_for_folders

/rpc/get_custom_attributes_for_folders

query Parameters
ids
required
string <uuid[]>
custom_attributes
string <text[]>
return_from_deleted
boolean <boolean>

Responses

/rpc/get_custom_attributes_for_folders

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
custom_attributes
Array of strings
ids
required
Array of strings
return_from_deleted
boolean <boolean>

Responses

Request samples

Content type
{
  • "custom_attributes": [
    ],
  • "ids": [
    ],
  • "return_from_deleted": true
}

(rpc) user_can_manage_attachment

/rpc/user_can_manage_attachment

query Parameters
attachment_id
required
string <uuid>

Responses

/rpc/user_can_manage_attachment

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
attachment_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "attachment_id": "4c76e620-6daa-46e6-9da1-9ac96abab601"
}

(rpc) upsert_notes

/rpc/upsert_notes

query Parameters
changes
required
string <jsonb>

Responses

/rpc/upsert_notes

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
changes
required
any <jsonb>

Responses

Request samples

Content type
{
  • "changes": null
}

(rpc) get_folders_for_user

/rpc/get_folders_for_user

query Parameters
user_id
required
string <uuid>
folder_type_ids
string <uuid[]>
state_ids
string <uuid[]>
return_deleted
boolean <boolean>

Responses

/rpc/get_folders_for_user

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_type_ids
Array of strings
return_deleted
boolean <boolean>
state_ids
Array of strings
user_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "folder_type_ids": [
    ],
  • "return_deleted": true,
  • "state_ids": [
    ],
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

(rpc) get_enumerators

/rpc/get_enumerators

Responses

/rpc/get_enumerators

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) get_project_constraints

/rpc/get_project_constraints

query Parameters
project_id
required
string <uuid>

Responses

/rpc/get_project_constraints

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
project_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"
}

(rpc) send_broadcast_event

/rpc/send_broadcast_event

query Parameters
event
required
string <text>
topic
required
string <text>
payload
required
string <jsonb>

Responses

/rpc/send_broadcast_event

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
event
required
string <text>
payload
required
any <jsonb>
topic
required
string <text>

Responses

Request samples

Content type
{
  • "event": "string",
  • "payload": null,
  • "topic": "string"
}

(rpc) get_user_folders_in_date_range

/rpc/get_user_folders_in_date_range

query Parameters
user_id
required
string <uuid>
start_date
required
string <timestamp with time zone>
end_date
required
string <timestamp with time zone>

Responses

/rpc/get_user_folders_in_date_range

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
end_date
required
string <timestamp with time zone>
start_date
required
string <timestamp with time zone>
user_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "end_date": "string",
  • "start_date": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

(rpc) create_current_scenario

/rpc/create_current_scenario

query Parameters
project_id
required
string <uuid>

Responses

/rpc/create_current_scenario

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
project_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"
}

(rpc) get_settings

/rpc/get_settings

Responses

/rpc/get_settings

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) upsert_actions

/rpc/upsert_actions

query Parameters
changes
required
string <jsonb[]>

Responses

/rpc/upsert_actions

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
changes
required
Array of any

Responses

Request samples

Content type
{
  • "changes": [
    ]
}

(rpc) has_read_permission_for_custom_attribute

/rpc/has_read_permission_for_custom_attribute

query Parameters
custom_attribute_definition_id
required
string <uuid>

Responses

/rpc/has_read_permission_for_custom_attribute

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
custom_attribute_definition_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "custom_attribute_definition_id": "831859ad-b6d2-4bdf-9020-e5ee9b2f5a00"
}

(rpc) update_versions_status

/rpc/update_versions_status

query Parameters
p_output_version_ids
required
string <uuid[]>
p_new_status_id
required
string <uuid>
as_user_email
string <text>

Responses

/rpc/update_versions_status

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
as_user_email
string <text>
p_new_status_id
required
string <uuid>
p_output_version_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "as_user_email": "string",
  • "p_new_status_id": "8b14243f-594c-4ee6-8bba-145ea7530b17",
  • "p_output_version_ids": [
    ]
}

(rpc) get_folder_by_name_and_parent

/rpc/get_folder_by_name_and_parent

query Parameters
project_name
required
string <text>
parent_name
required
string <text>
folder_name
required
string <text>

Responses

/rpc/get_folder_by_name_and_parent

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_name
required
string <text>
parent_name
required
string <text>
project_name
required
string <text>

Responses

Request samples

Content type
{
  • "folder_name": "string",
  • "parent_name": "string",
  • "project_name": "string"
}

(rpc) copy_folders

/rpc/copy_folders

query Parameters
source_ids
required
string <uuid[]>
target_id
required
string <uuid>
conflict_strategy
string <public.folder_conflict_strategy>
continue_on_error
boolean <boolean>

Responses

/rpc/copy_folders

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
conflict_strategy
string <public.folder_conflict_strategy>
continue_on_error
boolean <boolean>
source_ids
required
Array of strings
target_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "conflict_strategy": "string",
  • "continue_on_error": true,
  • "source_ids": [
    ],
  • "target_id": "d3bcdc92-4191-401b-ad0c-42056c6efab9"
}

(rpc) create_and_assign_folder_type

/rpc/create_and_assign_folder_type

query Parameters
input_data
required
string <jsonb>

Responses

/rpc/create_and_assign_folder_type

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
input_data
required
any <jsonb>

Responses

Request samples

Content type
{
  • "input_data": null
}

(rpc) create_payout

/rpc/create_payout

query Parameters
name
required
string <text>
note
required
string <text>
payment_reference
required
string <text>
payment_status_id
required
string <uuid>
start_date
required
string <timestamp with time zone>
end_date
required
string <timestamp with time zone>
user_id
required
string <uuid>
author_id
required
string <uuid>
worker_fee_ids
required
string <uuid[]>
tax_percentage
required
number <numeric>
tax_amount
required
number <numeric>

Responses

/rpc/create_payout

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
author_id
required
string <uuid>
end_date
required
string <timestamp with time zone>
name
required
string <text>
note
required
string <text>
payment_reference
required
string <text>
payment_status_id
required
string <uuid>
start_date
required
string <timestamp with time zone>
tax_amount
required
number <numeric>
tax_percentage
required
number <numeric>
user_id
required
string <uuid>
worker_fee_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "author_id": "78424c75-5c41-4b25-9735-3c9f7d05c59e",
  • "end_date": "string",
  • "name": "string",
  • "note": "string",
  • "payment_reference": "string",
  • "payment_status_id": "271a536c-038f-4123-84a2-9fb822c9c25b",
  • "start_date": "string",
  • "tax_amount": 0,
  • "tax_percentage": 0,
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "worker_fee_ids": [
    ]
}

(rpc) get_scheduler_data

/rpc/get_scheduler_data

query Parameters
project_id
required
string <uuid>
limit_number
integer <integer>
return_deleted
boolean <boolean>

Responses

/rpc/get_scheduler_data

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
limit_number
integer <integer>
project_id
required
string <uuid>
return_deleted
boolean <boolean>

Responses

Request samples

Content type
{
  • "limit_number": 0,
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "return_deleted": true
}

(rpc) delete_security_role_permissions

/rpc/delete_security_role_permissions

query Parameters
permission_id
required
string <uuid>
security_role_id
required
string <uuid>

Responses

/rpc/delete_security_role_permissions

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
permission_id
required
string <uuid>
security_role_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "permission_id": "2793a5a1-5444-40bb-8094-97de834ce9e4",
  • "security_role_id": "b17c01af-61d1-4f51-8db8-cda4f446777d"
}

(rpc) delete_webhook

/rpc/delete_webhook

query Parameters
table_name
required
string <text>
trigger_name
required
string <text>

Responses

/rpc/delete_webhook

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
table_name
required
string <text>
trigger_name
required
string <text>

Responses

Request samples

Content type
{
  • "table_name": "string",
  • "trigger_name": "string"
}

(rpc) generate_uuid

/rpc/generate_uuid

query Parameters
seed
required
string <text>

Responses

/rpc/generate_uuid

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
seed
required
string <text>

Responses

Request samples

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

(rpc) get_folder_parent_ids

/rpc/get_folder_parent_ids

query Parameters
folder_id
required
string <uuid>

Responses

/rpc/get_folder_parent_ids

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"
}

(rpc) capitalize

/rpc/capitalize

query Parameters
required
string <text>

Responses

/rpc/capitalize

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) find_common_folder_parent

/rpc/find_common_folder_parent

query Parameters
ids
required
string <uuid[]>

Responses

/rpc/find_common_folder_parent

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ids
required
Array of strings

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

(rpc) user_is_playlist_author

/rpc/user_is_playlist_author

query Parameters
playlist_id
required
string <uuid>

Responses

/rpc/user_is_playlist_author

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
playlist_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "playlist_id": "4a089bd6-aad8-455a-b371-0f37773c35d2"
}

(rpc) start_user_time_tracker

/rpc/start_user_time_tracker

query Parameters
user_id
required
string <uuid>
folder_id
required
string <uuid>

Responses

/rpc/start_user_time_tracker

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_id
required
string <uuid>
user_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

(rpc) get_next_version_number

/rpc/get_next_version_number

query Parameters
outcome_id
required
string <uuid>

Responses

/rpc/get_next_version_number

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
outcome_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "outcome_id": "0323e489-6bf9-4b68-9c8d-5674f46921e4"
}

(rpc) get_best_path_profiles

/rpc/get_best_path_profiles

query Parameters
profiles
required
string <jsonb>
host
required
string <text>
task_name
required
string <text>
task_type
required
string <text>
product_type
required
string <text>

Responses

/rpc/get_best_path_profiles

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
host
required
string <text>
product_type
required
string <text>
profiles
required
any <jsonb>
task_name
required
string <text>
task_type
required
string <text>

Responses

Request samples

Content type
{
  • "host": "string",
  • "product_type": "string",
  • "profiles": null,
  • "task_name": "string",
  • "task_type": "string"
}

(rpc) add_user_time_tracker

/rpc/add_user_time_tracker

query Parameters
folder_id
required
string <uuid>
description
required
string <text>
start_time
required
string <timestamp with time zone>
end_time
required
string <timestamp with time zone>
user_id
required
string <uuid>
iteration_id
required
string <uuid>

Responses

/rpc/add_user_time_tracker

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
description
required
string <text>
end_time
required
string <timestamp with time zone>
folder_id
required
string <uuid>
iteration_id
required
string <uuid>
start_time
required
string <timestamp with time zone>
user_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "description": "string",
  • "end_time": "string",
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "iteration_id": "97b5ab97-bbd5-4876-b0ff-f6dddd5449ca",
  • "start_time": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

(rpc) get_folder_path_ids

/rpc/get_folder_path_ids

query Parameters
ids
required
string <uuid[]>

Responses

/rpc/get_folder_path_ids

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ids
required
Array of strings

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

(rpc) upsert_security_role_permissions

/rpc/upsert_security_role_permissions

query Parameters
permission_id
required
string <uuid>
security_role_ids
required
string <uuid[]>

Responses

/rpc/upsert_security_role_permissions

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
permission_id
required
string <uuid>
security_role_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "permission_id": "2793a5a1-5444-40bb-8094-97de834ce9e4",
  • "security_role_ids": [
    ]
}

(rpc) update_playlist_components_order

/rpc/update_playlist_components_order

query Parameters
playlist_id
required
string <uuid>
component_ids
required
string <uuid[]>

Responses

/rpc/update_playlist_components_order

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
component_ids
required
Array of strings
playlist_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "component_ids": [
    ],
  • "playlist_id": "4a089bd6-aad8-455a-b371-0f37773c35d2"
}

(rpc) get_folders_for_current_user

/rpc/get_folders_for_current_user

query Parameters
folder_type_ids
string <uuid[]>
state_ids
string <uuid[]>
custom_attributes
string <text[]>
return_custom_attributes
boolean <boolean>
return_deleted
boolean <boolean>

Responses

/rpc/get_folders_for_current_user

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
custom_attributes
Array of strings
folder_type_ids
Array of strings
return_custom_attributes
boolean <boolean>
return_deleted
boolean <boolean>
state_ids
Array of strings

Responses

Request samples

Content type
{
  • "custom_attributes": [
    ],
  • "folder_type_ids": [
    ],
  • "return_custom_attributes": true,
  • "return_deleted": true,
  • "state_ids": [
    ]
}

(rpc) get_latest_version_with_thumbnail

/rpc/get_latest_version_with_thumbnail

query Parameters
folder_id
required
string <uuid>

Responses

/rpc/get_latest_version_with_thumbnail

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"
}

(rpc) diag_test_name

/rpc/diag_test_name

query Parameters
required
string <text>

Responses

/rpc/diag_test_name

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) get_best_name_profiles

/rpc/get_best_name_profiles

query Parameters
profiles
required
string <jsonb>
host
required
string <text>
task_name
required
string <text>
task_type
required
string <text>
product_type
required
string <text>

Responses

/rpc/get_best_name_profiles

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
host
required
string <text>
product_type
required
string <text>
profiles
required
any <jsonb>
task_name
required
string <text>
task_type
required
string <text>

Responses

Request samples

Content type
{
  • "host": "string",
  • "product_type": "string",
  • "profiles": null,
  • "task_name": "string",
  • "task_type": "string"
}

(rpc) todo

/rpc/todo

query Parameters
why
required
string <text>
how_many
required
integer <integer>

Responses

/rpc/todo

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
how_many
required
integer <integer>
why
required
string <text>

Responses

Request samples

Content type
{
  • "how_many": 0,
  • "why": "string"
}

(rpc) upload_payout_document

/rpc/upload_payout_document

query Parameters
documents
required
string <jsonb>
payout_id
required
string <uuid>
payment_reference
required
string <text>

Responses

/rpc/upload_payout_document

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
documents
required
any <jsonb>
payment_reference
required
string <text>
payout_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "documents": null,
  • "payment_reference": "string",
  • "payout_id": "89e4daf5-d103-4869-b9da-3d54ecc98dfe"
}

(rpc) current_user_id

/rpc/current_user_id

Responses

/rpc/current_user_id

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) get_project_by_output_id

/rpc/get_project_by_output_id

query Parameters
output_id
required
string <uuid>

Responses

/rpc/get_project_by_output_id

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
output_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "output_id": "91698f21-6d0d-4805-bf33-160da1b86362"
}

(rpc) user_is_note_author

/rpc/user_is_note_author

query Parameters
note_id
required
string <uuid>

Responses

/rpc/user_is_note_author

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
note_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "note_id": "f37a7c27-f466-4182-88ae-001e80802cdc"
}

(rpc) execute_query

/rpc/execute_query

query Parameters
ai_query
required
string <text>

Responses

/rpc/execute_query

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ai_query
required
string <text>

Responses

Request samples

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

(rpc) get_output_name

/rpc/get_output_name

query Parameters
folder_id
required
string <uuid>
suffix
required
string <text>

Responses

/rpc/get_output_name

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_id
required
string <uuid>
suffix
required
string <text>

Responses

Request samples

Content type
{
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "suffix": "string"
}

(rpc) todo_start

/rpc/todo_start

query Parameters
required
string <text>

Responses

/rpc/todo_start

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) has_unique

/rpc/has_unique

query Parameters
required
string <text>

Responses

/rpc/has_unique

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) get_folder_by_path

/rpc/get_folder_by_path

query Parameters
folder_path
required
string <text>

Responses

/rpc/get_folder_by_path

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_path
required
string <text>

Responses

Request samples

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

(rpc) create_project

/rpc/create_project

query Parameters
new_id
required
string <uuid>
project_definition_id
required
string <uuid>
create_new_project_definition
required
boolean <boolean>
project_status_id
required
string <uuid>
name
required
string <text>
code_name
required
string <text>
short_name
required
string <text>
start_date
required
string <timestamp with time zone>
end_date
required
string <timestamp with time zone>
description
required
string <text>
icon
required
string <text>
color
required
string <text>
client_id
required
string <uuid>
assignee_ids
required
string <uuid[]>
manager_ids
required
string <uuid[]>
reviewer_ids
required
string <uuid[]>
client_ids
required
string <uuid[]>
custom_attributes
required
string <jsonb>
restore_deleted
boolean <boolean>

Responses

/rpc/create_project

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
assignee_ids
required
Array of strings
client_id
required
string <uuid>
client_ids
required
Array of strings
code_name
required
string <text>
color
required
string <text>
create_new_project_definition
required
boolean <boolean>
custom_attributes
required
any <jsonb>
description
required
string <text>
end_date
required
string <timestamp with time zone>
icon
required
string <text>
manager_ids
required
Array of strings
name
required
string <text>
new_id
required
string <uuid>
project_definition_id
required
string <uuid>
project_status_id
required
string <uuid>
restore_deleted
boolean <boolean>
reviewer_ids
required
Array of strings
short_name
required
string <text>
start_date
required
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "assignee_ids": [
    ],
  • "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
  • "client_ids": [
    ],
  • "code_name": "string",
  • "color": "string",
  • "create_new_project_definition": true,
  • "custom_attributes": null,
  • "description": "string",
  • "end_date": "string",
  • "icon": "string",
  • "manager_ids": [
    ],
  • "name": "string",
  • "new_id": "fbf57724-2070-400e-a5c8-1963550ba853",
  • "project_definition_id": "2b80baf4-533a-4887-8845-e1bf8705bc37",
  • "project_status_id": "67097703-0720-4593-97bf-82ecaa2884e4",
  • "restore_deleted": true,
  • "reviewer_ids": [
    ],
  • "short_name": "string",
  • "start_date": "string"
}

(rpc) create_and_assign_folder_tags

/rpc/create_and_assign_folder_tags

query Parameters
input_data
required
string <jsonb>

Responses

/rpc/create_and_assign_folder_tags

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
input_data
required
any <jsonb>

Responses

Request samples

Content type
{
  • "input_data": null
}

(rpc) get_user_id_from_api_key

/rpc/get_user_id_from_api_key

query Parameters
apikey
required
string <text>

Responses

/rpc/get_user_id_from_api_key

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
apikey
required
string <text>

Responses

Request samples

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

(rpc) delete_and_replace_status

/rpc/delete_and_replace_status

query Parameters
delete_status_id
required
string <uuid>
replace_status_id
required
string <uuid>

Responses

/rpc/delete_and_replace_status

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
delete_status_id
required
string <uuid>
replace_status_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "delete_status_id": "429b48a9-8073-44b7-9d8e-3a0cc2aab946",
  • "replace_status_id": "5ccaf6bb-ecea-40b0-b069-c4a6b251d19c"
}

(rpc) add_folder_assignees

/rpc/add_folder_assignees

query Parameters
user_ids
required
string <uuid[]>
folder_ids
required
string <uuid[]>
assignee_role_id
required
string <uuid>

Responses

/rpc/add_folder_assignees

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
assignee_role_id
required
string <uuid>
folder_ids
required
Array of strings
user_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "assignee_role_id": "34743d2e-11bd-4d73-b9ee-e25f97b48f81",
  • "folder_ids": [
    ],
  • "user_ids": [
    ]
}

(rpc) get_latest_version_of_folders

/rpc/get_latest_version_of_folders

query Parameters
folder_ids
required
string <uuid[]>
return_only_reviewable
boolean <boolean>

Responses

/rpc/get_latest_version_of_folders

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_ids
required
Array of strings
return_only_reviewable
boolean <boolean>

Responses

Request samples

Content type
{
  • "folder_ids": [
    ],
  • "return_only_reviewable": true
}

(rpc) user_can_insert_output_version

/rpc/user_can_insert_output_version

query Parameters
output_id
required
string <uuid>
security_role_ids
required
string <uuid[]>

Responses

/rpc/user_can_insert_output_version

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
output_id
required
string <uuid>
security_role_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "output_id": "91698f21-6d0d-4805-bf33-160da1b86362",
  • "security_role_ids": [
    ]
}

(rpc) delete_storage_objects

/rpc/delete_storage_objects

query Parameters
bucket_name
required
string <text>
base_filename
required
string <text>

Responses

/rpc/delete_storage_objects

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
base_filename
required
string <text>
bucket_name
required
string <text>

Responses

Request samples

Content type
{
  • "base_filename": "string",
  • "bucket_name": "string"
}

(rpc) get_playlist_grid

/rpc/get_playlist_grid

query Parameters
parent_id
string <uuid>
project_id
string <uuid>
return_active
boolean <boolean>
return_private
boolean <boolean>
return_client
boolean <boolean>
return_from_deleted
boolean <boolean>
limit_number
integer <integer>

Responses

/rpc/get_playlist_grid

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
limit_number
integer <integer>
parent_id
string <uuid>
project_id
string <uuid>
return_active
boolean <boolean>
return_client
boolean <boolean>
return_from_deleted
boolean <boolean>
return_private
boolean <boolean>

Responses

Request samples

Content type
{
  • "limit_number": 0,
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "return_active": true,
  • "return_client": true,
  • "return_from_deleted": true,
  • "return_private": true
}

(rpc) user_has_permission_silent

/rpc/user_has_permission_silent

query Parameters
security_role_ids
required
string <uuid[]>

Responses

/rpc/user_has_permission_silent

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
security_role_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "security_role_ids": [
    ]
}

(rpc) create_scheduler_view

/rpc/create_scheduler_view

query Parameters
id
required
string <uuid>
name
required
string <text>
description
required
string <text>
is_public
required
boolean <boolean>
pivot_mode
required
boolean <boolean>
table_state
required
string <jsonb>
filter
required
string <text>
project_id
string <uuid>
folder_id
string <uuid>
owner_id
string <uuid>
view_group_id
string <uuid>
folder_type_ids
string <uuid[]>

Responses

/rpc/create_scheduler_view

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
description
required
string <text>
filter
required
string <text>
folder_id
string <uuid>
folder_type_ids
Array of strings
id
required
string <uuid>
is_public
required
boolean <boolean>
name
required
string <text>
owner_id
string <uuid>
pivot_mode
required
boolean <boolean>
project_id
string <uuid>
table_state
required
any <jsonb>
view_group_id
string <uuid>

Responses

Request samples

Content type
{
  • "description": "string",
  • "filter": "string",
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "folder_type_ids": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_public": true,
  • "name": "string",
  • "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  • "pivot_mode": true,
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "table_state": null,
  • "view_group_id": "88a6b93c-0fd6-4fc3-b978-6eab016a4d68"
}

(rpc) update_folder_statuses

/rpc/update_folder_statuses

query Parameters
folder_ids
required
string <uuid[]>
status_ids
required
string <uuid[]>
type
required
string <text>

Responses

/rpc/update_folder_statuses

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_ids
required
Array of strings
status_ids
required
Array of strings
type
required
string <text>

Responses

Request samples

Content type
{
  • "folder_ids": [
    ],
  • "status_ids": [
    ],
  • "type": "string"
}

(rpc) get_webhooks

/rpc/get_webhooks

Responses

/rpc/get_webhooks

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) set_default_project_definition

/rpc/set_default_project_definition

query Parameters
project_definition_id
required
string <uuid>

Responses

/rpc/set_default_project_definition

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
project_definition_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "project_definition_id": "2b80baf4-533a-4887-8845-e1bf8705bc37"
}

(rpc) update_webhook

/rpc/update_webhook

query Parameters
table_name
required
string <text>
trigger_name
required
string <text>
webhook_url
required
string <text>
trigger_events
required
string <text[]>
http_method
string <text>
headers
string <jsonb>
body
string <jsonb>
timeout_ms
integer <integer>

Responses

/rpc/update_webhook

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
body
any <jsonb>
headers
any <jsonb>
http_method
string <text>
table_name
required
string <text>
timeout_ms
integer <integer>
trigger_events
required
Array of strings
trigger_name
required
string <text>
webhook_url
required
string <text>

Responses

Request samples

Content type
{
  • "body": null,
  • "headers": null,
  • "http_method": "string",
  • "table_name": "string",
  • "timeout_ms": 0,
  • "trigger_events": [
    ],
  • "trigger_name": "string",
  • "webhook_url": "string"
}

(rpc) get_project_directory_structure

/rpc/get_project_directory_structure

query Parameters
project_id
required
string <uuid>

Responses

/rpc/get_project_directory_structure

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
project_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"
}

(rpc) _currtest

/rpc/_currtest

Responses

/rpc/_currtest

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) get_project_tree_data

/rpc/get_project_tree_data

query Parameters
project_id
string <uuid>
parent_id
string <uuid>
return_deleted
boolean <boolean>
max_level
integer <integer>

Responses

/rpc/get_project_tree_data

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
max_level
integer <integer>
parent_id
string <uuid>
project_id
string <uuid>
return_deleted
boolean <boolean>

Responses

Request samples

Content type
{
  • "max_level": 0,
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "return_deleted": true
}

(rpc) get_project_tasks

/rpc/get_project_tasks

query Parameters
project_ids
required
string <uuid[]>

Responses

/rpc/get_project_tasks

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
project_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "project_ids": [
    ]
}

(rpc) unaccent

/rpc/unaccent

query Parameters
required
string <text>

Responses

/rpc/unaccent

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) update_user_time_tracker

/rpc/update_user_time_tracker

query Parameters
user_time_tracker_id
required
string <uuid>
folder_id
string <uuid>
p_description
string <text>
start_time
string <timestamp with time zone>
end_time
string <timestamp with time zone>
user_id
string <uuid>
iteration_id
string <uuid>

Responses

/rpc/update_user_time_tracker

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
end_time
string <timestamp with time zone>
folder_id
string <uuid>
iteration_id
string <uuid>
p_description
string <text>
start_time
string <timestamp with time zone>
user_id
string <uuid>
user_time_tracker_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "end_time": "string",
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "iteration_id": "97b5ab97-bbd5-4876-b0ff-f6dddd5449ca",
  • "p_description": "string",
  • "start_time": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "user_time_tracker_id": "9a1e5ad3-116e-4c9d-ba78-fed9d31276a3"
}

(rpc) _query

/rpc/_query

query Parameters
required
string <text>

Responses

/rpc/_query

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) get_project_grid

/rpc/get_project_grid

query Parameters
parent_id
required
string <uuid>
folder_type_id
string <uuid>
limit_number
integer <integer>
custom_attributes
string <text[]>
return_custom_attributes
boolean <boolean>
return_links
boolean <boolean>
return_assignees
boolean <boolean>
return_recursive
boolean <boolean>
return_folder_template_source
boolean <boolean>
return_deleted
boolean <boolean>

Responses

/rpc/get_project_grid

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
custom_attributes
Array of strings
folder_type_id
string <uuid>
limit_number
integer <integer>
parent_id
required
string <uuid>
return_assignees
boolean <boolean>
return_custom_attributes
boolean <boolean>
return_deleted
boolean <boolean>
return_folder_template_source
boolean <boolean>
return_links
boolean <boolean>
return_recursive
boolean <boolean>

Responses

Request samples

Content type
{
  • "custom_attributes": [
    ],
  • "folder_type_id": "4877dd4f-f664-442c-a5e1-ad7846a12238",
  • "limit_number": 0,
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
  • "return_assignees": true,
  • "return_custom_attributes": true,
  • "return_deleted": true,
  • "return_folder_template_source": true,
  • "return_links": true,
  • "return_recursive": true
}

(rpc) update_folders_from_scenario

/rpc/update_folders_from_scenario

query Parameters
project_scenario_id
required
string <uuid>
use_soft_assignee_as_assignee
required
boolean <boolean>
update_ats
required
boolean <boolean>
update_deadline
required
boolean <boolean>
range_start
string <text>
range_end
string <text>
structure
string <jsonb>
task_ids
string <uuid[]>

Responses

/rpc/update_folders_from_scenario

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
project_scenario_id
required
string <uuid>
range_end
string <text>
range_start
string <text>
structure
any <jsonb>
task_ids
Array of strings
update_ats
required
boolean <boolean>
update_deadline
required
boolean <boolean>
use_soft_assignee_as_assignee
required
boolean <boolean>

Responses

Request samples

Content type
{
  • "project_scenario_id": "fc60d4bf-88f1-4225-9fe0-769ce80f75a2",
  • "range_end": "string",
  • "range_start": "string",
  • "structure": null,
  • "task_ids": [
    ],
  • "update_ats": true,
  • "update_deadline": true,
  • "use_soft_assignee_as_assignee": true
}

(rpc) skip

/rpc/skip

query Parameters
why
required
string <text>
how_many
required
integer <integer>

Responses

/rpc/skip

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
how_many
required
integer <integer>
why
required
string <text>

Responses

Request samples

Content type
{
  • "how_many": 0,
  • "why": "string"
}

(rpc) duplicate_folder_template

/rpc/duplicate_folder_template

query Parameters
folder_template_id
required
string <uuid>
new_name
required
string <text>
new_parent_id
string <uuid>

Responses

/rpc/duplicate_folder_template

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_template_id
required
string <uuid>
new_name
required
string <text>
new_parent_id
string <uuid>

Responses

Request samples

Content type
{
  • "folder_template_id": "9466babb-919d-4518-9148-2f80cdb7ef14",
  • "new_name": "string",
  • "new_parent_id": "95240cae-bfce-4d31-9b0f-a42763cd03ac"
}

(rpc) get_grouped_worker_fees

/rpc/get_grouped_worker_fees

query Parameters
fee_type
required
string <text>
start_date
required
string <timestamp with time zone>
end_date
required
string <timestamp with time zone>
payment_status_ids
string <uuid[]>
paid_only
boolean <boolean>

Responses

/rpc/get_grouped_worker_fees

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
end_date
required
string <timestamp with time zone>
fee_type
required
string <text>
paid_only
boolean <boolean>
payment_status_ids
Array of strings
start_date
required
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "end_date": "string",
  • "fee_type": "string",
  • "paid_only": true,
  • "payment_status_ids": [
    ],
  • "start_date": "string"
}

(rpc) build_folders_group_filter_conditions

/rpc/build_folders_group_filter_conditions

query Parameters
group_model
required
string <json>
group_keys
required
string <json>

Responses

/rpc/build_folders_group_filter_conditions

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
group_keys
required
any <json>
group_model
required
any <json>

Responses

Request samples

Content type
{
  • "group_keys": null,
  • "group_model": null
}

(rpc) get_publish_data

/rpc/get_publish_data

query Parameters
user_id
required
string <uuid>
project_id
required
string <uuid>
folder_id
required
string <uuid>
output_type_id
required
string <uuid>
host
string <text>
suffix
string <text>
comment
string <text>
template_type
string <text>
template_name
string <text>
default_values
string <json>

Responses

/rpc/get_publish_data

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
comment
string <text>
default_values
any <json>
folder_id
required
string <uuid>
host
string <text>
output_type_id
required
string <uuid>
project_id
required
string <uuid>
suffix
string <text>
template_name
string <text>
template_type
string <text>
user_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "comment": "string",
  • "default_values": null,
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "host": "string",
  • "output_type_id": "4f91c8e1-27d7-47a8-bfc9-0947d64f4a21",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "suffix": "string",
  • "template_name": "string",
  • "template_type": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

(rpc) upsert_output_automatic_actions

/rpc/upsert_output_automatic_actions

query Parameters
input_data
required
string <jsonb>

Responses

/rpc/upsert_output_automatic_actions

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
input_data
required
any <jsonb>

Responses

Request samples

Content type
{
  • "input_data": null
}

(rpc) upsert_folder_many

/rpc/upsert_folder_many

query Parameters
changes
required
string <jsonb>
conflict_strategy
string <public.folder_conflict_strategy>

Responses

/rpc/upsert_folder_many

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
changes
required
any <jsonb>
conflict_strategy
string <public.folder_conflict_strategy>

Responses

Request samples

Content type
{
  • "changes": null,
  • "conflict_strategy": "string"
}

(rpc) code_name

/rpc/code_name

query Parameters
input_string
required
string <text>

Responses

/rpc/code_name

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
input_string
required
string <text>

Responses

Request samples

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

(rpc) set_all_notifications_seen

/rpc/set_all_notifications_seen

query Parameters
user_id
string <uuid>

Responses

/rpc/set_all_notifications_seen

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
user_id
string <uuid>

Responses

Request samples

Content type
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

(rpc) get_client_folders_for_current_user

/rpc/get_client_folders_for_current_user

query Parameters
folder_type_ids
string <uuid[]>
state_ids
string <uuid[]>

Responses

/rpc/get_client_folders_for_current_user

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_type_ids
Array of strings
state_ids
Array of strings

Responses

Request samples

Content type
{
  • "folder_type_ids": [
    ],
  • "state_ids": [
    ]
}

(rpc) build_folders_paged_rows_cte

/rpc/build_folders_paged_rows_cte

query Parameters
group_model
required
string <json>
group_keys
required
string <json>
order_by_group_field
required
string <text>
order_by_sql
required
string <text>
all_fields
required
string <text[]>
from_index
required
integer <integer>
to_index
required
integer <integer>

Responses

/rpc/build_folders_paged_rows_cte

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
all_fields
required
Array of strings
from_index
required
integer <integer>
group_keys
required
any <json>
group_model
required
any <json>
order_by_group_field
required
string <text>
order_by_sql
required
string <text>
to_index
required
integer <integer>

Responses

Request samples

Content type
{
  • "all_fields": [
    ],
  • "from_index": 0,
  • "group_keys": null,
  • "group_model": null,
  • "order_by_group_field": "string",
  • "order_by_sql": "string",
  • "to_index": 0
}

(rpc) get_project_date_boundaries

/rpc/get_project_date_boundaries

query Parameters
project_ids
required
string <uuid[]>

Responses

/rpc/get_project_date_boundaries

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
project_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "project_ids": [
    ]
}

/rpc/update_iteration_and_related

query Parameters
iteration_id
required
string <uuid>

Responses

/rpc/update_iteration_and_related

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
iteration_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "iteration_id": "97b5ab97-bbd5-4876-b0ff-f6dddd5449ca"
}

(rpc) collect_chart_data

/rpc/collect_chart_data

Responses

/rpc/collect_chart_data

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) check_thumbnail_exists

/rpc/check_thumbnail_exists

query Parameters
objectname
required
string <character varying>

Responses

/rpc/check_thumbnail_exists

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
objectname
required
string <character varying>

Responses

Request samples

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

(rpc) update_project_definition

/rpc/update_project_definition

query Parameters
project_definition_id
required
string <uuid>
name
string <text>
is_active
boolean <boolean>
has_basic_folder_structure
boolean <boolean>
directory_structure_settings
string <jsonb>
roots
string <jsonb>
templates
string <jsonb>
output_name_settings
string <jsonb>
template_name_profiles
string <jsonb>
task_link_patterns
string <json>
default_priority_id
string <uuid>
default_note_category_id
string <uuid>
default_folder_type_id
string <uuid>
default_output_type_id
string <uuid>
default_type_id
string <uuid>
default_activity_type_id
string <uuid>
default_folder_status_id
string <uuid>
default_output_status_id
string <uuid>
custom_attribute_definition_ids
string <uuid[]>
priority_ids
string <uuid[]>
note_category_ids
string <uuid[]>
folder_type_ids
string <uuid[]>
output_type_ids
string <uuid[]>
type_ids
string <uuid[]>
activity_type_ids
string <uuid[]>
folder_status_ids
string <uuid[]>
output_status_ids
string <uuid[]>
tag_ids
string <uuid[]>

Responses

/rpc/update_project_definition

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
activity_type_ids
Array of strings
custom_attribute_definition_ids
Array of strings
default_activity_type_id
string <uuid>
default_folder_status_id
string <uuid>
default_folder_type_id
string <uuid>
default_note_category_id
string <uuid>
default_output_status_id
string <uuid>
default_output_type_id
string <uuid>
default_priority_id
string <uuid>
default_type_id
string <uuid>
directory_structure_settings
any <jsonb>
folder_status_ids
Array of strings
folder_type_ids
Array of strings
has_basic_folder_structure
boolean <boolean>
is_active
boolean <boolean>
name
string <text>
note_category_ids
Array of strings
output_name_settings
any <jsonb>
output_status_ids
Array of strings
output_type_ids
Array of strings
priority_ids
Array of strings
project_definition_id
required
string <uuid>
roots
any <jsonb>
tag_ids
Array of strings
task_link_patterns
any <json>
template_name_profiles
any <jsonb>
templates
any <jsonb>
type_ids
Array of strings

Responses

Request samples

Content type
{
  • "activity_type_ids": [
    ],
  • "custom_attribute_definition_ids": [
    ],
  • "default_activity_type_id": "167ce7f0-cbd4-41b0-969a-3a8fd895db90",
  • "default_folder_status_id": "153c006a-920f-4221-b10a-dfd8fe563401",
  • "default_folder_type_id": "0099219c-0cfd-415e-b719-9dcc87eb0d6b",
  • "default_note_category_id": "496461f0-f28f-4e5f-aed4-0ff3725b3448",
  • "default_output_status_id": "9b3c8240-48de-4e90-b866-db10e95f0cbd",
  • "default_output_type_id": "761cfeb9-fa8f-4888-aff1-5d5b15f94636",
  • "default_priority_id": "6972a2b2-3560-4182-a759-5a150f4af813",
  • "default_type_id": "82a197a3-238a-4c60-9cd7-ef9280876477",
  • "directory_structure_settings": null,
  • "folder_status_ids": [
    ],
  • "folder_type_ids": [
    ],
  • "has_basic_folder_structure": true,
  • "is_active": true,
  • "name": "string",
  • "note_category_ids": [
    ],
  • "output_name_settings": null,
  • "output_status_ids": [
    ],
  • "output_type_ids": [
    ],
  • "priority_ids": [
    ],
  • "project_definition_id": "2b80baf4-533a-4887-8845-e1bf8705bc37",
  • "roots": null,
  • "tag_ids": [
    ],
  • "task_link_patterns": null,
  • "template_name_profiles": null,
  • "templates": null,
  • "type_ids": [
    ]
}

(rpc) build_folders_pivot_key_expr

/rpc/build_folders_pivot_key_expr

query Parameters
pivot_cols
required
string <json>
separator
string <text>

Responses

/rpc/build_folders_pivot_key_expr

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
pivot_cols
required
any <json>
separator
string <text>

Responses

Request samples

Content type
{
  • "pivot_cols": null,
  • "separator": "string"
}

(rpc) create_webhook

/rpc/create_webhook

query Parameters
table_name
required
string <text>
trigger_name
required
string <text>
webhook_url
required
string <text>
trigger_events
required
string <text[]>
http_method
string <text>
headers
string <jsonb>
body
string <jsonb>
timeout_ms
integer <integer>

Responses

/rpc/create_webhook

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
body
any <jsonb>
headers
any <jsonb>
http_method
string <text>
table_name
required
string <text>
timeout_ms
integer <integer>
trigger_events
required
Array of strings
trigger_name
required
string <text>
webhook_url
required
string <text>

Responses

Request samples

Content type
{
  • "body": null,
  • "headers": null,
  • "http_method": "string",
  • "table_name": "string",
  • "timeout_ms": 0,
  • "trigger_events": [
    ],
  • "trigger_name": "string",
  • "webhook_url": "string"
}

(rpc) get_other_publish_data

/rpc/get_other_publish_data

query Parameters
user_id
required
string <uuid>
project_id
required
string <uuid>
folder_id
required
string <uuid>
output_type_id
required
string <uuid>
host
string <text>
suffix
string <text>
comment
string <text>
template_name
string <text>
default_values
string <json>

Responses

/rpc/get_other_publish_data

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
comment
string <text>
default_values
any <json>
folder_id
required
string <uuid>
host
string <text>
output_type_id
required
string <uuid>
project_id
required
string <uuid>
suffix
string <text>
template_name
string <text>
user_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "comment": "string",
  • "default_values": null,
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "host": "string",
  • "output_type_id": "4f91c8e1-27d7-47a8-bfc9-0947d64f4a21",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "suffix": "string",
  • "template_name": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

(rpc) get_default_studio_type_price

/rpc/get_default_studio_type_price

Responses

/rpc/get_default_studio_type_price

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) user_can_manage_user_skill

/rpc/user_can_manage_user_skill

query Parameters
user_skill_id
required
string <uuid>

Responses

/rpc/user_can_manage_user_skill

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
user_skill_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "user_skill_id": "3b83e7fa-7d2b-411e-9a84-442683667b07"
}

(rpc) delete_old_events

/rpc/delete_old_events

Responses

/rpc/delete_old_events

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) get_project_by_version_id

/rpc/get_project_by_version_id

query Parameters
version_id
required
string <uuid>

Responses

/rpc/get_project_by_version_id

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
version_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "version_id": "9e94c502-ca41-4342-a7f7-af96b444512c"
}

(rpc) get_playlists

/rpc/get_playlists

query Parameters
ids
required
string <uuid[]>

Responses

/rpc/get_playlists

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ids
required
Array of strings

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

(rpc) set_output_version_as_main

/rpc/set_output_version_as_main

query Parameters
output_version_id
required
string <uuid>

Responses

/rpc/set_output_version_as_main

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
output_version_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "output_version_id": "e19a0dbc-33ca-4b3a-aff0-0964e8604da2"
}

(rpc) is_authenticated

/rpc/is_authenticated

query Parameters
apikey
required
string <text>

Responses

/rpc/is_authenticated

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
apikey
required
string <text>

Responses

Request samples

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

(rpc) is_authenticated_or_anonymous

/rpc/is_authenticated_or_anonymous

query Parameters
apikey
required
string <text>

Responses

/rpc/is_authenticated_or_anonymous

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
apikey
required
string <text>

Responses

Request samples

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

(rpc) get_outputs_recursive

/rpc/get_outputs_recursive

query Parameters
parent_id
required
string <uuid>
is_external
boolean <boolean>
limit_number
integer <integer>

Responses

/rpc/get_outputs_recursive

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
is_external
boolean <boolean>
limit_number
integer <integer>
parent_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "is_external": true,
  • "limit_number": 0,
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef"
}

(rpc) user_can_manage_view

/rpc/user_can_manage_view

query Parameters
view_id
required
string <uuid>

Responses

/rpc/user_can_manage_view

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
view_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "view_id": "51ee3349-7269-4d2c-8a79-ea7055ee54f4"
}

(rpc) _get_note

/rpc/_get_note

query Parameters
required
string <text>

Responses

/rpc/_get_note

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) update_worker_fee_group

/rpc/update_worker_fee_group

query Parameters
worker_fee_ids
required
string <uuid[]>
payout_id
string <uuid>
payment_status_id
string <uuid>
hourly_rate
integer <integer>

Responses

/rpc/update_worker_fee_group

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
hourly_rate
integer <integer>
payment_status_id
string <uuid>
payout_id
string <uuid>
worker_fee_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "hourly_rate": 0,
  • "payment_status_id": "271a536c-038f-4123-84a2-9fb822c9c25b",
  • "payout_id": "89e4daf5-d103-4869-b9da-3d54ecc98dfe",
  • "worker_fee_ids": [
    ]
}

(rpc) add_project_assignees

/rpc/add_project_assignees

query Parameters
user_ids
required
string <uuid[]>
project_ids
required
string <uuid[]>
assignee_role_id
required
string <uuid>

Responses

/rpc/add_project_assignees

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
assignee_role_id
required
string <uuid>
project_ids
required
Array of strings
user_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "assignee_role_id": "34743d2e-11bd-4d73-b9ee-e25f97b48f81",
  • "project_ids": [
    ],
  • "user_ids": [
    ]
}

(rpc) get_project_by_folder_id

/rpc/get_project_by_folder_id

query Parameters
folder_id
required
string <uuid>

Responses

/rpc/get_project_by_folder_id

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"
}

(rpc) get_folders_by_paths

/rpc/get_folders_by_paths

query Parameters
input_paths
required
string <text[]>
return_only_active_projects
boolean <boolean>
return_only_my
boolean <boolean>
match_condition
string <text>
return_deleted
boolean <boolean>

Responses

/rpc/get_folders_by_paths

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
input_paths
required
Array of strings
match_condition
string <text>
return_deleted
boolean <boolean>
return_only_active_projects
boolean <boolean>
return_only_my
boolean <boolean>

Responses

Request samples

Content type
{
  • "input_paths": [
    ],
  • "match_condition": "string",
  • "return_deleted": true,
  • "return_only_active_projects": true,
  • "return_only_my": true
}

(rpc) create_playlist

/rpc/create_playlist

query Parameters
component_ids
required
string <uuid[]>
project_id
required
string <uuid>
playlist_name
string <text>
description
string <text>
link
string <text>
external_link
string <text>
is_active
boolean <boolean>
is_private
boolean <boolean>
is_client
boolean <boolean>
properties
string <jsonb>

Responses

/rpc/create_playlist

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
component_ids
required
Array of strings
description
string <text>
external_link
string <text>
is_active
boolean <boolean>
is_client
boolean <boolean>
is_private
boolean <boolean>
link
string <text>
playlist_name
string <text>
project_id
required
string <uuid>
properties
any <jsonb>

Responses

Request samples

Content type
{
  • "component_ids": [
    ],
  • "description": "string",
  • "external_link": "string",
  • "is_active": true,
  • "is_client": true,
  • "is_private": true,
  • "link": "string",
  • "playlist_name": "string",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "properties": null
}

(rpc) get_user_api_key

/rpc/get_user_api_key

query Parameters
user_id
required
string <uuid>

Responses

/rpc/get_user_api_key

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
user_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

(rpc) get_folders_recursive

/rpc/get_folders_recursive

query Parameters
parent_id
required
string <uuid>
folder_type_id
string <uuid>
limit_number
integer <integer>

Responses

/rpc/get_folders_recursive

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_type_id
string <uuid>
limit_number
integer <integer>
parent_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "folder_type_id": "4877dd4f-f664-442c-a5e1-ad7846a12238",
  • "limit_number": 0,
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef"
}

(rpc) set_file_types_to_output

/rpc/set_file_types_to_output

query Parameters
output_id
required
string <uuid>
file_type_ids
required
string <uuid[]>
logical_operator
required
string <text>

Responses

/rpc/set_file_types_to_output

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
file_type_ids
required
Array of strings
logical_operator
required
string <text>
output_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "file_type_ids": [
    ],
  • "logical_operator": "string",
  • "output_id": "91698f21-6d0d-4805-bf33-160da1b86362"
}

(rpc) pg_version_num

/rpc/pg_version_num

Responses

/rpc/pg_version_num

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) get_folders_by_path

/rpc/get_folders_by_path

query Parameters
input_path
required
string <text>
return_only_active_projects
boolean <boolean>
return_only_my
boolean <boolean>

Responses

/rpc/get_folders_by_path

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
input_path
required
string <text>
return_only_active_projects
boolean <boolean>
return_only_my
boolean <boolean>

Responses

Request samples

Content type
{
  • "input_path": "string",
  • "return_only_active_projects": true,
  • "return_only_my": true
}

(rpc) get_folders_for_bidding_recursive

/rpc/get_folders_for_bidding_recursive

query Parameters
parent_id
required
string <uuid>
folder_type_id
string <uuid>

Responses

/rpc/get_folders_for_bidding_recursive

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_type_id
string <uuid>
parent_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "folder_type_id": "4877dd4f-f664-442c-a5e1-ad7846a12238",
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef"
}

(rpc) get_folders

/rpc/get_folders

query Parameters
ids
string <uuid[]>
project_ids
string <uuid[]>
parent_ids
string <uuid[]>
type_ids
string <uuid[]>
folder_type_ids
string <uuid[]>
priority_ids
string <uuid[]>
status_ids
string <uuid[]>
created_from
string <timestamp with time zone>
created_to
string <timestamp with time zone>
updated_from
string <timestamp with time zone>
updated_to
string <timestamp with time zone>
return_deleted
boolean <boolean>

Responses

/rpc/get_folders

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
created_from
string <timestamp with time zone>
created_to
string <timestamp with time zone>
folder_type_ids
Array of strings
ids
Array of strings
parent_ids
Array of strings
priority_ids
Array of strings
project_ids
Array of strings
return_deleted
boolean <boolean>
status_ids
Array of strings
type_ids
Array of strings
updated_from
string <timestamp with time zone>
updated_to
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "created_from": "string",
  • "created_to": "string",
  • "folder_type_ids": [
    ],
  • "ids": [
    ],
  • "parent_ids": [
    ],
  • "priority_ids": [
    ],
  • "project_ids": [
    ],
  • "return_deleted": true,
  • "status_ids": [
    ],
  • "type_ids": [
    ],
  • "updated_from": "string",
  • "updated_to": "string"
}

(rpc) get_output_versions_for_review_tool

/rpc/get_output_versions_for_review_tool

query Parameters
ids
required
string <uuid[]>

Responses

/rpc/get_output_versions_for_review_tool

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ids
required
Array of strings

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

(rpc) get_user_time_trackers

/rpc/get_user_time_trackers

query Parameters
user_id
string <uuid>
folder_id
string <uuid>
is_live
boolean <boolean>
return_recursive
boolean <boolean>

Responses

/rpc/get_user_time_trackers

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_id
string <uuid>
is_live
boolean <boolean>
return_recursive
boolean <boolean>
user_id
string <uuid>

Responses

Request samples

Content type
{
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "is_live": true,
  • "return_recursive": true,
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

(rpc) user_has_permission

/rpc/user_has_permission

query Parameters
security_role_ids
required
string <uuid[]>

Responses

/rpc/user_has_permission

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
security_role_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "security_role_ids": [
    ]
}

(rpc) user_can_manage_user

/rpc/user_can_manage_user

query Parameters
user_update_id
required
string <uuid>

Responses

/rpc/user_can_manage_user

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
user_update_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "user_update_id": "0cbea07a-65b8-403c-bf3a-a193ee0c889d"
}

(rpc) update_folder_custom_attribute

/rpc/update_folder_custom_attribute

query Parameters
folder_id
required
string <uuid>
custom_attribute
required
string <text>
attribute_value
required
string <text>

Responses

/rpc/update_folder_custom_attribute

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
attribute_value
required
string <text>
custom_attribute
required
string <text>
folder_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "attribute_value": "string",
  • "custom_attribute": "string",
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"
}

(rpc) get_folder_code_name_paths

/rpc/get_folder_code_name_paths

query Parameters
ids
required
string <uuid[]>

Responses

/rpc/get_folder_code_name_paths

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ids
required
Array of strings

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

(rpc) delete_application_file_types

/rpc/delete_application_file_types

query Parameters
application_ids
required
string <uuid[]>
file_type_ids
required
string <uuid[]>

Responses

/rpc/delete_application_file_types

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
application_ids
required
Array of strings
file_type_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "application_ids": [
    ],
  • "file_type_ids": [
    ]
}

(rpc) get_project_folders

/rpc/get_project_folders

query Parameters
project_id
required
string <uuid>
max_level
integer <integer>

Responses

/rpc/get_project_folders

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
max_level
integer <integer>
project_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "max_level": 0,
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"
}

(rpc) user_can_insert_component

/rpc/user_can_insert_component

query Parameters
output_version_id
required
string <uuid>
security_role_ids
required
string <uuid[]>

Responses

/rpc/user_can_insert_component

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
output_version_id
required
string <uuid>
security_role_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "output_version_id": "e19a0dbc-33ca-4b3a-aff0-0964e8604da2",
  • "security_role_ids": [
    ]
}

(rpc) user_can_insert_output

/rpc/user_can_insert_output

query Parameters
output_folder_id
required
string <uuid>
security_role_ids
required
string <uuid[]>

Responses

/rpc/user_can_insert_output

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
output_folder_id
required
string <uuid>
security_role_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "output_folder_id": "c0c1616e-055a-47a2-b982-acd7a43d88cb",
  • "security_role_ids": [
    ]
}

(rpc) get_notes_public

/rpc/get_notes_public

query Parameters
ids
string <uuid[]>
project_ids
string <uuid[]>
folder_ids
string <uuid[]>
note_category_ids
string <uuid[]>
output_version_ids
string <uuid[]>
component_ids
string <uuid[]>
parent_ids
string <uuid[]>
author_ids
string <uuid[]>
created_from
string <timestamp with time zone>
created_to
string <timestamp with time zone>
updated_from
string <timestamp with time zone>
updated_to
string <timestamp with time zone>
is_autogenerated
boolean <boolean>
frame_from
integer <integer>
frame_to
integer <integer>
is_pinned
boolean <boolean>
from_index
integer <integer>
to_index
integer <integer>

Responses

/rpc/get_notes_public

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
author_ids
Array of strings
component_ids
Array of strings
created_from
string <timestamp with time zone>
created_to
string <timestamp with time zone>
folder_ids
Array of strings
frame_from
integer <integer>
frame_to
integer <integer>
from_index
integer <integer>
ids
Array of strings
is_autogenerated
boolean <boolean>
is_pinned
boolean <boolean>
note_category_ids
Array of strings
output_version_ids
Array of strings
parent_ids
Array of strings
project_ids
Array of strings
to_index
integer <integer>
updated_from
string <timestamp with time zone>
updated_to
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "author_ids": [
    ],
  • "component_ids": [
    ],
  • "created_from": "string",
  • "created_to": "string",
  • "folder_ids": [
    ],
  • "frame_from": 0,
  • "frame_to": 0,
  • "from_index": 0,
  • "ids": [
    ],
  • "is_autogenerated": true,
  • "is_pinned": true,
  • "note_category_ids": [
    ],
  • "output_version_ids": [
    ],
  • "parent_ids": [
    ],
  • "project_ids": [
    ],
  • "to_index": 0,
  • "updated_from": "string",
  • "updated_to": "string"
}

(rpc) _todo

/rpc/_todo

Responses

/rpc/_todo

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) _prokind

/rpc/_prokind

query Parameters
p_oid
required
string <oid>

Responses

/rpc/_prokind

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
p_oid
required
string <oid>

Responses

Request samples

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

(rpc) get_template_keys

/rpc/get_template_keys

query Parameters
user_id
required
string <uuid>
project_id
required
string <uuid>
folder_id
required
string <uuid>
output_type_id
required
string <uuid>
host
string <text>
suffix
string <text>
comment
string <text>
default_values
string <json>

Responses

/rpc/get_template_keys

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
comment
string <text>
default_values
any <json>
folder_id
required
string <uuid>
host
string <text>
output_type_id
required
string <uuid>
project_id
required
string <uuid>
suffix
string <text>
user_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "comment": "string",
  • "default_values": null,
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "host": "string",
  • "output_type_id": "4f91c8e1-27d7-47a8-bfc9-0947d64f4a21",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "suffix": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

(rpc) normalize_path

/rpc/normalize_path

query Parameters
input_path
required
string <text>
platform
required
string <text>

Responses

/rpc/normalize_path

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
input_path
required
string <text>
platform
required
string <text>

Responses

Request samples

Content type
{
  • "input_path": "string",
  • "platform": "string"
}

(rpc) update_playlist

/rpc/update_playlist

query Parameters
playlist_id
required
string <uuid>
component_ids
string <uuid[]>
playlist_name
string <text>
description
string <text>
link
string <text>
external_link
string <text>
is_active
boolean <boolean>
is_private
boolean <boolean>
is_client
boolean <boolean>
properties
string <jsonb>
properties_is_set
boolean <boolean>

Responses

/rpc/update_playlist

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
component_ids
Array of strings
description
string <text>
external_link
string <text>
is_active
boolean <boolean>
is_client
boolean <boolean>
is_private
boolean <boolean>
link
string <text>
playlist_id
required
string <uuid>
playlist_name
string <text>
properties
any <jsonb>
properties_is_set
boolean <boolean>

Responses

Request samples

Content type
{
  • "component_ids": [
    ],
  • "description": "string",
  • "external_link": "string",
  • "is_active": true,
  • "is_client": true,
  • "is_private": true,
  • "link": "string",
  • "playlist_id": "4a089bd6-aad8-455a-b371-0f37773c35d2",
  • "playlist_name": "string",
  • "properties": null,
  • "properties_is_set": true
}

(rpc) create_and_assign_output_version_tags

/rpc/create_and_assign_output_version_tags

query Parameters
input_data
required
string <jsonb>

Responses

/rpc/create_and_assign_output_version_tags

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
input_data
required
any <jsonb>

Responses

Request samples

Content type
{
  • "input_data": null
}

(rpc) in_todo

/rpc/in_todo

Responses

/rpc/in_todo

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) delete_note

/rpc/delete_note

query Parameters
note_id
required
string <uuid>

Responses

/rpc/delete_note

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
note_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "note_id": "f37a7c27-f466-4182-88ae-001e80802cdc"
}

(rpc) find_constraints

/rpc/find_constraints

query Parameters
folder_id
required
string <uuid>
complexity
required
integer <integer>
type_id
required
string <uuid>

Responses

/rpc/find_constraints

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
complexity
required
integer <integer>
folder_id
required
string <uuid>
type_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "complexity": 0,
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "type_id": "d9779ea4-ba95-4824-86d7-4f1ac083a564"
}

(rpc) user_is_attachment_author

/rpc/user_is_attachment_author

query Parameters
attachment_id
required
string <uuid>

Responses

/rpc/user_is_attachment_author

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
attachment_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "attachment_id": "4c76e620-6daa-46e6-9da1-9ac96abab601"
}

(rpc) isnt_empty

/rpc/isnt_empty

query Parameters
required
string <text>

Responses

/rpc/isnt_empty

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) get_anonymous_user

/rpc/get_anonymous_user

query Parameters
email
required
string <text>

Responses

/rpc/get_anonymous_user

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
email
required
string <text>

Responses

Request samples

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

(rpc) get_payouts_with_details

/rpc/get_payouts_with_details

query Parameters
paid_only
boolean <boolean>
start_date
string <date>
end_date
string <date>
payment_status_ids
string <uuid[]>

Responses

/rpc/get_payouts_with_details

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
end_date
string <date>
paid_only
boolean <boolean>
payment_status_ids
Array of strings
start_date
string <date>

Responses

Request samples

Content type
{
  • "end_date": "2019-08-24",
  • "paid_only": true,
  • "payment_status_ids": [
    ],
  • "start_date": "2019-08-24"
}

(rpc) throws_ok

/rpc/throws_ok

query Parameters
required
string <text>

Responses

/rpc/throws_ok

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) get_version_grid

/rpc/get_version_grid

query Parameters
ids
string <uuid[]>
parent_id
string <uuid>
project_id
string <uuid>
return_only_latest
boolean <boolean>
return_recursive
boolean <boolean>
return_only_client_reviewable
boolean <boolean>
return_only_my
boolean <boolean>
limit_number
integer <integer>
state_ids
string <uuid[]>
project_assignee_role_ids
string <uuid[]>
folder_assignee_role_ids
string <uuid[]>
return_from_deleted
boolean <boolean>

Responses

/rpc/get_version_grid

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_assignee_role_ids
Array of strings
ids
Array of strings
limit_number
integer <integer>
parent_id
string <uuid>
project_assignee_role_ids
Array of strings
project_id
string <uuid>
return_from_deleted
boolean <boolean>
return_only_client_reviewable
boolean <boolean>
return_only_latest
boolean <boolean>
return_only_my
boolean <boolean>
return_recursive
boolean <boolean>
state_ids
Array of strings

Responses

Request samples

Content type
{
  • "folder_assignee_role_ids": [
    ],
  • "ids": [
    ],
  • "limit_number": 0,
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
  • "project_assignee_role_ids": [
    ],
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "return_from_deleted": true,
  • "return_only_client_reviewable": true,
  • "return_only_latest": true,
  • "return_only_my": true,
  • "return_recursive": true,
  • "state_ids": [
    ]
}

(rpc) user_can_manage_playlist

/rpc/user_can_manage_playlist

query Parameters
playlist_id
required
string <uuid>

Responses

/rpc/user_can_manage_playlist

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
playlist_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "playlist_id": "4a089bd6-aad8-455a-b371-0f37773c35d2"
}

(rpc) findfuncs

/rpc/findfuncs

query Parameters
required
string <text>

Responses

/rpc/findfuncs

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) delete_folder_tags

/rpc/delete_folder_tags

query Parameters
tag_ids
required
string <uuid[]>
folder_ids
required
string <uuid[]>

Responses

/rpc/delete_folder_tags

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_ids
required
Array of strings
tag_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "folder_ids": [
    ],
  • "tag_ids": [
    ]
}

(rpc) delete_and_replace_folder_type

/rpc/delete_and_replace_folder_type

query Parameters
delete_folder_type_id
required
string <uuid>
replace_folder_type_id
required
string <uuid>

Responses

/rpc/delete_and_replace_folder_type

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
delete_folder_type_id
required
string <uuid>
replace_folder_type_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "delete_folder_type_id": "b0f44ee0-970c-49a8-b6ac-9f8e27f9efc3",
  • "replace_folder_type_id": "f737cec0-3bf9-4ef4-9426-c2d9644a2ad8"
}

(rpc) check_entities_affected_by_deletion

/rpc/check_entities_affected_by_deletion

query Parameters
table_name
required
string <text>
filter_column_name
required
string <text>
delete_entity_id
required
string <uuid>
template_table_name
required
string <text>
template_filter_column_name
required
string <text>
definition_join_table_name
required
string <text>
definition_filter_column_name
required
string <text>

Responses

/rpc/check_entities_affected_by_deletion

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
definition_filter_column_name
required
string <text>
definition_join_table_name
required
string <text>
delete_entity_id
required
string <uuid>
filter_column_name
required
string <text>
table_name
required
string <text>
template_filter_column_name
required
string <text>
template_table_name
required
string <text>

Responses

Request samples

Content type
{
  • "definition_filter_column_name": "string",
  • "definition_join_table_name": "string",
  • "delete_entity_id": "20a92a51-9578-43bc-86db-284096900d40",
  • "filter_column_name": "string",
  • "table_name": "string",
  • "template_filter_column_name": "string",
  • "template_table_name": "string"
}

(rpc) get_outputs_by_ids

/rpc/get_outputs_by_ids

query Parameters
ids
required
string <uuid[]>

Responses

/rpc/get_outputs_by_ids

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ids
required
Array of strings

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

(rpc) _is_verbose

/rpc/_is_verbose

Responses

/rpc/_is_verbose

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) delete_output_version_tags

/rpc/delete_output_version_tags

query Parameters
tag_ids
required
string <uuid[]>
output_version_ids
required
string <uuid[]>

Responses

/rpc/delete_output_version_tags

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
output_version_ids
required
Array of strings
tag_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "output_version_ids": [
    ],
  • "tag_ids": [
    ]
}

(rpc) get_folder_template_placeholders

/rpc/get_folder_template_placeholders

query Parameters
folder_type_id
string <uuid>
project_definition_id
string <uuid>

Responses

/rpc/get_folder_template_placeholders

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_type_id
string <uuid>
project_definition_id
string <uuid>

Responses

Request samples

Content type
{
  • "folder_type_id": "4877dd4f-f664-442c-a5e1-ad7846a12238",
  • "project_definition_id": "2b80baf4-533a-4887-8845-e1bf8705bc37"
}

(rpc) delete_projects

/rpc/delete_projects

query Parameters
ids
required
string <uuid[]>

Responses

/rpc/delete_projects

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ids
required
Array of strings

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

(rpc) get_all_folder_row_ids

/rpc/get_all_folder_row_ids

query Parameters
parent_id
required
string <uuid>
folder_type_id
string <uuid>
return_recursive
boolean <boolean>
return_deleted
boolean <boolean>
filter_model
string <json>
group_model
string <json>
group_keys
string <json>

Responses

/rpc/get_all_folder_row_ids

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
filter_model
any <json>
folder_type_id
string <uuid>
group_keys
any <json>
group_model
any <json>
parent_id
required
string <uuid>
return_deleted
boolean <boolean>
return_recursive
boolean <boolean>

Responses

Request samples

Content type
{
  • "filter_model": null,
  • "folder_type_id": "4877dd4f-f664-442c-a5e1-ad7846a12238",
  • "group_keys": null,
  • "group_model": null,
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
  • "return_deleted": true,
  • "return_recursive": true
}

(rpc) get_folder_paths_simple

/rpc/get_folder_paths_simple

query Parameters
ids
required
string <uuid[]>

Responses

/rpc/get_folder_paths_simple

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ids
required
Array of strings

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

(rpc) fail

/rpc/fail

query Parameters
required
string <text>

Responses

/rpc/fail

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) upsert_folder_template_bidding_override_many

/rpc/upsert_folder_template_bidding_override_many

query Parameters
input_data
required
string <jsonb>

Responses

/rpc/upsert_folder_template_bidding_override_many

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
input_data
required
any <jsonb>

Responses

Request samples

Content type
{
  • "input_data": null
}

(rpc) parse_root

/rpc/parse_root

query Parameters
template
required
string <text>
roots
required
string <jsonb>

Responses

/rpc/parse_root

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
roots
required
any <jsonb>
template
required
string <text>

Responses

Request samples

Content type
{
  • "roots": null,
  • "template": "string"
}

(rpc) get_project_size

/rpc/get_project_size

query Parameters
project_id
required
string <uuid>

Responses

/rpc/get_project_size

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
project_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"
}

(rpc) delete_and_replace_priority

/rpc/delete_and_replace_priority

query Parameters
delete_priority_id
required
string <uuid>
replace_priority_id
required
string <uuid>

Responses

/rpc/delete_and_replace_priority

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
delete_priority_id
required
string <uuid>
replace_priority_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "delete_priority_id": "53bacaf1-0769-414a-a89e-4dd13c6b8e25",
  • "replace_priority_id": "b4aabc8e-dfea-4364-81d4-75a519b82c3f"
}

(rpc) user_is_assignee_of_project

/rpc/user_is_assignee_of_project

query Parameters
project_id
required
string <uuid>

Responses

/rpc/user_is_assignee_of_project

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
project_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"
}

(rpc) get_folders_recursive_many

/rpc/get_folders_recursive_many

query Parameters
parent_ids
required
string <uuid[]>
folder_type_id
string <uuid>

Responses

/rpc/get_folders_recursive_many

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_type_id
string <uuid>
parent_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "folder_type_id": "4877dd4f-f664-442c-a5e1-ad7846a12238",
  • "parent_ids": [
    ]
}

(rpc) parse_templates

/rpc/parse_templates

query Parameters
templates
required
string <jsonb>
template_data
required
string <jsonb>

Responses

/rpc/parse_templates

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
template_data
required
any <jsonb>
templates
required
any <jsonb>

Responses

Request samples

Content type
{
  • "template_data": null,
  • "templates": null
}

(rpc) delete_folders

/rpc/delete_folders

query Parameters
ids
required
string <uuid[]>
hard_delete
boolean <boolean>
return_deleted
boolean <boolean>

Responses

/rpc/delete_folders

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
hard_delete
boolean <boolean>
ids
required
Array of strings
return_deleted
boolean <boolean>

Responses

Request samples

Content type
{
  • "hard_delete": true,
  • "ids": [
    ],
  • "return_deleted": true
}

(rpc) lives_ok

/rpc/lives_ok

query Parameters
required
string <text>

Responses

/rpc/lives_ok

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) log_activity

/rpc/log_activity

query Parameters
p_change_json
required
string <text>
p_data_json
required
string <text>
p_context_id
required
string <uuid>
p_context_type
required
string <text>
p_folder_id
required
string <uuid>
p_action_label
required
string <text>
p_activity_type_id
required
string <uuid>
p_context_record_id
required
string <uuid>

Responses

/rpc/log_activity

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
p_action_label
required
string <text>
p_activity_type_id
required
string <uuid>
p_change_json
required
string <text>
p_context_id
required
string <uuid>
p_context_record_id
required
string <uuid>
p_context_type
required
string <text>
p_data_json
required
string <text>
p_folder_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "p_action_label": "string",
  • "p_activity_type_id": "9f23dd0b-76e9-4d0a-b508-7d48c9ccc7da",
  • "p_change_json": "string",
  • "p_context_id": "ffd3a6b2-2883-416c-832a-79aaff25066d",
  • "p_context_record_id": "5febdb2f-c7f1-4514-919a-aa0caa97c6e9",
  • "p_context_type": "string",
  • "p_data_json": "string",
  • "p_folder_id": "dc556963-d886-444c-bb8e-6deb97b3fc5d"
}

(rpc) user_is_notification_owner

/rpc/user_is_notification_owner

query Parameters
notification_id
required
string <uuid>

Responses

/rpc/user_is_notification_owner

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
notification_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "notification_id": "f96afe21-aef9-465c-a9f6-813055655b04"
}

(rpc) user_can_insert_storage_record

/rpc/user_can_insert_storage_record

query Parameters
component_id
required
string <uuid>
security_role_ids
required
string <uuid[]>

Responses

/rpc/user_can_insert_storage_record

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
component_id
required
string <uuid>
security_role_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "component_id": "41afafe5-2a48-424a-baef-34c2ad44ef7b",
  • "security_role_ids": [
    ]
}

(rpc) col_is_null

/rpc/col_is_null

query Parameters
schema_name
required
string <name>
table_name
required
string <name>
column_name
required
string <name>
description
string <text>

Responses

/rpc/col_is_null

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
column_name
required
string <name>
description
string <text>
schema_name
required
string <name>
table_name
required
string <name>

Responses

Request samples

Content type
{
  • "column_name": "string",
  • "description": "string",
  • "schema_name": "string",
  • "table_name": "string"
}

(rpc) todo_end

/rpc/todo_end

Responses

/rpc/todo_end

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) get_external_inputs

/rpc/get_external_inputs

query Parameters
folder_id
required
string <uuid>

Responses

/rpc/get_external_inputs

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"
}

(rpc) get_wasabi_assigned_components

/rpc/get_wasabi_assigned_components

query Parameters
days_since_creation
required
integer <integer>
timestamp_filter
required
string <timestamp without time zone>

Responses

/rpc/get_wasabi_assigned_components

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
days_since_creation
required
integer <integer>
timestamp_filter
required
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "days_since_creation": 0,
  • "timestamp_filter": "string"
}

(rpc) get_project_grid_ssrm

/rpc/get_project_grid_ssrm

query Parameters
parent_id
required
string <uuid>
folder_type_id
string <uuid>
limit_number
integer <integer>
custom_attributes
string <text[]>
return_custom_attributes
boolean <boolean>
return_links
boolean <boolean>
return_assignees
boolean <boolean>
return_recursive
boolean <boolean>
return_folder_template_source
boolean <boolean>
return_deleted
boolean <boolean>
from_index
integer <integer>
to_index
integer <integer>
filter_model
string <json>
sort_model
string <json>
group_model
string <json>
group_keys
string <json>
pivot_mode
boolean <boolean>
pivot_cols
string <json>
value_cols
string <json>
pivot_field_separator
string <text>

Responses

/rpc/get_project_grid_ssrm

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
custom_attributes
Array of strings
filter_model
any <json>
folder_type_id
string <uuid>
from_index
integer <integer>
group_keys
any <json>
group_model
any <json>
limit_number
integer <integer>
parent_id
required
string <uuid>
pivot_cols
any <json>
pivot_field_separator
string <text>
pivot_mode
boolean <boolean>
return_assignees
boolean <boolean>
return_custom_attributes
boolean <boolean>
return_deleted
boolean <boolean>
return_folder_template_source
boolean <boolean>
return_links
boolean <boolean>
return_recursive
boolean <boolean>
sort_model
any <json>
to_index
integer <integer>
value_cols
any <json>

Responses

Request samples

Content type
{
  • "custom_attributes": [
    ],
  • "filter_model": null,
  • "folder_type_id": "4877dd4f-f664-442c-a5e1-ad7846a12238",
  • "from_index": 0,
  • "group_keys": null,
  • "group_model": null,
  • "limit_number": 0,
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
  • "pivot_cols": null,
  • "pivot_field_separator": "string",
  • "pivot_mode": true,
  • "return_assignees": true,
  • "return_custom_attributes": true,
  • "return_deleted": true,
  • "return_folder_template_source": true,
  • "return_links": true,
  • "return_recursive": true,
  • "sort_model": null,
  • "to_index": 0,
  • "value_cols": null
}

(rpc) get_me

/rpc/get_me

Responses

/rpc/get_me

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) _table_privs

/rpc/_table_privs

Responses

/rpc/_table_privs

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) no_plan

/rpc/no_plan

Responses

/rpc/no_plan

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) build_folders_total_count

/rpc/build_folders_total_count

query Parameters
group_model
required
string <json>
group_keys
required
string <json>

Responses

/rpc/build_folders_total_count

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
group_keys
required
any <json>
group_model
required
any <json>

Responses

Request samples

Content type
{
  • "group_keys": null,
  • "group_model": null
}

(rpc) update_scheduler_view

/rpc/update_scheduler_view

query Parameters
id
required
string <uuid>
name
required
string <text>
description
required
string <text>
is_public
required
boolean <boolean>
pivot_mode
required
boolean <boolean>
table_state
required
string <jsonb>
filter
required
string <text>
project_id
string <uuid>
folder_id
string <uuid>
owner_id
string <uuid>
view_group_id
string <uuid>
folder_type_ids
string <uuid[]>

Responses

/rpc/update_scheduler_view

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
description
required
string <text>
filter
required
string <text>
folder_id
string <uuid>
folder_type_ids
Array of strings
id
required
string <uuid>
is_public
required
boolean <boolean>
name
required
string <text>
owner_id
string <uuid>
pivot_mode
required
boolean <boolean>
project_id
string <uuid>
table_state
required
any <jsonb>
view_group_id
string <uuid>

Responses

Request samples

Content type
{
  • "description": "string",
  • "filter": "string",
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "folder_type_ids": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_public": true,
  • "name": "string",
  • "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  • "pivot_mode": true,
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "table_state": null,
  • "view_group_id": "88a6b93c-0fd6-4fc3-b978-6eab016a4d68"
}

(rpc) add_type_to_project_definition

/rpc/add_type_to_project_definition

query Parameters
project_definition_id
required
string <uuid>
type_id
required
string <uuid>
price
number <numeric>

Responses

/rpc/add_type_to_project_definition

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
price
number <numeric>
project_definition_id
required
string <uuid>
type_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "price": 0,
  • "project_definition_id": "2b80baf4-533a-4887-8845-e1bf8705bc37",
  • "type_id": "d9779ea4-ba95-4824-86d7-4f1ac083a564"
}

(rpc) user_is_document_template_author

/rpc/user_is_document_template_author

query Parameters
document_template_id
required
string <uuid>

Responses

/rpc/user_is_document_template_author

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
document_template_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "document_template_id": "2574412b-843e-409c-ab85-b4d8aeb24485"
}

(rpc) restore_folders

/rpc/restore_folders

query Parameters
ids
required
string <uuid[]>

Responses

/rpc/restore_folders

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ids
required
Array of strings

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

(rpc) get_projects

/rpc/get_projects

query Parameters
project_ids
string <uuid[]>
status_ids
string <uuid[]>
search_text
string <text>
from_index
integer <integer>
to_index
integer <integer>
return_deleted
boolean <boolean>

Responses

/rpc/get_projects

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
from_index
integer <integer>
project_ids
Array of strings
return_deleted
boolean <boolean>
search_text
string <text>
status_ids
Array of strings
to_index
integer <integer>

Responses

Request samples

Content type
{
  • "from_index": 0,
  • "project_ids": [
    ],
  • "return_deleted": true,
  • "search_text": "string",
  • "status_ids": [
    ],
  • "to_index": 0
}

(rpc) user_is_user_skill_owner

/rpc/user_is_user_skill_owner

query Parameters
user_skill_id
required
string <uuid>

Responses

/rpc/user_is_user_skill_owner

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
user_skill_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "user_skill_id": "3b83e7fa-7d2b-411e-9a84-442683667b07"
}

(rpc) build_filter_conditions

/rpc/build_filter_conditions

query Parameters
filter_model
required
string <json>

Responses

/rpc/build_filter_conditions

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
filter_model
required
any <json>

Responses

Request samples

Content type
{
  • "filter_model": null
}

(rpc) get_scheduler_model_multi

/rpc/get_scheduler_model_multi

query Parameters
project_ids
required
string <uuid[]>
project_deadline
string <timestamp with time zone>
reserve
integer <integer>

Responses

/rpc/get_scheduler_model_multi

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
project_deadline
string <timestamp with time zone>
project_ids
required
Array of strings
reserve
integer <integer>

Responses

Request samples

Content type
{
  • "project_deadline": "string",
  • "project_ids": [
    ],
  • "reserve": 0
}

(rpc) create_outgoing_status_mapping

/rpc/create_outgoing_status_mapping

query Parameters
new_id
required
string <uuid>
project_definition_id
required
string <uuid>
version_status_id
required
string <uuid>
folder_new_status
required
string <uuid>
use_other_incoming_folder_statuses
required
boolean <boolean>

Responses

/rpc/create_outgoing_status_mapping

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_new_status
required
string <uuid>
new_id
required
string <uuid>
project_definition_id
required
string <uuid>
use_other_incoming_folder_statuses
required
boolean <boolean>
version_status_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "folder_new_status": "98ea6e3e-d7d6-4de0-bc3b-0fdf2f372940",
  • "new_id": "fbf57724-2070-400e-a5c8-1963550ba853",
  • "project_definition_id": "2b80baf4-533a-4887-8845-e1bf8705bc37",
  • "use_other_incoming_folder_statuses": true,
  • "version_status_id": "910a6907-dca7-4136-92bc-e26e905cb129"
}

(rpc) create_folders_from_folder_structure_template

/rpc/create_folders_from_folder_structure_template

query Parameters
folder_template_ids
required
string <uuid[]>
target_ids
required
string <uuid[]>
project_id
required
string <uuid>
create_outputs
required
boolean <boolean>
create_todos
required
boolean <boolean>
create_links
required
boolean <boolean>
create_assignees
required
boolean <boolean>
overrides
string <jsonb>
restore_deleted
boolean <boolean>

Responses

/rpc/create_folders_from_folder_structure_template

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
create_assignees
required
boolean <boolean>
create_links
required
boolean <boolean>
create_outputs
required
boolean <boolean>
create_todos
required
boolean <boolean>
folder_template_ids
required
Array of strings
overrides
any <jsonb>
project_id
required
string <uuid>
restore_deleted
boolean <boolean>
target_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "create_assignees": true,
  • "create_links": true,
  • "create_outputs": true,
  • "create_todos": true,
  • "folder_template_ids": [
    ],
  • "overrides": null,
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "restore_deleted": true,
  • "target_ids": [
    ]
}

(rpc) get_user_hourly_rate

/rpc/get_user_hourly_rate

query Parameters
user_id
required
string <uuid>
folder_id
required
string <uuid>

Responses

/rpc/get_user_hourly_rate

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_id
required
string <uuid>
user_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

(rpc) delete_orphan_document_attachments

/rpc/delete_orphan_document_attachments

Responses

/rpc/delete_orphan_document_attachments

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) user_is_time_tracker_owner

/rpc/user_is_time_tracker_owner

query Parameters
time_tracker_id
required
string <uuid>

Responses

/rpc/user_is_time_tracker_owner

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
time_tracker_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "time_tracker_id": "87830a93-0564-4308-8a71-c7df45cf3298"
}

(rpc) http_header

/rpc/http_header

query Parameters
name
required
string <text>

Responses

/rpc/http_header

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
name
required
string <text>

Responses

Request samples

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

(rpc) recalculate_amount

/rpc/recalculate_amount

query Parameters
payout_ids
required
string <uuid[]>

Responses

/rpc/recalculate_amount

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
payout_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "payout_ids": [
    ]
}

(rpc) _contract_on

/rpc/_contract_on

query Parameters
required
string <text>

Responses

/rpc/_contract_on

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) update_parents_many

/rpc/update_parents_many

query Parameters
parent_name_child_ids
required
string <public.parent_child_type[]>
parent_parent_id
required
string <uuid>
parent_folders
required
string <jsonb>

Responses

/rpc/update_parents_many

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
parent_folders
required
any <jsonb>
parent_name_child_ids
required
Array of strings
parent_parent_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "parent_folders": null,
  • "parent_name_child_ids": [
    ],
  • "parent_parent_id": "168435b5-9509-4ab3-a802-6fe16695f527"
}

(rpc) delete_and_replace_output_type

/rpc/delete_and_replace_output_type

query Parameters
delete_output_type_id
required
string <uuid>
replace_output_type_id
required
string <uuid>

Responses

/rpc/delete_and_replace_output_type

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
delete_output_type_id
required
string <uuid>
replace_output_type_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "delete_output_type_id": "ecdd58d4-49df-4efc-a937-3549aa5222c3",
  • "replace_output_type_id": "fa0007c9-d512-452a-8df9-570fbb3de6d4"
}

(rpc) create_folder_template_structure

/rpc/create_folder_template_structure

query Parameters
folder_ids
required
string <uuid[]>
template_name
required
string <text>
template_code_name
required
string <text>
folder_type_id
required
string <uuid>
description
required
string <text>
save_output_templates
required
boolean <boolean>
save_todo_templates
required
boolean <boolean>
save_link_templates
required
boolean <boolean>
save_assignee_templates
required
boolean <boolean>

Responses

/rpc/create_folder_template_structure

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
description
required
string <text>
folder_ids
required
Array of strings
folder_type_id
required
string <uuid>
save_assignee_templates
required
boolean <boolean>
save_link_templates
required
boolean <boolean>
save_output_templates
required
boolean <boolean>
save_todo_templates
required
boolean <boolean>
template_code_name
required
string <text>
template_name
required
string <text>

Responses

Request samples

Content type
{
  • "description": "string",
  • "folder_ids": [
    ],
  • "folder_type_id": "4877dd4f-f664-442c-a5e1-ad7846a12238",
  • "save_assignee_templates": true,
  • "save_link_templates": true,
  • "save_output_templates": true,
  • "save_todo_templates": true,
  • "template_code_name": "string",
  • "template_name": "string"
}

(rpc) prepare_template_keys_variants

/rpc/prepare_template_keys_variants

query Parameters
data
required
string <jsonb>

Responses

/rpc/prepare_template_keys_variants

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
data
required
any <jsonb>

Responses

Request samples

Content type
{
  • "data": null
}

(rpc) _refine_vol

/rpc/_refine_vol

query Parameters
required
string <text>

Responses

/rpc/_refine_vol

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) user_can_manage_note

/rpc/user_can_manage_note

query Parameters
note_id
required
string <uuid>

Responses

/rpc/user_can_manage_note

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
note_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "note_id": "f37a7c27-f466-4182-88ae-001e80802cdc"
}

(rpc) get_output_versions

/rpc/get_output_versions

query Parameters
ids
required
string <uuid[]>

Responses

/rpc/get_output_versions

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ids
required
Array of strings

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

(rpc) user_is_view_author

/rpc/user_is_view_author

query Parameters
view_id
required
string <uuid>

Responses

/rpc/user_is_view_author

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
view_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "view_id": "51ee3349-7269-4d2c-8a79-ea7055ee54f4"
}

(rpc) get_orphan_document_attachments

/rpc/get_orphan_document_attachments

Responses

/rpc/get_orphan_document_attachments

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) do_tap

/rpc/do_tap

query Parameters
required
string <text>

Responses

/rpc/do_tap

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) update_naming_on_empty_outputs

/rpc/update_naming_on_empty_outputs

query Parameters
folder_ids
required
string <uuid[]>
user_id
required
string <uuid>

Responses

/rpc/update_naming_on_empty_outputs

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_ids
required
Array of strings
user_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "folder_ids": [
    ],
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

(rpc) get_timeline_data

/rpc/get_timeline_data

query Parameters
project_ids
required
string <uuid[]>
limit_number
integer <integer>
start_date
string <text>
end_date
string <text>
return_deleted
boolean <boolean>

Responses

/rpc/get_timeline_data

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
end_date
string <text>
limit_number
integer <integer>
project_ids
required
Array of strings
return_deleted
boolean <boolean>
start_date
string <text>

Responses

Request samples

Content type
{
  • "end_date": "string",
  • "limit_number": 0,
  • "project_ids": [
    ],
  • "return_deleted": true,
  • "start_date": "string"
}

(rpc) duplicate_project_definition

/rpc/duplicate_project_definition

query Parameters
project_definition_id
required
string <uuid>
project_definition_name
required
string <text>

Responses

/rpc/duplicate_project_definition

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
project_definition_id
required
string <uuid>
project_definition_name
required
string <text>

Responses

Request samples

Content type
{
  • "project_definition_id": "2b80baf4-533a-4887-8845-e1bf8705bc37",
  • "project_definition_name": "string"
}

(rpc) upsert_folder_template_bidding_override

/rpc/upsert_folder_template_bidding_override

query Parameters
folder_template_id
required
string <uuid>
bidding_override_id
required
string <uuid>
bidding_data
required
string <jsonb>

Responses

/rpc/upsert_folder_template_bidding_override

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
bidding_data
required
any <jsonb>
bidding_override_id
required
string <uuid>
folder_template_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "bidding_data": null,
  • "bidding_override_id": "9cbd7208-1929-49c1-9998-39cecb8076cd",
  • "folder_template_id": "9466babb-919d-4518-9148-2f80cdb7ef14"
}

(rpc) get_folder_linked_outputs

/rpc/get_folder_linked_outputs

query Parameters
folder_id
required
string <uuid>

Responses

/rpc/get_folder_linked_outputs

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"
}

(rpc) get_client_view_data

/rpc/get_client_view_data

query Parameters
assignee_role_ids
string <uuid[]>
version_state_ids
string <uuid[]>
return_only_my
boolean <boolean>
return_deleted
boolean <boolean>

Responses

/rpc/get_client_view_data

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
assignee_role_ids
Array of strings
return_deleted
boolean <boolean>
return_only_my
boolean <boolean>
version_state_ids
Array of strings

Responses

Request samples

Content type
{
  • "assignee_role_ids": [
    ],
  • "return_deleted": true,
  • "return_only_my": true,
  • "version_state_ids": [
    ]
}

(rpc) _temptypes

/rpc/_temptypes

query Parameters
required
string <text>

Responses

/rpc/_temptypes

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) get_security_role_id

/rpc/get_security_role_id

query Parameters
user_id
required
string <uuid>

Responses

/rpc/get_security_role_id

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
user_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

(rpc) _cleanup

/rpc/_cleanup

Responses

/rpc/_cleanup

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) update_folder_financial_data_many

/rpc/update_folder_financial_data_many

query Parameters
changes
required
string <jsonb>

Responses

/rpc/update_folder_financial_data_many

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
changes
required
any <jsonb>

Responses

Request samples

Content type
{
  • "changes": null
}

(rpc) create_folder_template

/rpc/create_folder_template

query Parameters
folder_ids
required
string <uuid[]>
template_name
required
string <text>
template_code_name
required
string <text>
folder_type_id
required
string <uuid>
description
required
string <text>
save_output_templates
required
boolean <boolean>
save_todo_templates
required
boolean <boolean>
save_link_templates
required
boolean <boolean>
save_assignee_templates
required
boolean <boolean>

Responses

/rpc/create_folder_template

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
description
required
string <text>
folder_ids
required
Array of strings
folder_type_id
required
string <uuid>
save_assignee_templates
required
boolean <boolean>
save_link_templates
required
boolean <boolean>
save_output_templates
required
boolean <boolean>
save_todo_templates
required
boolean <boolean>
template_code_name
required
string <text>
template_name
required
string <text>

Responses

Request samples

Content type
{
  • "description": "string",
  • "folder_ids": [
    ],
  • "folder_type_id": "4877dd4f-f664-442c-a5e1-ad7846a12238",
  • "save_assignee_templates": true,
  • "save_link_templates": true,
  • "save_output_templates": true,
  • "save_todo_templates": true,
  • "template_code_name": "string",
  • "template_name": "string"
}

(rpc) get_review_view_data

/rpc/get_review_view_data

query Parameters
assignee_role_ids
string <uuid[]>
version_state_ids
string <uuid[]>
return_only_my
boolean <boolean>
return_deleted
boolean <boolean>

Responses

/rpc/get_review_view_data

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
assignee_role_ids
Array of strings
return_deleted
boolean <boolean>
return_only_my
boolean <boolean>
version_state_ids
Array of strings

Responses

Request samples

Content type
{
  • "assignee_role_ids": [
    ],
  • "return_deleted": true,
  • "return_only_my": true,
  • "version_state_ids": [
    ]
}

(rpc) parse_template

/rpc/parse_template

query Parameters
template
required
string <text>
template_data
required
string <jsonb>
template_type
string <text>

Responses

/rpc/parse_template

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
template
required
string <text>
template_data
required
any <jsonb>
template_type
string <text>

Responses

Request samples

Content type
{
  • "template": "string",
  • "template_data": null,
  • "template_type": "string"
}

(rpc) get_action_placeholders

/rpc/get_action_placeholders

query Parameters
from_date
required
string <timestamp with time zone>
to_date
required
string <timestamp with time zone>
return_only_my
boolean <boolean>

Responses

/rpc/get_action_placeholders

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
from_date
required
string <timestamp with time zone>
return_only_my
boolean <boolean>
to_date
required
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "from_date": "string",
  • "return_only_my": true,
  • "to_date": "string"
}

(rpc) upsert_note

/rpc/upsert_note

query Parameters
note_id
required
string <uuid>
folder_id
required
string <uuid>
note_category_id
required
string <uuid>
content
required
string <text>
status_id
string <uuid>
output_version_id
string <uuid>
component_id
string <uuid>
parent_id
string <uuid>
author_id
string <uuid>
frame
integer <integer>
review_data
string <json>
is_autogenerated
boolean <boolean>
is_pinned
boolean <boolean>
attachments
string <jsonb>
as_user_email
string <text>

Responses

/rpc/upsert_note

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
as_user_email
string <text>
attachments
any <jsonb>
author_id
string <uuid>
component_id
string <uuid>
content
required
string <text>
folder_id
required
string <uuid>
frame
integer <integer>
is_autogenerated
boolean <boolean>
is_pinned
boolean <boolean>
note_category_id
required
string <uuid>
note_id
required
string <uuid>
output_version_id
string <uuid>
parent_id
string <uuid>
review_data
any <json>
status_id
string <uuid>

Responses

Request samples

Content type
{
  • "as_user_email": "string",
  • "attachments": null,
  • "author_id": "78424c75-5c41-4b25-9735-3c9f7d05c59e",
  • "component_id": "41afafe5-2a48-424a-baef-34c2ad44ef7b",
  • "content": "string",
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "frame": 0,
  • "is_autogenerated": true,
  • "is_pinned": true,
  • "note_category_id": "447bc3d0-2b75-4d3c-9f40-c1bd816c8cb0",
  • "note_id": "f37a7c27-f466-4182-88ae-001e80802cdc",
  • "output_version_id": "e19a0dbc-33ca-4b3a-aff0-0964e8604da2",
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
  • "review_data": null,
  • "status_id": "4e949624-bc0f-439e-a9f2-25a23938812c"
}

(rpc) upsert_type_bidding

/rpc/upsert_type_bidding

query Parameters
type_id
required
string <uuid>
bidding_id
required
string <uuid>
bidding_data
required
string <jsonb>

Responses

/rpc/upsert_type_bidding

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
bidding_data
required
any <jsonb>
bidding_id
required
string <uuid>
type_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "bidding_data": null,
  • "bidding_id": "8aca3d01-27ac-4662-958c-f88627dc087f",
  • "type_id": "d9779ea4-ba95-4824-86d7-4f1ac083a564"
}

(rpc) delete_project_assignees

/rpc/delete_project_assignees

query Parameters
user_ids
required
string <uuid[]>
project_ids
required
string <uuid[]>
assignee_role_id
required
string <uuid>

Responses

/rpc/delete_project_assignees

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
assignee_role_id
required
string <uuid>
project_ids
required
Array of strings
user_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "assignee_role_id": "34743d2e-11bd-4d73-b9ee-e25f97b48f81",
  • "project_ids": [
    ],
  • "user_ids": [
    ]
}

(rpc) get_folders_by_ids

/rpc/get_folders_by_ids

query Parameters
ids
required
string <uuid[]>

Responses

/rpc/get_folders_by_ids

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ids
required
Array of strings

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

(rpc) get_folder_paths

/rpc/get_folder_paths

query Parameters
ids
required
string <uuid[]>

Responses

/rpc/get_folder_paths

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ids
required
Array of strings

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

(rpc) user_exists

/rpc/user_exists

query Parameters
email
required
string <text>

Responses

/rpc/user_exists

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
email
required
string <text>

Responses

Request samples

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

(rpc) get_project_statistics

/rpc/get_project_statistics

query Parameters
project_id
required
string <uuid>
return_deleted
boolean <boolean>

Responses

/rpc/get_project_statistics

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
project_id
required
string <uuid>
return_deleted
boolean <boolean>

Responses

Request samples

Content type
{
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "return_deleted": true
}

(rpc) delete_and_replace_note_category

/rpc/delete_and_replace_note_category

query Parameters
delete_note_category_id
required
string <uuid>
replace_note_category_id
required
string <uuid>

Responses

/rpc/delete_and_replace_note_category

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
delete_note_category_id
required
string <uuid>
replace_note_category_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "delete_note_category_id": "0cf4ab32-8f46-4912-9ce2-237242cc8246",
  • "replace_note_category_id": "8825bbf9-6abe-43de-96e9-bb7a13637bbe"
}

(rpc) finish

/rpc/finish

query Parameters
exception_on_failure
boolean <boolean>

Responses

/rpc/finish

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
exception_on_failure
boolean <boolean>

Responses

Request samples

Content type
{
  • "exception_on_failure": true
}

(rpc) get_output_latest_version_with_thumbnail

/rpc/get_output_latest_version_with_thumbnail

query Parameters
output_id
required
string <uuid>

Responses

/rpc/get_output_latest_version_with_thumbnail

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
output_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "output_id": "91698f21-6d0d-4805-bf33-160da1b86362"
}

(rpc) create_project_definition

/rpc/create_project_definition

query Parameters
project_definition_name
required
string <text>
custom_attribute_definition_ids
required
string <uuid[]>
priority_ids
required
string <uuid[]>
note_category_ids
required
string <uuid[]>
folder_type_ids
required
string <uuid[]>
output_type_ids
required
string <uuid[]>
type_ids
required
string <uuid[]>
activity_type_ids
required
string <uuid[]>
folder_status_ids
required
string <uuid[]>
output_status_ids
required
string <uuid[]>
tag_ids
required
string <uuid[]>
directory_structure_settings
string <jsonb>
roots
string <jsonb>
templates
string <jsonb>
output_name_settings
string <jsonb>
template_name_profiles
string <jsonb>
task_link_patterns
string <jsonb>

Responses

/rpc/create_project_definition

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
activity_type_ids
required
Array of strings
custom_attribute_definition_ids
required
Array of strings
directory_structure_settings
any <jsonb>
folder_status_ids
required
Array of strings
folder_type_ids
required
Array of strings
note_category_ids
required
Array of strings
output_name_settings
any <jsonb>
output_status_ids
required
Array of strings
output_type_ids
required
Array of strings
priority_ids
required
Array of strings
project_definition_name
required
string <text>
roots
any <jsonb>
tag_ids
required
Array of strings
task_link_patterns
any <jsonb>
template_name_profiles
any <jsonb>
templates
any <jsonb>
type_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "activity_type_ids": [
    ],
  • "custom_attribute_definition_ids": [
    ],
  • "directory_structure_settings": null,
  • "folder_status_ids": [
    ],
  • "folder_type_ids": [
    ],
  • "note_category_ids": [
    ],
  • "output_name_settings": null,
  • "output_status_ids": [
    ],
  • "output_type_ids": [
    ],
  • "priority_ids": [
    ],
  • "project_definition_name": "string",
  • "roots": null,
  • "tag_ids": [
    ],
  • "task_link_patterns": null,
  • "template_name_profiles": null,
  • "templates": null,
  • "type_ids": [
    ]
}

(rpc) get_notes_for_folder

/rpc/get_notes_for_folder

query Parameters
folder_id
required
string <uuid>
page_size
required
integer <integer>
page
required
integer <integer>

Responses

/rpc/get_notes_for_folder

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_id
required
string <uuid>
page
required
integer <integer>
page_size
required
integer <integer>

Responses

Request samples

Content type
{
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "page": 0,
  • "page_size": 0
}

(rpc) get_project_folders_for_scheduler

/rpc/get_project_folders_for_scheduler

query Parameters
project_ids
required
string <uuid[]>
folder_type_id
string <uuid>
limit_number
integer <integer>
custom_attributes
string <text[]>
return_custom_attributes
boolean <boolean>
return_deleted
boolean <boolean>

Responses

/rpc/get_project_folders_for_scheduler

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
custom_attributes
Array of strings
folder_type_id
string <uuid>
limit_number
integer <integer>
project_ids
required
Array of strings
return_custom_attributes
boolean <boolean>
return_deleted
boolean <boolean>

Responses

Request samples

Content type
{
  • "custom_attributes": [
    ],
  • "folder_type_id": "4877dd4f-f664-442c-a5e1-ad7846a12238",
  • "limit_number": 0,
  • "project_ids": [
    ],
  • "return_custom_attributes": true,
  • "return_deleted": true
}

(rpc) get_current_user_security_role_id

/rpc/get_current_user_security_role_id

Responses

/rpc/get_current_user_security_role_id

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) get_folder_templates

/rpc/get_folder_templates

query Parameters
ids
required
string <uuid[]>

Responses

/rpc/get_folder_templates

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ids
required
Array of strings

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

(rpc) pgtap_version

/rpc/pgtap_version

Responses

/rpc/pgtap_version

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) build_folders_order_group_field

/rpc/build_folders_order_group_field

query Parameters
sort_model
required
string <json>

Responses

/rpc/build_folders_order_group_field

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
sort_model
required
any <json>

Responses

Request samples

Content type
{
  • "sort_model": null
}

(rpc) update_ftrack_status_id

/rpc/update_ftrack_status_id

query Parameters
soko_status_id
required
string <uuid>
ftrack_status_id
required
string <uuid>

Responses

/rpc/update_ftrack_status_id

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ftrack_status_id
required
string <uuid>
soko_status_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "ftrack_status_id": "f88f542e-a9c3-4ee2-b947-0f29c8b228ee",
  • "soko_status_id": "df905778-a9f4-42be-9ec7-f9eabfd30aaf"
}

(rpc) find_objects

/rpc/find_objects

query Parameters
object_ids
required
string <text[]>
bucket
string <text>
size
string <text>

Responses

/rpc/find_objects

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
bucket
string <text>
object_ids
required
Array of strings
size
string <text>

Responses

Request samples

Content type
{
  • "bucket": "string",
  • "object_ids": [
    ],
  • "size": "string"
}

(rpc) get_project_grid_attributes

/rpc/get_project_grid_attributes

query Parameters
parent_id
required
string <uuid>
folder_type_id
string <uuid>
limit_number
integer <integer>
custom_attributes
string <text[]>

Responses

/rpc/get_project_grid_attributes

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
custom_attributes
Array of strings
folder_type_id
string <uuid>
limit_number
integer <integer>
parent_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "custom_attributes": [
    ],
  • "folder_type_id": "4877dd4f-f664-442c-a5e1-ad7846a12238",
  • "limit_number": 0,
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef"
}

(rpc) get_base_project_definitions

/rpc/get_base_project_definitions

Responses

/rpc/get_base_project_definitions

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) num_failed

/rpc/num_failed

Responses

/rpc/num_failed

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) user_can_manage_document_template

/rpc/user_can_manage_document_template

query Parameters
document_template_id
required
string <uuid>

Responses

/rpc/user_can_manage_document_template

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
document_template_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "document_template_id": "2574412b-843e-409c-ab85-b4d8aeb24485"
}

(rpc) user_can_manage_notification

/rpc/user_can_manage_notification

query Parameters
notification_id
required
string <uuid>

Responses

/rpc/user_can_manage_notification

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
notification_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "notification_id": "f96afe21-aef9-465c-a9f6-813055655b04"
}

(rpc) get_outputs_by_project_id

/rpc/get_outputs_by_project_id

query Parameters
project_id
required
string <uuid>

Responses

/rpc/get_outputs_by_project_id

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
project_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"
}

(rpc) user_is_me

/rpc/user_is_me

query Parameters
user_update_id
required
string <uuid>

Responses

/rpc/user_is_me

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
user_update_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "user_update_id": "0cbea07a-65b8-403c-bf3a-a193ee0c889d"
}

(rpc) folder_code_name

/rpc/folder_code_name

query Parameters
input_string
required
string <text>
parent_id
required
string <uuid>

Responses

/rpc/folder_code_name

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
input_string
required
string <text>
parent_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "input_string": "string",
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef"
}

(rpc) get_latest_version_of_folders_per_output

/rpc/get_latest_version_of_folders_per_output

query Parameters
folder_ids
required
string <uuid[]>
return_recursive
boolean <boolean>
limit_number
integer <integer>
state_ids
string <uuid[]>
project_assignee_role_ids
string <uuid[]>
folder_assignee_role_ids
string <uuid[]>
return_from_deleted
boolean <boolean>

Responses

/rpc/get_latest_version_of_folders_per_output

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_assignee_role_ids
Array of strings
folder_ids
required
Array of strings
limit_number
integer <integer>
project_assignee_role_ids
Array of strings
return_from_deleted
boolean <boolean>
return_recursive
boolean <boolean>
state_ids
Array of strings

Responses

Request samples

Content type
{
  • "folder_assignee_role_ids": [
    ],
  • "folder_ids": [
    ],
  • "limit_number": 0,
  • "project_assignee_role_ids": [
    ],
  • "return_from_deleted": true,
  • "return_recursive": true,
  • "state_ids": [
    ]
}

(rpc) _get

/rpc/_get

query Parameters
required
string <text>

Responses

/rpc/_get

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) get_project_root_folder

/rpc/get_project_root_folder

query Parameters
project_id
required
string <uuid>

Responses

/rpc/get_project_root_folder

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
project_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"
}

(rpc) col_not_null

/rpc/col_not_null

query Parameters
schema_name
required
string <name>
table_name
required
string <name>
column_name
required
string <name>
description
string <text>

Responses

/rpc/col_not_null

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
column_name
required
string <name>
description
string <text>
schema_name
required
string <name>
table_name
required
string <name>

Responses

Request samples

Content type
{
  • "column_name": "string",
  • "description": "string",
  • "schema_name": "string",
  • "table_name": "string"
}

(rpc) get_scheduler_constraints

/rpc/get_scheduler_constraints

query Parameters
project_ids
required
string <uuid[]>
start_date
required
string <timestamp with time zone>
end_date
required
string <timestamp with time zone>
project_scenario_structure
string <jsonb>
folder_ids
string <uuid[]>

Responses

/rpc/get_scheduler_constraints

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
end_date
required
string <timestamp with time zone>
folder_ids
Array of strings
project_ids
required
Array of strings
project_scenario_structure
any <jsonb>
start_date
required
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "end_date": "string",
  • "folder_ids": [
    ],
  • "project_ids": [
    ],
  • "project_scenario_structure": null,
  • "start_date": "string"
}

(rpc) delete_folder_assignees

/rpc/delete_folder_assignees

query Parameters
user_ids
required
string <uuid[]>
folder_ids
required
string <uuid[]>
assignee_role_id
required
string <uuid>

Responses

/rpc/delete_folder_assignees

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
assignee_role_id
required
string <uuid>
folder_ids
required
Array of strings
user_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "assignee_role_id": "34743d2e-11bd-4d73-b9ee-e25f97b48f81",
  • "folder_ids": [
    ],
  • "user_ids": [
    ]
}

(rpc) is_empty

/rpc/is_empty

query Parameters
required
string <text>

Responses

/rpc/is_empty

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) get_project_by_component_id

/rpc/get_project_by_component_id

query Parameters
component_id
required
string <uuid>

Responses

/rpc/get_project_by_component_id

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
component_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "component_id": "41afafe5-2a48-424a-baef-34c2ad44ef7b"
}

(rpc) get_project_time_trackers

/rpc/get_project_time_trackers

query Parameters
project_id
required
string <uuid>
folder_type_id
required
string <uuid>
user_id
required
string <uuid>

Responses

/rpc/get_project_time_trackers

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_type_id
required
string <uuid>
project_id
required
string <uuid>
user_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "folder_type_id": "4877dd4f-f664-442c-a5e1-ad7846a12238",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

(rpc) update_worker_fee_group_status

/rpc/update_worker_fee_group_status

query Parameters
worker_fee_ids
required
string <uuid[]>
payment_status_id
string <uuid>

Responses

/rpc/update_worker_fee_group_status

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
payment_status_id
string <uuid>
worker_fee_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "payment_status_id": "271a536c-038f-4123-84a2-9fb822c9c25b",
  • "worker_fee_ids": [
    ]
}

(rpc) delete_and_replace_tag

/rpc/delete_and_replace_tag

query Parameters
delete_tag_id
required
string <uuid>
replace_tag_id
required
string <uuid>

Responses

/rpc/delete_and_replace_tag

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
delete_tag_id
required
string <uuid>
replace_tag_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "delete_tag_id": "097c106b-180c-4ef8-93de-5be3fde1f65e",
  • "replace_tag_id": "c75b3cbc-4bd5-499e-96e8-127fa2d1df24"
}

(rpc) get_outputs_by_folder_ids

/rpc/get_outputs_by_folder_ids

query Parameters
folder_ids
required
string <uuid[]>

Responses

/rpc/get_outputs_by_folder_ids

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "folder_ids": [
    ]
}

(rpc) set_default_view

/rpc/set_default_view

query Parameters
project_id
required
string <uuid>
user_id
string <uuid>
view_id
string <uuid>
is_for_project_view
boolean <boolean>
is_for_version_view
boolean <boolean>

Responses

/rpc/set_default_view

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
is_for_project_view
boolean <boolean>
is_for_version_view
boolean <boolean>
project_id
required
string <uuid>
user_id
string <uuid>
view_id
string <uuid>

Responses

Request samples

Content type
{
  • "is_for_project_view": true,
  • "is_for_version_view": true,
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "view_id": "51ee3349-7269-4d2c-8a79-ea7055ee54f4"
}

(rpc) get_project_chart_data

/rpc/get_project_chart_data

query Parameters
project_id
required
string <uuid>
state_ids
string <uuid[]>
type_ids
string <uuid[]>
limit_number
integer <integer>

Responses

/rpc/get_project_chart_data

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
limit_number
integer <integer>
project_id
required
string <uuid>
state_ids
Array of strings
type_ids
Array of strings

Responses

Request samples

Content type
{
  • "limit_number": 0,
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "state_ids": [
    ],
  • "type_ids": [
    ]
}

(rpc) get_scheduler_grid

/rpc/get_scheduler_grid

query Parameters
parent_id
required
string <uuid>
folder_type_id
string <uuid>
limit_number
integer <integer>
custom_attributes
string <text[]>
return_custom_attributes
boolean <boolean>
return_links
boolean <boolean>
return_assignees
boolean <boolean>
return_recursive
boolean <boolean>
return_iterations
boolean <boolean>
return_deleted
boolean <boolean>

Responses

/rpc/get_scheduler_grid

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
custom_attributes
Array of strings
folder_type_id
string <uuid>
limit_number
integer <integer>
parent_id
required
string <uuid>
return_assignees
boolean <boolean>
return_custom_attributes
boolean <boolean>
return_deleted
boolean <boolean>
return_iterations
boolean <boolean>
return_links
boolean <boolean>
return_recursive
boolean <boolean>

Responses

Request samples

Content type
{
  • "custom_attributes": [
    ],
  • "folder_type_id": "4877dd4f-f664-442c-a5e1-ad7846a12238",
  • "limit_number": 0,
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
  • "return_assignees": true,
  • "return_custom_attributes": true,
  • "return_deleted": true,
  • "return_iterations": true,
  • "return_links": true,
  • "return_recursive": true
}

(rpc) delete_iteration

/rpc/delete_iteration

query Parameters
iteration_id
required
string <uuid>

Responses

/rpc/delete_iteration

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
iteration_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "iteration_id": "97b5ab97-bbd5-4876-b0ff-f6dddd5449ca"
}

(rpc) get_review_project_info_by_folder_id

/rpc/get_review_project_info_by_folder_id

query Parameters
folder_id
required
string <uuid>

Responses

/rpc/get_review_project_info_by_folder_id

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"
}

(rpc) create_component_many

/rpc/create_component_many

query Parameters
changes
required
string <jsonb>

Responses

/rpc/create_component_many

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
changes
required
any <jsonb>

Responses

Request samples

Content type
{
  • "changes": null
}

(rpc) duplicate_folder

/rpc/duplicate_folder

query Parameters
folder_id
required
string <uuid>
new_name
required
string <text>
new_code_name
required
string <text>

Responses

/rpc/duplicate_folder

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_id
required
string <uuid>
new_code_name
required
string <text>
new_name
required
string <text>

Responses

Request samples

Content type
{
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "new_code_name": "string",
  • "new_name": "string"
}

(rpc) runtests

/rpc/runtests

query Parameters
required
string <text>

Responses

/rpc/runtests

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) pg_version

/rpc/pg_version

Responses

/rpc/pg_version

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) create_user_skill

/rpc/create_user_skill

query Parameters
user_id
required
string <uuid>
type_id
required
string <uuid>
skill_level
required
integer <integer>

Responses

/rpc/create_user_skill

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
skill_level
required
integer <integer>
type_id
required
string <uuid>
user_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "skill_level": 0,
  • "type_id": "d9779ea4-ba95-4824-86d7-4f1ac083a564",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

(rpc) get_users

/rpc/get_users

query Parameters
ids
required
string <uuid[]>

Responses

/rpc/get_users

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ids
required
Array of strings

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

(rpc) diag

/rpc/diag

query Parameters
msg
required
string <text>

Responses

/rpc/diag

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
msg
required
string <text>

Responses

Request samples

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

(rpc) user_can_manage_vacation

/rpc/user_can_manage_vacation

query Parameters
vacation_id
required
string <uuid>

Responses

/rpc/user_can_manage_vacation

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
vacation_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "vacation_id": "452dac2f-2f00-43c9-95f7-22c774086518"
}

(rpc) get_latest_reviewable_components_count_for_folder

/rpc/get_latest_reviewable_components_count_for_folder

query Parameters
folder_id
required
string <uuid>

Responses

/rpc/get_latest_reviewable_components_count_for_folder

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"
}

(rpc) can_update_time_tracker

/rpc/can_update_time_tracker

query Parameters
time_tracker_id
required
string <uuid>

Responses

/rpc/can_update_time_tracker

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
time_tracker_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "time_tracker_id": "87830a93-0564-4308-8a71-c7df45cf3298"
}

(rpc) os_name

/rpc/os_name

Responses

/rpc/os_name

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) get_components

/rpc/get_components

query Parameters
ids
string <uuid[]>
version_ids
string <uuid[]>
root_files
boolean <boolean>
openable_files
boolean <boolean>
supported_files
boolean <boolean>
playable_files
boolean <boolean>

Responses

/rpc/get_components

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ids
Array of strings
openable_files
boolean <boolean>
playable_files
boolean <boolean>
root_files
boolean <boolean>
supported_files
boolean <boolean>
version_ids
Array of strings

Responses

Request samples

Content type
{
  • "ids": [
    ],
  • "openable_files": true,
  • "playable_files": true,
  • "root_files": true,
  • "supported_files": true,
  • "version_ids": [
    ]
}

(rpc) build_folders_order_by_clause

/rpc/build_folders_order_by_clause

query Parameters
sort_model
required
string <json>

Responses

/rpc/build_folders_order_by_clause

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
sort_model
required
any <json>

Responses

Request samples

Content type
{
  • "sort_model": null
}

(rpc) user_is_vacation_owner

/rpc/user_is_vacation_owner

query Parameters
vacation_id
required
string <uuid>

Responses

/rpc/user_is_vacation_owner

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
vacation_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "vacation_id": "452dac2f-2f00-43c9-95f7-22c774086518"
}

(rpc) update_folder_custom_attribute_many

/rpc/update_folder_custom_attribute_many

query Parameters
changes
required
string <jsonb>

Responses

/rpc/update_folder_custom_attribute_many

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
changes
required
any <jsonb>

Responses

Request samples

Content type
{
  • "changes": null
}

(rpc) stop_user_time_tracker

/rpc/stop_user_time_tracker

query Parameters
user_id
required
string <uuid>

Responses

/rpc/stop_user_time_tracker

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
user_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

(rpc) get_scheduler_model

/rpc/get_scheduler_model

query Parameters
project_id
required
string <uuid>
project_deadline
string <timestamp with time zone>
reserve
integer <integer>
project_scenario_structure
string <jsonb>
folder_ids
string <uuid[]>

Responses

/rpc/get_scheduler_model

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_ids
Array of strings
project_deadline
string <timestamp with time zone>
project_id
required
string <uuid>
project_scenario_structure
any <jsonb>
reserve
integer <integer>

Responses

Request samples

Content type
{
  • "folder_ids": [
    ],
  • "project_deadline": "string",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "project_scenario_structure": null,
  • "reserve": 0
}

(rpc) update_payout_amount

/rpc/update_payout_amount

query Parameters
payout_id
required
string <uuid>

Responses

/rpc/update_payout_amount

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
payout_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "payout_id": "89e4daf5-d103-4869-b9da-3d54ecc98dfe"
}

(rpc) _db_privs

/rpc/_db_privs

Responses

/rpc/_db_privs

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) delete_and_replace_type

/rpc/delete_and_replace_type

query Parameters
delete_type_id
required
string <uuid>
replace_type_id
required
string <uuid>

Responses

/rpc/delete_and_replace_type

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
delete_type_id
required
string <uuid>
replace_type_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "delete_type_id": "242e6cfc-2e6c-4db1-986a-a88c9db07ff8",
  • "replace_type_id": "c7ad5ae0-1e07-4452-a0f1-b93cf530698c"
}

(rpc) update_zero_hourly_rates_for_user

/rpc/update_zero_hourly_rates_for_user

query Parameters
user_id
required
string <uuid>

Responses

/rpc/update_zero_hourly_rates_for_user

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
user_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

(rpc) get_output_versions_by_output_ids

/rpc/get_output_versions_by_output_ids

query Parameters
output_ids
required
string <uuid[]>

Responses

/rpc/get_output_versions_by_output_ids

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
output_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "output_ids": [
    ]
}

(rpc) generate_api_token

/rpc/generate_api_token

Responses

/rpc/generate_api_token

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) get_wasabi_components

/rpc/get_wasabi_components

query Parameters
days_since_creation
required
integer <integer>
timestamp_filter
required
string <timestamp without time zone>

Responses

/rpc/get_wasabi_components

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
days_since_creation
required
integer <integer>
timestamp_filter
required
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "days_since_creation": 0,
  • "timestamp_filter": "string"
}

(rpc) _extensions

/rpc/_extensions

Responses

/rpc/_extensions

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) create_status_mapping

/rpc/create_status_mapping

query Parameters
new_id
required
string <uuid>
project_definition_id
required
string <uuid>
version_status_id
required
string <uuid>
folder_new_status
required
string <uuid>

Responses

/rpc/create_status_mapping

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
folder_new_status
required
string <uuid>
new_id
required
string <uuid>
project_definition_id
required
string <uuid>
version_status_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "folder_new_status": "98ea6e3e-d7d6-4de0-bc3b-0fdf2f372940",
  • "new_id": "fbf57724-2070-400e-a5c8-1963550ba853",
  • "project_definition_id": "2b80baf4-533a-4887-8845-e1bf8705bc37",
  • "version_status_id": "910a6907-dca7-4136-92bc-e26e905cb129"
}

(rpc) build_folders_field_expr

/rpc/build_folders_field_expr

query Parameters
field
required
string <text>

Responses

/rpc/build_folders_field_expr

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
field
required
string <text>

Responses

Request samples

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

(rpc) _get_latest

/rpc/_get_latest

query Parameters
required
string <text>

Responses

/rpc/_get_latest

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
required
string <text>

Responses

Request samples

Content type
{
  • "": "string"
}

(rpc) delete_old_jobs

/rpc/delete_old_jobs

Responses

/rpc/delete_old_jobs

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) create_project_scenario

/rpc/create_project_scenario

query Parameters
id
required
string <uuid>
name
required
string <text>
structure
required
string <jsonb>
project_id
string <uuid>

Responses

/rpc/create_project_scenario

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
id
required
string <uuid>
name
required
string <text>
project_id
string <uuid>
structure
required
any <jsonb>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "structure": null
}

(rpc) get_project_summary

/rpc/get_project_summary

query Parameters
project_id
required
string <uuid>
parent_id
string <uuid>
return_recursive
boolean <boolean>
return_only_latest
boolean <boolean>
return_deleted
boolean <boolean>
limit_number
integer <integer>

Responses

/rpc/get_project_summary

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
limit_number
integer <integer>
parent_id
string <uuid>
project_id
required
string <uuid>
return_deleted
boolean <boolean>
return_only_latest
boolean <boolean>
return_recursive
boolean <boolean>

Responses

Request samples

Content type
{
  • "limit_number": 0,
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "return_deleted": true,
  • "return_only_latest": true,
  • "return_recursive": true
}

(rpc) delete_user_time_tracker

/rpc/delete_user_time_tracker

query Parameters
user_time_tracker_id
required
string <uuid>

Responses

/rpc/delete_user_time_tracker

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
user_time_tracker_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "user_time_tracker_id": "9a1e5ad3-116e-4c9d-ba78-fed9d31276a3"
}