ProgramParameters

post/public/v1/program/programs/{programId}/parameters

Request

  • Base URL: https://api.platform.softwareone.com
  • URL: https://api.platform.softwareone.com/public/v1/program/programs/{programId}/parameters
  • Auth: none declared

Path parameters

programIdstring required

Request body

scope'Enrollment'
phase'Order' | 'Fulfillment'
namestring required
descriptionstring required
multipleboolean
externalIdstring nullable
displayOrderinteger required
type'SingleLineText' | 'MultiLineText' | 'Address' | 'Contact' | 'Checkbox' | 'Choice' | 'Subdomain' | 'Heading' | 'DropDown' | 'Email' | 'DataObject' | 'Date' | 'DateAndTime' | 'Collection'

Response

Created

idstring
namestring
revisioninteger
descriptionstring
multipleboolean
externalIdstring nullable
displayOrderinteger nullable
optionsunknown
type'SingleLineText' | 'MultiLineText' | 'Address' | 'Contact' | 'Checkbox' | 'Choice' | 'Subdomain' | 'Heading' | 'DropDown' | 'Email' | 'DataObject' | 'Date' | 'DateAndTime' | 'Collection'
status'Active' | 'Deleted'
scope'Enrollment'
phase'Order' | 'Fulfillment'

Changes

No recorded changes to this operation across all 1 revision of this API.