1 of 7

Parameter

Parameter object

Field

Type

Description

Example

Parameter States

The following diagram shows the possible states a parameter may have in the Marketplace Platform and the transition between these states:

State

Definition

Create Product Parameter

Create a product parameter.

List Product Parameters

Get a list of parameters for a product.

Update Product Parameter

Update a product parameter definition.

Get Product Parameter

Get a product parameter definition.

Delete Product Parameter

Delete a product parameter definition.

The parameter has been created as part of the product definition.

It can be used to collect data as part of the order, fulfillment, or configuration phases.

The parameter no longer exists.

It's no longer part of the product definition and can't be used to collect data as part of the order, fulfillment, or configuration phases.

{
  "scope": "Agreement",
  "phase": "Order",
  "description": "Agreement identifier of the reseller",
  "externalId": "RES-233-33-xx3",
  "displayOrder": 100,
  "constraints": {
    "hidden": true,
    "readonly": true,
    "optional": false
  },
  "type": "SingleLineText",
  "options": {
    "name": "Aggreement Id",
    "placeholderText": "AGR-xxx-xxx-xxx",
    "hintText": "Add agreement id",
    "minChar": 15,
    "maxChar": 15,
    "defaultValue": null
  },
  "group": { "id": PGR-7373-6782" }
}

{
    "label": "Client address",
    "hintText": "please add your email",
    "placeholderText": "someone@org.com",
    "defaultValue": "none"
}

const response = await fetch('https://api.platform.softwareone.com/public/v1/products/{productId}/parameters/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}