Skip to main content

register

Register a new Custom API in Dataverse

Usage​

ppds custom-apis register [options]

Arguments​

NameRequiredDescription
unique-nameyesUnique message name for the Custom API

Options​

LongShortTypeDefaultDescription
--allowed-step-typestringAllowed processing step type: None, AsyncOnly, or SyncAndAsync (default: None)
--assemblystringPlugin assembly name
--binding-typestringBinding type: Global, Entity, or EntityCollection (default: Global)
--bound-entitystringBound entity logical name (required when binding-type is Entity or EntityCollection)
--correlation-idstringCorrelation ID for distributed tracing
--debugboolShow trace-level diagnostic output
--descriptionstringOptional description
--display-namestringDisplay name for the Custom API (defaults to unique name)
--environment-envstringOverride the environment URL. Takes precedence over profile's bound environment.
--execute-privilegestringPrivilege name required to execute the API
--is-functionboolMark this API as a function (returns a value)
--is-privateboolMark this API as private
--output-format-fOutputFormatOutput format
--pluginstringPlugin type name (e.g. MyAssembly.MyPlugin)
--profile-pstringAuthentication profile name
--quiet-qboolShow only warnings and errors
--verbose-vboolShow detailed output including debug messages