REST API Reference

Back Next

Running the ParamSetCli commands

You can use the following command to run an action using the action name.

paramsetcli.bat runParamSetCli -a <actionName>

You can perform different actions such as upload, download, and delete a parameter set and list all of the uploaded parameter sets. For each action, you must provide the

-a

argument and appropriate arguments specific to the action as shown below:

Upload a parameter set: You can use the upload action to upload a parameter set to the cloud-hosted repository. You can upload a file with a size up to 5 MB.
To upload a parameter set, use the following syntax:

paramsetcli.bat runParamSetCli -un <unique_param_set_name> -pf <parameter_file_name> -pd <parameter_directory> -a <action>

For example:

paramsetcli.bat runParamSetCli -un Paramset.params -pf Paramsetfile.params -pd C:\files -a upload

Here,
-un
,
-pf
, and
-pd
are mandatory arguments. If a parameter set already exists in the cloud-hosted repository, you cannot upload a parameter set with the same name. However, if you want to force an update of the content in the existing parameter set, you can use the
-f
force argument.

If you update the parameter set after uploading it to the cloud-hosted repository, you must reupload the parameter set for the changes to take effect.

After you run this command, the parameter set is uploaded to the cloud-hosted repository. The unique name of the parameter set is used in a taskflow to read the inputs.
Download a parameter set: You can use the unique name of an uploaded parameter set to download it from the cloud-hosted repository.
To download a parameter set, use the following syntax:

paramsetcli.bat runParamSetCli -un <unique_param_set_name> -pf <parameter_file_name> -pd <parameter_directory> -a <action>

For example:

paramsetcli.bat runParamSetCli -un Paramset.params -pf Paramsetfile.paramsDownload -pd C:\files -a download

Here,
-un
,
-pf
, and
-pd
are mandatory arguments.
-pf
specifies the file name with which you want to download the parameter set, and
-pd
specifies the directory where the parameter set is to be downloaded. If the specified file already exists on the local machine, the ParamSetCli utility does not download the parameter set. To forcefully download and overwrite the existing file, you can use the
-f
force argument.

After you run this command, the parameter set is downloaded to the specified directory.
Delete a parameter set: You can use the unique name of the parameter set to delete it from the cloud-hosted repository.
To delete a parameter set, use the following syntax:

paramsetcli.bat runParamSetCli -un <unique_param_set_name> -a <action>

For example:

paramsetcli.bat runParamSetCli -un Paramset.params -a delete

Here,
-un
is a mandatory argument.

After you run this command, the parameter set is permanently deleted from the cloud-hosted repository.
List the parameter sets: You can list the parameter sets that you have uploaded to the cloud-hosted repository.

To list the parameter sets, use the following syntax:

paramsetcli.bat runParamSetCli -a list

When you run the above command, the first page with 50 entries is listed. It displays basic information such as created by, creation date, parameter set name, parameter file name, and parameter directory for the parameter sets available in the cloud-hosted repository.

The default and the maximum number of entries that you can list is 50 per page. If you want a customized list, you can specify the page number and page size as per the requirement.

To customize the parameter set list, use the following syntax:

paramsetcli.bat runParamSetCli -a list -page <page_number> -ps <page_size>

For example:
paramsetcli.bat runParamSetCli -a list -page <5> -ps <10>

Here,
-page
is the page number that you want to list and
-ps
is the number of entries you want to display on that page.

After you run this command, the fifth page with 10 entries are listed.