ジャンプ先

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

ユーザー・プロファイルへの新規デバイスの追加

post

https://oaainstall-host/risk-analyzer/device/v1/{requestId}

ユーザー・プロファイルに新しいデバイスを追加します。複数のデバイスを単一のリクエストに追加できます。また、追加時にデバイスを安全としてマークすることもできます

リクエスト

パス・パラメータ

• requestId(required): string

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

• application/xml
• application/json

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

ルート・スキーマ: schema

型: object

ユーザー・デバイス作成リクエスト

ソースを表示

• friendlyName: string
  デバイスのわかりやすい名前。
• markSafe: boolean
  trueまたはfalseの値に基づいて、リクエストIDに関連付けられたデバイスを、安全または安全でないとマークします。

{
    "description":"User device create request",
    "properties":{
        "markSafe":{
            "type":"boolean",
            "description":"mark the device, associated with request id, safe or unsafe based in the true or false value."
        },
        "friendlyName":{
            "type":"string",
            "description":"friendly name of the device."
        }
    }
}

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

ルート・スキーマ: schema

型: object

ユーザー・デバイス作成リクエスト

ソースを表示

• friendlyName: string
  デバイスのわかりやすい名前。
• markSafe: boolean
  trueまたはfalseの値に基づいて、リクエストIDに関連付けられたデバイスを、安全または安全でないとマークします。

{
    "description":"User device create request",
    "properties":{
        "markSafe":{
            "type":"boolean",
            "description":"mark the device, associated with request id, safe or unsafe based in the true or false value."
        },
        "friendlyName":{
            "type":"string",
            "description":"friendly name of the device."
        }
    }
}

先頭に戻る

レスポンス

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

• application/xml
• application/json
• text/plain

201レスポンス

ユーザー・デバイスが作成され、ユーザー・プロファイルに追加されます。

本文()

ルート・スキーマ: UserDeviceApiResponse

型: object

RESTコールのステータスに対するユーザー・デバイスAPIレスポンス

ソースを表示

• responseCode: string
  リクエストのステータス・コード
• responseMessage: string
  レスポンス・コードに関連するレスポンス・メッセージ(必要に応じて)。
• success: boolean
  操作のステータス

{
    "type":"object",
    "description":"User device API response for status of the rest call",
    "properties":{
        "success":{
            "type":"boolean",
            "description":"status of the operation."
        },
        "responseCode":{
            "type":"string",
            "description":"status code of the request"
        },
        "responseMessage":{
            "type":"string",
            "description":"response message related to the response code if needed."
        }
    }
}

401レスポンス

未認可

405レスポンス

無効な入力

本文()

ルート・スキーマ: UserDeviceApiResponse

型: object

RESTコールのステータスに対するユーザー・デバイスAPIレスポンス

ソースを表示

• responseCode: string
  リクエストのステータス・コード
• responseMessage: string
  レスポンス・コードに関連するレスポンス・メッセージ(必要に応じて)。
• success: boolean
  操作のステータス

{
    "type":"object",
    "description":"User device API response for status of the rest call",
    "properties":{
        "success":{
            "type":"boolean",
            "description":"status of the operation."
        },
        "responseCode":{
            "type":"string",
            "description":"status code of the request"
        },
        "responseMessage":{
            "type":"string",
            "description":"response message related to the response code if needed."
        }
    }
}

500レスポンス

内部サーバー・エラー

503レスポンス

サービス使用不可

先頭に戻る