The OData API Services uses an instance of the SPFAPIEntryPoint class definition to denote that a class definition or interface definition type should be exposed to services and appear in the OData Metadata.
The SPFAPIEntryPoint class definition uses the following property definitions:
|
Name |
Description |
|---|---|
|
SPFAPIEPSetName |
Used in the metadata to identify the set name in plural. For example, Tags. |
|
SPFAPIEPSingleName |
Used in the metadata to identify the single name. For example, Tag. |
|
SPFAPIEPPropertyComp |
Used with standard property comparison syntax criteria that is applied to any query for this type. For example, ISPFDocumentRevision~SPFRevState~=~@e1Current|e1Working |
The SPFAPIEntryPoint instance uses the following relationship definitions:
|
Name |
Description |
|---|---|
|
SPFAPIEntryPointColumnSet |
Relates an SPFAPIEntryPoint instance to a single column set. If this relationship is not set, the most appropriate column set is automatically selected for the type at runtime. |
|
SPFAPIEntryPointAccessGroup |
Relates an SPFAPIEntryPoint instance to one or more access groups. To access the type using a query or relationship expansion, the user must be configured to one of these access groups. |
|
SPFAPIEntryPointClassDef |
Relates an SPFAPIEntryPoint instance to a single class definition. |
|
SPFAPIEntryPointInterfaceDef |
Relates an SPFAPIEntryPoint instance to a single interface definition. |
|
SPFAPIEntryPointServerProcedure |
Relates an SPFAPIEntryPoint to an SPFAPIServerProcedure to bind an action to a specific API Entry Point. For example, binding the RetrieveFileURL action to the File API Entry Point. |
-
The OData API Metadata generation process automatically seeks out and configures relationship definitions and edge definitions based on the user's access and permissions. No further configuration is required.
-
An SPFAPIEntryPoint instance must be related to a single interface definition or a single class definition. This relationship denotes which type of data is exposed when the API Entry Point is queried. For example, if an SPFAPIEntryPoint instance is related to the ISPFFunctionalArea interface definition, then any objects with this interface definition are returned by the services for that entry type.
-
To expose document types to the API Services, you must expose the document version. For example, you expose the ISPFDesignDocumentVersion by relating the interface definition or class definition to a SPFAPIEntryPoint instance.