OData headers in Web API v1 or v2 - HxGN SDx - Update 70 - Administration & Configuration - Hexagon

HxGN SDx API Services Configuration
ft:locale
en-US
Product
HxGN SDx
Search by Category
Administration & Configuration

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

Requirement

Example header

Restriction

Set both create and query configs

SPFConfigUID: PL_PlantA

Available in all API versions.

Set only Create config

SPFCreateConfigUID: PL_PlantA

Available in API v2 and above only.

Set only Query config

SPFQueryConfigUID: PL_PlantA

Available in API v2 and above only.

Full metadata

Accept: application/json;odata.metadata = full

Selecting a column set

Accept: application/vnd.intergraph.columnset.CS_SPFObject+json

Only works on the Objects endpoint on v2.

Selecting a column set and getting full metadata

Accept: application/json;odata.metadata = full,application/vnd.intergraph.columnset.CS_SPFObject+json

Only works on the Objects endpoint – Full metadata on the Objects endpoint gets you the type information.

Getting display names for column items ​

Prefer: odata.include-annotations = "*"

Only works on the Objects endpoint on v2.

Omitting null values from the output

Prefer: odata.omit-values = nulls​

Only works on the Objects endpoint on v2.

Omitting properties from the output

Prefer: odata.omit-properties = "CreationDate,CreationUser,TerminationDate,TerminationUser,LastUpdatedDate"​​

Only works on the Objects endpoint on v2.

Respond with no-content on POST create

Prefer: return=minimal

Only works on the Objects endpoint on v2.

Continue batching following an error

Prefer: odata.continue-on-error

This tells a batch request to continue when an error occurs rather than stop processing.

Available in all versions.

Change the page size for a request

Prefer: odata.maxpagesize = N

For example: odata.maxpagesize = 100

Available in all versions.

The odata.maxpagesize property allows you to change the number of items returned in one page of a server request. The default setting is 25.​

If the odata.maxpagesize property is set, the response Preference-Applied header applies the max page size value.

Getting full objects

Accept: application/vnd.intergraph.data+json

Only works on the Objects endpoint on v2.

Querying in a specific config

SPFQuerySelectedConfigOnly: True/False

Available in all versions.

Getting latest doc versions instead of revisions or masters

SPFResolveDocumentsToVersion: True/False

Default behaviour is true, you only get latest versions. Affects only certain types of query on the Objects endpoint.

Force output stream to be un-buffered

ForceUnBufferedOutputStream: True/False

Responses are buffered by default. This header forces response to be not be buffered and is useful for large data size.

Available in all versions.

Disabling ENS when creating an object

SuppressENS: True/False

When SuppressENS is set to True, any name value is passed and the ENS is ignored.

Available in all versions.

For more configuration header examples, see Configuration.