In this article
Note: The below article uses examples of accessing the Decipher API from a Unix system that has the Beacon library package installed. See Decipher REST API to learn more about accessing the Decipher REST API.
You can use the Decipher API to create and manage project parameters. Project parameters allow you to better organize your projects and provide improved search ability within the Portal. Project parameters are not applied by default, however, and will need to be added to your company directory before they can be used on any survey. Using the Decipher API, you can enable project parameters for a company, modify existing parameters, and set / retrieve their values on a per-project basis.
You can use the following API calls to manage your project parameters. Click any call name to view more information.
| Call Name | Description |
|---|---|
| Add Parameters | Adds project parameters to the specified survey. |
| Available Parameters | Retrieves a list of all project parameters that can be setup for the specified survey. |
| Update Parameters | Updates project parameters for the specified survey. |
| View Parameters | Retrieves the project parameter configuration for the specified survey. |
Note: By default, API calls in the shell output information directly to the console screen. If you want to reuse that output, you will want to save it to a file.
Note: If you are using a web call method to access the API, you will need to have a way of providing your API key. See Decipher REST API for more information.
Note: You will need to change v2.decipherinc.com to the domain that you use to log into the Decipher platform.
1: Viewing Returned Data
You can use the global select parameter to retrieve a subset of any GET call's returned data. You can pass in select as an argument set to a comma-separated list of properties to return.
For example, select=id, login, active will only retrieve these three specific fields when calling in the User List API:
beacon get rh/users select=id,login,active
Note: The select parameter should only be used on GET method API calls to filter information retrieved via an API call, and not information that you send (e.g., via a PUT or POST method) to Decipher.