Set Parameter Result Template (ACS)

Set-Parameter Result Template defines the response for SetParameter results. The response has a JSON body and custom HTTP headers. The body can use placeholders such as ${serial}, ${domain}, and ${model}.

Where to find parameter descriptions: The HTTP Headers editor and the Body Template editor each have a description under the label. The Fields section below also explains each field.

When to use it

Use Set Parameter Result Template to change the HTTP headers and the body of the response for SetParameterValues remote procedure call (RPC) results. The page shows one template. The system manages the template key. You cannot change it.

Before you start

Open the ACS dashboard and select Set Parameter Result Template.
If you have a read-only role, you can run a dry-run and export.
A read-only role cannot apply an import or change the template.

Fields

Field Type Required Validation

Field	Type	Required	Validation
Template Key	String	Yes	Managed by the system. You cannot change it.
HTTP Headers	Key-value pairs	No	HTTP response headers, for example `Content-Type: application/json`
Body Template	String (JSON)	Yes	Must be valid JSON. The page checks it before save and shows it with syntax highlighting.

Template Key

String

Yes

Managed by the system. You cannot change it.

HTTP Headers

Key-value pairs

HTTP response headers, for example Content-Type: application/json

Body Template

String (JSON)

Yes

Must be valid JSON. The page checks it before save and shows it with syntax highlighting.

The page also shows the created and updated times and authors.

View the template

Open the page.
Read the HTTP Headers and the Body Template.

The body is the HTTP response body.

Change the template

Select Edit Template.
To add a header, enter the key and the value, then click Add Header.
To remove a header, click the remove button next to the header.
Change the body content in the text area.
Select Save Changes.

To cancel the changes, select Cancel.

Expected result: The template updates and the page returns to view mode. The page shows the changes immediately. The page saves all changes as one update.

Export the template

Select Export.

Expected result: The browser downloads a JSON file with the current template, including headers and body. Export the template to keep a backup.

Import with dry-run

Select Import.
Upload a JSON file.
Read the dry-run preview of the changes to the headers and the body.
If the dry-run shows warnings, select Allow import with warnings.
Apply the import.

Expected result: The template refreshes.

The import replaces the whole template, headers and body.

Refresh the template

Select Refresh.

Expected result: The page loads the current template from the server. Use Refresh after an import or after changes by other operators.

Troubleshooting

Edit actions are disabled: Your role does not allow changes. Use an EDITOR or ADMIN role.
Cannot save changes: The body has a wrong format. Check the body. It must be valid JSON.
Import blocked by errors: The file has errors. Fix the reported errors in the JSON file and import again.
Template not found: The template does not exist. Select Refresh, or import a JSON file to create the template.