search cancel

How to use a Multi Valued Lookup with the REST API

book

Article ID: 228425

calendar_today

Updated On:

Products

Clarity PPM On Premise Clarity PPM SaaS

Issue/Introduction

What syntax should be used when using a Multi Valued Lookup (MVL) with the REST API?

For example, I would like to create a new instance of a Custom Investment object via the REST API that includes an MVL, for instance, referencing a static lookup with three values:

"Option A" (id: A)

"Option B" (id: B)

"Option C" (id: C)

and select "Option A" and "Option B" values.

Environment

Release : 16.0.0

Component : CLARITY XML OPEN GATEWAY (XOG)

Resolution

In the previous scenario, the following JSON syntax could be used to create a new Custom Investment instance (minimal example):

{
  "code": "custinv1",
  "name": "Custom Investment 1",
  "z_mvl1": [
        "a",
        "b"
    ]
}