Skip to main content
POST
Create

Authorizations

x-api-key
string
header
required

A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.

Body

application/json
subject
object
required
name
string
required
kind
string | null
reference
string · null · null
issuedOn
string · null · null
expiresOn
string · null · null
notes
string · null · null
eicrOutcome
string · null · null
remedialsDueOn
string · null · null
remedialsCompletedOn
string · null · null
epcRating
string · null · null
coAlarmChecked
boolean · null · null
supersedesDraftId
string · null · null
fileIntent
enum<string> | null
Available options:
metadata_only,
file

Response

Success

id
string
required
subjectKind
string
required
subjectId
string
required
kind
string
required
name
string
required
storageKey
string | null
required
contentType
string | null
required
sizeBytes
required
reference
string | null
required
issuedOn
string | null
required
expiresOn
string | null
required
notes
string | null
required
contentDigest
string | null
required
bytesState
string
required
fileIntent
string
required
revision
required
supersedesDraftId
string | null
required
supersedesId
string | null
required
uploadedByUserId
string | null
required
archivedAt
string | null
required
createdAt
string
required
eicrOutcome
string · null · null
remedialsDueOn
string · null · null
remedialsCompletedOn
string · null · null
epcRating
string · null · null
coAlarmChecked
boolean · null · null