XaitCPQ API

GET item-builder/behaviours

Gets the available behaviours.

Request Information

URI

https://ofd-api.blueprintcpq.net/item-builder/behaviours

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

The behaviours.

Collection of BehaviourOption
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
Name

string

None.
Description

string

None.
Size

string

None.
ProductBehaviour

boolean

None.
CompatiblePropertyTypes

Collection of string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": "50860efa-199d-48fd-834d-9c42a862d634",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "Size": "sample string 4",
    "ProductBehaviour": true,
    "CompatiblePropertyTypes": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "Id": "50860efa-199d-48fd-834d-9c42a862d634",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "Size": "sample string 4",
    "ProductBehaviour": true,
    "CompatiblePropertyTypes": [
      "sample string 1",
      "sample string 2"
    ]
  }
]

text/html

Sample: 
[{"Id":"50860efa-199d-48fd-834d-9c42a862d634","Name":"sample string 2","Description":"sample string 3","Size":"sample string 4","ProductBehaviour":true,"CompatiblePropertyTypes":["sample string 1","sample string 2"]},{"Id":"50860efa-199d-48fd-834d-9c42a862d634","Name":"sample string 2","Description":"sample string 3","Size":"sample string 4","ProductBehaviour":true,"CompatiblePropertyTypes":["sample string 1","sample string 2"]}]

application/xml, text/xml

Sample: 
<ArrayOfBehaviourOption xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <BehaviourOption>
    <CompatiblePropertyTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </CompatiblePropertyTypes>
    <Description>sample string 3</Description>
    <Id>50860efa-199d-48fd-834d-9c42a862d634</Id>
    <Name>sample string 2</Name>
    <ProductBehaviour>true</ProductBehaviour>
    <Size>sample string 4</Size>
  </BehaviourOption>
  <BehaviourOption>
    <CompatiblePropertyTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </CompatiblePropertyTypes>
    <Description>sample string 3</Description>
    <Id>50860efa-199d-48fd-834d-9c42a862d634</Id>
    <Name>sample string 2</Name>
    <ProductBehaviour>true</ProductBehaviour>
    <Size>sample string 4</Size>
  </BehaviourOption>
</ArrayOfBehaviourOption>