PUT data/{name}/{id}
Update data by record Id.
Request Information
URI
https://ofd-api.blueprintcpq.net/data/{name}/{id}?share={share}
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
name |
Page name. |
string |
Required |
id |
Record Identifier. |
string |
Required |
share |
Optional share identifier. |
globally unique identifier |
None. |
Body Parameters
Values to update.
Collection of SectionDataName | Description | Type | Additional information |
---|---|---|---|
Section | string |
None. |
|
Locked | boolean |
None. |
|
CurrencyField | globally unique identifier |
None. |
|
Data | Collection of DataValue |
None. |
Request Formats
application/json, text/json
Sample:
[ { "Section": "sample string 1", "Locked": true, "CurrencyField": "90b056d0-7b64-47ba-81ae-bbd11aa315cc", "Data": [ { "Field": "7d247340-b5e3-4b83-b99b-01d2a7998065", "FieldName": "sample string 2", "Locked": true, "Component": "sample string 4", "Value": {}, "HumanReadableValue": {} }, { "Field": "7d247340-b5e3-4b83-b99b-01d2a7998065", "FieldName": "sample string 2", "Locked": true, "Component": "sample string 4", "Value": {}, "HumanReadableValue": {} } ] }, { "Section": "sample string 1", "Locked": true, "CurrencyField": "90b056d0-7b64-47ba-81ae-bbd11aa315cc", "Data": [ { "Field": "7d247340-b5e3-4b83-b99b-01d2a7998065", "FieldName": "sample string 2", "Locked": true, "Component": "sample string 4", "Value": {}, "HumanReadableValue": {} }, { "Field": "7d247340-b5e3-4b83-b99b-01d2a7998065", "FieldName": "sample string 2", "Locked": true, "Component": "sample string 4", "Value": {}, "HumanReadableValue": {} } ] } ]
text/html
Sample:
[{"Section":"sample string 1","Locked":true,"CurrencyField":"90b056d0-7b64-47ba-81ae-bbd11aa315cc","Data":[{"Field":"7d247340-b5e3-4b83-b99b-01d2a7998065","FieldName":"sample string 2","Locked":true,"Component":"sample string 4","Value":{},"HumanReadableValue":{}},{"Field":"7d247340-b5e3-4b83-b99b-01d2a7998065","FieldName":"sample string 2","Locked":true,"Component":"sample string 4","Value":{},"HumanReadableValue":{}}]},{"Section":"sample string 1","Locked":true,"CurrencyField":"90b056d0-7b64-47ba-81ae-bbd11aa315cc","Data":[{"Field":"7d247340-b5e3-4b83-b99b-01d2a7998065","FieldName":"sample string 2","Locked":true,"Component":"sample string 4","Value":{},"HumanReadableValue":{}},{"Field":"7d247340-b5e3-4b83-b99b-01d2a7998065","FieldName":"sample string 2","Locked":true,"Component":"sample string 4","Value":{},"HumanReadableValue":{}}]}]
application/xml, text/xml
Sample:
<ArrayOfSectionData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels"> <SectionData> <CurrencyField>90b056d0-7b64-47ba-81ae-bbd11aa315cc</CurrencyField> <Data> <DataValue> <Component>sample string 4</Component> <Field>7d247340-b5e3-4b83-b99b-01d2a7998065</Field> <FieldName>sample string 2</FieldName> <HumanReadableValue /> <Locked>true</Locked> <Value /> </DataValue> <DataValue> <Component>sample string 4</Component> <Field>7d247340-b5e3-4b83-b99b-01d2a7998065</Field> <FieldName>sample string 2</FieldName> <HumanReadableValue /> <Locked>true</Locked> <Value /> </DataValue> </Data> <Locked>true</Locked> <Section>sample string 1</Section> </SectionData> <SectionData> <CurrencyField>90b056d0-7b64-47ba-81ae-bbd11aa315cc</CurrencyField> <Data> <DataValue> <Component>sample string 4</Component> <Field>7d247340-b5e3-4b83-b99b-01d2a7998065</Field> <FieldName>sample string 2</FieldName> <HumanReadableValue /> <Locked>true</Locked> <Value /> </DataValue> <DataValue> <Component>sample string 4</Component> <Field>7d247340-b5e3-4b83-b99b-01d2a7998065</Field> <FieldName>sample string 2</FieldName> <HumanReadableValue /> <Locked>true</Locked> <Value /> </DataValue> </Data> <Locked>true</Locked> <Section>sample string 1</Section> </SectionData> </ArrayOfSectionData>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
True if it succeeds, false if it fails.
booleanResponse Formats
application/json, text/json, text/html
Sample:
true
application/xml, text/xml
Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>