Handling special characters in filter parameter - Intergraph Smart 3D Web API - Customization & Programming - Hexagon PPM

Intergraph Smart 3D Web API Programmers Reference

Language
English
Product
Intergraph Smart 3D Web API
Subproduct
Smart 3D Web APIs
Search by Category
Customization & Programming
Smart 3D Version
12 (2018)

Some special characters are not allowed directly in filter parameters. They should be replaced with corresponding hexadecimal value with exception of ' (apostrophe). Apostrophe (') should be replaced with two apostrophes ('').

The table below lists a few special characters that are not allowed and the corresponding hexadecimal values that should be used instead.

Special Character

Replace With

+

%2B

&

%26

#

%23

%

%25

'

''
(two apostrophes not double quotes)

Examples:

Incorrect (# near the end)

/Plants('PlantKey')/PipingRuns?$filter=Name eq ‘CRouteYTest_Pipe#Run_4'

Correct (%23 near the end)

/Plants('PlantKey')/PipingRuns?$filter=Name eq ‘CRouteYTest_Pipe%23Run_4'

Incorrect (single ' near the end)

/Plants('PlantKey')/PipingRuns?$filter=Name eq ‘CCompAtYComp_Pipe'Run_7'

Correct (two '' near the end)

/Plants('PlantKey')/PipingRuns?$filter=Name eq ‘CCompAtYComp_Pipe''Run_7'