SettingsDepotsOfflineSummary

The Offline.Summary structure defines the summary information regarding an offline depot.


Properties

string
description Required

Description of the depot. If not set during import, it will be empty.


source_type Required

Type of the source from which offline depot is obtained.

Possible values are: PULLPUSH


string
file_id Optional

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.


string as uri
location Optional

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.

JSON Example

{
    "description": "string",
    "source_type": "enum"
}
Returned By

List Depots Offline
Feedback

Was this page helpful?