移動先

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

FPPサーバー・プロパティの追加

post

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

EMで登録済FPPサーバーのプロパティを追加します

リクエスト

パス・パラメータ

• fppServerId(必須): string
  FPPサーバーのID

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

• application/json

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

ルート・スキーマ: schema

型: object

すべてに一致

ソースの表示

• object PropertySummary
  プロパティの詳細

{
    "type":"object",
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/PropertySummary"
        }
    ]
}

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

型: object

プロパティの詳細

ソースの表示

• name(必須): string
  プロパティの名前
• value(必須): string
  プロパティの値

{
    "description":"Details of the property",
    "type":"object",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "description":"Name of the property",
            "type":"string"
        },
        "value":{
            "description":"Value of the property",
            "type":"string"
        }
    }
}

例

例の選択 ペイロード

先頭に戻る

レスポンス

201レスポンス

FPPサーバー・プロパティが追加されました。

ヘッダー

• Location:
  例

  例の選択 場所

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

先頭に戻る