pacx customapi run

Executes a Dataverse Custom API, passing input parameters from a JSON string or file and printing the response.

Usage

Execute a Custom API passing parameters as an inline JSON string:

pacx customapi run -n nn_GregSum -i "{\"Addend1\":5,\"Addend2\":3}"

Execute using a JSON file for the input:

pacx customapi run -n nn_GregSum --input-file .\params.json

Execute a Custom API that requires no input parameters:

pacx customapi run -n nn_Ping

JSON keys are the short parameter names (without publisher prefix and without the -in- segment). Supported scalar types: Boolean, DateTime, Decimal, Float, Guid, Integer, Money, Picklist, String, StringArray. For EntityReference use {"logicalname":"account","id":""}.

Arguments

Long Name	Short Name	Required?	Description	Default value	Valid values
unique-name	n	Y	Unique name of the Custom API to execute (e.g. nn_GregSum).	-	String
input	i	N	Input parameters as an inline JSON object, e.g. {"Addend1":5,"Addend2":3}. Mutually exclusive with --input-file.	-	String
input-file	f	N	Path to a JSON file containing input parameters. Mutually exclusive with --input.	-	String