Get a Depot by ID
get
/api/package/Depots/{id}
Gets the depot that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The depot ID.Example:
1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : packageDepotsRead
Type:
Show Source
object
-
DepotID: integer
Depot IDExample:
3
-
DepotLocation: string
It can be an absolute path of local filesystem (Depot Type=3), or http/s url including the full path of directory (Depot Type=2).Example:
api/url/local path
-
DepotName: string
Depot NameExample:
stable
-
DepotType: integer
Depot Type ID Allowed Values: - 2 => Remote URL - 3 => Local FilesystemExample:
2
-
DepotTypeName: string
Name of the Depot Type Possible values: - Remote URL (Depot Type=2) - Local Path (Depot Type=3)Example:
Remote URL
-
Status: string
Value of the Status IDExample:
Enabled
-
StatusIcon: string
Status IconExample:
OrbGreen.png
-
StatusID: integer
Status ID Allowed Values: - 0 => Disabled - 1 => EnabledExample:
1
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object