Jump to: navigation, search

Update Record In State Extension

ApiRef2.png PUT /services/${service_id}/state/${state_id}extensions/${ext_name}/by/unique
Available since: 8.0.200.00

Description

Updates the content of a single record in a multi-valued extension for a given state of a given service. The attributes which are part of the 'unique' list specified at the Extension Schema creation are passed in the body and are used to find the correct record to update. Important.png This update cannot change the values of the attributes which are part of the 'unique' list specified at the Extension Schema creation. 'Unique' attributes identify which record should be updated.

Operation

Prerequisites: The extension record exists.
ID CV.WS.SRV.20
Method PUT
URL /services/${service_id}/states/${state_id}/extensions/${ext_name}/by/unique
Parameter   Type   Mandatory Description
URI Parameters
${service_id} long yes The service ID.
${state_id} integer yes The state ID.
${ext_name} string yes The name of the State Extension to update.
Body<ref>Record attributes for the State Extension.</ref>
<attribute n>
  • string
  • integer
  • long
  • double
  • date
  • datetime
  • currency
  • boolean
yes Individual attributes defined in the State 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.

<references />

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 'Tons of Hill, Paris' record of extension relatedOffers in service 8389.

PUT /services/8389/states/1/extensions/Satisfaction/by/unique
{
   "rating":2,
   "pertinence":8,
   "usefull":true,
   "place":"Tons of Hill, Paris"
  }

Result

204 No Content
This page was last modified on November 23, 2017, at 09:00.

Feedback

Comment on this article:

blog comments powered by Disqus