API docs by Redocly

standard public schema (1.0.8)

Download OpenAPI specification:

PostgREST Documentation

Introspection

OpenAPI description (this document)

Responses

types

/types

query Parameters
id
string <uuid>
folderTypeId
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
string <integer>
isCore
string <boolean>
price
string <real>
biddingId
string <uuid>
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.

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"
}

/types

query Parameters
id
string <uuid>
folderTypeId
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
string <integer>
isCore
string <boolean>
price
string <real>
biddingId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/types

query Parameters
id
string <uuid>
folderTypeId
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
string <integer>
isCore
string <boolean>
price
string <real>
biddingId
string <uuid>
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.

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"
}

projectDefinitionTypes

/projectDefinitionTypes

query Parameters
projectDefinitionId
string <uuid>
typeId
string <uuid>
price
string <real>
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

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "price": 0
}

/projectDefinitionTypes

query Parameters
projectDefinitionId
string <uuid>
typeId
string <uuid>
price
string <real>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionTypes

query Parameters
projectDefinitionId
string <uuid>
typeId
string <uuid>
price
string <real>
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

Responses

Request samples

Content type
{
  • "projectDefinitionId": "d3d6d914-03e2-4cca-9401-d0ac1415d3a3",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "price": 0
}

apiKeys

/apiKeys

query Parameters
id
string <uuid>
userId
string <uuid>
token
string <text>
createdAt
string <timestamp with time zone>
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 <uuid>
userId
string <uuid>
token
string <text>
createdAt
string <timestamp with time zone>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/apiKeys

query Parameters
id
string <uuid>
userId
string <uuid>
token
string <text>
createdAt
string <timestamp with time zone>
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())"
}

viewGroups

/viewGroups

query Parameters
id
string <uuid>
name
string <character varying>
screenPriority
string <integer>
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 <uuid>
name
string <character varying>
screenPriority
string <integer>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/viewGroups

query Parameters
id
string <uuid>
name
string <character varying>
screenPriority
string <integer>
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
}

iterations

/iterations

query Parameters
id
string <uuid>
number
string <smallint>
isDone
string <boolean>
folderId
string <uuid>
name
string <text>
availableToStart
string <timestamp with time zone>
deadline
string <timestamp with time zone>
plannedHours
string <numeric>
startDate
string <timestamp with time zone>
endDate
string <timestamp with time zone>
softAssigneeId
string <uuid>
assigneeId
string <uuid>
description
string <character varying>
usedHours
string <numeric>
isIndependent
string <boolean>
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 <uuid>
number
string <smallint>
isDone
string <boolean>
folderId
string <uuid>
name
string <text>
availableToStart
string <timestamp with time zone>
deadline
string <timestamp with time zone>
plannedHours
string <numeric>
startDate
string <timestamp with time zone>
endDate
string <timestamp with time zone>
softAssigneeId
string <uuid>
assigneeId
string <uuid>
description
string <character varying>
usedHours
string <numeric>
isIndependent
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/iterations

query Parameters
id
string <uuid>
number
string <smallint>
isDone
string <boolean>
folderId
string <uuid>
name
string <text>
availableToStart
string <timestamp with time zone>
deadline
string <timestamp with time zone>
plannedHours
string <numeric>
startDate
string <timestamp with time zone>
endDate
string <timestamp with time zone>
softAssigneeId
string <uuid>
assigneeId
string <uuid>
description
string <character varying>
usedHours
string <numeric>
isIndependent
string <boolean>
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
}

userSharedComponents

/userSharedComponents

query Parameters
userId
string <uuid>
componentId
string <uuid>
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 <uuid>
componentId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/userSharedComponents

query Parameters
userId
string <uuid>
componentId
string <uuid>
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"
}

integrationApplications

/integrationApplications

query Parameters
id
string <uuid>
name
string <text>
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 <uuid>
name
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/integrationApplications

query Parameters
id
string <uuid>
name
string <text>
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"
}

components

/components

query Parameters
id
string <uuid>
outputVersionId
string <uuid>
fileTypeId
string <uuid>
componentStateId
string <uuid>
relativePath
string <character varying>
isAutogenerated
string <boolean>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
publisherOs
string <text>
data
string <jsonb>
projectId
string <uuid>
isReviewable
string <boolean>
isWebComponent
string <boolean>
webLink
string <text>
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 <uuid>
outputVersionId
string <uuid>
fileTypeId
string <uuid>
componentStateId
string <uuid>
relativePath
string <character varying>
isAutogenerated
string <boolean>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
publisherOs
string <text>
data
string <jsonb>
projectId
string <uuid>
isReviewable
string <boolean>
isWebComponent
string <boolean>
webLink
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/components

query Parameters
id
string <uuid>
outputVersionId
string <uuid>
fileTypeId
string <uuid>
componentStateId
string <uuid>
relativePath
string <character varying>
isAutogenerated
string <boolean>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
publisherOs
string <text>
data
string <jsonb>
projectId
string <uuid>
isReviewable
string <boolean>
isWebComponent
string <boolean>
webLink
string <text>
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"
}

outputVersions

/outputVersions

query Parameters
id
string <uuid>
outputId
string <uuid>
statusId
string <uuid>
authorId
string <uuid>
versionNumber
string <smallint>
comment
string <character varying>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
isMain
string <boolean>
isClientVersion
string <boolean>
isAutogenerated
string <boolean>
properties
string <jsonb>
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 <uuid>
outputId
string <uuid>
statusId
string <uuid>
authorId
string <uuid>
versionNumber
string <smallint>
comment
string <character varying>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
isMain
string <boolean>
isClientVersion
string <boolean>
isAutogenerated
string <boolean>
properties
string <jsonb>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outputVersions

query Parameters
id
string <uuid>
outputId
string <uuid>
statusId
string <uuid>
authorId
string <uuid>
versionNumber
string <smallint>
comment
string <character varying>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
isMain
string <boolean>
isClientVersion
string <boolean>
isAutogenerated
string <boolean>
properties
string <jsonb>
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
}

folders

/folders

query Parameters
id
string <uuid>
projectId
string <uuid>
folderTypeId
string <uuid>
priorityId
string <uuid>
statusId
string <uuid>
typeId
string <uuid>
parentId
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
isHiddenable
string <boolean>
description
string <character varying>
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
string <numeric>
bidPrice
string <numeric>
usedHours
string <numeric>
codaioPageId
string <text>
codaioBrowserLink
string <text>
bidHours
string <real>
availableToStartConflict
string <boolean>
invoiceNo
string <text>
invoicedHours
string <real>
availableToStart
string <timestamp with time zone>
deadline
string <timestamp with time zone>
importanceNo
string <integer>
downstreamHoursTotal
string <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
string <real>
softAssigneeId
string <uuid>
upstreamHoursCritical
string <real>
deadlineConflict
string <boolean>
spentHoursDiffecence
string <real>
qnote
string <text>
lastTask
string <text>
sprint
string <text>
properties
string <jsonb>
downstreamHoursCritical
string <real>
downstreamHoursDirect
string <real>
lastClientNoteDate
string <timestamp with time zone>
lastNoteDate
string <timestamp with time zone>
fixPrice
string <numeric>
sourceFolderTemplateId
string <uuid>
sourceFolderTemplateItemId
string <uuid>
billPrice
string <numeric>
laborCost
string <numeric>
creationOrder
string <integer>
deletedDate
string <timestamp with time zone>
isDeleted
string <boolean>
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

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
}

/folders

query Parameters
id
string <uuid>
projectId
string <uuid>
folderTypeId
string <uuid>
priorityId
string <uuid>
statusId
string <uuid>
typeId
string <uuid>
parentId
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
isHiddenable
string <boolean>
description
string <character varying>
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
string <numeric>
bidPrice
string <numeric>
usedHours
string <numeric>
codaioPageId
string <text>
codaioBrowserLink
string <text>
bidHours
string <real>
availableToStartConflict
string <boolean>
invoiceNo
string <text>
invoicedHours
string <real>
availableToStart
string <timestamp with time zone>
deadline
string <timestamp with time zone>
importanceNo
string <integer>
downstreamHoursTotal
string <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
string <real>
softAssigneeId
string <uuid>
upstreamHoursCritical
string <real>
deadlineConflict
string <boolean>
spentHoursDiffecence
string <real>
qnote
string <text>
lastTask
string <text>
sprint
string <text>
properties
string <jsonb>
downstreamHoursCritical
string <real>
downstreamHoursDirect
string <real>
lastClientNoteDate
string <timestamp with time zone>
lastNoteDate
string <timestamp with time zone>
fixPrice
string <numeric>
sourceFolderTemplateId
string <uuid>
sourceFolderTemplateItemId
string <uuid>
billPrice
string <numeric>
laborCost
string <numeric>
creationOrder
string <integer>
deletedDate
string <timestamp with time zone>
isDeleted
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/folders

query Parameters
id
string <uuid>
projectId
string <uuid>
folderTypeId
string <uuid>
priorityId
string <uuid>
statusId
string <uuid>
typeId
string <uuid>
parentId
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
isHiddenable
string <boolean>
description
string <character varying>
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
string <numeric>
bidPrice
string <numeric>
usedHours
string <numeric>
codaioPageId
string <text>
codaioBrowserLink
string <text>
bidHours
string <real>
availableToStartConflict
string <boolean>
invoiceNo
string <text>
invoicedHours
string <real>
availableToStart
string <timestamp with time zone>
deadline
string <timestamp with time zone>
importanceNo
string <integer>
downstreamHoursTotal
string <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
string <real>
softAssigneeId
string <uuid>
upstreamHoursCritical
string <real>
deadlineConflict
string <boolean>
spentHoursDiffecence
string <real>
qnote
string <text>
lastTask
string <text>
sprint
string <text>
properties
string <jsonb>
downstreamHoursCritical
string <real>
downstreamHoursDirect
string <real>
lastClientNoteDate
string <timestamp with time zone>
lastNoteDate
string <timestamp with time zone>
fixPrice
string <numeric>
sourceFolderTemplateId
string <uuid>
sourceFolderTemplateItemId
string <uuid>
billPrice
string <numeric>
laborCost
string <numeric>
creationOrder
string <integer>
deletedDate
string <timestamp with time zone>
isDeleted
string <boolean>
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

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
}

outgoingStatusMappingIncomingStatuses

/outgoingStatusMappingIncomingStatuses

query Parameters
outgoingStatusMappingId
string <uuid>
statusId
string <uuid>
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 <uuid>
statusId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outgoingStatusMappingIncomingStatuses

query Parameters
outgoingStatusMappingId
string <uuid>
statusId
string <uuid>
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"
}

documentations

/documentations

query Parameters
id
string <uuid>
entityId
string <uuid>
url
string <text>
entityName
string <text>
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 <uuid>
entityId
string <uuid>
url
string <text>
entityName
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/documentations

query Parameters
id
string <uuid>
entityId
string <uuid>
url
string <text>
entityName
string <text>
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"
}

jobInstances

/jobInstances

query Parameters
id
string <uuid>
authorId
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
string <jsonb>
traceback
string <text>
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 <uuid>
authorId
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
string <jsonb>
traceback
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/jobInstances

query Parameters
id
string <uuid>
authorId
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
string <jsonb>
traceback
string <text>
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"
}

notificationTypes

/notificationTypes

query Parameters
id
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
description
string <text>
isCore
string <boolean>
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 <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
description
string <text>
isCore
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/notificationTypes

query Parameters
id
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
description
string <text>
isCore
string <boolean>
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
}

typeOutputTypes

/typeOutputTypes

query Parameters
outputTypeId
string <uuid>
typeId
string <uuid>
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 <uuid>
typeId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/typeOutputTypes

query Parameters
outputTypeId
string <uuid>
typeId
string <uuid>
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"
}

payouts

/payouts

query Parameters
id
string <uuid>
name
string <text>
amount
string <numeric>
paymentStatusId
string <uuid>
note
string <text>
startDate
string <timestamp with time zone>
endDate
string <timestamp with time zone>
userId
string <uuid>
paymentReference
string <text>
paymentDate
string <timestamp with time zone>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
authorId
string <uuid>
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.

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"
}

/payouts

query Parameters
id
string <uuid>
name
string <text>
amount
string <numeric>
paymentStatusId
string <uuid>
note
string <text>
startDate
string <timestamp with time zone>
endDate
string <timestamp with time zone>
userId
string <uuid>
paymentReference
string <text>
paymentDate
string <timestamp with time zone>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
authorId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/payouts

query Parameters
id
string <uuid>
name
string <text>
amount
string <numeric>
paymentStatusId
string <uuid>
note
string <text>
startDate
string <timestamp with time zone>
endDate
string <timestamp with time zone>
userId
string <uuid>
paymentReference
string <text>
paymentDate
string <timestamp with time zone>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
authorId
string <uuid>
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.

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"
}

schedulerViews

/schedulerViews

query Parameters
id
string <uuid>
ownerId
string <uuid>
isPublic
string <boolean>
tableState
string <jsonb>
name
string <text>
description
string <text>
projectId
string <uuid>
folderId
string <uuid>
filter
string <text>
pivotMode
string <boolean>
viewGroupId
string <uuid>
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 <uuid>
ownerId
string <uuid>
isPublic
string <boolean>
tableState
string <jsonb>
name
string <text>
description
string <text>
projectId
string <uuid>
folderId
string <uuid>
filter
string <text>
pivotMode
string <boolean>
viewGroupId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/schedulerViews

query Parameters
id
string <uuid>
ownerId
string <uuid>
isPublic
string <boolean>
tableState
string <jsonb>
name
string <text>
description
string <text>
projectId
string <uuid>
folderId
string <uuid>
filter
string <text>
pivotMode
string <boolean>
viewGroupId
string <uuid>
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"
}

chartDatas

/chartDatas

query Parameters
id
string <uuid>
stateId
string <uuid>
typeId
string <uuid>
projectId
string <uuid>
hours
string <numeric>
count
string <integer>
date
string <timestamp with time zone>
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 <uuid>
stateId
string <uuid>
typeId
string <uuid>
projectId
string <uuid>
hours
string <numeric>
count
string <integer>
date
string <timestamp with time zone>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/chartDatas

query Parameters
id
string <uuid>
stateId
string <uuid>
typeId
string <uuid>
projectId
string <uuid>
hours
string <numeric>
count
string <integer>
date
string <timestamp with time zone>
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"
}

statusMappingStatuses

/statusMappingStatuses

query Parameters
statusMappingId
string <uuid>
statusId
string <uuid>
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 <uuid>
statusId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/statusMappingStatuses

query Parameters
statusMappingId
string <uuid>
statusId
string <uuid>
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"
}

outputActionTemplates

/outputActionTemplates

query Parameters
outputTemplateId
string <uuid>
actionId
string <uuid>
statusIds
string <uuid[]>
order
string <integer>
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 <uuid>
actionId
string <uuid>
statusIds
string <uuid[]>
order
string <integer>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outputActionTemplates

query Parameters
outputTemplateId
string <uuid>
actionId
string <uuid>
statusIds
string <uuid[]>
order
string <integer>
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
}

paymentStatuses

/paymentStatuses

query Parameters
id
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
string <integer>
locksEditing
string <boolean>
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 <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
string <integer>
locksEditing
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/paymentStatuses

query Parameters
id
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
string <integer>
locksEditing
string <boolean>
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
}

statusMappings

/statusMappings

query Parameters
id
string <uuid>
folderNewStatusId
string <uuid>
outputVersionStatusId
string <uuid>
projectDefinitionId
string <uuid>
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 <uuid>
folderNewStatusId
string <uuid>
outputVersionStatusId
string <uuid>
projectDefinitionId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/statusMappings

query Parameters
id
string <uuid>
folderNewStatusId
string <uuid>
outputVersionStatusId
string <uuid>
projectDefinitionId
string <uuid>
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"
}

outputFileTypes

/outputFileTypes

query Parameters
outputId
string <uuid>
fileTypeId
string <uuid>
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 <uuid>
fileTypeId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outputFileTypes

query Parameters
outputId
string <uuid>
fileTypeId
string <uuid>
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"
}

typeApplicationExcludes

/typeApplicationExcludes

query Parameters
typeId
string <uuid>
applicationId
string <uuid>
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 <uuid>
applicationId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/typeApplicationExcludes

query Parameters
typeId
string <uuid>
applicationId
string <uuid>
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"
}

folderTypes

/folderTypes

query Parameters
id
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
isTaskable
string <boolean>
isTypeable
string <boolean>
isTodoable
string <boolean>
isCore
string <boolean>
isHiddenable
string <boolean>
screenPriority
string <integer>
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 <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
isTaskable
string <boolean>
isTypeable
string <boolean>
isTodoable
string <boolean>
isCore
string <boolean>
isHiddenable
string <boolean>
screenPriority
string <integer>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/folderTypes

query Parameters
id
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
isTaskable
string <boolean>
isTypeable
string <boolean>
isTodoable
string <boolean>
isCore
string <boolean>
isHiddenable
string <boolean>
screenPriority
string <integer>
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
}

projectDefinitionOutputTypes

/projectDefinitionOutputTypes

query Parameters
projectDefinitionId
string <uuid>
outputTypeId
string <uuid>
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 <uuid>
outputTypeId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionOutputTypes

query Parameters
projectDefinitionId
string <uuid>
outputTypeId
string <uuid>
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"
}

serverInfo

/serverInfo

query Parameters
id
string <integer>
version
string <text>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
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 <integer>
version
string <text>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/serverInfo

query Parameters
id
string <integer>
version
string <text>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
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"
}

/cloudLinks

query Parameters
id
string <uuid>
cloudApplicationId
string <uuid>
componentId
string <uuid>
link
string <character varying>
originalId
string <text>
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 <uuid>
cloudApplicationId
string <uuid>
componentId
string <uuid>
link
string <character varying>
originalId
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/cloudLinks

query Parameters
id
string <uuid>
cloudApplicationId
string <uuid>
componentId
string <uuid>
link
string <character varying>
originalId
string <text>
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"
}

projectStatuses

/projectStatuses

query Parameters
id
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
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 <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectStatuses

query Parameters
id
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
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"
}

help

/help

query Parameters
id
string <uuid>
helpStructure
string <jsonb>
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 <uuid>
helpStructure
string <jsonb>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/help

query Parameters
id
string <uuid>
helpStructure
string <jsonb>
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
}

clients

/clients

query Parameters
id
string <uuid>
name
string <character varying>
description
string <character varying>
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 <uuid>
name
string <character varying>
description
string <character varying>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/clients

query Parameters
id
string <uuid>
name
string <character varying>
description
string <character varying>
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"
}

folder_paths

/folder_paths

query Parameters
folderId
string <uuid>
folderPath
string <text>
folderPathIds
string <uuid[]>
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

/outputTemplates

query Parameters
id
string <uuid>
outputTypeId
string <uuid>
suffix
string <character varying>
hiddenInOutgoing
string <boolean>
isExternal
string <boolean>
folderTemplateId
string <uuid>
tagId
string <uuid>
name
string <character varying>
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 <uuid>
outputTypeId
string <uuid>
suffix
string <character varying>
hiddenInOutgoing
string <boolean>
isExternal
string <boolean>
folderTemplateId
string <uuid>
tagId
string <uuid>
name
string <character varying>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outputTemplates

query Parameters
id
string <uuid>
outputTypeId
string <uuid>
suffix
string <character varying>
hiddenInOutgoing
string <boolean>
isExternal
string <boolean>
folderTemplateId
string <uuid>
tagId
string <uuid>
name
string <character varying>
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": ""
}

cloudApplications

/cloudApplications

query Parameters
id
string <uuid>
name
string <character varying>
icon
string <character varying>
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 <uuid>
name
string <character varying>
icon
string <character varying>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/cloudApplications

query Parameters
id
string <uuid>
name
string <character varying>
icon
string <character varying>
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"
}

fileTypes

/fileTypes

query Parameters
id
string <uuid>
name
string <character varying>
fileExtension
string <character varying>
isCore
string <boolean>
isOpenable
string <boolean>
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

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "fileExtension": "string",
  • "isCore": true,
  • "isOpenable": false
}

/fileTypes

query Parameters
id
string <uuid>
name
string <character varying>
fileExtension
string <character varying>
isCore
string <boolean>
isOpenable
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/fileTypes

query Parameters
id
string <uuid>
name
string <character varying>
fileExtension
string <character varying>
isCore
string <boolean>
isOpenable
string <boolean>
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

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "fileExtension": "string",
  • "isCore": true,
  • "isOpenable": false
}

applicationFileTypes

/applicationFileTypes

query Parameters
applicationId
string <uuid>
fileTypeId
string <uuid>
screenPriority
string <integer>
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 <uuid>
fileTypeId
string <uuid>
screenPriority
string <integer>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/applicationFileTypes

query Parameters
applicationId
string <uuid>
fileTypeId
string <uuid>
screenPriority
string <integer>
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
}

settings

/settings

query Parameters
id
string <uuid>
key
string <text>
value
string <text>
type
string <integer>
isCore
string <boolean>
isSecret
string <boolean>
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 <uuid>
key
string <text>
value
string <text>
type
string <integer>
isCore
string <boolean>
isSecret
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/settings

query Parameters
id
string <uuid>
key
string <text>
value
string <text>
type
string <integer>
isCore
string <boolean>
isSecret
string <boolean>
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
}

folderAssigneeTemplates

/folderAssigneeTemplates

query Parameters
folderTemplateId
string <uuid>
userId
string <uuid>
assigneeRoleId
string <uuid>
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 <uuid>
userId
string <uuid>
assigneeRoleId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/folderAssigneeTemplates

query Parameters
folderTemplateId
string <uuid>
userId
string <uuid>
assigneeRoleId
string <uuid>
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"
}

outputs

/outputs

query Parameters
id
string <uuid>
folderId
string <uuid>
outputTypeId
string <uuid>
name
string <character varying>
suffix
string <character varying>
hiddenInOutgoing
string <boolean>
isExternal
string <boolean>
tagId
string <uuid>
fileTypeLogicalOperator
string <integer>
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 <uuid>
folderId
string <uuid>
outputTypeId
string <uuid>
name
string <character varying>
suffix
string <character varying>
hiddenInOutgoing
string <boolean>
isExternal
string <boolean>
tagId
string <uuid>
fileTypeLogicalOperator
string <integer>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outputs

query Parameters
id
string <uuid>
folderId
string <uuid>
outputTypeId
string <uuid>
name
string <character varying>
suffix
string <character varying>
hiddenInOutgoing
string <boolean>
isExternal
string <boolean>
tagId
string <uuid>
fileTypeLogicalOperator
string <integer>
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
}

__EFMigrationsHistory

/__EFMigrationsHistory

query Parameters
migrationId
string <character varying>
productVersion
string <character varying>
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 <character varying>
productVersion
string <character varying>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/__EFMigrationsHistory

query Parameters
migrationId
string <character varying>
productVersion
string <character varying>
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"
}

documentationOverrides

/documentationOverrides

query Parameters
id
string <uuid>
entityId
string <uuid>
url
string <text>
entityName
string <text>
projectDefinitionId
string <uuid>
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 <uuid>
entityId
string <uuid>
url
string <text>
entityName
string <text>
projectDefinitionId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/documentationOverrides

query Parameters
id
string <uuid>
entityId
string <uuid>
url
string <text>
entityName
string <text>
projectDefinitionId
string <uuid>
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"
}

projectViews

/projectViews

query Parameters
id
string <uuid>
ownerId
string <uuid>
isPublic
string <boolean>
tableState
string <jsonb>
name
string <text>
description
string <text>
projectId
string <uuid>
folderId
string <uuid>
folderTypeId
string <uuid>
filter
string <text>
googleSheetURL
string <text>
viewGroupId
string <uuid>
isForManagerView
string <boolean>
isForProjectView
string <boolean>
isForVersionView
string <boolean>
pivotMode
string <boolean>
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
[
  • {
    }
]

/projectViews

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:

projectViews

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>
folderTypeId
string <uuid>
filter
string <text>
googleSheetURL
string <text>
viewGroupId
string <uuid>

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

isForManagerView
required
boolean <boolean>
Default: false
isForProjectView
required
boolean <boolean>
Default: false
isForVersionView
required
boolean <boolean>
Default: false
pivotMode
required
boolean <boolean>
Default: false

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",
  • "folderTypeId": "71aced48-af8d-4945-986e-3673fa133f54",
  • "filter": "string",
  • "googleSheetURL": "string",
  • "viewGroupId": "48a48f5a-0254-4b2d-9d67-3d59b4f210f9",
  • "isForManagerView": false,
  • "isForProjectView": false,
  • "isForVersionView": false,
  • "pivotMode": false
}

/projectViews

query Parameters
id
string <uuid>
ownerId
string <uuid>
isPublic
string <boolean>
tableState
string <jsonb>
name
string <text>
description
string <text>
projectId
string <uuid>
folderId
string <uuid>
folderTypeId
string <uuid>
filter
string <text>
googleSheetURL
string <text>
viewGroupId
string <uuid>
isForManagerView
string <boolean>
isForProjectView
string <boolean>
isForVersionView
string <boolean>
pivotMode
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectViews

query Parameters
id
string <uuid>
ownerId
string <uuid>
isPublic
string <boolean>
tableState
string <jsonb>
name
string <text>
description
string <text>
projectId
string <uuid>
folderId
string <uuid>
folderTypeId
string <uuid>
filter
string <text>
googleSheetURL
string <text>
viewGroupId
string <uuid>
isForManagerView
string <boolean>
isForProjectView
string <boolean>
isForVersionView
string <boolean>
pivotMode
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

projectViews

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>
folderTypeId
string <uuid>
filter
string <text>
googleSheetURL
string <text>
viewGroupId
string <uuid>

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

isForManagerView
required
boolean <boolean>
Default: false
isForProjectView
required
boolean <boolean>
Default: false
isForVersionView
required
boolean <boolean>
Default: false
pivotMode
required
boolean <boolean>
Default: false

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",
  • "folderTypeId": "71aced48-af8d-4945-986e-3673fa133f54",
  • "filter": "string",
  • "googleSheetURL": "string",
  • "viewGroupId": "48a48f5a-0254-4b2d-9d67-3d59b4f210f9",
  • "isForManagerView": false,
  • "isForProjectView": false,
  • "isForVersionView": false,
  • "pivotMode": false
}

noteAssignees

/noteAssignees

query Parameters
id
string <uuid>
noteId
string <uuid>
userId
string <uuid>
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 <uuid>
noteId
string <uuid>
userId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/noteAssignees

query Parameters
id
string <uuid>
noteId
string <uuid>
userId
string <uuid>
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"
}

folderTemplates

/folderTemplates

query Parameters
id
string <uuid>
folderTypeId
string <uuid>
typeId
string <uuid>
parentId
string <uuid>
statusId
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
folderTemplateName
string <character varying>
folderTemplateCodeName
string <character varying>
description
string <character varying>
plannedHours
string <numeric>
priorityId
string <uuid>
biddingOverrideId
string <uuid>
folderTemplateDescription
string <text>
creationOrder
string <integer>
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 <uuid>
folderTypeId
string <uuid>
typeId
string <uuid>
parentId
string <uuid>
statusId
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
folderTemplateName
string <character varying>
folderTemplateCodeName
string <character varying>
description
string <character varying>
plannedHours
string <numeric>
priorityId
string <uuid>
biddingOverrideId
string <uuid>
folderTemplateDescription
string <text>
creationOrder
string <integer>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/folderTemplates

query Parameters
id
string <uuid>
folderTypeId
string <uuid>
typeId
string <uuid>
parentId
string <uuid>
statusId
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
folderTemplateName
string <character varying>
folderTemplateCodeName
string <character varying>
description
string <character varying>
plannedHours
string <numeric>
priorityId
string <uuid>
biddingOverrideId
string <uuid>
folderTemplateDescription
string <text>
creationOrder
string <integer>
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
}

projectDefinitionActivityTypes

/projectDefinitionActivityTypes

query Parameters
projectDefinitionId
string <uuid>
activityTypeId
string <uuid>
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 <uuid>
activityTypeId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionActivityTypes

query Parameters
projectDefinitionId
string <uuid>
activityTypeId
string <uuid>
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"
}

assigneeRoleNotificationTypes

/assigneeRoleNotificationTypes

query Parameters
assigneeRoleId
string <uuid>
notificationTypeId
string <uuid>
state
string <integer>
defaultEnabled
string <boolean>
defaultEmailEnabled
string <boolean>
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 <uuid>
notificationTypeId
string <uuid>
state
string <integer>
defaultEnabled
string <boolean>
defaultEmailEnabled
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/assigneeRoleNotificationTypes

query Parameters
assigneeRoleId
string <uuid>
notificationTypeId
string <uuid>
state
string <integer>
defaultEnabled
string <boolean>
defaultEmailEnabled
string <boolean>
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
}

applicationVersions

/applicationVersions

query Parameters
id
string <uuid>
applicationId
string <uuid>
version
string <character varying>
isActive
string <boolean>
arguments
string <jsonb>
environment
string <jsonb>
executables
string <jsonb>
versionLabel
string <character varying>
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 <uuid>
applicationId
string <uuid>
version
string <character varying>
isActive
string <boolean>
arguments
string <jsonb>
environment
string <jsonb>
executables
string <jsonb>
versionLabel
string <character varying>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/applicationVersions

query Parameters
id
string <uuid>
applicationId
string <uuid>
version
string <character varying>
isActive
string <boolean>
arguments
string <jsonb>
environment
string <jsonb>
executables
string <jsonb>
versionLabel
string <character varying>
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"
}

biddingOverrides

/biddingOverrides

query Parameters
id
string <uuid>
data
string <jsonb>
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 <uuid>
data
string <jsonb>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/biddingOverrides

query Parameters
id
string <uuid>
data
string <jsonb>
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
}

projectAssignees

/projectAssignees

query Parameters
projectId
string <uuid>
userId
string <uuid>
assigneeRoleId
string <uuid>
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 <uuid>
userId
string <uuid>
assigneeRoleId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectAssignees

query Parameters
projectId
string <uuid>
userId
string <uuid>
assigneeRoleId
string <uuid>
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"
}

customAttributeDefinitions

/customAttributeDefinitions

query Parameters
id
string <uuid>
customAttributeBaseTypeId
string <uuid>
customAttributeGroupId
string <uuid>
name
string <character varying>
isCore
string <boolean>
isInheritable
string <boolean>
isPinned
string <boolean>
isHidden
string <boolean>
defaultValue
string <text>
values
string <jsonb>
screenPriority
string <integer>
codeName
string <character varying>
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 <uuid>
customAttributeBaseTypeId
string <uuid>
customAttributeGroupId
string <uuid>
name
string <character varying>
isCore
string <boolean>
isInheritable
string <boolean>
isPinned
string <boolean>
isHidden
string <boolean>
defaultValue
string <text>
values
string <jsonb>
screenPriority
string <integer>
codeName
string <character varying>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/customAttributeDefinitions

query Parameters
id
string <uuid>
customAttributeBaseTypeId
string <uuid>
customAttributeGroupId
string <uuid>
name
string <character varying>
isCore
string <boolean>
isInheritable
string <boolean>
isPinned
string <boolean>
isHidden
string <boolean>
defaultValue
string <text>
values
string <jsonb>
screenPriority
string <integer>
codeName
string <character varying>
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": ""
}

views

/views

query Parameters
id
string <uuid>
ownerId
string <uuid>
isPublic
string <boolean>
tableState
string <jsonb>
name
string <text>
description
string <text>
isForProjectView
string <boolean>
isForVersionView
string <boolean>
isForManagerView
string <boolean>
folderTypeId
string <uuid>
filter
string <text>
viewGroupId
string <uuid>
pivotMode
string <boolean>
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
required
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

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
}

/views

query Parameters
id
string <uuid>
ownerId
string <uuid>
isPublic
string <boolean>
tableState
string <jsonb>
name
string <text>
description
string <text>
isForProjectView
string <boolean>
isForVersionView
string <boolean>
isForManagerView
string <boolean>
folderTypeId
string <uuid>
filter
string <text>
viewGroupId
string <uuid>
pivotMode
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/views

query Parameters
id
string <uuid>
ownerId
string <uuid>
isPublic
string <boolean>
tableState
string <jsonb>
name
string <text>
description
string <text>
isForProjectView
string <boolean>
isForVersionView
string <boolean>
isForManagerView
string <boolean>
folderTypeId
string <uuid>
filter
string <text>
viewGroupId
string <uuid>
pivotMode
string <boolean>
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
required
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

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
}

folderAssignees

/folderAssignees

query Parameters
folderId
string <uuid>
userId
string <uuid>
assigneeRoleId
string <uuid>
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 <uuid>
userId
string <uuid>
assigneeRoleId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/folderAssignees

query Parameters
folderId
string <uuid>
userId
string <uuid>
assigneeRoleId
string <uuid>
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"
}

outgoingStatusMappingTags

/outgoingStatusMappingTags

query Parameters
outgoingStatusMappingId
string <uuid>
tagId
string <uuid>
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 <uuid>
tagId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outgoingStatusMappingTags

query Parameters
outgoingStatusMappingId
string <uuid>
tagId
string <uuid>
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"
}

noteCategories

/noteCategories

query Parameters
id
string <uuid>
name
string <text>
color
string <text>
isCore
string <boolean>
screenPriority
string <integer>
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 <uuid>
name
string <text>
color
string <text>
isCore
string <boolean>
screenPriority
string <integer>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/noteCategories

query Parameters
id
string <uuid>
name
string <text>
color
string <text>
isCore
string <boolean>
screenPriority
string <integer>
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
}

projectDefinitionFolderTypes

/projectDefinitionFolderTypes

query Parameters
projectDefinitionId
string <uuid>
folderTypeId
string <uuid>
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 <uuid>
folderTypeId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionFolderTypes

query Parameters
projectDefinitionId
string <uuid>
folderTypeId
string <uuid>
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"
}

uploadRecords

/uploadRecords

query Parameters
id
string <uuid>
jobId
string <uuid>
status
string <character varying>
fileName
string <character varying>
path
string <character varying>
traceback
string <character varying>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
authorId
string <uuid>
progress
string <double precision>
total
string <integer>
retries
string <integer>
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 <uuid>
jobId
string <uuid>
status
string <character varying>
fileName
string <character varying>
path
string <character varying>
traceback
string <character varying>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
authorId
string <uuid>
progress
string <double precision>
total
string <integer>
retries
string <integer>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/uploadRecords

query Parameters
id
string <uuid>
jobId
string <uuid>
status
string <character varying>
fileName
string <character varying>
path
string <character varying>
traceback
string <character varying>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
authorId
string <uuid>
progress
string <double precision>
total
string <integer>
retries
string <integer>
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
}

customAttributeDefinitionPermissions

/customAttributeDefinitionPermissions

query Parameters
customAttributeDefinitionId
string <uuid>
securityRoleId
string <uuid>
canRead
string <boolean>
canWrite
string <boolean>
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 <uuid>
securityRoleId
string <uuid>
canRead
string <boolean>
canWrite
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/customAttributeDefinitionPermissions

query Parameters
customAttributeDefinitionId
string <uuid>
securityRoleId
string <uuid>
canRead
string <boolean>
canWrite
string <boolean>
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
}

actions

/actions

query Parameters
id
string <uuid>
name
string <character varying>
runLocal
string <boolean>
isAutomatic
string <boolean>
data
string <jsonb>
description
string <character varying>
group
string <text>
icon
string <character varying>
label
string <text>
version
string <character varying>
outputTemplateId
string <uuid>
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.

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"
}

/actions

query Parameters
id
string <uuid>
name
string <character varying>
runLocal
string <boolean>
isAutomatic
string <boolean>
data
string <jsonb>
description
string <character varying>
group
string <text>
icon
string <character varying>
label
string <text>
version
string <character varying>
outputTemplateId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/actions

query Parameters
id
string <uuid>
name
string <character varying>
runLocal
string <boolean>
isAutomatic
string <boolean>
data
string <jsonb>
description
string <character varying>
group
string <text>
icon
string <character varying>
label
string <text>
version
string <character varying>
outputTemplateId
string <uuid>
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.

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"
}

states

/states

query Parameters
id
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
string <integer>
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 <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
string <integer>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/states

query Parameters
id
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
string <integer>
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
}

folderFolders

/folderFolders

query Parameters
inputFolderId
string <uuid>
outputFolderId
string <uuid>
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 <uuid>
outputFolderId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/folderFolders

query Parameters
inputFolderId
string <uuid>
outputFolderId
string <uuid>
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"
}

folderTemplateFolderTemplates

/folderTemplateFolderTemplates

query Parameters
inputFolderTemplateId
string <uuid>
outputFolderTemplateId
string <uuid>
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 <uuid>
outputFolderTemplateId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/folderTemplateFolderTemplates

query Parameters
inputFolderTemplateId
string <uuid>
outputFolderTemplateId
string <uuid>
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"
}

permissions

/permissions

query Parameters
id
string <uuid>
name
string <character varying>
description
string <character varying>
scope
string <character varying>
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 <uuid>
name
string <character varying>
description
string <character varying>
scope
string <character varying>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/permissions

query Parameters
id
string <uuid>
name
string <character varying>
description
string <character varying>
scope
string <character varying>
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"
}

hourlyRates

/hourlyRates

query Parameters
id
string <uuid>
userId
string <uuid>
projectDefinitionId
string <uuid>
value
string <numeric>
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 <uuid>
userId
string <uuid>
projectDefinitionId
string <uuid>
value
string <numeric>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/hourlyRates

query Parameters
id
string <uuid>
userId
string <uuid>
projectDefinitionId
string <uuid>
value
string <numeric>
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
}

folderTags

/folderTags

query Parameters
folderId
string <uuid>
tagId
string <uuid>
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 <uuid>
tagId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/folderTags

query Parameters
folderId
string <uuid>
tagId
string <uuid>
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"
}

storageRecords

/storageRecords

query Parameters
id
string <uuid>
componentId
string <uuid>
storageLocation
string <smallint>
link
string <text>
status
string <smallint>
statusMessage
string <text>
progress
string <smallint>
linkExpiration
string <timestamp with time zone>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
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>

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"
}

/storageRecords

query Parameters
id
string <uuid>
componentId
string <uuid>
storageLocation
string <smallint>
link
string <text>
status
string <smallint>
statusMessage
string <text>
progress
string <smallint>
linkExpiration
string <timestamp with time zone>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/storageRecords

query Parameters
id
string <uuid>
componentId
string <uuid>
storageLocation
string <smallint>
link
string <text>
status
string <smallint>
statusMessage
string <text>
progress
string <smallint>
linkExpiration
string <timestamp with time zone>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
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>

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"
}

ayonProductTypes

/ayonProductTypes

query Parameters
id
string <uuid>
name
string <text>
screenPriority
string <integer>
isCore
string <boolean>
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 <uuid>
name
string <text>
screenPriority
string <integer>
isCore
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/ayonProductTypes

query Parameters
id
string <uuid>
name
string <text>
screenPriority
string <integer>
isCore
string <boolean>
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
}

frameIOLabels

/frameIOLabels

query Parameters
id
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
isCore
string <boolean>
statusId
string <uuid>
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 <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
isCore
string <boolean>
statusId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/frameIOLabels

query Parameters
id
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
isCore
string <boolean>
statusId
string <uuid>
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"
}

todoTemplates

/todoTemplates

query Parameters
id
string <uuid>
isDone
string <boolean>
text
string <character varying>
color
string <character>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
doneDate
string <timestamp with time zone>
folderTemplateId
string <uuid>
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 <uuid>
isDone
string <boolean>
text
string <character varying>
color
string <character>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
doneDate
string <timestamp with time zone>
folderTemplateId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/todoTemplates

query Parameters
id
string <uuid>
isDone
string <boolean>
text
string <character varying>
color
string <character>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
doneDate
string <timestamp with time zone>
folderTemplateId
string <uuid>
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"
}

projects

/projects

query Parameters
id
string <uuid>
projectDefinitionId
string <uuid>
projectStatusId
string <uuid>
clientId
string <uuid>
name
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>
shortName
string <text>
icon
string <text>
codeName
string <text>
color
string <text>
deletedDate
string <timestamp with time zone>
isDeleted
string <boolean>
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 <uuid>
projectDefinitionId
string <uuid>
projectStatusId
string <uuid>
clientId
string <uuid>
name
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>
shortName
string <text>
icon
string <text>
codeName
string <text>
color
string <text>
deletedDate
string <timestamp with time zone>
isDeleted
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projects

query Parameters
id
string <uuid>
projectDefinitionId
string <uuid>
projectStatusId
string <uuid>
clientId
string <uuid>
name
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>
shortName
string <text>
icon
string <text>
codeName
string <text>
color
string <text>
deletedDate
string <timestamp with time zone>
isDeleted
string <boolean>
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
}

cloudPlaces

/cloudPlaces

query Parameters
id
string <uuid>
cloudApplicationId
string <uuid>
componentStateId
string <uuid>
componentId
string <uuid>
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 <uuid>
cloudApplicationId
string <uuid>
componentStateId
string <uuid>
componentId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/cloudPlaces

query Parameters
id
string <uuid>
cloudApplicationId
string <uuid>
componentStateId
string <uuid>
componentId
string <uuid>
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"
}

userAvailabilities

/userAvailabilities

query Parameters
id
string <uuid>
userId
string <uuid>
weekDayId
string <uuid>
workTimeStart
string <interval>
workTimeEnd
string <interval>
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 <uuid>
userId
string <uuid>
weekDayId
string <uuid>
workTimeStart
string <interval>
workTimeEnd
string <interval>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/userAvailabilities

query Parameters
id
string <uuid>
userId
string <uuid>
weekDayId
string <uuid>
workTimeStart
string <interval>
workTimeEnd
string <interval>
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"
}

holidays

/holidays

query Parameters
id
string <uuid>
holidayStartDate
string <timestamp with time zone>
holidayEndDate
string <timestamp with time zone>
holidayType
string <integer>
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 <uuid>
holidayStartDate
string <timestamp with time zone>
holidayEndDate
string <timestamp with time zone>
holidayType
string <integer>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/holidays

query Parameters
id
string <uuid>
holidayStartDate
string <timestamp with time zone>
holidayEndDate
string <timestamp with time zone>
holidayType
string <integer>
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
}

customAttributeDefinitionFolderTypes

/customAttributeDefinitionFolderTypes

query Parameters
id
string <uuid>
customAttributeDefinitionId
string <uuid>
folderTypeId
string <uuid>
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 <uuid>
customAttributeDefinitionId
string <uuid>
folderTypeId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/customAttributeDefinitionFolderTypes

query Parameters
id
string <uuid>
customAttributeDefinitionId
string <uuid>
folderTypeId
string <uuid>
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"
}

defaultViews

/defaultViews

query Parameters
projectId
string <uuid>
userId
string <uuid>
viewId
string <uuid>
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 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.

viewId
required
string <uuid>

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

Responses

Request samples

Content type
{
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "viewId": "5aa272a5-73e4-4f9c-8123-4bac998fdb73"
}

/defaultViews

query Parameters
projectId
string <uuid>
userId
string <uuid>
viewId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/defaultViews

query Parameters
projectId
string <uuid>
userId
string <uuid>
viewId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

defaultViews

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.

viewId
required
string <uuid>

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

Responses

Request samples

Content type
{
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "viewId": "5aa272a5-73e4-4f9c-8123-4bac998fdb73"
}

biddings

/biddings

query Parameters
id
string <uuid>
data
string <jsonb>
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 <uuid>
data
string <jsonb>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/biddings

query Parameters
id
string <uuid>
data
string <jsonb>
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
}

statusMappingTags

/statusMappingTags

query Parameters
statusMappingId
string <uuid>
tagId
string <uuid>
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 <uuid>
tagId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/statusMappingTags

query Parameters
statusMappingId
string <uuid>
tagId
string <uuid>
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"
}

userTimeTrackers

/userTimeTrackers

query Parameters
id
string <uuid>
folderId
string <uuid>
description
string <text>
startTime
string <timestamp with time zone>
endTime
string <timestamp with time zone>
isLive
string <boolean>
userId
string <uuid>
iterationId
string <uuid>
userHourlyRate
string <numeric>
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 <uuid>
folderId
string <uuid>
description
string <text>
startTime
string <timestamp with time zone>
endTime
string <timestamp with time zone>
isLive
string <boolean>
userId
string <uuid>
iterationId
string <uuid>
userHourlyRate
string <numeric>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/userTimeTrackers

query Parameters
id
string <uuid>
folderId
string <uuid>
description
string <text>
startTime
string <timestamp with time zone>
endTime
string <timestamp with time zone>
isLive
string <boolean>
userId
string <uuid>
iterationId
string <uuid>
userHourlyRate
string <numeric>
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
}

projectDefinitionNoteCategories

/projectDefinitionNoteCategories

query Parameters
projectDefinitionId
string <uuid>
noteCategoryId
string <uuid>
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 <uuid>
noteCategoryId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionNoteCategories

query Parameters
projectDefinitionId
string <uuid>
noteCategoryId
string <uuid>
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"
}

projectDefinitions

/projectDefinitions

query Parameters
id
string <uuid>
name
string <character varying>
isActive
string <boolean>
hasBasicFolderStructure
string <boolean>
directoryStructureSettings
string <jsonb>
templates
string <jsonb>
defaultActivityTypeId
string <uuid>
defaultFolderStatusId
string <uuid>
defaultFolderTypeId
string <uuid>
defaultNoteCategoryId
string <uuid>
defaultOutputStatusId
string <uuid>
defaultOutputTypeId
string <uuid>
defaultPriorityId
string <uuid>
defaultTypeId
string <uuid>
roots
string <jsonb>
isDefault
string <boolean>
outputNameSettings
string <jsonb>
templateNameProfiles
string <jsonb>
taskLinkPatterns
string <json>
defaultTypePrice
string <real>
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>

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
}

/projectDefinitions

query Parameters
id
string <uuid>
name
string <character varying>
isActive
string <boolean>
hasBasicFolderStructure
string <boolean>
directoryStructureSettings
string <jsonb>
templates
string <jsonb>
defaultActivityTypeId
string <uuid>
defaultFolderStatusId
string <uuid>
defaultFolderTypeId
string <uuid>
defaultNoteCategoryId
string <uuid>
defaultOutputStatusId
string <uuid>
defaultOutputTypeId
string <uuid>
defaultPriorityId
string <uuid>
defaultTypeId
string <uuid>
roots
string <jsonb>
isDefault
string <boolean>
outputNameSettings
string <jsonb>
templateNameProfiles
string <jsonb>
taskLinkPatterns
string <json>
defaultTypePrice
string <real>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitions

query Parameters
id
string <uuid>
name
string <character varying>
isActive
string <boolean>
hasBasicFolderStructure
string <boolean>
directoryStructureSettings
string <jsonb>
templates
string <jsonb>
defaultActivityTypeId
string <uuid>
defaultFolderStatusId
string <uuid>
defaultFolderTypeId
string <uuid>
defaultNoteCategoryId
string <uuid>
defaultOutputStatusId
string <uuid>
defaultOutputTypeId
string <uuid>
defaultPriorityId
string <uuid>
defaultTypeId
string <uuid>
roots
string <jsonb>
isDefault
string <boolean>
outputNameSettings
string <jsonb>
templateNameProfiles
string <jsonb>
taskLinkPatterns
string <json>
defaultTypePrice
string <real>
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>

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
}

outputVersionTags

/outputVersionTags

query Parameters
outputVersionId
string <uuid>
tagId
string <uuid>
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 <uuid>
tagId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outputVersionTags

query Parameters
outputVersionId
string <uuid>
tagId
string <uuid>
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"
}

userSkills

/userSkills

query Parameters
id
string <uuid>
userId
string <uuid>
typeId
string <uuid>
skillLevel
string <integer>
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 <uuid>
userId
string <uuid>
typeId
string <uuid>
skillLevel
string <integer>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/userSkills

query Parameters
id
string <uuid>
userId
string <uuid>
typeId
string <uuid>
skillLevel
string <integer>
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
}

customAttributes

/customAttributes

query Parameters
id
string <uuid>
customAttributeDefinitionId
string <uuid>
projectId
string <uuid>
folderId
string <uuid>
value
string <text>
inheritedValue
string <text>
computedValue
string <text>
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 <uuid>
customAttributeDefinitionId
string <uuid>
projectId
string <uuid>
folderId
string <uuid>
value
string <text>
inheritedValue
string <text>
computedValue
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/customAttributes

query Parameters
id
string <uuid>
customAttributeDefinitionId
string <uuid>
projectId
string <uuid>
folderId
string <uuid>
value
string <text>
inheritedValue
string <text>
computedValue
string <text>
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"
}

publicHolidays

/publicHolidays

query Parameters
id
string <uuid>
name
string <text>
date
string <text>
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>

Responses

Request samples

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

/publicHolidays

query Parameters
id
string <uuid>
name
string <text>
date
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/publicHolidays

query Parameters
id
string <uuid>
name
string <text>
date
string <text>
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>

Responses

Request samples

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

userTags

/userTags

query Parameters
id
string <uuid>
icon
string <character varying>
note
string <character varying>
color
string <character>
userId
string <uuid>
folderId
string <uuid>
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 <uuid>
icon
string <character varying>
note
string <character varying>
color
string <character>
userId
string <uuid>
folderId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/userTags

query Parameters
id
string <uuid>
icon
string <character varying>
note
string <character varying>
color
string <character>
userId
string <uuid>
folderId
string <uuid>
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"
}

outputActions

/outputActions

query Parameters
outputId
string <uuid>
actionId
string <uuid>
statusIds
string <uuid[]>
order
string <integer>
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 <uuid>
actionId
string <uuid>
statusIds
string <uuid[]>
order
string <integer>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outputActions

query Parameters
outputId
string <uuid>
actionId
string <uuid>
statusIds
string <uuid[]>
order
string <integer>
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
}

noteAttachments

/noteAttachments

query Parameters
noteId
string <uuid>
attachmentId
string <uuid>
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 <uuid>
attachmentId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/noteAttachments

query Parameters
noteId
string <uuid>
attachmentId
string <uuid>
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"
}

payoutAttachments

/payoutAttachments

query Parameters
payoutId
string <uuid>
attachmentId
string <uuid>
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 <uuid>
attachmentId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/payoutAttachments

query Parameters
payoutId
string <uuid>
attachmentId
string <uuid>
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"
}

outgoingStatusMappingCurrentStatuses

/outgoingStatusMappingCurrentStatuses

query Parameters
outgoingStatusMappingId
string <uuid>
statusId
string <uuid>
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 <uuid>
statusId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outgoingStatusMappingCurrentStatuses

query Parameters
outgoingStatusMappingId
string <uuid>
statusId
string <uuid>
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"
}

customAttributeGroups

/customAttributeGroups

query Parameters
id
string <uuid>
name
string <character varying>
description
string <jsonb>
screenPriority
string <integer>
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 <uuid>
name
string <character varying>
description
string <jsonb>
screenPriority
string <integer>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/customAttributeGroups

query Parameters
id
string <uuid>
name
string <character varying>
description
string <jsonb>
screenPriority
string <integer>
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
}

projectScenarios

/projectScenarios

query Parameters
id
string <uuid>
projectId
string <uuid>
name
string <character varying>
structure
string <jsonb>
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>

Responses

Request samples

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

/projectScenarios

query Parameters
id
string <uuid>
projectId
string <uuid>
name
string <character varying>
structure
string <jsonb>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectScenarios

query Parameters
id
string <uuid>
projectId
string <uuid>
name
string <character varying>
structure
string <jsonb>
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>

Responses

Request samples

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

notes

/notes

query Parameters
id
string <uuid>
folderId
string <uuid>
noteCategoryId
string <uuid>
outputVersionId
string <uuid>
parentId
string <uuid>
authorId
string <uuid>
content
string <text>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
isAutogenerated
string <boolean>
isPinned
string <boolean>
frame
string <integer>
reviewData
string <json>
componentId
string <uuid>
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.

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"
}

/notes

query Parameters
id
string <uuid>
folderId
string <uuid>
noteCategoryId
string <uuid>
outputVersionId
string <uuid>
parentId
string <uuid>
authorId
string <uuid>
content
string <text>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
isAutogenerated
string <boolean>
isPinned
string <boolean>
frame
string <integer>
reviewData
string <json>
componentId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/notes

query Parameters
id
string <uuid>
folderId
string <uuid>
noteCategoryId
string <uuid>
outputVersionId
string <uuid>
parentId
string <uuid>
authorId
string <uuid>
content
string <text>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
isAutogenerated
string <boolean>
isPinned
string <boolean>
frame
string <integer>
reviewData
string <json>
componentId
string <uuid>
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.

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"
}

playlistComponents

/playlistComponents

query Parameters
playlistId
string <uuid>
componentId
string <uuid>
order
string <integer>
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 <uuid>
componentId
string <uuid>
order
string <integer>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/playlistComponents

query Parameters
playlistId
string <uuid>
componentId
string <uuid>
order
string <integer>
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
}

todos

/todos

query Parameters
id
string <uuid>
folderId
string <uuid>
isDone
string <boolean>
text
string <character varying>
color
string <character>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
doneDate
string <timestamp with time zone>
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 <uuid>
folderId
string <uuid>
isDone
string <boolean>
text
string <character varying>
color
string <character>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
doneDate
string <timestamp with time zone>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/todos

query Parameters
id
string <uuid>
folderId
string <uuid>
isDone
string <boolean>
text
string <character varying>
color
string <character>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
doneDate
string <timestamp with time zone>
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"
}

weekDays

/weekDays

query Parameters
id
string <uuid>
name
string <text>
abbreviation
string <text>
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 <uuid>
name
string <text>
abbreviation
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/weekDays

query Parameters
id
string <uuid>
name
string <text>
abbreviation
string <text>
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"
}

activityTypes

/activityTypes

query Parameters
id
string <uuid>
name
string <character varying>
displayText
string <character varying>
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 <uuid>
name
string <character varying>
displayText
string <character varying>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/activityTypes

query Parameters
id
string <uuid>
name
string <character varying>
displayText
string <character varying>
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"
}

events

/events

query Parameters
id
string <uuid>
authorId
string <uuid>
payload
string <jsonb>
status
string <character varying>
topic
string <text>
description
string <text>
sender
string <text>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
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 <uuid>
authorId
string <uuid>
payload
string <jsonb>
status
string <character varying>
topic
string <text>
description
string <text>
sender
string <text>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/events

query Parameters
id
string <uuid>
authorId
string <uuid>
payload
string <jsonb>
status
string <character varying>
topic
string <text>
description
string <text>
sender
string <text>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
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"
}

integrationApplicationUsers

/integrationApplicationUsers

query Parameters
integrationApplicationId
string <uuid>
userId
string <uuid>
value
string <text>
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 <uuid>
userId
string <uuid>
value
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/integrationApplicationUsers

query Parameters
integrationApplicationId
string <uuid>
userId
string <uuid>
value
string <text>
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"
}

componentStates

/componentStates

query Parameters
id
string <uuid>
state
string <text>
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 <uuid>
state
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/componentStates

query Parameters
id
string <uuid>
state
string <text>
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"
}

priorities

/priorities

query Parameters
id
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
value
string <smallint>
screenPriority
string <integer>
isCore
string <boolean>
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 <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
value
string <smallint>
screenPriority
string <integer>
isCore
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/priorities

query Parameters
id
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
value
string <smallint>
screenPriority
string <integer>
isCore
string <boolean>
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
}

playlists

/playlists

query Parameters
id
string <uuid>
name
string <character varying>
description
string <text>
authorId
string <uuid>
projectId
string <uuid>
link
string <character varying>
externalLink
string <character varying>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
properties
string <jsonb>
isActive
string <boolean>
isPrivate
string <boolean>
isClient
string <boolean>
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 <uuid>
name
string <character varying>
description
string <text>
authorId
string <uuid>
projectId
string <uuid>
link
string <character varying>
externalLink
string <character varying>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
properties
string <jsonb>
isActive
string <boolean>
isPrivate
string <boolean>
isClient
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/playlists

query Parameters
id
string <uuid>
name
string <character varying>
description
string <text>
authorId
string <uuid>
projectId
string <uuid>
link
string <character varying>
externalLink
string <character varying>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
properties
string <jsonb>
isActive
string <boolean>
isPrivate
string <boolean>
isClient
string <boolean>
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
}

securityRoles

/securityRoles

query Parameters
id
string <uuid>
name
string <character varying>
color
string <text>
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 <uuid>
name
string <character varying>
color
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/securityRoles

query Parameters
id
string <uuid>
name
string <character varying>
color
string <text>
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"
}

statuses

/statuses

query Parameters
id
string <uuid>
stateId
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
canBeUsedForFolder
string <boolean>
canBeUsedForOutput
string <boolean>
screenPriority
string <integer>
isCore
string <boolean>
frameIOLabelId
string <uuid>
ftrackStatusId
string <uuid>
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>

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"
}

/statuses

query Parameters
id
string <uuid>
stateId
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
canBeUsedForFolder
string <boolean>
canBeUsedForOutput
string <boolean>
screenPriority
string <integer>
isCore
string <boolean>
frameIOLabelId
string <uuid>
ftrackStatusId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/statuses

query Parameters
id
string <uuid>
stateId
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
canBeUsedForFolder
string <boolean>
canBeUsedForOutput
string <boolean>
screenPriority
string <integer>
isCore
string <boolean>
frameIOLabelId
string <uuid>
ftrackStatusId
string <uuid>
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>

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"
}

tags

/tags

query Parameters
id
string <uuid>
description
string <character varying>
color
string <text>
isCore
string <boolean>
isHidden
string <boolean>
canBeUsedForFolder
string <boolean>
canBeUsedForOutput
string <boolean>
canBeUsedForOutputVersion
string <boolean>
codeName
string <text>
icon
string <text>
name
string <text>
shortName
string <text>
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 <uuid>
description
string <character varying>
color
string <text>
isCore
string <boolean>
isHidden
string <boolean>
canBeUsedForFolder
string <boolean>
canBeUsedForOutput
string <boolean>
canBeUsedForOutputVersion
string <boolean>
codeName
string <text>
icon
string <text>
name
string <text>
shortName
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/tags

query Parameters
id
string <uuid>
description
string <character varying>
color
string <text>
isCore
string <boolean>
isHidden
string <boolean>
canBeUsedForFolder
string <boolean>
canBeUsedForOutput
string <boolean>
canBeUsedForOutputVersion
string <boolean>
codeName
string <text>
icon
string <text>
name
string <text>
shortName
string <text>
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"
}

customAttributeBaseTypes

/customAttributeBaseTypes

query Parameters
id
string <uuid>
attributeType
string <character varying>
name
string <character varying>
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 <uuid>
attributeType
string <character varying>
name
string <character varying>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/customAttributeBaseTypes

query Parameters
id
string <uuid>
attributeType
string <character varying>
name
string <character varying>
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"
}

assigneeRoles

/assigneeRoles

query Parameters
id
string <uuid>
name
string <character varying>
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 <uuid>
name
string <character varying>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/assigneeRoles

query Parameters
id
string <uuid>
name
string <character varying>
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"
}

active_locks

/active_locks

query Parameters
schemaname
string <name>
relname
string <name>
locktype
string <text>
page
string <integer>
virtualtransaction
string <text>
pid
string <integer>
mode
string <text>
granted
string <boolean>
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

/schedulerViewFolderTypes

query Parameters
schedulerViewId
string <uuid>
folderTypeId
string <uuid>
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 <uuid>
folderTypeId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/schedulerViewFolderTypes

query Parameters
schedulerViewId
string <uuid>
folderTypeId
string <uuid>
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"
}

attachments

/attachments

query Parameters
id
string <uuid>
fileName
string <character varying>
contextType
string <character varying>
contextId
string <uuid>
authorId
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
mimeType
string <character varying>
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 <uuid>
fileName
string <character varying>
contextType
string <character varying>
contextId
string <uuid>
authorId
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
mimeType
string <character varying>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/attachments

query Parameters
id
string <uuid>
fileName
string <character varying>
contextType
string <character varying>
contextId
string <uuid>
authorId
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
mimeType
string <character varying>
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"
}

users

/users

query Parameters
id
string <uuid>
email
string <text>
fullName
string <text>
userName
string <text>
emailConfirmedAt
string <timestamp with time zone>
rawAppMetaData
string <jsonb>
rawUserMetaData
string <jsonb>
createdAt
string <timestamp with time zone>
updatedAt
string <timestamp with time zone>
emailVerified
string <boolean>
userVerified
string <boolean>
securityRoleId
string <uuid>
contractEnd
string <timestamp with time zone>
contractStart
string <timestamp with time zone>
hourlyRate
string <numeric>
lunchEnd
string <interval>
lunchStart
string <interval>
workEndTime
string <interval>
workStartTime
string <interval>
phone
string <text>
color
string <text>
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>

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"
}

/users

query Parameters
id
string <uuid>
email
string <text>
fullName
string <text>
userName
string <text>
emailConfirmedAt
string <timestamp with time zone>
rawAppMetaData
string <jsonb>
rawUserMetaData
string <jsonb>
createdAt
string <timestamp with time zone>
updatedAt
string <timestamp with time zone>
emailVerified
string <boolean>
userVerified
string <boolean>
securityRoleId
string <uuid>
contractEnd
string <timestamp with time zone>
contractStart
string <timestamp with time zone>
hourlyRate
string <numeric>
lunchEnd
string <interval>
lunchStart
string <interval>
workEndTime
string <interval>
workStartTime
string <interval>
phone
string <text>
color
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/users

query Parameters
id
string <uuid>
email
string <text>
fullName
string <text>
userName
string <text>
emailConfirmedAt
string <timestamp with time zone>
rawAppMetaData
string <jsonb>
rawUserMetaData
string <jsonb>
createdAt
string <timestamp with time zone>
updatedAt
string <timestamp with time zone>
emailVerified
string <boolean>
userVerified
string <boolean>
securityRoleId
string <uuid>
contractEnd
string <timestamp with time zone>
contractStart
string <timestamp with time zone>
hourlyRate
string <numeric>
lunchEnd
string <interval>
lunchStart
string <interval>
workEndTime
string <interval>
workStartTime
string <interval>
phone
string <text>
color
string <text>
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>

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"
}

projectDefinitionOutputStatuses

/projectDefinitionOutputStatuses

query Parameters
projectDefinitionId
string <uuid>
statusId
string <uuid>
isClientReviewable
string <boolean>
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 <uuid>
statusId
string <uuid>
isClientReviewable
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionOutputStatuses

query Parameters
projectDefinitionId
string <uuid>
statusId
string <uuid>
isClientReviewable
string <boolean>
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
}

userWeekDays

/userWeekDays

query Parameters
userId
string <uuid>
weekDayId
string <uuid>
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 <uuid>
weekDayId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/userWeekDays

query Parameters
userId
string <uuid>
weekDayId
string <uuid>
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"
}

projectDefinitionTags

/projectDefinitionTags

query Parameters
projectDefinitionId
string <uuid>
tagId
string <uuid>
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 <uuid>
tagId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionTags

query Parameters
projectDefinitionId
string <uuid>
tagId
string <uuid>
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"
}

activities

/activities

query Parameters
id
string <uuid>
folderId
string <uuid>
activityTypeId
string <uuid>
authorId
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
action
string <character varying>
changes
string <jsonb>
contextType
string <character varying>
data
string <jsonb>
contextId
string <uuid>
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 <uuid>
folderId
string <uuid>
activityTypeId
string <uuid>
authorId
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
action
string <character varying>
changes
string <jsonb>
contextType
string <character varying>
data
string <jsonb>
contextId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/activities

query Parameters
id
string <uuid>
folderId
string <uuid>
activityTypeId
string <uuid>
authorId
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
action
string <character varying>
changes
string <jsonb>
contextType
string <character varying>
data
string <jsonb>
contextId
string <uuid>
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"
}

applications

/applications

query Parameters
id
string <uuid>
name
string <character varying>
isActive
string <boolean>
isSoftware
string <boolean>
arguments
string <jsonb>
isCore
string <boolean>
environment
string <jsonb>
family
string <character varying>
executables
string <jsonb>
label
string <character varying>
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 <uuid>
name
string <character varying>
isActive
string <boolean>
isSoftware
string <boolean>
arguments
string <jsonb>
isCore
string <boolean>
environment
string <jsonb>
family
string <character varying>
executables
string <jsonb>
label
string <character varying>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/applications

query Parameters
id
string <uuid>
name
string <character varying>
isActive
string <boolean>
isSoftware
string <boolean>
arguments
string <jsonb>
isCore
string <boolean>
environment
string <jsonb>
family
string <character varying>
executables
string <jsonb>
label
string <character varying>
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"
}

typeUser

/typeUser

query Parameters
skilledUserId
string <uuid>
skillsId
string <uuid>
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 <uuid>
skillsId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/typeUser

query Parameters
skilledUserId
string <uuid>
skillsId
string <uuid>
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"
}

projectDefinitionPriorities

/projectDefinitionPriorities

query Parameters
projectDefinitionId
string <uuid>
priorityId
string <uuid>
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 <uuid>
priorityId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionPriorities

query Parameters
projectDefinitionId
string <uuid>
priorityId
string <uuid>
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"
}

projectDefinitionCustomAttributeDefinitions

/projectDefinitionCustomAttributeDefinitions

query Parameters
customAttributeDefinitionId
string <uuid>
projectDefinitionId
string <uuid>
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 <uuid>
projectDefinitionId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionCustomAttributeDefinitions

query Parameters
customAttributeDefinitionId
string <uuid>
projectDefinitionId
string <uuid>
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"
}

advancePayments

/advancePayments

query Parameters
id
string <uuid>
type
string <text>
amount
string <numeric>
note
string <text>
projectId
string <uuid>
userId
string <uuid>
payoutId
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
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 <uuid>
type
string <text>
amount
string <numeric>
note
string <text>
projectId
string <uuid>
userId
string <uuid>
payoutId
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/advancePayments

query Parameters
id
string <uuid>
type
string <text>
amount
string <numeric>
note
string <text>
projectId
string <uuid>
userId
string <uuid>
payoutId
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
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"
}

notifications

/notifications

query Parameters
id
string <uuid>
userId
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
seen
string <boolean>
changes
string <jsonb>
authorId
string <uuid>
contextId
string <uuid>
contextType
string <character varying>
objectId
string <uuid>
objectType
string <character varying>
action
string <character varying>
notificationTypeId
string <uuid>
data
string <jsonb>
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 <uuid>
userId
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
seen
string <boolean>
changes
string <jsonb>
authorId
string <uuid>
contextId
string <uuid>
contextType
string <character varying>
objectId
string <uuid>
objectType
string <character varying>
action
string <character varying>
notificationTypeId
string <uuid>
data
string <jsonb>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/notifications

query Parameters
id
string <uuid>
userId
string <uuid>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
seen
string <boolean>
changes
string <jsonb>
authorId
string <uuid>
contextId
string <uuid>
contextType
string <character varying>
objectId
string <uuid>
objectType
string <character varying>
action
string <character varying>
notificationTypeId
string <uuid>
data
string <jsonb>
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
}

outputTypes

/outputTypes

query Parameters
id
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
string <integer>
isCore
string <boolean>
ayonProductTypeId
string <uuid>
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 <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
string <integer>
isCore
string <boolean>
ayonProductTypeId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outputTypes

query Parameters
id
string <uuid>
name
string <text>
shortName
string <text>
codeName
string <text>
icon
string <text>
color
string <text>
screenPriority
string <integer>
isCore
string <boolean>
ayonProductTypeId
string <uuid>
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"
}

outgoingStatusMappings

/outgoingStatusMappings

query Parameters
id
string <uuid>
outgoingFolderNewStatusId
string <uuid>
outputVersionStatusId
string <uuid>
projectDefinitionId
string <uuid>
useOtherIncomingFolderStatuses
string <boolean>
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 <uuid>
outgoingFolderNewStatusId
string <uuid>
outputVersionStatusId
string <uuid>
projectDefinitionId
string <uuid>
useOtherIncomingFolderStatuses
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/outgoingStatusMappings

query Parameters
id
string <uuid>
outgoingFolderNewStatusId
string <uuid>
outputVersionStatusId
string <uuid>
projectDefinitionId
string <uuid>
useOtherIncomingFolderStatuses
string <boolean>
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
}

securityRolePermissions

/securityRolePermissions

query Parameters
securityRoleId
string <uuid>
permissionId
string <uuid>
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 <uuid>
permissionId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/securityRolePermissions

query Parameters
securityRoleId
string <uuid>
permissionId
string <uuid>
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"
}

projectDefinitionFolderStatuses

/projectDefinitionFolderStatuses

query Parameters
projectDefinitionId
string <uuid>
statusId
string <uuid>
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 <uuid>
statusId
string <uuid>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/projectDefinitionFolderStatuses

query Parameters
projectDefinitionId
string <uuid>
statusId
string <uuid>
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"
}

workerFees

/workerFees

query Parameters
id
string <uuid>
type
string <text>
amount
string <numeric>
paymentStatusId
string <uuid>
note
string <text>
folderId
string <uuid>
projectId
string <uuid>
userId
string <uuid>
payoutId
string <uuid>
color
string <text>
isLocked
string <boolean>
userTimeTrackerId
string <uuid>
hourlyRate
string <numeric>
spentHours
string <numeric>
workingDuration
string <integer>
frameFee
string <numeric>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
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>

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"
}

/workerFees

query Parameters
id
string <uuid>
type
string <text>
amount
string <numeric>
paymentStatusId
string <uuid>
note
string <text>
folderId
string <uuid>
projectId
string <uuid>
userId
string <uuid>
payoutId
string <uuid>
color
string <text>
isLocked
string <boolean>
userTimeTrackerId
string <uuid>
hourlyRate
string <numeric>
spentHours
string <numeric>
workingDuration
string <integer>
frameFee
string <numeric>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/workerFees

query Parameters
id
string <uuid>
type
string <text>
amount
string <numeric>
paymentStatusId
string <uuid>
note
string <text>
folderId
string <uuid>
projectId
string <uuid>
userId
string <uuid>
payoutId
string <uuid>
color
string <text>
isLocked
string <boolean>
userTimeTrackerId
string <uuid>
hourlyRate
string <numeric>
spentHours
string <numeric>
workingDuration
string <integer>
frameFee
string <numeric>
createdDate
string <timestamp with time zone>
updatedDate
string <timestamp with time zone>
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>

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"
}

vacations

/vacations

query Parameters
id
string <uuid>
vacationStartDate
string <timestamp with time zone>
vacationEndDate
string <timestamp with time zone>
userId
string <uuid>
status
string <text>
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 <uuid>
vacationStartDate
string <timestamp with time zone>
vacationEndDate
string <timestamp with time zone>
userId
string <uuid>
status
string <text>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/vacations

query Parameters
id
string <uuid>
vacationStartDate
string <timestamp with time zone>
vacationEndDate
string <timestamp with time zone>
userId
string <uuid>
status
string <text>
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": ""
}

userAssigneeRoleNotificationTypeOverrides

/userAssigneeRoleNotificationTypeOverrides

query Parameters
assigneeRoleId
string <uuid>
notificationTypeId
string <uuid>
userId
string <uuid>
enabled
string <boolean>
emailEnabled
string <boolean>
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 <uuid>
notificationTypeId
string <uuid>
userId
string <uuid>
enabled
string <boolean>
emailEnabled
string <boolean>
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/userAssigneeRoleNotificationTypeOverrides

query Parameters
assigneeRoleId
string <uuid>
notificationTypeId
string <uuid>
userId
string <uuid>
enabled
string <boolean>
emailEnabled
string <boolean>
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
}

(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) 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_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) 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) update_versions_status

/rpc/update_versions_status

query Parameters
p_output_version_ids
required
string <uuid[]>
p_new_status_id
required
string <uuid>

Responses

/rpc/update_versions_status

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
p_new_status_id
required
string <uuid>
p_output_version_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "p_new_status_id": "8b14243f-594c-4ee6-8bba-145ea7530b17",
  • "p_output_version_ids": [
    ]
}

(rpc) get_version_grid

/rpc/get_version_grid

query Parameters
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
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": [
    ],
  • "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) 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>

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>
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",
  • "target_ids": [
    ]
}

(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_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) get_folder_template_placeholders

/rpc/get_folder_template_placeholders

query Parameters
folder_type_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>

Responses

Request samples

Content type
{
  • "folder_type_id": "4877dd4f-f664-442c-a5e1-ad7846a12238"
}

(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_scheduler_model

/rpc/get_scheduler_model

query Parameters
project_id
required
string <uuid>
project_deadline
string <timestamp with time zone>
reserve
integer <integer>

Responses

/rpc/get_scheduler_model

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
project_deadline
string <timestamp with time zone>
project_id
required
string <uuid>
reserve
integer <integer>

Responses

Request samples

Content type
{
  • "project_deadline": "string",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "reserve": 0
}

(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) 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) 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) 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) 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_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) 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) 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) 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) 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) 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) 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) 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) 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_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) 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) 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_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_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) 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) create_folder_many

/rpc/create_folder_many

query Parameters
changes
required
string <jsonb>
restore_deleted
required
boolean <boolean>

Responses

/rpc/create_folder_many

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
changes
required
any <jsonb>
restore_deleted
required
boolean <boolean>

Responses

Request samples

Content type
{
  • "changes": null,
  • "restore_deleted": true
}

(rpc) user_is_project_view_author

/rpc/user_is_project_view_author

query Parameters
project_view_id
required
string <uuid>

Responses

/rpc/user_is_project_view_author

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
project_view_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "project_view_id": "1a0fa95d-6325-4536-9d30-a80f8735773f"
}

(rpc) copy_folders

/rpc/copy_folders

query Parameters
source_ids
required
string <uuid[]>
target_id
required
string <uuid>

Responses

/rpc/copy_folders

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
source_ids
required
Array of strings
target_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "source_ids": [
    ],
  • "target_id": "d3bcdc92-4191-401b-ad0c-42056c6efab9"
}

(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) 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_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) 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) 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/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) 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) 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) 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) 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) 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) 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) 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) 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_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) 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) 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) 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_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) 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) 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) 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) 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_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) 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) 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_wasabi_assigned_components

/rpc/get_wasabi_assigned_components

query Parameters
days_since_creation
required
integer <integer>

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>

Responses

Request samples

Content type
{
  • "days_since_creation": 0
}

(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) 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) 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) trim_name

/rpc/trim_name

query Parameters
name
required
string <text>

Responses

/rpc/trim_name

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) 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) 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) 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) 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) 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) 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) 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) 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) 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) 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) 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) 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>
create_empty
required
boolean <boolean>
worker_fee_ids
required
string <uuid[]>

Responses

/rpc/create_payout

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
author_id
required
string <uuid>
create_empty
required
boolean <boolean>
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>
user_id
required
string <uuid>
worker_fee_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "author_id": "78424c75-5c41-4b25-9735-3c9f7d05c59e",
  • "create_empty": true,
  • "end_date": "string",
  • "name": "string",
  • "note": "string",
  • "payment_reference": "string",
  • "payment_status_id": "271a536c-038f-4123-84a2-9fb822c9c25b",
  • "start_date": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "worker_fee_ids": [
    ]
}

(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_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) 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) 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) 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) 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) 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_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) 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_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) 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) 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) 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) 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_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) 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) get_notes

/rpc/get_notes

query Parameters
ids
required
string <uuid[]>

Responses

/rpc/get_notes

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_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>
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>

Responses

/rpc/upsert_note

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
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>

Responses

Request samples

Content type
{
  • "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
}

(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) 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) 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_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) 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) 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) 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) 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) 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_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_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) 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) get_folders

/rpc/get_folders

query Parameters
ids
string <uuid[]>
return_deleted
boolean <boolean>

Responses

/rpc/get_folders

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ids
Array of strings
return_deleted
boolean <boolean>

Responses

Request samples

Content type
{
  • "ids": [
    ],
  • "return_deleted": true
}

(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) 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) 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) 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) parse_templates

/rpc/parse_templates

query Parameters
templates
required
string <text[]>
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
Array of strings

Responses

Request samples

Content type
{
  • "template_data": null,
  • "templates": [
    ]
}

(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) 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) 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) get_components

/rpc/get_components

query Parameters
ids
required
string <uuid[]>
version_ids
required
string <uuid[]>
root_files
required
boolean <boolean>
openable_files
required
boolean <boolean>
supported_files
required
boolean <boolean>

Responses

/rpc/get_components

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
ids
required
Array of strings
openable_files
required
boolean <boolean>
root_files
required
boolean <boolean>
supported_files
required
boolean <boolean>
version_ids
required
Array of strings

Responses

Request samples

Content type
{
  • "ids": [
    ],
  • "openable_files": true,
  • "root_files": true,
  • "supported_files": true,
  • "version_ids": [
    ]
}

(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) delete_folders

/rpc/delete_folders

query Parameters
ids
required
string <uuid[]>

Responses

/rpc/delete_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) 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_grouped_worker_fees

/rpc/get_grouped_worker_fees

query Parameters
user_id
required
string <uuid>
fee_type
required
string <text>
start_date
required
string <date>
end_date
required
string <date>
payment_status_ids
string <uuid[]>

Responses

/rpc/get_grouped_worker_fees

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
end_date
required
string <date>
fee_type
required
string <text>
payment_status_ids
Array of strings
start_date
required
string <date>
user_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "end_date": "2019-08-24",
  • "fee_type": "string",
  • "payment_status_ids": [
    ],
  • "start_date": "2019-08-24",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

(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) 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) 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_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) 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"
}

(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) 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) 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) 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) 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_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) 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) 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) 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) get_scheduler_constraints

/rpc/get_scheduler_constraints

query Parameters
project_id
required
string <uuid>
start_date
required
string <timestamp with time zone>
end_date
required
string <timestamp with time zone>

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>
project_id
required
string <uuid>
start_date
required
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "end_date": "string",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "start_date": "string"
}

(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) 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) 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) 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) 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) 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) 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) 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) 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) 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) 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) 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) 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) 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) user_can_manage_project_view

/rpc/user_can_manage_project_view

query Parameters
project_view_id
required
string <uuid>

Responses

/rpc/user_can_manage_project_view

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
project_view_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "project_view_id": "1a0fa95d-6325-4536-9d30-a80f8735773f"
}

(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) 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) 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) 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) 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_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) 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) get_latest_version_of_folder

/rpc/get_latest_version_of_folder

query Parameters
folder_id
required
string <uuid>

Responses

/rpc/get_latest_version_of_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) 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) 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) 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) 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) 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_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) 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) 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) 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_deadline
required
boolean <boolean>
range_start
string <text>
range_end
string <text>
structure
string <jsonb>

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>
update_ats_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,
  • "update_ats_deadline": true,
  • "use_soft_assignee_as_assignee": true
}

(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_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) 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) 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) create_folder_template_structure

/rpc/create_folder_template_structure

query Parameters
folder_id
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_id
required
string <uuid>
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_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "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) 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) 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) get_folders_for_current_user

/rpc/get_folders_for_current_user

query Parameters
folder_type_ids
string <uuid[]>
state_ids
string <uuid[]>
return_deleted
boolean <boolean>

Responses

/rpc/get_folders_for_current_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

Responses

Request samples

Content type
{
  • "folder_type_ids": [
    ],
  • "return_deleted": true,
  • "state_ids": [
    ]
}

(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) 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) 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) 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) 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) 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) 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_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) 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) upsert_folder_many

/rpc/upsert_folder_many

query Parameters
changes
required
string <jsonb>
restore_deleted
required
boolean <boolean>

Responses

/rpc/upsert_folder_many

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
changes
required
any <jsonb>
restore_deleted
required
boolean <boolean>

Responses

Request samples

Content type
{
  • "changes": null,
  • "restore_deleted": true
}

(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) 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) 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) 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) 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) 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>

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>
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",
  • "reviewer_ids": [
    ],
  • "short_name": "string",
  • "start_date": "string"
}

(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) 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) 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) 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_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) 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) 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) 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) 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) 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_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) 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) 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) 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) 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) 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>

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
return_only_active_projects
boolean <boolean>
return_only_my
boolean <boolean>

Responses

Request samples

Content type
{
  • "input_paths": [
    ],
  • "return_only_active_projects": true,
  • "return_only_my": true
}

(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_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"
}