機械翻訳について

ジャンプ先

• 要求
• レスポンス

アプリケーション・データソースの取得

get

/essbase/rest/v1/applications/{applicationName}/datasources/{datasouceName}

指定されたアプリケーション・レベルのデータソースに関する詳細を返します。

要求

パス・パラメータ

• applicationName: string

  アプリケーション名

• datasouceName: string

  データソース名

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

データソース詳細が正常に返されました。

本文()

ルート・スキーマ : datasource

タイプ: object

Show Source

• application: string
• columns: object ColumnsType
• connection: string
• cube: string
• customDelimiter(optional): string
• delimeter(optional): string
• description: string
• endRow(optional): integer(int64)
• headerRow(optional): integer(int64)
• headers(optional): array headers
• ignoreErrorRecords(optional): boolean
• links(optional): array links
• name(optional): string
• query: string
• queryParameters(optional): array queryParameters
• sheet: string
• skipHiddenRows(optional): boolean
• startRow: integer(int64)
• type: string
  許可される値: [ "TEMPLATE", "EXCELFILE", "DB", "DELIMITEDFILE", "FIXEDWIDTHFILE", "BI", "ESSBASE", "JDBC", "SPARK", "MS_SQL", "MYSQL", "DB2", "ORACLE", "FILE" ]
• widths: array widths

{
    "type":"object",
    "required":[
        "application",
        "columns",
        "connection",
        "cube",
        "description",
        "query",
        "sheet",
        "startRow",
        "type",
        "widths"
    ],
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "TEMPLATE",
                "EXCELFILE",
                "DB",
                "DELIMITEDFILE",
                "FIXEDWIDTHFILE",
                "BI",
                "ESSBASE",
                "JDBC",
                "SPARK",
                "MS_SQL",
                "MYSQL",
                "DB2",
                "ORACLE",
                "FILE"
            ]
        },
        "connection":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "columns":{
            "$ref":"#/definitions/ColumnsType"
        },
        "name":{
            "type":"string"
        },
        "ignoreErrorRecords":{
            "type":"boolean"
        },
        "delimeter":{
            "type":"string",
            "xml":{
                "name":"delimiter"
            }
        },
        "customDelimiter":{
            "type":"string"
        },
        "query":{
            "type":"string"
        },
        "application":{
            "type":"string"
        },
        "cube":{
            "type":"string"
        },
        "startRow":{
            "type":"integer",
            "format":"int64"
        },
        "endRow":{
            "type":"integer",
            "format":"int64"
        },
        "headerRow":{
            "type":"integer",
            "format":"int64"
        },
        "sheet":{
            "type":"string"
        },
        "skipHiddenRows":{
            "type":"boolean"
        },
        "widths":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int64",
                "xml":{
                    "name":"widths"
                }
            }
        },
        "queryParameters":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"queryParameters"
                },
                "$ref":"#/definitions/QueryParamsInfo"
            }
        },
        "headers":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"headers"
                },
                "$ref":"#/definitions/HeaderType"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"datasource"
    }
}

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

タイプ: object

Show Source

• column: array Column

{
    "type":"object",
    "required":[
        "column"
    ],
    "properties":{
        "column":{
            "type":"array",
            "xml":{
                "name":"Column"
            },
            "items":{
                "xml":{
                    "name":"Column"
                },
                "$ref":"#/definitions/ColumnType"
            }
        }
    }
}

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

タイプ: array

Show Source

• Array of: object HeaderType

{
    "type":"array",
    "items":{
        "xml":{
            "name":"headers"
        },
        "$ref":"#/definitions/HeaderType"
    }
}

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

タイプ: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

タイプ: array

Show Source

• Array of: object QueryParamsInfo

{
    "type":"array",
    "items":{
        "xml":{
            "name":"queryParameters"
        },
        "$ref":"#/definitions/QueryParamsInfo"
    }
}

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

タイプ: array

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int64",
        "xml":{
            "name":"widths"
        }
    }
}

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

タイプ: array

Show Source

• Array of: object ColumnType

{
    "type":"array",
    "xml":{
        "name":"Column"
    },
    "items":{
        "xml":{
            "name":"Column"
        },
        "$ref":"#/definitions/ColumnType"
    }
}

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

タイプ: object

Show Source

• format(optional): string
• index(optional): integer(int32)
• name(optional): string
• nullable(optional): boolean
• system(optional): boolean
• type(optional): string
  許可される値: [ "STRING", "DOUBLE", "DATE", "TIMESTAMP", "LONG" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        },
        "type":{
            "type":"string",
            "xml":{
                "attribute":true
            },
            "enum":[
                "STRING",
                "DOUBLE",
                "DATE",
                "TIMESTAMP",
                "LONG"
            ]
        },
        "nullable":{
            "type":"boolean",
            "xml":{
                "attribute":true
            }
        },
        "format":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        },
        "index":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "system":{
            "type":"boolean",
            "xml":{
                "attribute":true
            }
        }
    }
}

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

タイプ: object

Show Source

• cell(optional): string
• name(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        },
        "cell":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        }
    }
}

ネストされたスキーマ : リンク

タイプ: object

Show Source

• href(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

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

タイプ: object

Show Source

• defaultValue(optional): string
• index(optional): integer(int32)
• name(optional): string
• required(optional): boolean
• type(optional): string
  許可される値: [ "STRING", "DOUBLE", "DATE", "TIMESTAMP", "LONG" ]

{
    "type":"object",
    "properties":{
        "index":{
            "type":"integer",
            "format":"int32"
        },
        "name":{
            "type":"string"
        },
        "defaultValue":{
            "type":"string"
        },
        "required":{
            "type":"boolean"
        },
        "type":{
            "type":"string",
            "enum":[
                "STRING",
                "DOUBLE",
                "DATE",
                "TIMESTAMP",
                "LONG"
            ]
        }
    }
}

400 レスポンス

不正なリクエスト

データソース詳細の取得に失敗しました。

先頭に戻る