The getParams queryType is passed to the API to get all parameter values passed to an analysis.
Parameters
These parameters should be passed to the functionParameters object regardless of which method you choose from here.
| Parameter | Description | Type | Defined Value Set | Value Req'd |
|---|
| queryType | Must equal "getParams". | STRING | "getParams" | Y |
| analysisJobId | The job id that was used to generate the analysis. | STRING | - | Y |
Responses
| Code | Type | Description |
|---|
| 200 | JSON | The requested data. |
| 401 | JSON | Occurs for various unauthorized tasks, such as not providing credentials in your parameters. |
| 500 | JSON | Occurs if an internal server error occurs. Contact altitudesupport@geotab.com if this occurs. |
Response Schema
| Attribute | Description | Data Type | Defined Value Set |
|---|
| Parameters | All parameter values passed to the analysis, formatted as a JSON string. | STRING | - |
Sample parameters
{
"analysisJobId": "<analysisJobId>",
"queryType":"getParams"
}