Jump to: navigation, search

Update Record In Profile Extension

Important
Prerequisites: You need to enable profiles in UCS.
PUT /profiles/${customer_id}/extensions/${ext_name}/by/unique

Description

Updates the content of a single record in a multi-valued extension. The attributes which are part of the 'unique' list specified at the Extension Schema creation are passed in the body and used to find the correct record to update.

This update cannot change the values of the attributes which are part of the 'unique' list of the Extension Schema; 'unique' attributes are used as identifiers for the given record. Workaround: If you wish to update a value for an attribute stamped as unique, you must delete the concerned record, then recreate this record with its correct values.

Operation

Prerequisites: The extension record exists.

ID CV.WS.PROF.6
Method PUT
URL /profiles/${customer_id}/extensions/${ext_name}/by/unique
Parameter   Type   Mandatory Description
URI Parameters
${customer_id} string yes The unique ID of the given customer. Limited to 16 characters.
${ext_name} string yes The name of the Profile Extension to update.
Body Record for the Profile Extension.
<attribute n>
  • string
  • integer
  • long
  • double
  • date
  • datetime
  • currency
  • boolean
yes Individual attributes defined in the Profile Extension Schema.
<attribute n> corresponds to the attribute name defined in the schema.
  • If the attribute is unique, its value is used to select the record to update. It is not updated.
  • If the attribute is not unique, its value is updated.

Response

The Context Management Service API answers with HTTP codes for every request. The following table shows the correct response for a successful request. See HTTP Response Codes and Errors for further details on the possible codes that this operation can return.

Response
HTTP code 204
HTTP message No Content

Example

Operation The following operation updates the Phone record associated with the unique "PhoneNumber":"3145926535".

PUT /profiles/0000Sb5U97XE000Y/extensions/Phone/by/unique
{
 "PhoneType":0, 
 "prefix":"+33", 
 "PhoneNumber":"3145926535",
 "description":"family phone", 
 "start_availabilty":"2009-12-18T18:30:00.000Z", 
 "end_availabilty":"2009-12-18T21:40:00.000Z"
}

Result

204 No Content with empty body

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on 7 September 2018, at 03:34.