Create Product Parameter

Create a product parameter.

post

/v1/products/{productId}/parameters

Path parameters

productIdstringrequired

Body

application/jsontext/jsonapplication/*+json

namestring · min: 1required

descriptionstring · min: 1required

externalIdstring | nullable

displayOrderinteger · int32required

constraintsobjectrequired

groupobject

scopestring · enum · min: 1required

Options: Agreement, Item, Request, Subscription

phasestring · enum · min: 1required

Options: Configuration, Order, Fulfillment

typestring · enum · min: 1required

Options: SingleLineText, MultiLineText, Address, Contact, Checkbox, Choice, Subdomain, Heading, DropDown, Email, DataObject, Date

optionsobject

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.platform.softwareone.com/public/v1/products/{productId}/parameters' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","description":"text","displayOrder":1,"constraints":{},"group":{},"scope":"Agreement","phase":"Configuration","type":"SingleLineText","options":{}}'

201

400

403

500

201

{
  "id": "text",
  "audit": {},
  "$meta": {},
  "href": "text",
  "name": "text",
  "description": "text",
  "group": {},
  "externalId": "text",
  "displayOrder": 1,
  "constraints": {},
  "product": {},
  "status": "text",
  "scope": "Agreement",
  "phase": "Configuration",
  "type": "SingleLineText",
  "options": {}
}

Created