OData headers in Web API v3 - HxGN SDx - Update 63 - Administration & Configuration - Hexagon

HxGN SDx API Services Configuration
Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

The following examples can be used with the standard OData headers and any specific headers required for the system:

Requirement

Example header

Usage

Restriction

Ignore config

SPFIgnoreConfig: true/false

Select true, when you want to extract information from multiple configurations (plants or projects) for an object type, and its related information in a single file.

The default value is false.

Available in Web API v3 and above only.

Ignore effectivity

SPFIgnoreEffectivity: true/false

Select true when you want to query for terminated objects.

The default value is false.

Available in Web API v3 and above only.

Set pick list display option

SPFPickListDisplayMode: Name/Description/Both

Select the display mode for how you want the forms content to appear for a specific request.

The default value is Name.

Available in Web API v3 and above only.

Set the effectivity date

SPFEffectiveDate: 2015-12-08T02:01:00.000Z

Enter a specific date and time so that data created before this date and time will appear in the list.