Jump to

• Request
• Response

Surveys input data

post

/data-tools/surveys/

Surveys input data

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

• surveys: array surveys

{
    "type":"object",
    "properties":{
        "surveys":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/survey-request"
            }
        }
    }
}

Nested Schema : surveys

Type: array

Show Source

• Array of: object survey-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/survey-request"
    }
}

Nested Schema : survey-request

Type: object

Show Source

• format: object format
  DBMS_CLOUD.COPY_DATA formatting options
• objects: array data_load_objects
• storage_link_name: string
  Name of Cloud Storage Link

  Example: MY-BUCKET
• survey_name: string
  Name of input data survey

  Example: SALES-SURVEY-20220605-112233-4567

{
    "type":"object",
    "properties":{
        "survey_name":{
            "$ref":"#/components/schemas/survey_name"
        },
        "objects":{
            "$ref":"#/components/schemas/data_load_objects"
        },
        "storage_link_name":{
            "$ref":"#/components/schemas/storage_link_name"
        },
        "format":{
            "$ref":"#/components/schemas/format"
        }
    }
}

Nested Schema : format

Type: object

DBMS_CLOUD.COPY_DATA formatting options

Example:

{
    "delimiter":",",
    "blankasnull":true,
    "characterset":"AL32UTF8"
}

Nested Schema : data_load_objects

Type: array

Show Source

• Array of: object data_load_object

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/data_load_object"
    },
    "example":[
        {
            "object_name":"sales1976.csv"
        },
        {
            "object_name":"sales2009.csv"
        },
        {
            "object_name":"sales2013.csv"
        }
    ]
}

Example:

[
    {
        "object_name":"sales1976.csv"
    },
    {
        "object_name":"sales2009.csv"
    },
    {
        "object_name":"sales2013.csv"
    }
]

Nested Schema : data_load_object

Type: object

Show Source

• object_name: string
  Name of object to load

  Example: sales.csv

{
    "type":"object",
    "properties":{
        "object_name":{
            "type":"string",
            "description":"Name of object to load",
            "example":"sales.csv"
        }
    }
}

Back to Top

Response

201 Response

Surveys of input files

Body ()

Root Schema : surveys

Type: object

Show Source

• surveys: array surveys

{
    "type":"object",
    "properties":{
        "surveys":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/survey"
            }
        }
    }
}

Nested Schema : surveys

Type: array

Show Source

• Array of: object survey

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/survey"
    }
}

Nested Schema : survey

Type: object

Show Source

• columns: array columns
• format: object format
  DBMS_CLOUD.COPY_DATA formatting options
• objects: array data_load_objects
• storage_link_name: string
  Name of Cloud Storage Link

  Example: MY-BUCKET
• survey_name: string
  Name of input data survey

  Example: SALES-SURVEY-20220605-112233-4567

{
    "type":"object",
    "properties":{
        "survey_name":{
            "$ref":"#/components/schemas/survey_name"
        },
        "objects":{
            "$ref":"#/components/schemas/data_load_objects"
        },
        "storage_link_name":{
            "$ref":"#/components/schemas/storage_link_name"
        },
        "format":{
            "$ref":"#/components/schemas/format"
        },
        "columns":{
            "$ref":"#/components/schemas/columns"
        }
    }
}

Nested Schema : columns

Type: array

Show Source

• Array of: object column

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/column"
    },
    "example":[
        {
            "column_name":"RECEIVED_DATE",
            "datatype":"DATE",
            "columnId":1,
            "format":"YYYY-MM-DD"
        },
        {
            "column_name":"UNITS",
            "datatype":"NUMBER",
            "columnId":2,
            "length":38
        }
    ]
}

Example:

[
    {
        "column_name":"RECEIVED_DATE",
        "datatype":"DATE",
        "columnId":1,
        "format":"YYYY-MM-DD"
    },
    {
        "column_name":"UNITS",
        "datatype":"NUMBER",
        "columnId":2,
        "length":38
    }
]

Nested Schema : format

Type: object

DBMS_CLOUD.COPY_DATA formatting options

Example:

{
    "delimiter":",",
    "blankasnull":true,
    "characterset":"AL32UTF8"
}

Nested Schema : data_load_objects

Type: array

Show Source

• Array of: object data_load_object

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/data_load_object"
    },
    "example":[
        {
            "object_name":"sales1976.csv"
        },
        {
            "object_name":"sales2009.csv"
        },
        {
            "object_name":"sales2013.csv"
        }
    ]
}

Example:

[
    {
        "object_name":"sales1976.csv"
    },
    {
        "object_name":"sales2009.csv"
    },
    {
        "object_name":"sales2013.csv"
    }
]

Nested Schema : column

Type: object

Show Source

• column_name: string
  Column name in table

  Example: UNITS
• columnId: integer
  Column position in input file

  Example: 2
• datatype: string
  Allowed Values: [ "VARCHAR2", "CLOB", "NUMBER", "INTEGER", "FLOAT", "BINARY_FLOAT", "BINARY_DOUBLE", "DATE", "TIMESTAMP", "TIMESTAMP WITH TIME ZONE", "TIMESTAMP WITH LOCAL TIME ZONE", "NVARCHAR2", "NCLOB" ]

  Data type of column

  Example: NUMBER
• format: string
  Data format for certain column types

  Example: YYYY-MM-DD
• length: integer
  Length or precision of column

  Example: 40

{
    "type":"object",
    "properties":{
        "column_name":{
            "$ref":"#/components/schemas/column_name"
        },
        "columnId":{
            "type":"integer",
            "example":2,
            "description":"Column position in input file"
        },
        "datatype":{
            "type":"string",
            "example":"NUMBER",
            "description":"Data type of column",
            "enum":[
                "VARCHAR2",
                "CLOB",
                "NUMBER",
                "INTEGER",
                "FLOAT",
                "BINARY_FLOAT",
                "BINARY_DOUBLE",
                "DATE",
                "TIMESTAMP",
                "TIMESTAMP WITH TIME ZONE",
                "TIMESTAMP WITH LOCAL TIME ZONE",
                "NVARCHAR2",
                "NCLOB"
            ]
        },
        "length":{
            "type":"integer",
            "example":40,
            "description":"Length or precision of column"
        },
        "format":{
            "type":"string",
            "example":"YYYY-MM-DD",
            "description":"Data format for certain column types"
        }
    }
}

Nested Schema : data_load_object

Type: object

Show Source

• object_name: string
  Name of object to load

  Example: sales.csv

{
    "type":"object",
    "properties":{
        "object_name":{
            "type":"string",
            "description":"Name of object to load",
            "example":"sales.csv"
        }
    }
}

204 Response

No content

Back to Top