タイトル: リソースのプロパティ値について Slug: api-api-property-values

リソースのプロパティ値について

リソースプロパティまたは Workload Security 設定の値を設定する際に注意する必要がある点がいくつかあります。

ヌル値の表現方法

APIを使用して null 値を表すには、 0 （ゼロ）を使用します。たとえば、 0 をコンピュータのpolicyIDとして使用する場合、コンピュータは nullとして解釈され、コンピュータには割り当てられたポリシーはありません。

これは、APIを直接使用する場合に適用されることに注意してください。クライアントライブラリはnull値の使用をサポートしています。

ブール値のプロパティの有効な値

APIを使用する場合は、Booleanプロパティの値として true または false のいずれかを使用する必要があります。その他の値はエラーを返します。

値を指定しない場合 (nullなど)、 false が初期設定値になります。

リソースの変更時に変更された値のみを含める

操作を使用してリソースを変更する場合は、変更する必要があるプロパティのみを指定します。たとえば、ポリシーの名前を変更するには、ポリシーオブジェクトにnameプロパティを指定します。他のすべてのプロパティはnullまたは指定されていません。このパターンファイルはREST APIの典型的なパターンです。

Python、JavaScript、Javaなどのプログラミング言語を使用する場合、リソースを表すオブジェクトを取得したり、プロパティを変更したり、アップデート呼び出しでオブジェクトを返すことに慣れている可能性があります。ただし、Workload Securityクライアントライブラリを使用してオブジェクトを作成する場合は、変更する値のみを設定し、そのオブジェクトをアップデート呼び出しで使用します。この例では、ポリシー名のみが変更されます。

policy = api.Policy()
policy.name = policy_name
policy_api = api.PoliciesApi()
policy_api.modifyPolicy(policyID, policy, false, "v1")