Jump to

• Request
• Response
• Examples

Update all custom key values

patch

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

This method replaces the UserKeyValue relationship of the User object with the list of UserKeyValue objects.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string
  The unique identifier of the User object

Body ()

The List of UserKeyValue objects

Root Schema : List UserKeyValueKey

Type: object

Title: List UserKeyValueKey

Show Source

• items(optional): array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object UserKeyValueKey
  Title: UserKeyValueKey

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

Nested Schema : UserKeyValueKey

Type: object

Title: UserKeyValueKey

Show Source

• links(optional): array links
• recordId(optional): string
  The unique identifier that represents a userKeyValue resource.

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

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Nested Schema : instanceLink

Type: object

Metadata describing link description objects that MAY appear in the JSON instance representation.

Show Source

• href: string
  URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true.
• mediaType(optional): string
  Media type, as defined by RFC 2046, describing the link target.
• method(optional): string
  HTTP method for requesting the target of the link.
• profile(optional): string
  Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
• rel: string
  Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
• templated(optional): boolean
  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.

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

Back to Top

Response

204 Response

No Content.

Back to Top

Examples

The following example shows how to update the User Key Value relationship of the user object with the list of User Key Value objects by submitting a patch request on the REST resource using cURL.

cURL Command Example

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

Example of Request Body

The following shows an example of the request body in JSON format.

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

Example of Response Body

The following shows an example of the response body in JSON format.

This request does not return any response body.

Back to Top