Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 2.07 KB

MigrationStatusDto.md

File metadata and controls

32 lines (24 loc) · 2.07 KB

MigrationStatusDto

How far the parse or the import queued for this portal has got, and what it produced once it stopped.

Properties

Name Type Description Notes
progress float The share of the job that is done, from 0 to 100. It advances unevenly, since the stages differ in length, so poll isCompleted rather than waiting for this to reach 100. [optional]
error str The message that ended the job, in the portal language. It stays empty while nothing has gone wrong, so once isCompleted is true this field is what tells success from failure. [optional]
parse_result MigrationApiInfo What the migrator has read so far. After a parse pass it holds the users, the groups and the archives it could not read, which is the body to edit and post to POST api/2.0/migration/migrate; during an import it also carries the accounts that were created and the ones that failed. Its own operation field, parse or migration, is what tells the two stages apart. [optional]
is_completed bool Whether the job has stopped, successfully or not. It is the field to poll on; the whole body comes back empty instead when the portal has no job at all, which is not an error. [optional]

Example

from docspace_api_sdk.models.migration_status_dto import MigrationStatusDto

# TODO update the JSON string below
json = "{}"
# create an instance of MigrationStatusDto from a JSON string
migration_status_dto_instance = MigrationStatusDto.from_json(json)
# print the JSON string representation of the object
print(MigrationStatusDto.to_json())

# convert the object into a dict
migration_status_dto_dict = migration_status_dto_instance.to_dict()
# create an instance of MigrationStatusDto from a dict
migration_status_dto_from_dict = MigrationStatusDto.from_dict(migration_status_dto_dict)

[Back to Model list] [Back to API list] [Back to README]