List Product Parameters

Get a list of parameters for a product.

get

Path parameters

productIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.platform.softwareone.com/public/v1/catalog/products/{productId}/parameters'

200

200

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "href": "text",
      "name": "text",
      "description": "text",
      "group": "[Circular Reference]",
      "scope": "Agreement",
      "phase": "Configuration",
      "externalId": "text",
      "displayOrder": 1,
      "constraints": {
        "hidden": true,
        "readonly": true,
        "optional": true,
        "required": true
      },
      "product": "[Circular Reference]",
      "options": {
        "hintText": "text",
        "defaultValue": "None"
      },
      "type": "SingleLineText",
      "status": "text"
    }
  ]
}

OK