XaitCPQ API

PUT algorithm/{id}

Saves a script.

Request Information

URI

https://ofd-api.blueprintcpq.net/algorithm/{id}

URI Parameters

NameDescriptionTypeAdditional information
id

The identifier.

 globally unique identifier

Required

Body Parameters

The visual script.

VisualScriptEdit
NameDescriptionTypeAdditional information
Name

string

None.
TestProduct

globally unique identifier

None.
Active

boolean

None.
BlocklyXML

string

None.
Script

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Name": "sample string 1",
  "TestProduct": "18418f42-0c91-41b3-85cf-fef96dac77f1",
  "Active": true,
  "BlocklyXML": "sample string 3",
  "Script": "sample string 4"
}

text/html

Sample: 
{"Name":"sample string 1","TestProduct":"18418f42-0c91-41b3-85cf-fef96dac77f1","Active":true,"BlocklyXML":"sample string 3","Script":"sample string 4"}

application/xml, text/xml

Sample: 
<VisualScriptEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <Active>true</Active>
  <BlocklyXML>sample string 3</BlocklyXML>
  <Name>sample string 1</Name>
  <Script>sample string 4</Script>
  <TestProduct>18418f42-0c91-41b3-85cf-fef96dac77f1</TestProduct>
</VisualScriptEdit>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A VisualScript.

globally unique identifier

Response Formats

application/json, text/json, text/html

Sample: 
"aae97ba3-8eb5-4ad9-a9f1-442e7687c925"

application/xml, text/xml

Sample: 
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">aae97ba3-8eb5-4ad9-a9f1-442e7687c925</guid>