Create Product Parameter

Create a product parameter.

post

Path parameters

productIdstringRequired

Body

application/jsontext/jsonapplication/*+json

scopestring · enum · min: 1RequiredPossible values:

phasestring · enum · min: 1RequiredPossible values:

namestring · min: 1Required

descriptionstring · min: 1Required

externalIdstring | nullableOptional

displayOrderinteger · int32Required

typestring · enum · min: 1RequiredPossible values:

optionsone ofOptional

or

or

or

or

or

or

or

or

objectOptional

or

or

or

Responses

201

Created

application/json

400

Bad Request

application/json

403

Forbidden

application/json

500

Internal Server Error

post

HTTPcURLJavaScriptPython

POST /public/v1/catalog/products/{productId}/parameters HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 293

{
  "scope": "Agreement",
  "phase": "Configuration",
  "name": "text",
  "description": "text",
  "externalId": "text",
  "displayOrder": 1,
  "constraints": {
    "hidden": true,
    "readonly": true,
    "optional": true,
    "required": true
  },
  "type": "SingleLineText",
  "options": {
    "hintText": "text",
    "defaultValue": "None"
  },
  "group": {
    "id": "text"
  }
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-05-12T07:48:57.807Z",
      "by": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-05-12T07:48:57.807Z",
            "by": "[Circular Reference]"
          },
          "updated": {
            "at": "2025-05-12T07:48:57.807Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-05-12T07:48:57.807Z",
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "href": "text",
  "name": "text",
  "description": "text",
  "group": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-05-12T07:48:57.807Z",
        "by": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-05-12T07:48:57.807Z",
              "by": "[Circular Reference]"
            },
            "updated": {
              "at": "2025-05-12T07:48:57.807Z",
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "updated": {
        "at": "2025-05-12T07:48:57.807Z",
        "by": "[Circular Reference]"
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "href": "text",
    "name": "text",
    "label": "text",
    "description": "text",
    "displayOrder": 1,
    "default": true,
    "parameterCount": 1,
    "product": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-05-12T07:48:57.807Z",
          "by": {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-05-12T07:48:57.807Z",
                "by": "[Circular Reference]"
              },
              "updated": {
                "at": "2025-05-12T07:48:57.807Z",
                "by": "[Circular Reference]"
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "updated": {
          "at": "2025-05-12T07:48:57.807Z",
          "by": {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-05-12T07:48:57.807Z",
                "by": "[Circular Reference]"
              },
              "updated": {
                "at": "2025-05-12T07:48:57.807Z",
                "by": "[Circular Reference]"
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "published": {
          "at": "2025-05-12T07:48:57.807Z",
          "by": {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-05-12T07:48:57.807Z",
                "by": "[Circular Reference]"
              },
              "updated": {
                "at": "2025-05-12T07:48:57.807Z",
                "by": "[Circular Reference]"
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "pending": {
          "at": "2025-05-12T07:48:57.807Z",
          "by": {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-05-12T07:48:57.807Z",
                "by": "[Circular Reference]"
              },
              "updated": {
                "at": "2025-05-12T07:48:57.807Z",
                "by": "[Circular Reference]"
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "unpublished": {
          "at": "2025-05-12T07:48:57.807Z",
          "by": {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-05-12T07:48:57.807Z",
                "by": "[Circular Reference]"
              },
              "updated": {
                "at": "2025-05-12T07:48:57.807Z",
                "by": "[Circular Reference]"
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "name": "text",
            "icon": "text"
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "href": "text",
      "name": "text",
      "shortDescription": "text",
      "longDescription": "text",
      "externalIds": {
        "operations": "text"
      },
      "website": "text",
      "icon": "text",
      "status": "text",
      "vendor": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-05-12T07:48:57.807Z",
            "by": {
              "id": "text",
              "audit": {
                "created": {
                  "at": "2025-05-12T07:48:57.807Z",
                  "by": "[Circular Reference]"
                },
                "updated": {
                  "at": "2025-05-12T07:48:57.807Z",
                  "by": "[Circular Reference]"
                }
              },
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "href": "text",
              "name": "text",
              "icon": "text"
            }
          },
          "updated": {
            "at": "2025-05-12T07:48:57.807Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "externalIds": {
          "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "externalId": "text",
        "externalName": "text",
        "type": "Client",
        "status": "Active",
        "serviceLevel": "Express",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "icon": "text",
        "technicalSupportEmail": "[e-mail]",
        "website": "text",
        "description": "text",
        "name": "text",
        "groups": [
          {
            "id": "text",
            "audit": "[Circular Reference]",
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "name": "text",
            "description": "text",
            "account": "[Circular Reference]",
            "modules": "[Circular Reference]",
            "logo": "text",
            "isDefault": true,
            "users": "[Circular Reference]",
            "buyers": "[Circular Reference]"
          }
        ]
      },
      "settings": {
        "productOrdering": true,
        "productRequests": {
          "enabled": true,
          "name": "text",
          "label": "text"
        },
        "itemSelection": true,
        "orderQueueChanges": true,
        "preValidation": {
          "purchaseOrderDraft": true,
          "purchaseOrderQuerying": true,
          "changeOrderDraft": true,
          "terminationOrder": true,
          "productRequest": true
        },
        "splitBilling": {
          "enabled": true,
          "type": "text"
        }
      },
      "statistics": {
        "itemCount": 1,
        "ordersPlacedCount": 1,
        "agreementCount": 1,
        "subscriptionCount": 1,
        "requestCount": 1
      }
    }
  },
  "scope": "Agreement",
  "phase": "Configuration",
  "externalId": "text",
  "displayOrder": 1,
  "constraints": {
    "hidden": true,
    "readonly": true,
    "optional": true,
    "required": true
  },
  "product": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-05-12T07:48:57.807Z",
        "by": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-05-12T07:48:57.807Z",
              "by": "[Circular Reference]"
            },
            "updated": {
              "at": "2025-05-12T07:48:57.807Z",
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "updated": {
        "at": "2025-05-12T07:48:57.807Z",
        "by": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-05-12T07:48:57.807Z",
              "by": "[Circular Reference]"
            },
            "updated": {
              "at": "2025-05-12T07:48:57.807Z",
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "published": {
        "at": "2025-05-12T07:48:57.807Z",
        "by": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-05-12T07:48:57.807Z",
              "by": "[Circular Reference]"
            },
            "updated": {
              "at": "2025-05-12T07:48:57.807Z",
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "pending": {
        "at": "2025-05-12T07:48:57.807Z",
        "by": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-05-12T07:48:57.807Z",
              "by": "[Circular Reference]"
            },
            "updated": {
              "at": "2025-05-12T07:48:57.807Z",
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "unpublished": {
        "at": "2025-05-12T07:48:57.807Z",
        "by": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-05-12T07:48:57.807Z",
              "by": "[Circular Reference]"
            },
            "updated": {
              "at": "2025-05-12T07:48:57.807Z",
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "href": "text",
    "name": "text",
    "shortDescription": "text",
    "longDescription": "text",
    "externalIds": {
      "operations": "text"
    },
    "website": "text",
    "icon": "text",
    "status": "text",
    "vendor": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-05-12T07:48:57.807Z",
          "by": {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-05-12T07:48:57.807Z",
                "by": "[Circular Reference]"
              },
              "updated": {
                "at": "2025-05-12T07:48:57.807Z",
                "by": "[Circular Reference]"
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "updated": {
          "at": "2025-05-12T07:48:57.807Z",
          "by": "[Circular Reference]"
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "href": "text",
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "type": "Client",
      "status": "Active",
      "serviceLevel": "Express",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "icon": "text",
      "technicalSupportEmail": "[e-mail]",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": [
        {
          "id": "text",
          "audit": "[Circular Reference]",
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "description": "text",
          "account": "[Circular Reference]",
          "modules": "[Circular Reference]",
          "logo": "text",
          "isDefault": true,
          "users": "[Circular Reference]",
          "buyers": "[Circular Reference]"
        }
      ]
    },
    "settings": {
      "productOrdering": true,
      "productRequests": {
        "enabled": true,
        "name": "text",
        "label": "text"
      },
      "itemSelection": true,
      "orderQueueChanges": true,
      "preValidation": {
        "purchaseOrderDraft": true,
        "purchaseOrderQuerying": true,
        "changeOrderDraft": true,
        "terminationOrder": true,
        "productRequest": true
      },
      "splitBilling": {
        "enabled": true,
        "type": "text"
      }
    },
    "statistics": {
      "itemCount": 1,
      "ordersPlacedCount": 1,
      "agreementCount": 1,
      "subscriptionCount": 1,
      "requestCount": 1
    }
  },
  "options": {
    "hintText": "text",
    "defaultValue": "None"
  },
  "type": "SingleLineText",
  "status": "text"
}