ALM
Revision
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id | str | The unique identifier of this revision. | required |
name | str | The name of this revision. | required |
description | str | None | The description of this revision. Not always present. | None |
created_on | str | The creation date of this revision in ISO format. | required |
created_by | str | The unique identifier of the user who created this revision. | required |
creation_method | str | The creation method of this revision. | required |
applied_on | str | The application date of this revision in ISO format. | required |
applied_by | str | The unique identifier of the user who applied this revision. | required |
ModelRevision
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id | str | The unique identifier of the model this revision belongs to. | required |
name | str | The name of the model this revision belongs to. This can be an empty string, when the calling user does not have access to the model, but is workspace admin in the workspace. | '' |
workspace_id | str | None | The unique identifier of the workspace this revision belongs to. | None |
applied_by | str | The unique identifier of the user who applied this revision. | required |
applied_on | str | The application date of this revision in ISO format. | required |
applied_method | str | The application method of this revision. | required |
deleted | bool | None | Whether the model has been deleted or not. | None |
SyncTaskResult
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
source_revision_id | str | The ID of the source revision. | required |
target_revision_id | str | The ID of the target revision. | required |
successful | bool | Whether the sync task was successful or not. | required |
SyncTask
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id | str | The unique identifier of this task. | required |
task_state | Literal[NOT_STARTED, IN_PROGRESS, COMPLETE] | The state of this task. | required |
creation_time | int | Unix timestamp of when this task was created. | required |
current_step | str | The current step of the sync task. | required |
result | SyncTaskResult | None | The result of the sync task. | None |
ReportTaskResult
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
source_revision_id | str | The ID of the source revision. | required |
target_revision_id | str | The ID of the target revision. | required |
successful | bool | Whether the sync task was successful or not. | required |
report_file_url | str | The URL of the report file generated by the sync task. | required |
ReportTaskError
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
title | str | The title of the error. | required |
message | str | The message of the error. | required |
ReportTaskFailureResult
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
successful | bool | Whether the sync task was successful or not. | required |
error | ReportTaskError | The error that occurred during the sync task. | required |
ReportTask
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id | str | The unique identifier of this task. | required |
task_state | Literal[NOT_STARTED, IN_PROGRESS, COMPLETE] | The state of this task. | required |
creation_time | int | Unix timestamp of when this task was created. | required |
current_step | str | The current step of the sync task. | required |
result | ReportTaskResult | ReportTaskFailureResult | None | The result of the comparison report task, including the report file URL. | None |
SummaryTotals
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
modified | int | The number of modified items. | 0 |
deleted | int | The number of deleted items. | 0 |
created | int | The number of created items. | 0 |
SummaryDifferences
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
line_items | SummaryTotals | Changes in line items. | SummaryTotals(modified=0, deleted=0, created=0) |
roles_contents | SummaryTotals | Changes in roles contents. | SummaryTotals(modified=0, deleted=0, created=0) |
lists | SummaryTotals | Changes in lists. | SummaryTotals(modified=0, deleted=0, created=0) |
modules | SummaryTotals | Changes in modules. | SummaryTotals(modified=0, deleted=0, created=0) |
SummaryReport
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
target_revision_id | str | The ID of the target revision. | required |
source_revision_id | str | The ID of the source revision. | required |
totals | SummaryTotals | The total counts of changes. | required |
differences | SummaryDifferences | The detailed breakdown of changes by category. | required |