Skip to main content

add-parameter

Add a request parameter or response property to a Custom API

Usage​

ppds custom-apis add-parameter [options]

Arguments​

NameRequiredDescription
api-nameyesCustom API unique name or GUID
param-nameyesUnique parameter name

Options​

LongShortTypeDefaultDescription
--correlation-idstringCorrelation ID for distributed tracing
--debugboolShow trace-level diagnostic output
--descriptionstringOptional description
--directionstringDirection: input or output
--display-namestringDisplay name (defaults to param-name)
--entitystringLogical entity name (required for Entity, EntityCollection, EntityReference types)
--environment-envstringOverride the environment URL. Takes precedence over profile's bound environment.
--optionalboolMark the parameter as optional (input parameters only)
--output-format-fOutputFormatOutput format
--profile-pstringAuthentication profile name
--quiet-qboolShow only warnings and errors
--typestringData type: Boolean, DateTime, Decimal, Entity, EntityCollection, EntityReference, Float, Integer, Money, Picklist, String, StringArray, or Guid
--verbose-vboolShow detailed output including debug messages