Model Library API
{ urn:com.akana.model.api } ModelAPI
The Model Libary API allows provides access to the system model (schema) registry.
POST/modelscreateModel
Parameters
Accepts application/json
Name
Type
Description
Model
body
entity
AddModelRequest
AddModelRequest {
SchemaDocumentReference {
SchemaImports {
Description( string )
VersionDescription( string )
SchemaDocumentReference( SchemaDocumentReference, required )
Summary( string )
Visibility( string )
VersionName( string )
ModelCategory( string )
BusinessID( string )
Tags( Collection of string )
Name( string )
}
SchemaDocumentReference {
DropboxFileId( long, required )
SchemaImports( Collection of SchemaImports, required )
FileName( string, required )
RequireModelName( boolean )
}
SchemaImports {
SchemaImports( Collection of SchemaImports, required )
AddToLibrary( boolean, required )
Name( string, required )
}
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
any
GET/models/{ModelID}getModel
Parameters
Name
Type
Description
Model
ModelID
path
string
includeVersions
query
boolean
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
Model
Model {
ModelVersion {
Action {
ActionParameter {
TargetResource {
Image {
Links {
ModelVersions( Collection of ModelVersion )
Description( string )
Updated( dateTime )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
LatestVersionID( string )
State( string )
Summary( string )
Links( Collection of Links )
Visibility( string )
Tag( Collection of string )
ModelVersion( ModelVersion )
ModelCategory( string )
ModelID( string )
BusinessID( string )
}
ModelVersion {
Action( Collection of Action )
Description( string )
Updated( dateTime )
Schema( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
State( string )
ModelVersionID( string )
ModelReferences( Collection of ModelVersion )
Links( Collection of Links )
Visibility( string )
Tag( Collection of string )
ModelID( string )
}
Action {
ActionName( string )
Parameters( Collection of ActionParameter )
UserID( string )
Comments( string )
}
ActionParameter {
Value( string )
Name( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
Links {
rel( string )
href( string )
type( string )
title( string )
}
POST/models/readfiledetailsreadFileDetails
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
FileName
form
string
body
entity
base64Binary
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
SchemaDocumentReference
SchemaDocumentReference {
SchemaImports {
DropboxFileId( long )
SchemaImports( Collection of SchemaImports )
FileName( string )
RequireModelName( boolean )
}
SchemaImports {
SchemaImports( Collection of SchemaImports )
AddToLibrary( boolean )
Name( string )
}
DELETE/models/{ModelID}deleteModel
Parameters
Name
Type
Description
Model
ModelID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
PUT/models/{ModelID}updateModel
Parameters
Accepts application/json
Name
Type
Description
Model
ModelID
path
string
body
entity
Model
Model {
ModelVersion {
Action {
ActionParameter {
TargetResource {
Image {
Links {
ModelVersions( Collection of ModelVersion, required )
Description( string )
Updated( dateTime )
Name( string, required )
Created( dateTime )
TargetResources( Collection of TargetResource, required )
LatestVersionID( string )
State( string )
Summary( string )
Links( Collection of Links, required )
Visibility( string )
Tag( Collection of string )
ModelVersion( ModelVersion, required )
ModelCategory( string )
ModelID( string, required )
BusinessID( string )
}
ModelVersion {
Action( Collection of Action, required )
Description( string )
Updated( dateTime )
Schema( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource, required )
State( string )
ModelVersionID( string, required )
ModelReferences( Collection of ModelVersion, required )
Links( Collection of Links, required )
Visibility( string )
Tag( Collection of string )
ModelID( string )
}
Action {
ActionName( string, required )
Parameters( Collection of ActionParameter, required )
UserID( string, required )
Comments( string )
}
ActionParameter {
Value( string )
Name( string, required )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image, required )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string, required )
Url( anyURI, required )
Link( anyURI, required )
}
Links {
rel( string, required )
href( string, required )
type( string )
title( string )
}
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
Model
Model {
ModelVersion {
Action {
ActionParameter {
TargetResource {
Image {
Links {
ModelVersions( Collection of ModelVersion )
Description( string )
Updated( dateTime )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
LatestVersionID( string )
State( string )
Summary( string )
Links( Collection of Links )
Visibility( string )
Tag( Collection of string )
ModelVersion( ModelVersion )
ModelCategory( string )
ModelID( string )
BusinessID( string )
}
ModelVersion {
Action( Collection of Action )
Description( string )
Updated( dateTime )
Schema( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
State( string )
ModelVersionID( string )
ModelReferences( Collection of ModelVersion )
Links( Collection of Links )
Visibility( string )
Tag( Collection of string )
ModelID( string )
}
Action {
ActionName( string )
Parameters( Collection of ActionParameter )
UserID( string )
Comments( string )
}
ActionParameter {
Value( string )
Name( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
Links {
rel( string )
href( string )
type( string )
title( string )
}
POST/models/{ModelID}/versionscreateVersion
Parameters
Accepts application/json
Name
Type
Description
Model
ModelID
path
string
body
entity
AddModelVersionRequest
AddModelVersionRequest {
SourceModelVersionID( string )
VersionDescription( string )
VersionName( string )
Visibility( string )
BusinessID( string )
Tags( Collection of string )
}
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
ModelVersion
ModelVersion {
Action {
ActionParameter {
TargetResource {
Image {
Links {
Action( Collection of Action )
Description( string )
Updated( dateTime )
Schema( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
State( string )
ModelVersionID( string )
ModelReferences( Collection of ModelVersion )
Links( Collection of Links )
Visibility( string )
Tag( Collection of string )
ModelID( string )
}
Action {
ActionName( string )
Parameters( Collection of ActionParameter )
UserID( string )
Comments( string )
}
ActionParameter {
Value( string )
Name( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
Links {
rel( string )
href( string )
type( string )
title( string )
}
GET/models/{ModelID}/versionslistModelVersions
Parameters
Name
Type
Description
Model
ModelID
path
string
includeSchema
query
boolean
includeReferences
query
boolean
includeTargetResources
query
boolean
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
ModelVersions
ModelVersions {
ModelVersion {
Action {
ActionParameter {
TargetResource {
Image {
Links {
ModelVersion( Collection of ModelVersion )
}
ModelVersion {
Action( Collection of Action )
Description( string )
Updated( dateTime )
Schema( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
State( string )
ModelVersionID( string )
ModelReferences( Collection of ModelVersion )
Links( Collection of Links )
Visibility( string )
Tag( Collection of string )
ModelID( string )
}
Action {
ActionName( string )
Parameters( Collection of ActionParameter )
UserID( string )
Comments( string )
}
ActionParameter {
Value( string )
Name( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
Links {
rel( string )
href( string )
type( string )
title( string )
}
PUT/models/versions/{ModelVersionID}updateVersionDetails
Parameters
Accepts application/json
Name
Type
Description
Model
ModelVersionID
path
string
body
entity
ModelVersion
ModelVersion {
Action {
ActionParameter {
TargetResource {
Image {
Links {
Action( Collection of Action, required )
Description( string )
Updated( dateTime )
Schema( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource, required )
State( string )
ModelVersionID( string, required )
ModelReferences( Collection of ModelVersion, required )
Links( Collection of Links, required )
Visibility( string )
Tag( Collection of string )
ModelID( string )
}
Action {
ActionName( string, required )
Parameters( Collection of ActionParameter, required )
UserID( string, required )
Comments( string )
}
ActionParameter {
Value( string )
Name( string, required )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image, required )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string, required )
Url( anyURI, required )
Link( anyURI, required )
}
Links {
rel( string, required )
href( string, required )
type( string )
title( string )
}
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
ModelVersion
ModelVersion {
Action {
ActionParameter {
TargetResource {
Image {
Links {
Action( Collection of Action )
Description( string )
Updated( dateTime )
Schema( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
State( string )
ModelVersionID( string )
ModelReferences( Collection of ModelVersion )
Links( Collection of Links )
Visibility( string )
Tag( Collection of string )
ModelID( string )
}
Action {
ActionName( string )
Parameters( Collection of ActionParameter )
UserID( string )
Comments( string )
}
ActionParameter {
Value( string )
Name( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
Links {
rel( string )
href( string )
type( string )
title( string )
}
DELETE/models/versions/{ModelVersionID}deleteVersion
Parameters
Name
Type
Description
Model
ModelVersionID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
GET/models/versions/{ModelVersionID}getVersion
Parameters
Name
Type
Description
Model
ModelVersionID
path
string
includeSchema
query
boolean
includeReferences
query
boolean
includeTags
query
boolean
includeActions
query
boolean
includeTargetResources
query
boolean
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
ModelVersion
ModelVersion {
Action {
ActionParameter {
TargetResource {
Image {
Links {
Action( Collection of Action )
Description( string )
Updated( dateTime )
Schema( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
State( string )
ModelVersionID( string )
ModelReferences( Collection of ModelVersion )
Links( Collection of Links )
Visibility( string )
Tag( Collection of string )
ModelID( string )
}
Action {
ActionName( string )
Parameters( Collection of ActionParameter )
UserID( string )
Comments( string )
}
ActionParameter {
Value( string )
Name( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
Links {
rel( string )
href( string )
type( string )
title( string )
}
GET/models/{ID}/picturegetImage
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
size
query
integer
Reponse
Produces image/jpeg
Status Code
Reason
Model
200
Success
byte
GET/models/{ID}/avatargetDefaultAvatar
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
size
query
integer
Reponse
Produces image/png
Status Code
Reason
Model
200
Success
byte
GET/models/{ID}/previewavatarpreviewAvatar
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
Provider
query
string
Reponse
Produces image/jpeg
Status Code
Reason
Model
200
Success
any
POST/models/{ID}/pictureupdateImage
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
ID
path
string
body
entity
base64Binary
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
DELETE/models/{ID}/picturedeleteImage
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
POST/models/versions/{ModelVersionID}/actionexecuteWorkflowAction
Parameters
Accepts application/json
Name
Type
Description
Model
ModelVersionID
path
string
body
entity
Action
Action {
ActionParameter {
ActionName( string, required )
Parameters( Collection of ActionParameter, required )
UserID( string, required )
Comments( string )
}
ActionParameter {
Value( string )
Name( string, required )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
PUT/models/versions/{ModelVersionID}/schemaupdateSchema
Parameters
Accepts text/plain
Name
Type
Description
Model
ModelVersionID
path
string
body
entity
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
ModelVersion
ModelVersion {
Action {
ActionParameter {
TargetResource {
Image {
Links {
Action( Collection of Action )
Description( string )
Updated( dateTime )
Schema( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
State( string )
ModelVersionID( string )
ModelReferences( Collection of ModelVersion )
Links( Collection of Links )
Visibility( string )
Tag( Collection of string )
ModelID( string )
}
Action {
ActionName( string )
Parameters( Collection of ActionParameter )
UserID( string )
Comments( string )
}
ActionParameter {
Value( string )
Name( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
Links {
rel( string )
href( string )
type( string )
title( string )
}
DELETE/models/versions/{ModelVersionID}/schemadeleteSchema
Parameters
Name
Type
Description
Model
ModelVersionID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
GET/models/versions/{ModelVersionID}/schemagetSchema
Parameters
Name
Type
Description
Model
ModelVersionID
path
string
resolveReferences
query
boolean
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/models/{ID}/avatars/{version}.pnggetAvatar
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
version
path
string
size
query
integer
Reponse
Produces image/png
Status Code
Reason
Model
200
Success
byte
GET/models/avatar/{version}{Extension:(/[^/]+?)*}getDefaultVersionedAvatar
Parameters
Accepts */*
Name
Type
Description
Model
version
path
string
Extension
path
string
size
query
integer
Reponse
Produces image/png
Status Code
Reason
Model
200
Success
byte