register
Register a new Custom API in Dataverse
Usage
ppds custom-apis register [options]
Arguments
| Name | Required | Description |
|---|---|---|
unique-name | yes | Unique message name for the Custom API |
Options
| Long | Short | Type | Default | Description |
|---|---|---|---|---|
--allowed-step-type | string | Allowed processing step type: None, AsyncOnly, or SyncAndAsync (default: None) | ||
--assembly | string | Plugin assembly name | ||
--binding-type | string | Binding type: Global, Entity, or EntityCollection (default: Global) | ||
--bound-entity | string | Bound entity logical name (required when binding-type is Entity or EntityCollection) | ||
--correlation-id | string | Correlation ID for distributed tracing | ||
--debug | bool | Show trace-level diagnostic output | ||
--description | string | Optional description | ||
--display-name | string | Display name for the Custom API (defaults to unique name) | ||
--environment | -env | string | Override the environment URL. Takes precedence over profile's bound environment. | |
--execute-privilege | string | Privilege name required to execute the API | ||
--is-function | bool | Mark this API as a function (returns a value) | ||
--is-private | bool | Mark this API as private | ||
--output-format | -f | OutputFormat | Output format | |
--plugin | string | Plugin type name (e.g. MyAssembly.MyPlugin) | ||
--profile | -p | string | Authentication profile name | |
--quiet | -q | bool | Show only warnings and errors | |
--verbose | -v | bool | Show detailed output including debug messages |