Understanding IFS Cloud provider method names¶
The metadata that is used by Portal Studio when generating IFS Applications/Cloud or oData providers determines the method names of each provider type, including the child types.
You can view the metadata for any oData 4 type provider like this:
Paste the provider URL into a browser tab followed by
/$metadata.For example,
https://<tenant>/main/ifsapplications/projection/v1/BusinessLeadHandling.svc/$metadata2. Enter the credentials used when creating the provider.You will then see the metadata as an XML file.
Each oData 4 type is an entity set. An entity set may have:
- One or more navigation properties - these are the relationship or child types
- Get, patch, create and delete methods - the syntax is
get@<entity set name>,create@<entity set name>and so on - Additional methods for each relationship - syntax is
get@<entity set name>@<relationship> - Other methods, such as DefaultCopy, dissociate, associate and so on which has been referenced as actions in the metadata
Consider these examples from the IFS Applications provider BusinessLeadHandling.
For the AddressCity provider type, this is the metadata:
<EntitySet Name="Reference_AddressCity" EntityType="IfsApp.BusinessLeadHandling.AddressCity"/>
The entity set name is Reference_AddressCity and the entity set type is IfsApp.BusinessLeadHandling.AddressCity
This entity set has no relationships so it only has these four methods:
delete@Reference_AddressCitypatch@Reference_AddressCitycreate@Reference_AddressCityget@Reference_AddressCity
BusinessActivity is a slightly more complex provider type - it has one relationship. This is its metadata:
<EntitySet Name="Reference_BusinessActivityRef" EntityType="IfsApp.BusinessLeadHandling.BusinessActivityRef">
<NavigationPropertyBinding Path="ActivityRef" Target="Reference_BusinessActivity"/>
</EntitySet>
The relationship is referenced by the path name "ActivityRef".
This entity set therefore has the basic four methods as well as get and patch methods for the relationship:
delete@Reference_BusinessActivityRefpatch@Reference_BusinessActivityRefcreate@Reference_BusinessActivityRefget@Reference_BusinessActivityRefget@Reference_BusinessActivityRef@ActivityRefpatch@Reference_BusinessActivityRef@ActivityRef
The get@Reference_BusinessActivityRef@ActivityRef method, for example, gets the ActivityRef children of each BusinessActivity.
This is how the metadata for BusinessActivity looks in the Metadata Viewer:
