ModelVersion Object
Contains information about a version for model objects defined at the organization level.
This object is used by the following operations:
- GET /api/models/versions/{ModelVersionID} (in the response)
- POST /api/models/{ModelID}/versions (in the response)
- PUT /api/models/versions/{ModelVersionID} (in request and response)
- Operations that reference the Model object
- Operations that reference the ModelVersions object
The properties included in the ModelVersion object are listed below.
| Property | Type | Description |
|---|---|---|
| ModelVersionID | string | The unique ID for a specific version of a model object defined for a business organization. Same format as ModelID. |
| ModelID | string | The unique ID for a model object defined for a business organization. |
| Name | string | Name of the model object. |
| Description | string | Description of the model object. |
| Tag | string[ ] | One or more user-defined tags assigned to the model object. |
| Visibility | string | The visibility setting for this resource. For a list of valid values, see Visibility Settings. |
| Created | dateTime | The date/time stamp when the resource was first created. Used only in response messages. |
| Updated | dateTime | The date/time stamp when the resource was last updated. Used only in response messages. |
| State | string | The state value for the model object; for example, com.akana.model.state.active. For valid values, see Model State values. |
| Schema | string | The schema for the model version. |
| ModelReferences | ModelReferences | Contains information about references defined within a model object for a business organization on the platform. |
| Links | Links[ ] |
Contains information about links relating to a resource on the platform. One or more links applicable to the model version. |
| Action | Action[ ] |
An extensibility element for a workflow action event that possibly could be taken on a specific resource. Used to call a JavaScript action. A list of actions available on the resource. |
| TargetResources | TargetResources | Contains information about one or more resources associated with the current resource. Used only in response messages. |