XaitCPQ API

PUT data/{name}/{id}

Update data by record Id.

Request Information

URI

https://ofd-api.blueprintcpq.net/data/{name}/{id}?share={share}

URI Parameters

NameDescriptionTypeAdditional 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 SectionData
NameDescriptionTypeAdditional 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": "5c583ad5-8a2a-4ff6-a564-e18f1b7ee799",
    "Data": [
      {
        "Field": "0456a1a0-43b4-42c2-9cd2-085adbcb0524",
        "FieldName": "sample string 2",
        "Locked": true,
        "Component": "sample string 4",
        "Value": {},
        "HumanReadableValue": {}
      },
      {
        "Field": "0456a1a0-43b4-42c2-9cd2-085adbcb0524",
        "FieldName": "sample string 2",
        "Locked": true,
        "Component": "sample string 4",
        "Value": {},
        "HumanReadableValue": {}
      }
    ]
  },
  {
    "Section": "sample string 1",
    "Locked": true,
    "CurrencyField": "5c583ad5-8a2a-4ff6-a564-e18f1b7ee799",
    "Data": [
      {
        "Field": "0456a1a0-43b4-42c2-9cd2-085adbcb0524",
        "FieldName": "sample string 2",
        "Locked": true,
        "Component": "sample string 4",
        "Value": {},
        "HumanReadableValue": {}
      },
      {
        "Field": "0456a1a0-43b4-42c2-9cd2-085adbcb0524",
        "FieldName": "sample string 2",
        "Locked": true,
        "Component": "sample string 4",
        "Value": {},
        "HumanReadableValue": {}
      }
    ]
  }
]

text/html

Sample: 
[{"Section":"sample string 1","Locked":true,"CurrencyField":"5c583ad5-8a2a-4ff6-a564-e18f1b7ee799","Data":[{"Field":"0456a1a0-43b4-42c2-9cd2-085adbcb0524","FieldName":"sample string 2","Locked":true,"Component":"sample string 4","Value":{},"HumanReadableValue":{}},{"Field":"0456a1a0-43b4-42c2-9cd2-085adbcb0524","FieldName":"sample string 2","Locked":true,"Component":"sample string 4","Value":{},"HumanReadableValue":{}}]},{"Section":"sample string 1","Locked":true,"CurrencyField":"5c583ad5-8a2a-4ff6-a564-e18f1b7ee799","Data":[{"Field":"0456a1a0-43b4-42c2-9cd2-085adbcb0524","FieldName":"sample string 2","Locked":true,"Component":"sample string 4","Value":{},"HumanReadableValue":{}},{"Field":"0456a1a0-43b4-42c2-9cd2-085adbcb0524","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>5c583ad5-8a2a-4ff6-a564-e18f1b7ee799</CurrencyField>
    <Data>
      <DataValue>
        <Component>sample string 4</Component>
        <Field>0456a1a0-43b4-42c2-9cd2-085adbcb0524</Field>
        <FieldName>sample string 2</FieldName>
        <HumanReadableValue />
        <Locked>true</Locked>
        <Value />
      </DataValue>
      <DataValue>
        <Component>sample string 4</Component>
        <Field>0456a1a0-43b4-42c2-9cd2-085adbcb0524</Field>
        <FieldName>sample string 2</FieldName>
        <HumanReadableValue />
        <Locked>true</Locked>
        <Value />
      </DataValue>
    </Data>
    <Locked>true</Locked>
    <Section>sample string 1</Section>
  </SectionData>
  <SectionData>
    <CurrencyField>5c583ad5-8a2a-4ff6-a564-e18f1b7ee799</CurrencyField>
    <Data>
      <DataValue>
        <Component>sample string 4</Component>
        <Field>0456a1a0-43b4-42c2-9cd2-085adbcb0524</Field>
        <FieldName>sample string 2</FieldName>
        <HumanReadableValue />
        <Locked>true</Locked>
        <Value />
      </DataValue>
      <DataValue>
        <Component>sample string 4</Component>
        <Field>0456a1a0-43b4-42c2-9cd2-085adbcb0524</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.

boolean

Response 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>