ExposedService attribute parameters - SmartPlant Foundation - IM Update 44 - Customization & Programming - Hexagon

ExposedServiceType

Required

Enum defining how to expose the method.

• Action – a method that can have an effect on the server

• Function – a method that cannot have an effect on the server

• Entity – a single entry in an EntitySet

• EntitySet – a collection of objects

• ContainedEntitySet – a collection of objects that are contained within another entity or a singleton

• Singleton – a single object

Name

Required

Exposed name for your service.

The service name must be unique.

UseTransaction

Not required

Determines whether a transaction is started and committed before and after your code executes.

Only actions are allowed to have an impact on the server, so only services and methods with a POST data parameter are allowed to set this to True.

Defaults to False

UID

Not required

Denotes the UID of the corresponding SPFAPIServerProcedure instance which represents the exposed service.

Without this value, the code is unable to determine any binding logic between the SPFAPIServerProcedure instance and any parent SPFAPIEntryPoint or SPFAPIServerProcedure instances.

IncludeAtRoot

Not required

Denotes that the procedure appears at the API root, as well as appearing at any configured group end point, such as api/v1/MyCustomAction