API-1003 error: Rest API Get call does not work for custom dynamic lookups

book

Article ID: 195281

calendar_today

Updated On:

Products

Clarity PPM SaaS Clarity PPM On Premise

Issue/Introduction

STEPS TO REPRODUCE:

1.Create a static custom lookup with ID

    LOOKUP_ABOVE_WATERLINE3

2.Note that there is an OOTB statis with ID

    LOOKUP_ABOVE_WATERLINE

3.Edit any dynamic type lookup, lets use the ID LOOKUP_RESURCES

4.Copy the query and create a new dynamic type lookup with ID LOOKUP_RESURCES3

5.Get your REST API documentation URL from Administration > System options > API

    example: http://myserver/niku/rest/describe/index.html

6.Under Other Resources expand the GET /lookups/{lookupType}/lookupValues call

7. On the lookupType parameter provide the lookup IDs mentioned initially: LOOKUP_ABOVE_WATERLINE, LOOKUP_ABOVE_WATERLINE3, LOOKUP_RESURCES and LOOKUP_RESURCES3

8. The custom and OOTB static lookups get the lookup values (LOOKUP_ABOVE_WATERLINE, LOOKUP_ABOVE_WATERLINE3, LOOKUP_RESOURCES):

9. Now try the custom dynamic lookup (LOOKUP_RESURCES3)

Expected results: To get the lookup values of LOOKUP_RESURCES3

Actual results: The lookup is not recognized and an API-1003 error is returned:

{

  "resourceId": "LOOKUP_RESOURCES3",

  "httpStatus": "404",

  "errorMessage": "API-1003 : Could not find resource LOOKUP_RESOURCES3.",

  "errorCode": "api.invalidResource"

}

Cause

All dynamic lookups are "NOT" API enabled by default. To make it API enable, the lookup should be used by any API enabled attribute. 

Where as the static lookups are by default API enabled. 

Environment

Clarity 15.7.1, 15.8.0 and 15.8.1

Resolution

All dynamic lookups are "NOT" API enabled by default. To make it API enable, the lookup should be used by any API enabled attribute. 

Where as the static lookups are by default API enabled. 

Attachments