Jump to

• Request
• Response

Creates Cloud Storage Link

post

/data-tools/cloud-storage-links/

Creates Cloud Storage Link

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

• cloud_storage_links: array cloud_storage_links

{
    "type":"object",
    "properties":{
        "cloud_storage_links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/cloud-storage-link"
            }
        }
    }
}

Nested Schema : cloud_storage_links

Type: array

Show Source

• Array of: object cloud-storage-link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/cloud-storage-link"
    }
}

Nested Schema : cloud-storage-link

Type: object

Show Source

• credential_name: string
  Credential name used to access bucket

  Example: MYCRED
• sql_statements: array sql_statements
  SQL statements to perform database operation
• storage_link_description: string
  Description of Cloud Storage Link

  Example: My bucket for CSV files
• storage_link_name: string
  Name of Cloud Storage Link

  Example: MY-BUCKET
• uri: string
  URI of bucket for Cloud Storage Links

  Example: https://objectstorage.us-ashburn-1.oraclecloud.com/n/kdnmfs3kdj2x/b/my-bucket/o/

{
    "type":"object",
    "properties":{
        "storage_link_name":{
            "$ref":"#/components/schemas/storage_link_name"
        },
        "storage_link_description":{
            "type":"string",
            "example":"My bucket for CSV files",
            "description":"Description of Cloud Storage Link"
        },
        "credential_name":{
            "type":"string",
            "example":"MYCRED",
            "description":"Credential name used to access bucket"
        },
        "uri":{
            "type":"string",
            "example":"https://objectstorage.us-ashburn-1.oraclecloud.com/n/kdnmfs3kdj2x/b/my-bucket/o/",
            "description":"URI of bucket for Cloud Storage Links"
        },
        "sql_statements":{
            "$ref":"#/components/schemas/sql_statements"
        }
    }
}

Nested Schema : sql_statements

Type: array

SQL statements to perform database operation

Show Source

• Array of: string
  SQL statement

{
    "type":"array",
    "items":{
        "description":"SQL statement",
        "type":"string"
    },
    "description":"SQL statements to perform database operation",
    "example":[
        "CREATE TABLE \"MYSCHEMA\".\"EXAMPLE_TABLE\"(\"ID\" NUMBER, \"DATE_RECV\" DATE);"
    ]
}

Example:

[
    "CREATE TABLE \"MYSCHEMA\".\"EXAMPLE_TABLE\"(\"ID\" NUMBER, \"DATE_RECV\" DATE);"
]

Back to Top

Response

Supported Media Types

• application/json

201 Response

Cloud Storage Links were succesfully created

Body ()

Root Schema : schema

Type: object

Show Source

• cloud_storage_links: array cloud_storage_links

{
    "type":"object",
    "properties":{
        "cloud_storage_links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/cloud-storage-link"
            }
        }
    }
}

Nested Schema : cloud_storage_links

Type: array

Show Source

• Array of: object cloud-storage-link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/cloud-storage-link"
    }
}

Nested Schema : cloud-storage-link

Type: object

Show Source

• credential_name: string
  Credential name used to access bucket

  Example: MYCRED
• sql_statements: array sql_statements
  SQL statements to perform database operation
• storage_link_description: string
  Description of Cloud Storage Link

  Example: My bucket for CSV files
• storage_link_name: string
  Name of Cloud Storage Link

  Example: MY-BUCKET
• uri: string
  URI of bucket for Cloud Storage Links

  Example: https://objectstorage.us-ashburn-1.oraclecloud.com/n/kdnmfs3kdj2x/b/my-bucket/o/

{
    "type":"object",
    "properties":{
        "storage_link_name":{
            "$ref":"#/components/schemas/storage_link_name"
        },
        "storage_link_description":{
            "type":"string",
            "example":"My bucket for CSV files",
            "description":"Description of Cloud Storage Link"
        },
        "credential_name":{
            "type":"string",
            "example":"MYCRED",
            "description":"Credential name used to access bucket"
        },
        "uri":{
            "type":"string",
            "example":"https://objectstorage.us-ashburn-1.oraclecloud.com/n/kdnmfs3kdj2x/b/my-bucket/o/",
            "description":"URI of bucket for Cloud Storage Links"
        },
        "sql_statements":{
            "$ref":"#/components/schemas/sql_statements"
        }
    }
}

Nested Schema : sql_statements

Type: array

SQL statements to perform database operation

Show Source

• Array of: string
  SQL statement

{
    "type":"array",
    "items":{
        "description":"SQL statement",
        "type":"string"
    },
    "description":"SQL statements to perform database operation",
    "example":[
        "CREATE TABLE \"MYSCHEMA\".\"EXAMPLE_TABLE\"(\"ID\" NUMBER, \"DATE_RECV\" DATE);"
    ]
}

Example:

[
    "CREATE TABLE \"MYSCHEMA\".\"EXAMPLE_TABLE\"(\"ID\" NUMBER, \"DATE_RECV\" DATE);"
]

204 Response

No content

409 Response

Name conflict with existing Cloud Storage Link

Back to Top