Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/packageDepotsRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/packageDepotsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object packageDepotsRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/packageDepotsRead"
    }
}

Nested Schema : packageDepotsRead

Type: object

Show Source

• DepotID: integer
  Depot ID

  Example: 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 Name

  Example: stable
• DepotType: integer
  Depot Type ID Allowed Values: - 2 => Remote URL - 3 => Local Filesystem

  Example: 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 ID

  Example: Enabled
• StatusIcon: string
  Status Icon

  Example: OrbGreen.png
• StatusID: integer
  Status ID Allowed Values: - 0 => Disabled - 1 => Enabled

  Example: 1

{
    "properties":{
        "DepotID":{
            "description":"Depot ID",
            "type":"integer",
            "example":"3"
        },
        "DepotName":{
            "description":"Depot Name",
            "type":"string",
            "example":"stable"
        },
        "DepotType":{
            "description":"Depot Type ID\n\nAllowed Values:\n- 2 => Remote URL\n- 3 => Local Filesystem",
            "type":"integer",
            "example":"2"
        },
        "DepotLocation":{
            "description":"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).",
            "type":"string",
            "example":"api/url/local path"
        },
        "StatusID":{
            "description":"Status ID\nAllowed Values:\n-  0 => Disabled\n-  1 => Enabled",
            "type":"integer",
            "example":"1"
        },
        "Status":{
            "description":"Value of the Status ID",
            "type":"string",
            "example":"Enabled"
        },
        "StatusIcon":{
            "description":"Status Icon",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "DepotTypeName":{
            "description":"Name of the Depot Type \n\nPossible values: \n- Remote URL (Depot Type=2)\n- Local Path (Depot Type=3)",
            "type":"string",
            "example":"Remote URL"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top