Parameters are used throughout the application to store values. The userId and companyId parameters are used for identifying the current user. Non-hidden parameters can be accessed in reports.

Important

All requests require a Session ID URL parameter and basic request headers. In the following document, headers are omitted for clarity.

Parameter JSON

Parameters are represented as JSON objects with the following properties:

Example

{
  "Id":         "MyParameter",
  "DataType":   "String",
  "Value":      "",
  "PromptText": "Input a value",
  "IsHidden":   true
}

List Parameters

GET /rest/Parameters

List all the parameters in the current configuration. Output is an array of objects, each representing an individual parameter.

Using curl

curl http://{webservice}/rest/Parameters?sid={sid} -X GET

Example response

Status: 200 OK

[
  {
    "Id": "MyParameter"
  },
  {
    "Id": "HelloWorld"
  }
]

Show Parameter

GET /rest/Parameters/{Id}

Show the properties of the parameter specified by its Id.

Using curl

curl http://{webservice}/rest/Parameters/{Id}?sid={sid} -X GET

Example response

Status: 200 OK

{
  "Id":         "MyParameter",
  "DataType":   "String",
  "Value":      "",
  "PromptText": "Input a value",
  "IsHidden":   true
}

Create Parameter

POST /rest/Parameters

Parameters are designed to be set in the API. If they do not already exist in config, create them programmatically.

Using curl

curl http://{webservice}/rest/Parameters?sid={sid} -X POST ^
	-d "{'Id':'Hello','DataType':'String','Value':'World','IsHidden':false}"

Example response

Status: 201 Created
Location: /{webservice}/rest/Parameters/Hello

{
  "Id":         "Hello",
  "DataType":   "String",
  "Value":      "World",
  "PromptText": "",
  "IsHidden":   false
}

Edit Parameter

PATCH /rest/Parameters/{Id}

Only supply the properties to be edited.

Using curl

curl http://{webservice}/rest/Parameters/{Id}?sid={sid} -X PATCH ^
	-d "{'IsHidden':true}"

Example response

Status: 204 No Content

Delete Parameter

DELETE /rest/Parameters/{Id}

Using curl

curl http://{webservice}/rest/Parameters/{Id}?sid={sid} -X DELETE

Example response

Status: 204 No Content