XaitCPQ API

POST item-builder/properties/add-enum

Adds an enum property.

Request Information

URI

https://ofd-api.blueprintcpq.net/item-builder/properties/add-enum

URI Parameters

None.

Body Parameters

The property.

AddEnumProperty
NameDescriptionTypeAdditional information
Name

string

None.
Type

integer

None.
Values

Collection of AddEnumPropertyValue

None.

Request Formats

application/json, text/json

Sample: 
{
  "Name": "sample string 1",
  "Type": 2,
  "Values": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "IPN": "sample string 3",
      "Order": 4,
      "Part": "dbedb04e-fc73-4fcb-a5ee-83d97951d8e6",
      "Graphic": "6f5a691e-ed55-4c7c-810d-571f5d08fcee"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "IPN": "sample string 3",
      "Order": 4,
      "Part": "dbedb04e-fc73-4fcb-a5ee-83d97951d8e6",
      "Graphic": "6f5a691e-ed55-4c7c-810d-571f5d08fcee"
    }
  ]
}

text/html

Sample: 
{"Name":"sample string 1","Type":2,"Values":[{"Name":"sample string 1","Value":"sample string 2","IPN":"sample string 3","Order":4,"Part":"dbedb04e-fc73-4fcb-a5ee-83d97951d8e6","Graphic":"6f5a691e-ed55-4c7c-810d-571f5d08fcee"},{"Name":"sample string 1","Value":"sample string 2","IPN":"sample string 3","Order":4,"Part":"dbedb04e-fc73-4fcb-a5ee-83d97951d8e6","Graphic":"6f5a691e-ed55-4c7c-810d-571f5d08fcee"}]}

application/xml, text/xml

Sample: 
<AddEnumProperty xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <Name>sample string 1</Name>
  <Type>2</Type>
  <Values xmlns:d2p1="http://schemas.datacontract.org/2004/07/Shared.Models">
    <d2p1:AddEnumPropertyValue>
      <d2p1:Graphic>6f5a691e-ed55-4c7c-810d-571f5d08fcee</d2p1:Graphic>
      <d2p1:IPN>sample string 3</d2p1:IPN>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Order>4</d2p1:Order>
      <d2p1:Part>dbedb04e-fc73-4fcb-a5ee-83d97951d8e6</d2p1:Part>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:AddEnumPropertyValue>
    <d2p1:AddEnumPropertyValue>
      <d2p1:Graphic>6f5a691e-ed55-4c7c-810d-571f5d08fcee</d2p1:Graphic>
      <d2p1:IPN>sample string 3</d2p1:IPN>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Order>4</d2p1:Order>
      <d2p1:Part>dbedb04e-fc73-4fcb-a5ee-83d97951d8e6</d2p1:Part>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:AddEnumPropertyValue>
  </Values>
</AddEnumProperty>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A GUID.

globally unique identifier

Response Formats

application/json, text/json, text/html

Sample: 
"617e1669-4665-4bdb-bf24-8619cd3c9692"

application/xml, text/xml

Sample: 
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">617e1669-4665-4bdb-bf24-8619cd3c9692</guid>