Jump to

• Request
• Response

Create a Depot

post

/api/package/Depots

Creates a new package depot.
The minimum required properties in the request body are:

• DepotName
• StatusID
• DepotType
• DepotLocation

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DepotLocation: string
  The location of the depot. When DepotType is 3, this should be an absolute path on the local file system. When DepotType is 2, this should be a URL.

  Example: <Unified_Assurance_server>/api
• DepotName: string
  The depot name.
  To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

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

  Example: 2
• StatusID: integer
  The depot status ID. Either 0 (disabled) or 1 (enabled).

  Example: 1

{
    "properties":{
        "DepotName":{
            "description":"The depot name.\n<br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"stable<timestamp>"
        },
        "DepotType":{
            "$ref":"#/components/schemas/packageDepotsRead/properties/DepotType"
        },
        "DepotLocation":{
            "$ref":"#/components/schemas/packageDepotsRead/properties/DepotLocation"
        },
        "StatusID":{
            "$ref":"#/components/schemas/packageDepotsRead/properties/StatusID"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/packageDepotsRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

• message: string
  The response message.

  Example: Added record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful add operation.",
    "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":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "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
  The location of the depot. When DepotType is 3, this should be an absolute path on the local file system. When DepotType is 2, this should be a URL.

  Example: <Unified_Assurance_server>/api
• DepotName: string
  Depot Name

  Example: stable<timestamp>
• 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
  The depot status ID. Either 0 (disabled) or 1 (enabled).

  Example: 1

{
    "properties":{
        "DepotID":{
            "description":"Depot ID",
            "type":"integer",
            "example":"3"
        },
        "DepotName":{
            "description":"Depot Name",
            "type":"string",
            "example":"stable<timestamp>"
        },
        "DepotType":{
            "description":"Depot Type ID\n\nAllowed Values:\n- 2 => Remote URL\n- 3 => Local Filesystem",
            "type":"integer",
            "example":"2"
        },
        "DepotLocation":{
            "description":"The location of the depot. When <b>DepotType</b> is <b>3</b>, this should be an absolute path on the local file system. When <b>DepotType</b> is <b>2</b>, this should be a URL.",
            "type":"string",
            "example":"<Unified_Assurance_server>/api"
        },
        "StatusID":{
            "description":"The depot status ID. Either <b>0</b> (disabled) or <b>1</b> (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":{
                "description":"An error.",
                "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
  An error.

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

Nested Schema : items

Type: object

An error.

Back to Top