pacx customapi describe

Shows the full signature and metadata of a Dataverse Custom API, including its request parameters and response properties.

Usage

Show the full signature and metadata of a Custom API:

pacx customapi describe -n nn_GregSum

Generate a sample input file (defaults to 'nn_GregSum-input.json' when no path given):

pacx customapi describe -n nn_GregSum --generate-input-file

pacx customapi describe -n nn_GregSum --generate-input-file my-input.json

Generate a JSON Schema for the input parameters (defaults to 'nn_GregSum-schema.json'):

pacx customapi describe -n nn_GregSum --generate-schema-file

pacx customapi describe -n nn_GregSum --generate-schema-file my-schema.json

Both flags can be combined in a single call:

pacx customapi describe -n nn_GregSum -gif -gsf

Arguments

Long Name	Short Name	Required?	Description	Default value	Valid values
unique-name	n	Y	Unique name of the Custom API to describe (e.g. nn_GregSum).	-	String
generate-input-file	gif	N	When specified, writes a sample JSON input file at this path, ready to pass to 'customapi run --input-file'.	-	String
generate-schema-file	gsf	N	When specified, writes a JSON Schema file at this path describing the expected input parameters.	-	String