Create Product Parameter

Create a product parameter.

post
Path parameters
productIdstringRequired
Body
scopestring · enum · min: 1RequiredPossible values:
phasestring · enum · min: 1RequiredPossible values:
contextstring · enum | nullableOptionalPossible values:
namestring · min: 1Required
descriptionstring · min: 1Required
externalIdstring | nullableOptional
displayOrderinteger · int32Required
constraintsall ofRequired
typestring · enum · min: 1RequiredPossible values:
optionsone ofOptional
or
or
or
or
or
or
or
or
objectOptional
or
or
or
groupall ofOptional
Responses
201
Created
application/json
post
POST /public/v1/catalog/products/{productId}/parameters HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 294

{
  "scope": "Agreement",
  "phase": "Configuration",
  "context": "None",
  "name": "text",
  "description": "text",
  "externalId": "text",
  "displayOrder": 1,
  "constraints": {
    "hidden": true,
    "readonly": true,
    "required": true
  },
  "type": "SingleLineText",
  "options": {
    "hintText": "text",
    "defaultValue": "text"
  },
  "group": {
    "id": "text"
  }
}
{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-07-04T01:36:59.767Z",
      "by": "[Circular Reference]"
    },
    "updated": {
      "at": "2025-07-04T01:36:59.767Z",
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "description": "text",
  "group": {
    "id": "text",
    "name": "text"
  },
  "scope": "Agreement",
  "phase": "Configuration",
  "context": "None",
  "externalId": "text",
  "displayOrder": 1,
  "constraints": {
    "hidden": true,
    "readonly": true,
    "required": true
  },
  "product": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "operations": "text"
    },
    "icon": "text",
    "status": "text"
  },
  "options": null,
  "type": "SingleLineText",
  "status": "text"
}

Last updated

Was this helpful?