XaitCPQ API

POST data/batch/{name}/{id}

Update and add new data in a batch

Request Information

URI

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

URI Parameters

NameDescriptionTypeAdditional information
name

Page name.

 string

Required
id

Base record identifier

 string

None.
share

Optional share identifier.

 globally unique identifier

None.

Body Parameters

List of record to add or update.

Collection of BatchSectionData
NameDescriptionTypeAdditional information
Section

string

None.
Data

Collection of RowData

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "Section": "sample string 1",
    "Data": null
  },
  {
    "Section": "sample string 1",
    "Data": null
  }
]

text/html

Sample: 
[{"Section":"sample string 1","Data":null},{"Section":"sample string 1","Data":null}]

application/xml, text/xml

Sample: 
<ArrayOfBatchSectionData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <BatchSectionData>
    <Data i:nil="true" />
    <Section>sample string 1</Section>
  </BatchSectionData>
  <BatchSectionData>
    <Data i:nil="true" />
    <Section>sample string 1</Section>
  </BatchSectionData>
</ArrayOfBatchSectionData>

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>