Jump to

• Request
• Response
• Examples

Update a user key value

put

/km/api/v1/users/{userId}/userKeyValues/{id}

This method updates a UserKeyValue object having the specified user key value ID.

Example URI

The example URI for this method is as follows:

• http://<IM_REST_API_HOST>/km/api/latest/users/{userId}/userKeyValues/{id}

  This request updates a UserKeyValue object having the specified user key value ID.

Response Errors

The possible error responses for this method are as follows:

• OK-GEN0024

  The error occurs when the record Id of the specified UserKeyValue in the service request does not match the userKeyValue.recordId parameter value.

• OK-GEN0005

  The error occurs in either of the following cases:

  • A user record for the specified ID does not exist.
  • The parameter values of userKeyValue.key, userinformation, or userinformation.reocrdId are null.

• OK-GEN0012

  The error occurs when the userKeyValue.key parameter value is not same as the previously stored value.

• OKDOM-USERKV0002

  The error occurs when the specified user record Id does not match the userinformation.recordId parameter value.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id(required): string
  The unique identifier of the object to be updated.

Body ()

The object to be updated.

Root Schema : UserKeyValue

Type: object

Title: UserKeyValue

Show Source

• dateAdded: string(date-time)
  The date when the UserKeyValue object was created.
• dateModified: string(date-time)
  The date when the UserKeyValue object was last modified.
• key: string
  The key associated with the UserKeyValue object. This field is related to the value field for a user. FAVORITES is an example key.
• links: array links
• recordId: string
  The unique identifier that represents a userKeyValue resource.
• userInformation: object UserKey
  Title: UserKey
• value: string
  The value associated with the UserKeyValue object. This field is related to the key field for a user. FAQ1, FAQ23, FAQ44 are example values.

{
    "title":"UserKeyValue",
    "properties":{
        "recordId":{
            "description":"The unique identifier that represents a userKeyValue resource.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date when the UserKeyValue object was last modified.",
            "format":"date-time",
            "type":"string"
        },
        "value":{
            "description":"The value associated with the UserKeyValue object. This field is related to the key field for a user. FAQ1, FAQ23, FAQ44 are example values.",
            "type":"string"
        },
        "dateAdded":{
            "description":"The date when the UserKeyValue object was created.",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "userInformation":{
            "description":"The relationship between the user and object.",
            "$ref":"#/definitions/UserKey"
        },
        "key":{
            "description":"The key associated with the UserKeyValue object. This field is related to the value field for a user. FAVORITES is an example key.",
            "type":"string"
        }
    }
}

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 : UserKey

Type: object

Title: UserKey

Show Source

• email: string
  Email of the User object
• externalId: integer
  The ExternalId is the Id of the corresponding User from an external system. It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.
• externalType: string
  The ExternalType is the type of the corresponding User from an external system. It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.
• links: array links
• name: string
  User's full name
• recordId: string
  The unique record ID of the User object.

{
    "title":"UserKey",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the User object.",
            "type":"string"
        },
        "externalType":{
            "description":"The ExternalType is the type of the corresponding User from an external system.  It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.",
            "type":"string"
        },
        "email":{
            "description":"Email of the User object",
            "type":"string"
        },
        "name":{
            "description":"User's full name",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "externalId":{
            "description":"The ExternalId is the Id of the corresponding User from an external system.  It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.",
            "type":"integer"
        }
    }
}

Nested Schema : instanceLink

Type: object

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

Show Source

• href(required): 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: string
  Media type, as defined by RFC 2046, describing the link target.
• method: string
  HTTP method for requesting the target of the link.
• profile: string
  Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
• rel(required): 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: 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"
}

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK.

Body ()

Root Schema : UserKeyValue

Type: object

Title: UserKeyValue

Show Source

• dateAdded: string(date-time)
  The date when the UserKeyValue object was created.
• dateModified: string(date-time)
  The date when the UserKeyValue object was last modified.
• key: string
  The key associated with the UserKeyValue object. This field is related to the value field for a user. FAVORITES is an example key.
• links: array links
• recordId: string
  The unique identifier that represents a userKeyValue resource.
• userInformation: object UserKey
  Title: UserKey
• value: string
  The value associated with the UserKeyValue object. This field is related to the key field for a user. FAQ1, FAQ23, FAQ44 are example values.

{
    "title":"UserKeyValue",
    "properties":{
        "recordId":{
            "description":"The unique identifier that represents a userKeyValue resource.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date when the UserKeyValue object was last modified.",
            "format":"date-time",
            "type":"string"
        },
        "value":{
            "description":"The value associated with the UserKeyValue object. This field is related to the key field for a user. FAQ1, FAQ23, FAQ44 are example values.",
            "type":"string"
        },
        "dateAdded":{
            "description":"The date when the UserKeyValue object was created.",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "userInformation":{
            "description":"The relationship between the user and object.",
            "$ref":"#/definitions/UserKey"
        },
        "key":{
            "description":"The key associated with the UserKeyValue object. This field is related to the value field for a user. FAVORITES is an example key.",
            "type":"string"
        }
    }
}

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 : UserKey

Type: object

Title: UserKey

Show Source

• email: string
  Email of the User object
• externalId: integer
  The ExternalId is the Id of the corresponding User from an external system. It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.
• externalType: string
  The ExternalType is the type of the corresponding User from an external system. It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.
• links: array links
• name: string
  User's full name
• recordId: string
  The unique record ID of the User object.

{
    "title":"UserKey",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the User object.",
            "type":"string"
        },
        "externalType":{
            "description":"The ExternalType is the type of the corresponding User from an external system.  It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.",
            "type":"string"
        },
        "email":{
            "description":"Email of the User object",
            "type":"string"
        },
        "name":{
            "description":"User's full name",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "externalId":{
            "description":"The ExternalId is the Id of the corresponding User from an external system.  It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.",
            "type":"integer"
        }
    }
}

Nested Schema : instanceLink

Type: object

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

Show Source

• href(required): 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: string
  Media type, as defined by RFC 2046, describing the link target.
• method: string
  HTTP method for requesting the target of the link.
• profile: string
  Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
• rel(required): 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: 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"
}

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

Back to Top

Examples

The following example shows how to update the User Key Value object for the specified user ID by submitting a post request on the REST resource using cURL.

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

Example of Request Body

The following example shows the contents of the request body in JSON format:

{
  "recordId" : "75F56044C4D94DC181CDA898D0F0B3E2",
  "userInformation" : {
    "recordId" : "62AE91CBB23A49668BC7B9A220B696C7",
    "name" : "User Name",
    "externalId" : 12345,
    "externalType" : "CONTACT",
    "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}"
  } ],
  "dateAdded" : "2013-04-23T20:06:43-0500",
  "dateModified" : "2017-03-28T14:48:21-0500",
  "key" : "FAVORITES2",
  "value" : "FAQ1,FAQ23,FAQ44"
}

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "userInformation": {
    "recordId": "62AE91CBB23A49668BC7B9A220B696C7",
    "name": "User Name",
    "externalType": "ACCOUNT",
    "links": [
      {
        "rel": "canonical",
        "href": "http://IM_REST_API_HOST/km/api/latest/users/62AE91CBB23A49668BC7B9A220B696C7",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  },
  "recordId": "75F56044C4D94DC181CDA898D0F0B3E2",
  "links": [
    {
      "rel": "canonical",
      "href": "http://IM_REST_API_HOST/km/api/latest/users/62AE91CBB23A49668BC7B9A220B696C7/userKeyValues/75F56044C4D94DC181CDA898D0F0B3E2",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    },
    {
      "rel": "collection",
      "href": "http://IM_REST_API_HOST/km/api/latest/users/62AE91CBB23A49668BC7B9A220B696C7/userKeyValues",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    }
  ],
  "dateAdded": "2017-03-28T14:48:21-0500",
  "dateModified": "2017-03-28T14:48:21-0500",
  "key": "FAVORITES2",
  "value": "FAQ1,FAQ23,FAQ44"
}

Back to Top