機械翻訳について

ジャンプ先

• 要求
• レスポンス

アプリケーション接続のリスト

get

/essbase/rest/v1/applications/{applicationName}/connections

名前、説明、タイプなどの詳細を含む、アプリケーションの接続のリストを返します。

要求

パス・パラメータ

• applicationName: string

  アプリケーション名

問合せパラメータ

• limit(optional): integer(int32)

  返される接続の最大数。 デフォルトは50です。

  デフォルト値: 50
• offset(optional): integer(int32)

  結果セットの先頭から除外する接続の数。

  デフォルト値: 0

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

接続のリストが正常に返されました。

本文()

ルート・スキーマ : ConnectionsList

タイプ: object

Show Source

• count(optional): integer(int64)
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer(int64)
• offset(optional): integer(int64)
• properties(optional): object properties
  許可される追加プロパティ: additionalProperties
• totalResults(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Connection"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

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

タイプ: array

Show Source

• Array of: object connection

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

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

タイプ: object

許可される追加プロパティ

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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

タイプ: object

Show Source

• catalog(optional): boolean
• datasource(optional): string
• dbDriver(optional): string
• dbURL(optional): string
• description(optional): string
• encrypted(optional): boolean
• host(optional): string
• links(optional): array links
• name: string
• password(optional): string
• path(optional): string
• port(optional): integer(int32)
• schema(optional): string
• service(optional): string
• sid(optional): string
• subtype(optional): string
  許可される値: [ "TEMPLATE", "EXCELFILE", "DB", "DELIMITEDFILE", "FIXEDWIDTHFILE", "BI", "ESSBASE", "JDBC", "SPARK", "MS_SQL", "MYSQL", "DB2", "ORACLE", "FILE" ]
• token(optional): string
• type: string
  許可される値: [ "FILE", "DB", "ESSBASE", "BI" ]
• user(optional): string
• walletPath(optional): string

{
    "type":"object",
    "required":[
        "name",
        "type"
    ],
    "properties":{
        "description":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "FILE",
                "DB",
                "ESSBASE",
                "BI"
            ]
        },
        "path":{
            "type":"string"
        },
        "catalog":{
            "type":"boolean"
        },
        "host":{
            "type":"string"
        },
        "port":{
            "type":"integer",
            "format":"int32"
        },
        "user":{
            "type":"string"
        },
        "password":{
            "type":"string"
        },
        "encrypted":{
            "type":"boolean"
        },
        "token":{
            "type":"string"
        },
        "sid":{
            "type":"string"
        },
        "service":{
            "type":"string"
        },
        "schema":{
            "type":"string"
        },
        "dbURL":{
            "type":"string"
        },
        "dbDriver":{
            "type":"string"
        },
        "datasource":{
            "type":"string"
        },
        "subtype":{
            "type":"string",
            "enum":[
                "TEMPLATE",
                "EXCELFILE",
                "DB",
                "DELIMITEDFILE",
                "FIXEDWIDTHFILE",
                "BI",
                "ESSBASE",
                "JDBC",
                "SPARK",
                "MS_SQL",
                "MYSQL",
                "DB2",
                "ORACLE",
                "FILE"
            ]
        },
        "walletPath":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"connection"
    }
}

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

タイプ: array

Show Source

• Array of: object Link

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

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

タイプ: 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"
        }
    }
}

400 レスポンス

不正なリクエスト

接続のリストに失敗しました。

先頭に戻る