XaitCPQ API

GET pricebook/categories

Gets the categories.

Request Information

URI

https://ofd-api.blueprintcpq.net/pricebook/categories

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

The categories.

Collection of TreeRecord
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
Value

string

None.
Text

string

None.
Code

string

None.
Colour

string

None.
Level

integer

None.
Graphic

globally unique identifier

None.
Note

globally unique identifier

None.
Children

Collection of TreeRecord

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": "565ef599-fccb-4a5e-b9d3-331f6c5a81f3",
    "Value": "sample string 2",
    "Text": "sample string 3",
    "Code": "sample string 4",
    "Colour": "sample string 5",
    "Level": 6,
    "Graphic": "46e53da9-85bb-49dd-a3b7-2a05fde4d193",
    "Note": "5ee94cf6-61dc-4ecc-bdd2-958ea32e7d3c",
    "Children": []
  },
  {
    "Id": "565ef599-fccb-4a5e-b9d3-331f6c5a81f3",
    "Value": "sample string 2",
    "Text": "sample string 3",
    "Code": "sample string 4",
    "Colour": "sample string 5",
    "Level": 6,
    "Graphic": "46e53da9-85bb-49dd-a3b7-2a05fde4d193",
    "Note": "5ee94cf6-61dc-4ecc-bdd2-958ea32e7d3c",
    "Children": []
  }
]

text/html

Sample: 
[{"Id":"565ef599-fccb-4a5e-b9d3-331f6c5a81f3","Value":"sample string 2","Text":"sample string 3","Code":"sample string 4","Colour":"sample string 5","Level":6,"Graphic":"46e53da9-85bb-49dd-a3b7-2a05fde4d193","Note":"5ee94cf6-61dc-4ecc-bdd2-958ea32e7d3c","Children":[]},{"Id":"565ef599-fccb-4a5e-b9d3-331f6c5a81f3","Value":"sample string 2","Text":"sample string 3","Code":"sample string 4","Colour":"sample string 5","Level":6,"Graphic":"46e53da9-85bb-49dd-a3b7-2a05fde4d193","Note":"5ee94cf6-61dc-4ecc-bdd2-958ea32e7d3c","Children":[]}]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.