add-parameter
Add a request parameter or response property to a Custom API
Usage
ppds custom-apis add-parameter [options]
Arguments
| Name | Required | Description |
|---|---|---|
api-name | yes | Custom API unique name or GUID |
param-name | yes | Unique parameter name |
Options
| Long | Short | Type | Default | Description |
|---|---|---|---|---|
--correlation-id | string | Correlation ID for distributed tracing | ||
--debug | bool | Show trace-level diagnostic output | ||
--description | string | Optional description | ||
--direction | string | Direction: input or output | ||
--display-name | string | Display name (defaults to param-name) | ||
--entity | string | Logical entity name (required for Entity, EntityCollection, EntityReference types) | ||
--environment | -env | string | Override the environment URL. Takes precedence over profile's bound environment. | |
--optional | bool | Mark the parameter as optional (input parameters only) | ||
--output-format | -f | OutputFormat | Output format | |
--profile | -p | string | Authentication profile name | |
--quiet | -q | bool | Show only warnings and errors | |
--type | string | Data type: Boolean, DateTime, Decimal, Entity, EntityCollection, EntityReference, Float, Integer, Money, Picklist, String, StringArray, or Guid | ||
--verbose | -v | bool | Show detailed output including debug messages |