Skip to main content
Solved

How could I know the parameter under entity page?

  • January 8, 2025
  • 5 replies
  • 106 views

ZTC ZTC JGOTA
Hero (Customer)
Forum|alt.badge.img+14

Hello IFS Community,

 

In IFS Cloud, I can navigate to the entity page and view the API and Package tabs.

 

However, how can I determine the required parameters for a function or method when searching for a package under the entity page?

 

For example, in the case of Inventory Part => Get_Description, I can see the function or method name, but I am unable to find the details of the parameters it requires.

 

Is there a way to view the parameters? fyi. my question is not about retrieving the description data. I am looking to understand how to locate and learn about the required parameters. Please, provide some screenshot for easy understanding. :-)

 

 

Thanks,

JL

Best answer by Marcel.Ausan

@ZTC ZTC JGOTA what you could do is to go to API Explorer - in your case look for InventoryPartHandling → and open the API Doc:

Normally the getter functions are inside the Service Operations. There you see that the webservice requires only the Part_No in order to get the description.

 

View original
Did this topic help you find an answer to your question?

5 replies

Marcel.Ausan
Ultimate Hero (Partner)
Forum|alt.badge.img+22
  • Ultimate Hero (Partner)
  • 1142 replies
  • Answer
  • January 9, 2025

@ZTC ZTC JGOTA what you could do is to go to API Explorer - in your case look for InventoryPartHandling → and open the API Doc:

Normally the getter functions are inside the Service Operations. There you see that the webservice requires only the Part_No in order to get the description.

 


ZTC ZTC JGOTA
Hero (Customer)
Forum|alt.badge.img+14
  • Author
  • Hero (Customer)
  • 216 replies
  • January 9, 2025

Hello ​@Marcel.Ausan , Thanks so much for your help.

 

Under the entity ConfigurationSpec , I can see the Get_Objstate

 

I need to find the parameters for the get on red . See screenshot above.

 

How could I find the parameters used to obtain the Get_Objstate? using the API Explorer.

 


Marcel.Ausan
Ultimate Hero (Partner)
Forum|alt.badge.img+22
  • Ultimate Hero (Partner)
  • 1142 replies
  • January 10, 2025

@ZTC ZTC JGOTA sorry, I don’t have an environment where CFGCHR component is active, so I can’t really check.


dsj
Superhero (Partner)
Forum|alt.badge.img+22
  • Superhero (Partner)
  • 820 replies
  • January 21, 2025

Hi ​@ZTC ZTC JGOTA ​@Marcel.Ausan 

 

Here’s a little hack I’m using to get the parameters of a server method when accessing the database is not possible.

  1. Create a new migration job with direction as Source Migration
  2. In the Method List tab, add a new method with your method name, Save

Transition from Entity name to API: InventoryPart → INVENTORY_PART_API

  1.  Now you could see the parameters and their data types in the Source Mapping tab

Once you are done, delete the source mapping records and the method list, so it can be reused later ;)

 

Cheers!

Damith


ZTC ZTC JGOTA
Hero (Customer)
Forum|alt.badge.img+14
  • Author
  • Hero (Customer)
  • 216 replies
  • January 23, 2025

Hello ​@dsj 

 

Thanks for sharing that. It very helpful. :-)


Reply


Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie settings