Maintenance Notice - PDF Generation
Dynamic PDF generation for web-based content is temporarily unavailable. This maintenance affects dynamic PDF files that are generated from either the HTML-based page or manual that you are viewing. Links that normally allow this functionality have been hidden, and will reappear as soon as the feature is restored.


Note: Access to static files, including PDF files that are not dynamically generated from our web-based content, is unaffected.

Jump to: navigation, search

Update State Extension

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

Description

This operation replaces the extension value with a new extension value. The former value of the extension is lost.

Operation

Updates a state's extension value
ID CV.WS.SRV.17
Method PUT
URL /services/${service_id}/states/${state_id}/extensions/${ext_name}
Name   Type   Mandatory Description
URI Parameters
${service_id} integer yes The ID of the service.
${state_id} integer yes The ID of the state.
${ext_name} string yes The name of the extension.
Body
<attribute n> value yes Values for one or more extension attributes (previously defined through the Create State Extension Schema operation).

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 200
HTTP message OK

Example

Operation: Update a multi-valued extension

 PUT /services/8389/states/1/extensions/Satisfaction
 [
  {
  "rating":2,
  "pertinence":8,
  "usefull":true,
  "place":"Terranova mexico resort"
 },
 {
  "rating":8,
  "pertinence":4,
  "usefull":false,
  "place":"Fancy resort Paris"
 }
]

Result

 200 OK

Operation: Update a single-valued extension

 PUT /services/8389/states/1/extensions/Feedback
 {
    "FeedbackType":"survey",
    "rating":7,
    "notes":"warm welcome at frontdesk, thanks for the nice trip"
 }

Result

 200 OK
This page was last edited on November 23, 2017, at 16:00.

Feedback

Comment on this article:

blog comments powered by Disqus