Web API for Models: Difference between revisions
Jump to navigation
Jump to search
(Created page with "Models API is used to create models, delete models and edit model properties. Data is imported to models by importing data to the datatables used by the model. ==Model Entity...") |
|||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
Models API is used to create models, delete models and edit model properties. Data is | Models API is used to create models, delete models and edit model properties. Data import is not done using the models API, but data is imported directly to the datatables used by the model. | ||
Note that the [[Web API for Workspace Elements|Workspace Elements API]] supports also models. | |||
==Model Entity== | ==Model Entity== | ||
The models API is based on the | The models API is based on the Model entity, which has the following properties: | ||
* Id (integer): model id. | * Id (integer): model id. | ||
* ProjectId (integer): Id of the project where the model is located. The | * ProjectId (integer): Id of the project where the model is located. The model is moved to another project by changing this property. | ||
* Name (string): Model name. | * Name (string): Model name. | ||
* Description (string): Model description. | * Description (string): Model description. | ||
* CreatedDate (datetime): Model creation date. | * CreatedDate (datetime): Model creation date. | ||
* CreatorId (integer): Model creator user id. | * CreatorId (integer): Model creator user id. | ||
* LastModifiedDate (datetime): Model last modification date | * LastModifiedDate (datetime): Model last modification date. | ||
* LastModifierId (integer): Model last modifier user id | * LastModifierId (integer): Model last modifier user id. | ||
* NCases (integer): | * NCases (integer): Number of cases in the model. | ||
* NEvents (integer): | * NEvents (integer): Number of events in the model. | ||
* NEventTypes (integer): | * NEventTypes (integer): Number of event types in the model. | ||
* NCaseAttributes (integer): | * NCaseAttributes (integer): Number of case attributes in the model. | ||
* NEventAttributes (integer): | * NEventAttributes (integer): Number of event attributes in the model. | ||
* NFilters (integer): | * NFilters (integer): Number of filters in the model. | ||
* NAnalyses (integer): | * NAnalyses (integer): Number of analyses in the model. | ||
* Configuration (JSON object): Model configuration JSON. | * Configuration (JSON object): Model configuration JSON. | ||
The following properties in model objects can be modified: Name, Description, ProjectId and Configuration. | |||
All | All object counts properties are calculated and stored to the model when the model is loaded into memory. | ||
==Methods== | ==Methods== | ||
| Line 30: | Line 32: | ||
GET api/models GET | GET api/models GET | ||
</pre> | </pre> | ||
Gets | Gets a list of all not deleted models in the system (if no parameter is provided). Supports optional query parameter ''projectId'' which is project id where to get models from. | ||
<pre> | <pre> | ||
GET api/models/{id} | GET api/models/{id} | ||
</pre> | </pre> | ||
Gets | Gets a model entity by the model id. If model doesn't exist, not found error is returned. If current user has no access to the model, unauthorized error is returned. | ||
<pre> | <pre> | ||
POST api/models | POST api/models | ||
</pre> | </pre> | ||
Creates a new empty model. Takes the model | Creates a new empty model. Takes the model entity in the body (read-only properties are ignored). Returns the created model entity. If current user has no rights to create model, unauthorized error is returned. | ||
<pre> | <pre> | ||
PUT api/models/{id} | PUT api/models/{id} | ||
</pre> | </pre> | ||
Updates | Updates properties of an existing model with the given id. The method takes the model entity in the body (model id in the entity should match the model id given in url). If model doesn't exist, not found error is returned. If current user has no rights to modify the model, unauthorized error is returned. | ||
<pre> | <pre> | ||
DELETE api/models/{id} | DELETE api/models/{id} | ||
</pre> | </pre> | ||
Deletes | Deletes a model with given id. Supports optional query parameter ''deletePermanently'' (boolean, false by default), which indicates whether to delete the model permanently. If the model doesn't exist, not found error is returned. If current user has no rights to delete the model, unauthorized error is returned. | ||
<pre> | <pre> | ||
GET api/models/export/{id} | GET api/models/export/{id} | ||
</pre> | </pre> | ||
Exports the model with given id | Exports the model with given id as PACM format. Returns the model content as a stream in the PACM format. If model doesn't exist, not found error is returned. If current user has no access to the model, unauthorized error is returned. | ||
[[Category: QPR ProcessAnalyzer]] | |||
Latest revision as of 09:13, 29 April 2022
Models API is used to create models, delete models and edit model properties. Data import is not done using the models API, but data is imported directly to the datatables used by the model.
Note that the Workspace Elements API supports also models.
Model Entity
The models API is based on the Model entity, which has the following properties:
- Id (integer): model id.
- ProjectId (integer): Id of the project where the model is located. The model is moved to another project by changing this property.
- Name (string): Model name.
- Description (string): Model description.
- CreatedDate (datetime): Model creation date.
- CreatorId (integer): Model creator user id.
- LastModifiedDate (datetime): Model last modification date.
- LastModifierId (integer): Model last modifier user id.
- NCases (integer): Number of cases in the model.
- NEvents (integer): Number of events in the model.
- NEventTypes (integer): Number of event types in the model.
- NCaseAttributes (integer): Number of case attributes in the model.
- NEventAttributes (integer): Number of event attributes in the model.
- NFilters (integer): Number of filters in the model.
- NAnalyses (integer): Number of analyses in the model.
- Configuration (JSON object): Model configuration JSON.
The following properties in model objects can be modified: Name, Description, ProjectId and Configuration.
All object counts properties are calculated and stored to the model when the model is loaded into memory.
Methods
The models API has the following methods.
GET api/models GET
Gets a list of all not deleted models in the system (if no parameter is provided). Supports optional query parameter projectId which is project id where to get models from.
GET api/models/{id}
Gets a model entity by the model id. If model doesn't exist, not found error is returned. If current user has no access to the model, unauthorized error is returned.
POST api/models
Creates a new empty model. Takes the model entity in the body (read-only properties are ignored). Returns the created model entity. If current user has no rights to create model, unauthorized error is returned.
PUT api/models/{id}
Updates properties of an existing model with the given id. The method takes the model entity in the body (model id in the entity should match the model id given in url). If model doesn't exist, not found error is returned. If current user has no rights to modify the model, unauthorized error is returned.
DELETE api/models/{id}
Deletes a model with given id. Supports optional query parameter deletePermanently (boolean, false by default), which indicates whether to delete the model permanently. If the model doesn't exist, not found error is returned. If current user has no rights to delete the model, unauthorized error is returned.
GET api/models/export/{id}
Exports the model with given id as PACM format. Returns the model content as a stream in the PACM format. If model doesn't exist, not found error is returned. If current user has no access to the model, unauthorized error is returned.