Get all tenant value list items

Copy 
GET /deviceinformationservice/api/v1/tenants/{tenantId}/value-lists

Gets all effective value lists of a given tenant.

Gets all the effective value lists for a given tenant.

The endpoint returns the following set of values list items:

  • Global values list items not customized by the tenant

  • Value list items created by the tenant

  • Global value list items customized by the tenant

To perform this operation, you must be authenticated by means of one of the following methods:

  • oauth2_implicit (scopes: PolicyAtLeastDisReader)

  • bearerAuth (scopes: PolicyAtLeastDisReader)

Parameters

Table 29 

Name

In

Type

Required

Description

tenantId

path

string (uuid)

true

The tenant ID.

Responses

Table 30 

Status

Meaning

Description

Schema

200

OK

OK

inline

401

Unauthorized

Unauthorized

none

403

Forbidden

Forbidden. Required authority: PolicyAtLeastDisReader

none

Response schema

Status code 200

Table 31 

Name

Type

Required

Restrictions

Description

anonymous

[value list item]

false

none

[The value list item contract.]

» Key

integer (int32)

false

none

Surrogate key of the key value pair.

» Id

string ¦ null

false

none

Value list external ID.

» Name

string ¦ null

false

none

Value list value.

» Description

string ¦ null

false

none

Value list description.

» ValueListId

string ¦ null

false

none

Value list group ID.

Example responses

Copy 
[
  {
    "Key": 0,
    "Id": "string",
    "Name": "string",
    "Description": "string",
    "ValueListId": "string"
  }
]