ジャンプ先

• リクエスト
• レスポンス

入力データの調査

POST

/data-tools/surveys/

入力データの調査

リクエスト

この操作のリクエスト・パラメータはありません。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

タイプ: object

ソースの表示

• surveys: array surveys

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

ネストされたスキーマ: surveys

タイプ: array

ソースの表示

• 配列: オブジェクト survey-request

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

ネストされたスキーマ: survey-request

タイプ: object

ソースの表示

• format: object format
  DBMS_CLOUD.COPY_DATA書式設定オプション
• objects: array data_load_objects
• storage_link_name: string
  クラウド・ストレージ・リンクの名前

  例: MY-BUCKET
• survey_name: string
  入力データ調査の名前

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

ネストされたスキーマ: format

タイプ: object

DBMS_CLOUD.COPY_DATA書式設定オプション

例:

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

ネストされたスキーマ: data_load_objects

タイプ: array

ソースの表示

• 配列: オブジェクト 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"
        }
    ]
}

例:

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

ネストされたスキーマ: data_load_object

タイプ: object

ソースの表示

• object_name: string
  ロードするオブジェクトの名前

  例: sales.csv

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

先頭に戻る

レスポンス

201レスポンス

入力ファイルの調査

本文 ()

ルート・スキーマ: surveys

タイプ: object

ソースの表示

• surveys: array surveys

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

ネストされたスキーマ: surveys

タイプ: array

ソースの表示

• 配列: オブジェクト survey

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

ネストされたスキーマ: survey

タイプ: object

ソースの表示

• columns: array columns
• format: object format
  DBMS_CLOUD.COPY_DATA書式設定オプション
• objects: array data_load_objects
• storage_link_name: string
  クラウド・ストレージ・リンクの名前

  例: MY-BUCKET
• survey_name: string
  入力データ調査の名前

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

ネストされたスキーマ: columns

タイプ: array

ソースの表示

• 配列: オブジェクト 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"
        }
    ]
}

例:

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

ネストされたスキーマ: format

タイプ: object

DBMS_CLOUD.COPY_DATA書式設定オプション

例:

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

ネストされたスキーマ: data_load_objects

タイプ: array

ソースの表示

• 配列: オブジェクト 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"
        }
    ]
}

例:

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

ネストされたスキーマ: column

タイプ: object

ソースの表示

• column_id: integer
  入力ファイルの列位置

  例: 2
• column_name: string
  表の列の名前

  例: UNITS
• data_format: string
  特定の列タイプのデータ書式

  例: YYYY-MM-DD
• data_length: integer
  列の長さまたは精度

  例: 40
• data_precision: integer
  特定の列タイプのデータの精度

  例: 10
• data_scale: integer
  特定の列タイプのデータのスケール

  例: 2
• data_type: string
  指定できる値: [ "VARCHAR2", "CLOB", "NUMBER", "INTEGER", "FLOAT", "BINARY_FLOAT", "BINARY_DOUBLE", "DATE", "TIMESTAMP", "TIMESTAMP WITH TIME ZONE", "TIMESTAMP WITH LOCAL TIME ZONE", "NVARCHAR2", "NCLOB", "BOOLEAN", "VECTOR" ]

  列のデータ型

  例: NUMBER
• field_name: string
  入力ファイルの列名

  例: customer name

{
    "type":"object",
    "properties":{
        "column_name":{
            "$ref":"#/components/schemas/column_name"
        },
        "field_name":{
            "type":"string",
            "example":"customer name",
            "description":"Name of column in input file"
        },
        "column_id":{
            "type":"integer",
            "example":"2",
            "description":"Column position in input file"
        },
        "data_type":{
            "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",
                "BOOLEAN",
                "VECTOR"
            ]
        },
        "data_length":{
            "type":"integer",
            "example":"40",
            "description":"Length or precision of column"
        },
        "data_precision":{
            "type":"integer",
            "example":"10",
            "description":"Precision of data for certain column types"
        },
        "data_scale":{
            "type":"integer",
            "example":"2",
            "description":"Scale of data for certain column types"
        },
        "data_format":{
            "type":"string",
            "example":"YYYY-MM-DD",
            "description":"Data format for certain column types"
        }
    }
}

ネストされたスキーマ: data_load_object

タイプ: object

ソースの表示

• object_name: string
  ロードするオブジェクトの名前

  例: sales.csv

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

204レスポンス

コンテンツがありません

先頭に戻る