ジャンプ先

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

ポリシーを作成する

post

/oaa-policy/policy/v1

ポリシー定義API

リクエスト

この操作にはリクエスト・パラメータはありません。

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

• application/xml
• application/json

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

ルート・スキーマ : schema

型: object

ポリシーを作成、変更およびフェッチするためのポリシー・オブジェクト。

ソースの表示

• agentgid(required): string
  ポリシーが属するエージェントの識別子
• assuranceLevelId(required): string
  ポリシーに関連付けられた保証レベルの識別子
• description(required): string
  ポリシーの説明。
• name(required): string
  ポリシー名。
• policygid: string
  ポリシーの識別子
• scoringEngine: string
  ポリシーのスコアリングに使用されるエンジン(集計済、平均、最大、最小、加重平均、加重最大、加重最小)
• status(required): string
  ポリシーのステータス。次のいずれかの値です。Active、DisabledまたはDeleted。
• weight: integer
  保証レベルに複数のポリシーがある場合、ポリシーの重みを定義する0から100までの数値。

{
    "type":"object",
    "required":[
        "agentgid",
        "assuranceLevelId",
        "name",
        "description",
        "status"
    ],
    "description":"Policy object for creating, modifying and fetching policy.",
    "properties":{
        "agentgid":{
            "type":"string",
            "description":"Identifier of the agent to which the policy belongs"
        },
        "assuranceLevelId":{
            "type":"string",
            "description":"Identifier of the assurance level which is associated with the policy"
        },
        "name":{
            "type":"string",
            "description":"Policy Name."
        },
        "description":{
            "type":"string",
            "description":"Policy description."
        },
        "status":{
            "type":"string",
            "description":"Status of the policy. It can be one of the following values. Active, Disabled or Deleted."
        },
        "scoringEngine":{
            "type":"string",
            "description":"Engine used for scoring the policy (Aggregated, Average, Maximum, Minimum, Weighted Average, Weighted Maximum, Weighted Minimum)"
        },
        "weight":{
            "type":"integer",
            "description":"Number between 0 to 100 to define the weight of the policy if there are multiple policies in the assurance level."
        },
        "policygid":{
            "type":"string",
            "description":"Identifier of the policy"
        }
    }
}

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

ルート・スキーマ : schema

型: object

ポリシーを作成、変更およびフェッチするためのポリシー・オブジェクト。

ソースの表示

• agentgid(required): string
  ポリシーが属するエージェントの識別子
• assuranceLevelId(required): string
  ポリシーに関連付けられた保証レベルの識別子
• description(required): string
  ポリシーの説明。
• name(required): string
  ポリシー名。
• policygid: string
  ポリシーの識別子
• scoringEngine: string
  ポリシーのスコアリングに使用されるエンジン(集計済、平均、最大、最小、加重平均、加重最大、加重最小)
• status(required): string
  ポリシーのステータス。次のいずれかの値です。Active、DisabledまたはDeleted。
• weight: integer
  保証レベルに複数のポリシーがある場合、ポリシーの重みを定義する0から100までの数値。

{
    "type":"object",
    "required":[
        "agentgid",
        "assuranceLevelId",
        "name",
        "description",
        "status"
    ],
    "description":"Policy object for creating, modifying and fetching policy.",
    "properties":{
        "agentgid":{
            "type":"string",
            "description":"Identifier of the agent to which the policy belongs"
        },
        "assuranceLevelId":{
            "type":"string",
            "description":"Identifier of the assurance level which is associated with the policy"
        },
        "name":{
            "type":"string",
            "description":"Policy Name."
        },
        "description":{
            "type":"string",
            "description":"Policy description."
        },
        "status":{
            "type":"string",
            "description":"Status of the policy. It can be one of the following values. Active, Disabled or Deleted."
        },
        "scoringEngine":{
            "type":"string",
            "description":"Engine used for scoring the policy (Aggregated, Average, Maximum, Minimum, Weighted Average, Weighted Maximum, Weighted Minimum)"
        },
        "weight":{
            "type":"integer",
            "description":"Number between 0 to 100 to define the weight of the policy if there are multiple policies in the assurance level."
        },
        "policygid":{
            "type":"string",
            "description":"Identifier of the policy"
        }
    }
}

先頭に戻る

レスポンス

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

• application/xml
• application/json

201レスポンス

ポリシーが作成されました

本文()

ルート・スキーマ: PolicyResponse

型: object

ソースの表示

• message: string
  リクエストのステータスに関連するメッセージ
• policy: object schema
  ポリシーを作成、変更およびフェッチするためのポリシー・オブジェクト。
• policygid: string
  ポリシーの識別子。
• status: string
  リクエストのステータス

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the request"
        },
        "message":{
            "type":"string",
            "description":"Message related to the status of the request"
        },
        "policygid":{
            "type":"string",
            "description":"Identifier of the policy."
        },
        "policy":{
            "$ref":"#/components/schemas/Policy"
        }
    }
}

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

型: object

ポリシーを作成、変更およびフェッチするためのポリシー・オブジェクト。

ソースの表示

• agentgid(required): string
  ポリシーが属するエージェントの識別子
• assuranceLevelId(required): string
  ポリシーに関連付けられた保証レベルの識別子
• description(required): string
  ポリシーの説明。
• name(required): string
  ポリシー名。
• policygid: string
  ポリシーの識別子
• scoringEngine: string
  ポリシーのスコアリングに使用されるエンジン(集計済、平均、最大、最小、加重平均、加重最大、加重最小)
• status(required): string
  ポリシーのステータス。次のいずれかの値です。Active、DisabledまたはDeleted。
• weight: integer
  保証レベルに複数のポリシーがある場合、ポリシーの重みを定義する0から100までの数値。

{
    "type":"object",
    "required":[
        "agentgid",
        "assuranceLevelId",
        "name",
        "description",
        "status"
    ],
    "description":"Policy object for creating, modifying and fetching policy.",
    "properties":{
        "agentgid":{
            "type":"string",
            "description":"Identifier of the agent to which the policy belongs"
        },
        "assuranceLevelId":{
            "type":"string",
            "description":"Identifier of the assurance level which is associated with the policy"
        },
        "name":{
            "type":"string",
            "description":"Policy Name."
        },
        "description":{
            "type":"string",
            "description":"Policy description."
        },
        "status":{
            "type":"string",
            "description":"Status of the policy. It can be one of the following values. Active, Disabled or Deleted."
        },
        "scoringEngine":{
            "type":"string",
            "description":"Engine used for scoring the policy (Aggregated, Average, Maximum, Minimum, Weighted Average, Weighted Maximum, Weighted Minimum)"
        },
        "weight":{
            "type":"integer",
            "description":"Number between 0 to 100 to define the weight of the policy if there are multiple policies in the assurance level."
        },
        "policygid":{
            "type":"string",
            "description":"Identifier of the policy"
        }
    }
}

401レスポンス

未認可

405レスポンス

無効な入力

本文()

ルート・スキーマ: PolicyResponse

型: object

ソースの表示

• message: string
  リクエストのステータスに関連するメッセージ
• policy: object schema
  ポリシーを作成、変更およびフェッチするためのポリシー・オブジェクト。
• policygid: string
  ポリシーの識別子。
• status: string
  リクエストのステータス

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the request"
        },
        "message":{
            "type":"string",
            "description":"Message related to the status of the request"
        },
        "policygid":{
            "type":"string",
            "description":"Identifier of the policy."
        },
        "policy":{
            "$ref":"#/components/schemas/Policy"
        }
    }
}

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

型: object

ポリシーを作成、変更およびフェッチするためのポリシー・オブジェクト。

ソースの表示

• agentgid(required): string
  ポリシーが属するエージェントの識別子
• assuranceLevelId(required): string
  ポリシーに関連付けられた保証レベルの識別子
• description(required): string
  ポリシーの説明。
• name(required): string
  ポリシー名。
• policygid: string
  ポリシーの識別子
• scoringEngine: string
  ポリシーのスコアリングに使用されるエンジン(集計済、平均、最大、最小、加重平均、加重最大、加重最小)
• status(required): string
  ポリシーのステータス。次のいずれかの値です。Active、DisabledまたはDeleted。
• weight: integer
  保証レベルに複数のポリシーがある場合、ポリシーの重みを定義する0から100までの数値。

{
    "type":"object",
    "required":[
        "agentgid",
        "assuranceLevelId",
        "name",
        "description",
        "status"
    ],
    "description":"Policy object for creating, modifying and fetching policy.",
    "properties":{
        "agentgid":{
            "type":"string",
            "description":"Identifier of the agent to which the policy belongs"
        },
        "assuranceLevelId":{
            "type":"string",
            "description":"Identifier of the assurance level which is associated with the policy"
        },
        "name":{
            "type":"string",
            "description":"Policy Name."
        },
        "description":{
            "type":"string",
            "description":"Policy description."
        },
        "status":{
            "type":"string",
            "description":"Status of the policy. It can be one of the following values. Active, Disabled or Deleted."
        },
        "scoringEngine":{
            "type":"string",
            "description":"Engine used for scoring the policy (Aggregated, Average, Maximum, Minimum, Weighted Average, Weighted Maximum, Weighted Minimum)"
        },
        "weight":{
            "type":"integer",
            "description":"Number between 0 to 100 to define the weight of the policy if there are multiple policies in the assurance level."
        },
        "policygid":{
            "type":"string",
            "description":"Identifier of the policy"
        }
    }
}

500レスポンス

内部サーバー・エラー

503レスポンス

サービス使用不可

先頭に戻る

例

次の例は、ポリシーを作成するサンプルのリクエストとレスポンスを示します。

JSON形式でポリシーを作成するcURLコマンド

curl --location --request POST '<PolicyUrl>/oaa-policy/policy/v1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
    "agentgid": "dede64d3-1d6a-42e9-89e1-714e88f8967c",
    "assuranceLevelId": "AssuranceLevel1",
    "name": "Policy1",
    "description": "Policy for AssuranceLevel1",
    "status": "Active"
}'

JSON形式のサンプル・レスポンス

{
    "status": "201",
    "message": "Policy created successfully.",
    "policygid": "141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171",
    "policy": {
        "agentgid": "dede64d3-1d6a-42e9-89e1-714e88f8967c",
        "assuranceLevelId": "AssuranceLevel1",
        "name": "Policy1",
        "description": "Policy for AssuranceLevel1",
        "status": "ACTIVE",
        "scoringEngine": "Average",
        "weight": 100,
        "policygid": "141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171"
    }
}

XML形式でポリシーを作成するcURLコマンド

curl --location --request POST '<PolicyUrl>/oaa-policy/policy/v1' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '<?xml version="1.0" encoding="UTF-8" ?>
 <PolicyRequest>
     <agentgid>dede64d3-1d6a-42e9-89e1-714e88f8967c</agentgid>
     <assuranceLevelId>AssuranceLevel1</assuranceLevelId>
     <name>Policy1</name>
     <description>Policy for AssuranceLevel1</description>
     <status>Active</status>
 </PolicyRequest>'

XML形式のサンプル・レスポンス

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <PolicyResponse>
     <status>201</status>
     <message>Policy created successfully.</message>
     <policygid>141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171</policygid>
     <policy>
         <agentgid>dede64d3-1d6a-42e9-89e1-714e88f8967c</agentgid>
         <assuranceLevelId>AssuranceLevel1</assuranceLevelId>
         <name>Policy1</name>
         <description>Policy for AssuranceLevel1</description>
         <status>ACTIVE</status>
         <scoringEngine>Average</scoringEngine>
         <weight>100</weight>
         <policygid>141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171</policygid>
     </policy>
 </PolicyResponse>

先頭に戻る