Skip to main content
POST
Create folder

Authorizations

x-api-key
string
header
required

API key authentication for the External Actor Gateway

Body

application/json
name
string
required
Minimum string length: 1
parentFolderId
string | null
Minimum string length: 1
Pattern: ^folder_[a-z0-9]{26}$

Response

Folder created successfully

folderId
string
required
Minimum string length: 1
Pattern: ^folder_[a-z0-9]{26}$
parentFolderId
string | null
required
Minimum string length: 1
Pattern: ^folder_[a-z0-9]{26}$
name
string
required
path
string
required

Materialised path of the folder from the root

Minimum string length: 1
Pattern: ^srclink_[a-z0-9]{26}$
providerExternalId
string | null
required
versionNumber
integer
required
Required range: x <= 9007199254740991
validFrom
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
validTo
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
isDeleted
boolean
required