REST API for Oracle AI Data Platform Workbench

Upload a file to volume by generating PAR

post

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

Uploads a volume file by generating PAR. If file exists, then it will be updated.

Request

Path Parameters

aiDataPlatformId(required): string

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

The key of the volume.

Query Parameters

isOverwrite: boolean

A boolean which decides if overwrite is allowed

Default Value: false

Header Parameters

opc-request-id: string

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

Minimum Length: 1

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.
path(required): string

Minimum Length: 1

Maximum Length: 255

The absolute path of the file or folder
should-update-recent: boolean

A flag to identify if the recent list should be updated.

Default Value: false

Contents of the file to upload.

Root Schema : UploadFileWithParDetails

Type: object

The data to create/update a file.

Show Source

action: string

Allowed Values: [ "CREATE", "REFRESH", "UPDATE" ]

Action type on create or close.
eTag: string

Etag that needs to be updated.
size: integer(int64)

Size of the file needed when closed.
systemTags: object systemTags

Additional Properties Allowed: additionalProperties

System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

{
    "description":"The data to create/update a file.",
    "type":"object",
    "properties":{
        "action":{
            "description":"Action type on create or close.",
            "type":"string",
            "enum":[
                "CREATE",
                "REFRESH",
                "UPDATE"
            ]
        },
        "eTag":{
            "description":"Etag that needs to be updated.",
            "type":"string"
        },
        "size":{
            "description":"Size of the file needed when closed.",
            "type":"integer",
            "format":"int64"
        },
        "systemTags":{
            "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported.\n"
                }
            }
        }
    }
}

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

Additional Properties Allowed: additionalProperties

Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}`

{
    "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported.\n"
        }
    }
}

System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported.\n"
    }
}

Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Response

Supported Media Types

application/json

200 Response

Successful operation. The file is uploaded to volume and generates a PAR.

Headers

content-location: string(uri-reference)

Same as location.
etag: string

For optimistic concurrency control. See `if-match`.
location: string(uri-reference)

URL for the uploaded volume file.
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.

Root Schema : UploadFileWithParResult

Type: object

Response object of generate PAR with Upload API.

Show Source

createdBy: string

The user who created the file.
createdTime: string

The time at which the file was created.
description: string

The file description.
eTag(required): string

Etag after creating or closing a file.
locationUri(required): string

The object storage URI which has bucket and namespace information.
parUrl: string

String representing the PAR URL.
size: integer(int64)

File size in bytes.
systemTags: object systemTags

Additional Properties Allowed: additionalProperties

System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
updatedBy: string

The user who last updated the file.
updatedTime: string

The last modified time of the file.

{
    "description":"Response object of generate PAR with Upload API.",
    "type":"object",
    "required":[
        "locationUri",
        "eTag"
    ],
    "properties":{
        "parUrl":{
            "description":"String representing the PAR URL.\n",
            "type":"string"
        },
        "eTag":{
            "description":"Etag after creating or closing a file.\n",
            "type":"string"
        },
        "locationUri":{
            "description":"The object storage URI which has bucket and namespace information.\n",
            "type":"string"
        },
        "size":{
            "description":"File size in bytes.\n",
            "type":"integer",
            "format":"int64"
        },
        "createdBy":{
            "description":"The user who created the file.\n",
            "type":"string"
        },
        "updatedBy":{
            "description":"The user who last updated the file.\n",
            "type":"string"
        },
        "createdTime":{
            "description":"The time at which the file was created.\n",
            "type":"string"
        },
        "updatedTime":{
            "description":"The last modified time of the file.\n",
            "type":"string"
        },
        "description":{
            "description":"The file description.\n",
            "type":"string"
        },
        "systemTags":{
            "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported.\n"
                }
            }
        }
    }
}

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

Additional Properties Allowed: additionalProperties

Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}`

{
    "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported.\n"
        }
    }
}

System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported.\n"
    }
}

Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

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.

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.

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.

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.

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.

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.

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.

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"
        }
    }
}