Skip to content
AveraAveraAvera Documentation

Export a project as a template package

GET
/api/v1/projects/{projectId}/export
curl --request GET \
  --url 'https://app.avera.io/api/v1/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/export?packageId=example&version=1.0.0'

Serializes the project’s closed subgraph, current versions only, into a package document.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string format: uuid

Query Parameters

Section titled “Query Parameters”
packageId
required
string
version
string
default: 1.0.0

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
manifest
required
object
packageId
required
string
version
required
string
name
required
string
description
string | null
minPlatformVersion
string | null
checksum
string | null
author
string | null
createdAt
string | null
includesHistory
required
boolean
payload
required
object
config
required
object
categories
required
Array<object>
object
slug
required
string
name
required
string
icon
required
string
itemTypes
required
Array<object>
object
slug
required
string
name
required
string
description
string | null
prefix
required
string
icon
string | null
color
string | null
workflowSlug
string | null
documentType
required
string
revisionable
required
boolean
guestPolicy
required
string
Allowed values: ALLOWED MARKED REFUSED
folderMembershipTypeSlug
string | null
categorySlug
string | null
attributeDefinitions
required
Array<object>
object
slug
required
string
name
required
string
label
required
string
description
string | null
dataType
required
string
unique
required
boolean
validation
string | null
enumValues
Array<string> | null
enumNumericValues
Array<integer> | null
formulaExpression
string | null
itemTypeAttributes
required
Array<object>
object
itemTypeSlug
required
string
attributeSlug
required
string
required
required
boolean
displayOrder
required
integer format: int32
defaultValue
string | null
readOnly
required
boolean
restricted
required
boolean
relationshipTypes
required
Array<object>
object
slug
required
string
name
required
string
description
string | null
forwardLabel
required
string
reverseLabel
required
string
allowedPairs
required
Array<object>
object
upstream
required
string
downstream
required
string
propagateSuspect
required
boolean
ordered
required
boolean
membership
required
string
Allowed values: TAB DOCUMENT
lifecycles
required
Array<object>
object
slug
required
string
name
required
string
description
string | null
initialStateSlug
required
string
workflowStates
required
Array<object>
object
slug
required
string
workflowSlug
required
string
name
required
string
description
string | null
color
string | null
type
required
string
lifecycleStatus
required
string
actionPolicy
required
object
key
additional properties
Array<string>
displayOrder
required
integer format: int32
workflowTransitions
required
Array<object>
object
slug
required
string
workflowSlug
required
string
fromStateSlug
required
string
toStateSlug
required
string
name
required
string
description
string | null
requiresSignature
required
boolean
separationOfDuties
required
boolean
allowedPrincipals
required
Array<string>
validationRules
string | null
requiredEndorsements
required
Array<object>
object
principal
required
string
signatureRequired
required
boolean
distinctUsers
integer | null format: int32
buttonLabel
string | null
buttonColor
required
string
buttonIcon
string | null
sortOrder
required
integer format: int32
requiresComment
required
boolean
commentMinLength
required
integer format: int32
confirmationRequired
required
boolean
confirmationMessage
string | null
permissionRules
required
Array<object>
object
principal
required
string
verb
required
string
itemTypes
Array<string> | null
states
Array<string> | null
fields
Array<string> | null
relationshipTypes
Array<string> | null
transitionIds
Array<string> | null
roles
required
Array<object>
object
id
required
string
name
required
string
description
string | null
aiActions
required
Array<object>
object
slug
required
string
name
required
string
description
required
string
outputType
required
string
sourceItemTypeSlug
required
string
systemPrompt
required
string
contextTree
required
string
allowedActionTypes
required
Array<string>
unique items
createableItemTypes
required
Array<string>
unique items
editableAttributes
required
Array<string>
unique items
usableRelationshipTypes
required
Array<string>
unique items
maxContextTokens
required
integer format: int32
minConfidenceThreshold
required
number format: float
temperature
required
number format: float
maxOutputTokens
required
integer format: int32
status
required
string
formLayouts
required
Array<object>
object
slug
required
string
subjectKind
required
string
subjectSlug
required
string
name
required
string
description
string | null
isDefault
required
boolean
applicability
required
object
contexts
required
Array<string>
roles
required
Array<string>
states
required
Array<string>
priority
required
integer format: int32
definition
required
object
sections
required
Array<object>
object
id
required
string
type
required
string
Allowed values: FIELDS GRID WIDGET
title
string | null
order
required
integer format: int32
tabGroupId
string | null
collapsible
required
boolean
collapsedByDefault
required
boolean
columns
integer | null format: int32
visibilityRule
string | null
fields
required
Array<object>
object
slug
required
string
order
required
integer format: int32
label
string | null
columnSpan
required
integer format: int32
helpText
string | null
visibilityRule
string | null
requiredRule
string | null
grid
One of:
object
container
boolean
nodeType
string
Allowed values: ARRAY BINARY BOOLEAN MISSING NULL NUMBER OBJECT POJO STRING
string
boolean
integralNumber
boolean
missingNode
boolean
valueNode
boolean
pojo
boolean
number
boolean
short
boolean
int
boolean
long
boolean
double
boolean
bigDecimal
boolean
bigInteger
boolean
textual
boolean
boolean
boolean
binary
boolean
floatingPointNumber
boolean
empty
boolean
array
boolean
null
boolean
object
boolean
float
boolean
embeddedValue
boolean
readOnly
required
boolean
expand
One of:
object
container
boolean
nodeType
string
Allowed values: ARRAY BINARY BOOLEAN MISSING NULL NUMBER OBJECT POJO STRING
string
boolean
integralNumber
boolean
missingNode
boolean
valueNode
boolean
pojo
boolean
number
boolean
short
boolean
int
boolean
long
boolean
double
boolean
bigDecimal
boolean
bigInteger
boolean
textual
boolean
boolean
boolean
binary
boolean
floatingPointNumber
boolean
empty
boolean
array
boolean
null
boolean
object
boolean
float
boolean
embeddedValue
boolean
widgetId
string | null
widgetParams
One of:
object
container
boolean
nodeType
string
Allowed values: ARRAY BINARY BOOLEAN MISSING NULL NUMBER OBJECT POJO STRING
string
boolean
integralNumber
boolean
missingNode
boolean
valueNode
boolean
pojo
boolean
number
boolean
short
boolean
int
boolean
long
boolean
double
boolean
bigDecimal
boolean
bigInteger
boolean
textual
boolean
boolean
boolean
binary
boolean
floatingPointNumber
boolean
empty
boolean
array
boolean
null
boolean
object
boolean
float
boolean
embeddedValue
boolean
tabGroups
required
Array<object>
object
id
required
string
name
required
string
order
required
integer format: int32
icon
string | null
icon
string | null
content
required
object
items
required
Array<object>
object
id
required
string
number
required
string
itemTypeSlug
required
string
revision
string | null
status
required
string
workflowStateSlug
string | null
canonicalId
string | null
attributeValues
required
Array<object>
object
id
required
string
itemId
required
string
attributeSlug
required
string
value
string | null
valueType
required
string
relationships
required
Array<object>
object
id
required
string
relationshipTypeSlug
required
string
upstreamItemId
required
string
downstreamItemId
required
string
suspect
required
boolean
position
integer | null format: int64
liveDocs
required
Array<object>
object
id
required
string
itemId
required
string
attributeSlug
string | null
content
required
string
responses
required
Array<object>
object
id
required
string
itemId
required
string
promptId
required
string
subjectKey
required
string
outcome
string | null
valueNumber
string | null
valueUnit
string | null
valueText
string | null
valueChoice
string | null
valueRef
string | null
deviationRef
string | null
evidence
required
Array<object>
object
fileId
string | null
uri
string | null
sha256
string | null
bytes
integer | null format: int64
files
required
Array<object>
object
id
required
string
itemId
string | null
attributeSlug
string | null
filename
required
string
contentType
required
string
sizeBytes
required
integer format: int64
sha256
required
string