Jump to

• Request
• Response

Upload and extract a volume ZIP file

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/uploadAndExtractZip

Creates or updates an asynchronous volume ZIP upload and extraction operation. CREATE returns a PAR URL for uploading the ZIP bytes and an async operation key. UPDATE records the uploaded ZIP metadata so extraction can continue.

Request

Path Parameters

• aiDataPlatformId(required): string
  Minimum Length: 1

  Maximum Length: 500

  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• volumeKey(required): string
  Minimum Length: 1

  Maximum Length: 255

  The key of the volume.

Header Parameters

• opc-request-id: string
  Maximum Length: 255

  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• opc-retry-token: string
  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected.

Body ()

Details for uploading and extracting the volume ZIP file.

Root Schema : UploadAndExtractZipDetails

Type: object

Details to create or update a workspace zip upload and extraction operation.

Show Source

• action(required): string
  Allowed Values: [ "CREATE", "UPDATE" ]

  Action to perform for the upload and extract operation. CREATE starts the async operation and returns an upload PAR URL. UPDATE records final uploaded object metadata for an existing operation.
• destinationFolderPath: string
  Minimum Length: 1

  Maximum Length: 1024

  Workspace folder where the zip root folder will be extracted. Required for CREATE.
• eTag: string
  Minimum Length: 1

  Maximum Length: 1024

  Final Object Storage ETag for the uploaded zip object. If multipart upload is used, the caller commits the multipart upload directly with Object Storage before calling UPDATE.
• isOverwrite: boolean
  Default Value: false

  Flag to overwrite existing files during extraction. If false, existing files are skipped.
• operationKey: string
  Minimum Length: 1

  Maximum Length: 255

  Async operation key returned by the CREATE action. Required for UPDATE.
• sizeInBytes: integer(int64)
  Minimum Value: 1

  Final uploaded zip object size in bytes. Required for UPDATE.
• zipFileName: string
  Minimum Length: 1

  Maximum Length: 255

  Name of the zip file that will be uploaded through the returned PAR URL. Required for CREATE.

{
    "description":"Details to create or update a workspace zip upload and extraction operation.",
    "type":"object",
    "required":[
        "action"
    ],
    "properties":{
        "action":{
            "description":"Action to perform for the upload and extract operation. CREATE starts the async operation and returns an upload PAR URL. UPDATE records final uploaded object metadata for an existing operation.",
            "type":"string",
            "enum":[
                "CREATE",
                "UPDATE"
            ]
        },
        "operationKey":{
            "description":"Async operation key returned by the CREATE action. Required for UPDATE.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "zipFileName":{
            "description":"Name of the zip file that will be uploaded through the returned PAR URL. Required for CREATE.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "destinationFolderPath":{
            "description":"Workspace folder where the zip root folder will be extracted. Required for CREATE.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        },
        "isOverwrite":{
            "description":"Flag to overwrite existing files during extraction. If false, existing files are skipped.",
            "type":"boolean",
            "default":false
        },
        "eTag":{
            "description":"Final Object Storage ETag for the uploaded zip object. If multipart upload is used, the caller commits the multipart upload directly with Object Storage before calling UPDATE.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        },
        "sizeInBytes":{
            "description":"Final uploaded zip object size in bytes. Required for UPDATE.",
            "type":"integer",
            "minimum":1,
            "format":"int64"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Request accepted. The volume ZIP upload and extraction operation is created or updated.

Headers

• aidp-async-operation-key: string
  The key of the asynchronous operations associated with an AI Data Platform instance. Use GetAsyncOperation with this key to track the status of the request.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : UploadAndExtractZipResult

Type: object

Result of creating or updating a workspace zip upload and extraction operation.

Show Source

• destinationFolderPath: string
  Minimum Length: 1

  Maximum Length: 1024

  Final workspace folder path where the zip will be extracted. Returned for CREATE.
• operationKey(required): string
  Minimum Length: 1

  Maximum Length: 255

  Async operation key for upload and extraction.
• uploadUrl: string(password)
  Minimum Length: 1

  PAR URL where the caller uploads the zip bytes. Returned for CREATE.

{
    "description":"Result of creating or updating a workspace zip upload and extraction operation.",
    "type":"object",
    "required":[
        "operationKey"
    ],
    "properties":{
        "operationKey":{
            "description":"Async operation key for upload and extraction.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "uploadUrl":{
            "description":"PAR URL where the caller uploads the zip bytes. Returned for CREATE.",
            "type":"string",
            "format":"password",
            "minLength":1
        },
        "destinationFolderPath":{
            "description":"Final workspace folder path where the zip will be extracted. Returned for CREATE.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

409 Response

Conflict. Request conflicts with the current state of the resource.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top