Reserve Package

Reserve Package
Reserve package

This operation has two purposes:

  1. Make initial request for importing package. Location of the new package is returned as a response header if body is not provided.
  2. Finalize the import when all batches are sent to the server if bundleIdis provided or make the complete import if compressedBundle is provided

This API implements the TUS RFC: https://github.com/tus/tus-resumable-upload-protocol/blob/main/protocol.md

Request
URI
POST
https://vcfa-10-162-161-9.vcfd.broadcom.net/iaas/api/integrations-ipam/package-import
COPY
Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

Header Parameters
string
Tus-Resumable
Required

Tus version

Tus-Resumable example
1.0.0
string
Upload-Length
Required

Length of file in bytes

Upload-Length example
1000
Request Body

Package import request specification

PackageImportRequest of type(s) application/json
Optional 
{
    "compressedBundle": "string",
    "bundleId": "string",
    "option": "string",
    "properties": {
        "properties": "string"
    }
}
string As byte As byte
compressedBundle
Optional

compressedBundle

string
bundleId
Optional

bundleId

string
option
Optional

option

Possible values are : FAIL, OVERWRITE,
object
properties
Optional

properties

Authentication
This operation uses the following authentication methods.
Responses
201

Created

Returns PackageImportResponse of type(s) application/json 
{
    "providerId": "string",
    "providerName": "string",
    "providerVersion": "string",
    "logoIcon": "string"
}
string
providerId
Optional

providerId

string
providerName
Optional

providerName

string
providerVersion
Optional

providerVersion

string As byte As byte
logoIcon
Optional

logoIcon


400

Invalid Request - bad data

Returns PackageImportBadRequestResponse of type(s) application/json 
{
    "providerId": "string",
    "providerName": "string",
    "providerVersion": "string",
    "logoIcon": "string",
    "bundleId": "string",
    "integrationType": "string",
    "message": "string"
}
string
providerId
Optional

providerId

string
providerName
Optional

providerName

string
providerVersion
Optional

providerVersion

string As byte As byte
logoIcon
Optional

logoIcon

string
bundleId
Optional

bundleId

string
integrationType
Optional

integrationType

Possible values are : vRO, ABX,
string
message
Optional

message


403

Forbidden

Returns ServiceErrorResponse of type(s) application/json 
{
    "message": "string",
    "messageId": "string",
    "stackTrace": [
        "string"
    ],
    "statusCode": 0,
    "errorCode": 0,
    "details": [
        "string"
    ],
    "serverErrorId": "string",
    "documentKind": "string",
    "internalErrorCode": 0
}
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


409

Conflict

Returns PackageImportConflictResponse of type(s) application/json 
{
    "providerId": "string",
    "providerName": "string",
    "providerVersion": "string",
    "logoIcon": "string",
    "bundleId": "string",
    "oldProviderVersion": "string",
    "message": "string"
}
string
providerId
Optional

providerId

string
providerName
Optional

providerName

string
providerVersion
Optional

providerVersion

string As byte As byte
logoIcon
Optional

logoIcon

string
bundleId
Optional

bundleId

string
oldProviderVersion
Optional

oldProviderVersion

string
message
Optional

message


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/iaas/api/integrations-ipam/package-import
On This Page
Package Import Operations
POST
Import Package Http Method Override
PATCH
Import Package
POST
Reserve Package