Oracle Fusionサービスでのナレッジ管理のREST API

機械翻訳について

すべてのカスタム・キー値の更新

patch

/km/api/v1/users/{id}/customKeyValues

このメソッドは、ユーザー・オブジェクトのUserKeyValue関係をUserKeyValueオブジェクトのリストに置き換えます。

リクエスト

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

application/json
application/xml

パス・パラメータ

id: string

ユーザー・オブジェクトの一意の識別子

UserKeyValueオブジェクトのリスト

ルート・スキーマ : リストUserKeyValueKey

タイプ: object

タイトル: List UserKeyValueKey

ソースを表示

items(optional): array items

{
    "title":"List UserKeyValueKey",
    "properties":{
        "items":{
            "items":{
                "$ref":"#/definitions/UserKeyValueKey"
            },
            "type":"array"
        }
    },
    "type":"object"
}

ネストされたスキーマ : アイテム

タイプ: array

ソースを表示

Array of: object UserKeyValueKey

タイトル: UserKeyValueKey

{
    "items":{
        "$ref":"#/definitions/UserKeyValueKey"
    },
    "type":"array"
}

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

タイプ: object

タイトル: UserKeyValueKey

ソースを表示

links(optional): array links
recordId(optional): string

userKeyValueリソースを表す一意の識別子。

{
    "title":"UserKeyValueKey",
    "properties":{
        "recordId":{
            "description":"The unique identifier that represents a userKeyValue resource.",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

ソースを表示

Array of: object instanceLink

JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

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

タイプ: object

JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

ソースを表示

href: string

URI [RFC3986]またはURIテンプレート[RFC6570]。値がURI Templateに設定されている場合、「templated」プロパティをtrueに設定する必要があります。
mediaType(optional): string

RFC 2046で定義された、リンク・ターゲットを説明するメディア・タイプ。
method(optional): string

リンクのターゲットをリクエストするためのHTTPメソッド。
profile(optional): string

ターゲット・リソースの参照解除時に予期されるリソースを記述する、JSONスキーマなどのリソースのメタデータへのリンク。
rel: string

リンクの詳細を取得するためにタイプ・プロパティに加えて使用できるリンク関係の名前。たとえば、hrefやprofileです。
templated(optional): boolean

hrefプロパティがURIまたはURIテンプレートであることを指定するブール・フラグ。プロパティがURIテンプレートの場合は、この値をtrueに設定します。デフォルトでは、この値はfalseです。

{
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "templated":{
            "description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.",
            "type":"boolean"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ],
    "type":"object"
}

トップに戻る

レスポンス

204 レスポンス

コンテンツがありません。

トップに戻る

例

次の例は、cURLを使用してRESTリソースに対するパッチ・リクエストを発行することによって、ユーザー・オブジェクトのユーザー・キー値関係とユーザー・キー値オブジェクトのリストを更新する方法を示しています。

cURLコマンドの例

curl -X PATCH "https://<IM_REST_API_HOST>/km/api/latest/users/{id}/customKeyValues" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json" -d "@<FilePath/RequestBody.json>"

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
  "items" : [ {
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://IM_REST_API_HOST/km/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://IM_REST_API_HOST/km/api/{version}/metadata-catalog/{resourceName}"
    } ]
  }, {
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://IM_REST_API_HOST/km/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://IM_REST_API_HOST/km/api/{version}/metadata-catalog/{resourceName}"
    } ]
  }, {
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://IM_REST_API_HOST/km/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://IM_REST_API_HOST/km/api/{version}/metadata-catalog/{resourceName}"
    } ]
  } ]
}

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

This request does not return any response body.

「トップに戻る」