POST xaitporter/publish
Publish API allows the XaitCPQ user to update the Table in XaitPorter by passing the XaitCPQ user selected table from Publish Dialog. The object with its property set to the XaitCPQ merge table data is what is all required. Optionally, you may also set to manage the rendering in the XP document as well as the .
Request Information
URI
https://ofd-api.blueprintcpq.net/xaitporter/publish
URI Parameters
None.
Body Parameters
XaitPorterPublishOptionsName | Description | Type | Additional information |
---|---|---|---|
Page | string |
None. |
|
View | string |
None. |
|
SectionId | string |
None. |
|
RecordId | string |
None. |
|
XpId | integer |
None. |
|
XpReference | integer |
None. |
|
XpName | string |
None. |
|
XpDocumentId | integer |
None. |
|
XpDocumentTitle | string |
None. |
|
XpDocumentLink | string |
None. |
|
XpSectionId | integer |
None. |
|
XpSectionTitle | string |
None. |
|
XpSectionLink | string |
None. |
|
XpProjectId | integer |
None. |
|
TableTag | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Page": "sample string 1", "View": "sample string 2", "SectionId": "sample string 3", "RecordId": "sample string 4", "XpId": 5, "XpReference": 6, "XpName": "sample string 7", "XpDocumentId": 8, "XpDocumentTitle": "sample string 9", "XpDocumentLink": "sample string 10", "XpSectionId": 11, "XpSectionTitle": "sample string 12", "XpSectionLink": "sample string 13", "XpProjectId": 14, "TableTag": "sample string 15" }
text/html
Sample:
{"Page":"sample string 1","View":"sample string 2","SectionId":"sample string 3","RecordId":"sample string 4","XpId":5,"XpReference":6,"XpName":"sample string 7","XpDocumentId":8,"XpDocumentTitle":"sample string 9","XpDocumentLink":"sample string 10","XpSectionId":11,"XpSectionTitle":"sample string 12","XpSectionLink":"sample string 13","XpProjectId":14,"TableTag":"sample string 15"}
application/xml, text/xml
Sample:
<XaitPorterPublishOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels"> <Page>sample string 1</Page> <RecordId>sample string 4</RecordId> <SectionId>sample string 3</SectionId> <TableTag>sample string 15</TableTag> <View>sample string 2</View> <XpDocumentId>8</XpDocumentId> <XpDocumentLink>sample string 10</XpDocumentLink> <XpDocumentTitle>sample string 9</XpDocumentTitle> <XpId>5</XpId> <XpName>sample string 7</XpName> <XpProjectId>14</XpProjectId> <XpReference>6</XpReference> <XpSectionId>11</XpSectionId> <XpSectionLink>sample string 13</XpSectionLink> <XpSectionTitle>sample string 12</XpSectionTitle> </XaitPorterPublishOptions>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
object containing outcome or Error along with the URL to the XaitPorter section containing the published table.
XpPublishResultName | Description | Type | Additional information |
---|---|---|---|
SectionURL | string |
None. |
|
Success | boolean |
None. |
|
Error | RESTError |
None. |
Response Formats
application/json, text/json
Sample:
{ "SectionURL": "sample string 1", "Success": true, "Error": null }
text/html
Sample:
{"SectionURL":"sample string 1","Success":true,"Error":null}
application/xml, text/xml
Sample:
<XpPublishResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Xait.XaitPorter.Integration"> <Error i:nil="true" /> <Success>true</Success> </XpPublishResult>