XaitCPQ API

GET algorithm/all

Get all active algorithms

Request Information

URI

https://ofd-api.blueprintcpq.net/algorithm/all

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of algorithms

Collection of VisualScript
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
Name

string

None.
TestProduct

globally unique identifier

None.
Active

boolean

None.
BlocklyXML

string

None.
Script

string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": "8f310298-14ac-4cdc-8cb8-08b7ff11c0b1",
    "Name": "sample string 2",
    "TestProduct": "ef1a4fcf-98b0-435e-9ef3-0d52631ac0f4",
    "Active": true,
    "BlocklyXML": "sample string 4",
    "Script": "sample string 5"
  },
  {
    "Id": "8f310298-14ac-4cdc-8cb8-08b7ff11c0b1",
    "Name": "sample string 2",
    "TestProduct": "ef1a4fcf-98b0-435e-9ef3-0d52631ac0f4",
    "Active": true,
    "BlocklyXML": "sample string 4",
    "Script": "sample string 5"
  }
]

text/html

Sample: 
[{"Id":"8f310298-14ac-4cdc-8cb8-08b7ff11c0b1","Name":"sample string 2","TestProduct":"ef1a4fcf-98b0-435e-9ef3-0d52631ac0f4","Active":true,"BlocklyXML":"sample string 4","Script":"sample string 5"},{"Id":"8f310298-14ac-4cdc-8cb8-08b7ff11c0b1","Name":"sample string 2","TestProduct":"ef1a4fcf-98b0-435e-9ef3-0d52631ac0f4","Active":true,"BlocklyXML":"sample string 4","Script":"sample string 5"}]

application/xml, text/xml

Sample: 
<ArrayOfVisualScript xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <VisualScript>
    <Active>true</Active>
    <BlocklyXML>sample string 4</BlocklyXML>
    <Name>sample string 2</Name>
    <Script>sample string 5</Script>
    <TestProduct>ef1a4fcf-98b0-435e-9ef3-0d52631ac0f4</TestProduct>
    <Id>8f310298-14ac-4cdc-8cb8-08b7ff11c0b1</Id>
  </VisualScript>
  <VisualScript>
    <Active>true</Active>
    <BlocklyXML>sample string 4</BlocklyXML>
    <Name>sample string 2</Name>
    <Script>sample string 5</Script>
    <TestProduct>ef1a4fcf-98b0-435e-9ef3-0d52631ac0f4</TestProduct>
    <Id>8f310298-14ac-4cdc-8cb8-08b7ff11c0b1</Id>
  </VisualScript>
</ArrayOfVisualScript>