The Report Parameters entity represents the report input definition and has the following attributes:
Name |
Type |
Required |
Description |
---|---|---|---|
Id |
Edm.String |
Yes |
The unique parameter definition id or name. This is a CSDL compliant identifier for a given parameter. |
Name |
Edm.String |
Yes |
The name of the parameter. |
DisplayName |
Edm.String |
Yes |
The name of the parameter to be displayed in the client. While implementing the clients, give priority to DisplayName instead of Name parameter. |
Description |
Edm.String |
No |
The parameter description. |
ParameterType |
Edm.String |
Yes |
A valid, fully qualified EDM type name that can be one of the following:
If the ParameterType is S3dFilter, then the additional properties IsRuntimeFilter and FilterId are populated. |
IsRequired |
Edm.Boolean |
Yes |
True if input for this parameter is required to execute a report, false otherwise. |
AllowedValues |
Edm.String |
No |
Specifies the possible values that can be selected as input for this parameter. If the ParameterType is SelectList, this property defines the name of the SelectList (for example, "Core-ObjectIntegrityStatus") whose items can be given as input. |
DefaultValue |
Edm.String |
No |
Specifies a default value for this parameter. DefaultValue and IsRequired are mutually exclusive. |
IsRuntimeFilter |
Edm.Boolean |
No |
If ParameterType is S3dFilter, then the flag indicates whether the user can supply a different filter or not. |
FilterId |
Edm.String |
No |
Optional parameter which specifies the OID/Id of the filter chosen to run this report. The FilterId depends on IsRuntimeFilter attribute. IsRuntimeFilter = true - User is allowed to specify a different filter, in which case the user must supply the OID of the new filter. IsRuntimeFilter = false - A parametric filter. The user must supply inputs for that filter. The OID/Id of the default filter must be supplied here. |
Call Parameters to get the parameters for a given report. Here is an example:
GET
https://MyServer.Domain.com/s3d/v1/Sites('MySiteAlias')/Plants('MyPlant')/Reports('{0000EAA5-0000-0000-AA2C-54C7B7541D04}')/Parameters