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 Algorithm
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
Name

string

None.
Script

string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": "6a78cf03-9c7d-4d3e-b6f7-9576d9479a18",
    "Name": "sample string 2",
    "Script": "sample string 3"
  },
  {
    "Id": "6a78cf03-9c7d-4d3e-b6f7-9576d9479a18",
    "Name": "sample string 2",
    "Script": "sample string 3"
  }
]

text/html

Sample: 
[{"Id":"6a78cf03-9c7d-4d3e-b6f7-9576d9479a18","Name":"sample string 2","Script":"sample string 3"},{"Id":"6a78cf03-9c7d-4d3e-b6f7-9576d9479a18","Name":"sample string 2","Script":"sample string 3"}]

application/xml, text/xml

Sample: 
<ArrayOfAlgorithm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <Algorithm>
    <Id>6a78cf03-9c7d-4d3e-b6f7-9576d9479a18</Id>
    <Name>sample string 2</Name>
    <Script>sample string 3</Script>
  </Algorithm>
  <Algorithm>
    <Id>6a78cf03-9c7d-4d3e-b6f7-9576d9479a18</Id>
    <Name>sample string 2</Name>
    <Script>sample string 3</Script>
  </Algorithm>
</ArrayOfAlgorithm>