Skip to main content

How to determine the REST API enumeration property?

In the GET call to retrieve an Activity Dependency by key the three values required are PredecessorActivitySeq, SuccessorActivitySeq, and DependencyType.

DependencyType is an enumeration and does not accept the string value directly:

…/ProjectScopeAndScheduleHandling.svc/ActivityDependencies(PredecessorActivitySeq=100049291,SuccessorActivitySeq=10049288,DependencyType=’StartToStart’)

“code”: “INVALID_KEY_VALUE”

“message”: “The key value ‘DependencyType’ is invalid.”

 

When filtering on an enumeration the full Property must be entered.

e.g. for filtering by PartyType on a Supplier CommMethod:

$filter=PartyType eq IfsApp.SupplierHandling.PartyType'Supplier'

 

How do we determine what the bold section is for each enumeration?

For the DependencyType I have tried the following but only get an error back “INVALID_KEY_PROPERTY“:

  • IfsApp.ProjectScopeAndScheduleHandling.DependencyType'StartToStart'
  • IfsApp.DependencyType'StartToStart'
  • ProjectScopeAndScheduleHandling.DependencyType'StartToStart'
  • DependencyType'StartToStart'

Hi Mat,

 

if you check the documentation in the API Explorer ( three dots/Documentation/API Doc):

 

 

The request body schema of one of the key API’s should give it and its values when referencing the relevant parameter  e.g.

 

 

Hope that helps.

Terms & ConditionsCookie settings