Jump to: navigation, search

Update Record In Task Extension

ApiRef2.png PUT /services/${service_id}/task/${task_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 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.21
Method PUT
URL /services/${service_id}/tasks/${state_id}/extensions/${ext_name}/by/unique
Parameter   Type   Mandatory Description
URI Parameters
${service_id} long yes The service ID.
${task_id} integer yes The state ID.
${ext_name} string yes The name of the Task Extension to update.
Body<ref>Record attributes for the Task Extension.</ref>
<attribute n>
  • string
  • integer
  • long
  • double
  • date
  • datetime
  • currency
  • boolean
yes Individual attributes defined in the Task Extension Schema.
<attribute n> corresponds to the attribute name defined in the schema.

<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 "cabriolet" record of the Proposal extension in the task 1 of service 8389.

PUT /services/8389/tasks/1/extensions/Proposal/by/unique
{
    "car type":"cabriolet",
    "price":25 000,
    "seats":3,
    "comments":"250 cv, hardtop"
}

Result

204 No Content
This page was last edited on July 17, 2020, at 15:47.
Comments or questions about this documentation? Contact us for support!