XaitCPQ API

GET configurator/header

Gets the header.

Request Information

URI

https://ofd-api.blueprintcpq.net/configurator/header?group={group}

URI Parameters

NameDescriptionTypeAdditional information
group

globally unique identifier

None.

Body Parameters

None.

Response Information

Resource Description

The header.

Header
NameDescriptionTypeAdditional information
BrandName

string

None.
InstanceName

string

None.
InstanceNameInHeader

boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "BrandName": "sample string 1",
  "InstanceName": "sample string 2",
  "InstanceNameInHeader": true
}

text/html

Sample: 
{"BrandName":"sample string 1","InstanceName":"sample string 2","InstanceNameInHeader":true}

application/xml, text/xml

Sample: 
<Header xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.Configurator">
  <BrandName>sample string 1</BrandName>
  <InstanceName>sample string 2</InstanceName>
  <InstanceNameInHeader>true</InstanceNameInHeader>
</Header>