Developer Documentation
OfflineSummary
The Offline.Summary structure defines the summary information regarding an Offline Depot.
Properties
| Required | Property Name | Type | Description |
|---|---|---|---|
| required | description | string |
Description of the Depot. If not set during import, it will be empty. |
| optional | file_id | string |
File identifier returned by the file upload endpoint after file is uploaded. This field is optional and it is only relevant when the value of Offline.Summary.source-type is PUSH. |
| optional | location | string |
Location of the depot from which content is retrieved. This field is optional and it is only relevant when the value of Offline.Summary.source-type is PULL. |
| required | source_type | OfflineSourceType Enum |
Type of the source from which Offline Depot is obtained. |
