Oracle Enterprise ManagerのREST API

FPP RESTユーザーのリスト

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/fppServers/{fppServerId}/restUsers

FPPサーバーのRESTユーザーをリストします

リクエスト

パス・パラメータ

fppServerId(必須): string

FPPサーバーのID

問合せパラメータ

limit: integer(int32)
レスポンス内のアイテム数を制限します
例:
```
10
```
page: string
アイテムの次のセット(ページ)を示すマーカー
例:
```
b2Zmc2V0OjA
```
sort: string
フィールドとソート方向(オプション)のカンマ区切りリスト。ソートでサポートされている属性は'username'です。有効なソート方向は'asc'および'desc'です。ソート方向を指定しない場合、デフォルトで'asc'が使用されます。
例:
```
username:asc
```

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

application/json

200レスポンス

OK。RESTユーザーが取得されました。

ルート・スキーマ: RestUserCollection

型: object

FPPサーバーに登録されたFPP RESTユーザーのリスト

ソースの表示

items: array items

RESTユーザーの配列
targetId: string

ターゲットのID

{
    "description":"List of FPP REST users registered with FPP Server",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Pagination"
        },
        {
            "$ref":"#/components/schemas/Target"
        }
    ],
    "properties":{
        "targetId":{
            "description":"ID of the Target",
            "type":"string"
        },
        "items":{
            "description":"Array of REST users",
            "type":"array",
            "items":{
                "type":"object",
                "allOf":[
                    {
                        "$ref":"#/components/schemas/CreateRestUserDetails"
                    }
                ]
            }
        }
    }
}

すべてに一致

FPPサーバーに登録されたFPP RESTユーザーのリスト

ソースの表示

object Pagination

リンク付きのアイテムのコレクション
object schema

ターゲットの詳細

{
    "description":"List of FPP REST users registered with FPP Server",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Pagination"
        },
        {
            "$ref":"#/components/schemas/Target"
        }
    ],
    "properties":{
        "targetId":{
            "description":"ID of the Target",
            "type":"string"
        },
        "items":{
            "description":"Array of REST users",
            "type":"array",
            "items":{
                "type":"object",
                "allOf":[
                    {
                        "$ref":"#/components/schemas/CreateRestUserDetails"
                    }
                ]
            }
        }
    }
}

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

型: array

RESTユーザーの配列

ソースの表示

配列: object items

{
    "description":"Array of REST users",
    "type":"array",
    "items":{
        "type":"object",
        "allOf":[
            {
                "$ref":"#/components/schemas/CreateRestUserDetails"
            }
        ]
    }
}

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

型: object

リンク付きのアイテムのコレクション

ソースの表示

count: integer

このフェッチの数

例: 40
links: object Links

リンクの配列を表します
total: integer

合計数

例: 40

{
    "description":"Collection of items with links",
    "properties":{
        "total":{
            "type":"integer",
            "description":"total count",
            "example":"40"
        },
        "count":{
            "type":"integer",
            "description":"Count of this fetch",
            "example":"40"
        },
        "links":{
            "$ref":"#/components/schemas/Links"
        }
    }
}

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

型: object

ターゲットの詳細

ソースの表示

targetName: string

ターゲットの名前

例: sales_db1
targetType: string

ターゲットのタイプ

例: oracle_database

{
    "description":"Target details",
    "type":"object",
    "properties":{
        "targetName":{
            "description":"Name of the target",
            "type":"string",
            "example":"sales_db1"
        },
        "targetType":{
            "description":"Type of the target",
            "type":"string",
            "example":"oracle_database"
        }
    }
}

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

型: object

すべてに一致

ソースの表示

object CreateRestUserDetails

RESTユーザーの詳細

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateRestUserDetails"
        }
    ]
}

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

型: object

RESTユーザーの詳細

ソースの表示

password(必須): string (password)

FPP REST URLをコールするために必要なREST資格証明をEMで作成するためのパスワード

例: welcome1
username(必須): string

FPPサーバーに登録するRESTユーザー名

{
    "description":"Details of REST user",
    "required":[
        "username",
        "password"
    ],
    "properties":{
        "username":{
            "description":"REST username to be registered with the FPP server",
            "type":"string"
        },
        "password":{
            "description":"Password to create the REST credential in EM, which is required to make a call to the FPP REST URL",
            "type":"string",
            "format":"password",
            "example":"welcome1"
        }
    }
}

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

型: object

リンクの配列を表します

ソースの表示

next: object Link

REST APIを参照するリンク。
previous: object Link

REST APIを参照するリンク。
self: object Link

REST APIを参照するリンク。

{
    "description":"Represents the array of links",
    "type":"object",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "previous":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

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

型: object

REST APIを参照するリンク。

ソースの表示

href: string

リンクURL

{
    "x-em-sdk-level":"emSDK",
    "description":"A link referencing a REST API.",
    "type":"object",
    "properties":{
        "href":{
            "description":"Link URL",
            "type":"string"
        }
    }
}

例

400レスポンス

不正なリクエスト。ペイロードがnullであるか、一部のパラメータがありません

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

401レスポンス

未認可。ユーザーにはリクエストされた操作を実行する権限がありません

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

403レスポンス

禁止。ユーザーは、リクエストされた操作の実行を禁止されています

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

404レスポンス

見つかりません。リクエストされたREST API URLが見つかりません。

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

500レスポンス

内部サーバー・エラー。REST APIの実行中に例外が発生しました。

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

503レスポンス

サービスが使用できません。サーバーはリクエストを処理できません。

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

先頭に戻る