ALM Client
Note
This Class is not meant to be instantiated directly, but rather accessed through the alm Property on an
instance of Client. For more details, see the Guide.
get_latest_revision
get_latest_revision() -> list[Revision]
Use this call to return the latest revision for a specific model. The response is in the same format as in Getting a list of syncable revisions between two models.
If a revision exists, the return list should contain one element only which is the latest revision.
Returns:
| Type | Description |
|---|---|
list[Revision]
|
The latest revision for a specific model. |
get_models_for_revision
get_models_for_revision(revision_id: str) -> list[ModelRevision]
Use this call when you need a list of the models that had a specific revision applied to them.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
revision_id
|
str
|
The ID of the revision. |
required |
Returns:
| Type | Description |
|---|---|
list[ModelRevision]
|
A list of models that had a specific revision applied to them. |
get_revisions
get_revisions() -> list[Revision]
Use this call to return a list of revisions for a specific model.
Returns:
| Type | Description |
|---|---|
list[Revision]
|
A list of revisions for a specific model. |
get_sync_tasks
get_sync_tasks() -> list[SyncTask]
Use this endpoint to return a list of sync tasks for a target model, where the tasks are either in progress, or they were completed within the last 48 hours.
The list is in descending order of when the tasks were created.
Returns:
| Type | Description |
|---|---|
list[SyncTask]
|
A list of sync tasks for a target model. |
get_syncable_revisions
get_syncable_revisions(source_model_id: str) -> list[Revision]
Use this call to return the list of revisions from your source model that can be synchronized to your target model.
The returned list displays in descending order, by creation date and time. This is consistent with how revisions are displayed in the user interface (UI).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
source_model_id
|
str
|
The ID of the source model. |
required |
Returns:
| Type | Description |
|---|---|
list[Revision]
|
A list of revisions that can be synchronized to the target model. |
list_users
list_users() -> list[User]
Lists all the Users in the authenticated users default tenant.
Returns:
| Type | Description |
|---|---|
list[User]
|
The List of Users. |