POST data/{name}
Add new data record.
Request Information
URI
https://ofd-api.blueprintcpq.net/data/{name}?share={share}
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
name |
Page name. |
string |
Required |
share |
Optional share identifier. |
globally unique identifier |
None. |
Body Parameters
Record to add.
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": "b04fd153-e955-4eb3-93c9-140cee747146", "Data": [ { "Field": "d98a5330-45f5-43d2-97cb-1e50c6844bf3", "FieldName": "sample string 2", "Locked": true, "Component": "sample string 4", "Value": {}, "HumanReadableValue": {} }, { "Field": "d98a5330-45f5-43d2-97cb-1e50c6844bf3", "FieldName": "sample string 2", "Locked": true, "Component": "sample string 4", "Value": {}, "HumanReadableValue": {} } ] }, { "Section": "sample string 1", "Locked": true, "CurrencyField": "b04fd153-e955-4eb3-93c9-140cee747146", "Data": [ { "Field": "d98a5330-45f5-43d2-97cb-1e50c6844bf3", "FieldName": "sample string 2", "Locked": true, "Component": "sample string 4", "Value": {}, "HumanReadableValue": {} }, { "Field": "d98a5330-45f5-43d2-97cb-1e50c6844bf3", "FieldName": "sample string 2", "Locked": true, "Component": "sample string 4", "Value": {}, "HumanReadableValue": {} } ] } ]
text/html
Sample:
[{"Section":"sample string 1","Locked":true,"CurrencyField":"b04fd153-e955-4eb3-93c9-140cee747146","Data":[{"Field":"d98a5330-45f5-43d2-97cb-1e50c6844bf3","FieldName":"sample string 2","Locked":true,"Component":"sample string 4","Value":{},"HumanReadableValue":{}},{"Field":"d98a5330-45f5-43d2-97cb-1e50c6844bf3","FieldName":"sample string 2","Locked":true,"Component":"sample string 4","Value":{},"HumanReadableValue":{}}]},{"Section":"sample string 1","Locked":true,"CurrencyField":"b04fd153-e955-4eb3-93c9-140cee747146","Data":[{"Field":"d98a5330-45f5-43d2-97cb-1e50c6844bf3","FieldName":"sample string 2","Locked":true,"Component":"sample string 4","Value":{},"HumanReadableValue":{}},{"Field":"d98a5330-45f5-43d2-97cb-1e50c6844bf3","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>b04fd153-e955-4eb3-93c9-140cee747146</CurrencyField> <Data> <DataValue> <Component>sample string 4</Component> <Field>d98a5330-45f5-43d2-97cb-1e50c6844bf3</Field> <FieldName>sample string 2</FieldName> <HumanReadableValue /> <Locked>true</Locked> <Value /> </DataValue> <DataValue> <Component>sample string 4</Component> <Field>d98a5330-45f5-43d2-97cb-1e50c6844bf3</Field> <FieldName>sample string 2</FieldName> <HumanReadableValue /> <Locked>true</Locked> <Value /> </DataValue> </Data> <Locked>true</Locked> <Section>sample string 1</Section> </SectionData> <SectionData> <CurrencyField>b04fd153-e955-4eb3-93c9-140cee747146</CurrencyField> <Data> <DataValue> <Component>sample string 4</Component> <Field>d98a5330-45f5-43d2-97cb-1e50c6844bf3</Field> <FieldName>sample string 2</FieldName> <HumanReadableValue /> <Locked>true</Locked> <Value /> </DataValue> <DataValue> <Component>sample string 4</Component> <Field>d98a5330-45f5-43d2-97cb-1e50c6844bf3</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
Id of master record.
ObjectNone.
Response Formats
application/json, text/json, text/html
Sample:
{}
application/xml, text/xml
Sample:
<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />