Get Product Parameter

Get a product parameter definition.

get

Path parameters

idstringRequired

productIdstringRequired

Query parameters

selectstringOptional

Responses

200

OK

application/json

idstringOptional

namestringOptional

revisioninteger · int32Optional

descriptionstringOptional

multiplebooleanOptional

externalIdstring · nullableOptional

displayOrderinteger · int32 · nullableOptional

optionsany · nullableOptional

typestring · enumOptionalPossible values:

statusstring · enumOptionalPossible values:

scopestring · enumOptionalPossible values:

phasestring · enumOptionalPossible values:

contextstring · enumOptionalPossible values:

404

Not Found

application/json

get/public/v1/catalog/products/{productId}/parameters/{id}

HTTPcURLJavaScriptPython

GET /public/v1/catalog/products/{productId}/parameters/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-08-08T08:02:58.340Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-08-08T08:02:58.340Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "revision": 1,
  "description": "text",
  "multiple": true,
  "externalId": "text",
  "displayOrder": 1,
  "constraints": {
    "hidden": true,
    "readonly": true,
    "required": true,
    "capacity": {
      "min": 1,
      "max": 1
    }
  },
  "options": null,
  "type": "SingleLineText",
  "status": "Active",
  "group": {
    "id": "text",
    "name": "text",
    "revision": 1
  },
  "scope": "Agreement",
  "phase": "Configuration",
  "context": "None",
  "product": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "externalIds": {
      "operations": "text",
      "defaultErpItem": "text"
    },
    "status": "text"
  }
}