ROSE Developers - Web API Reference

Master Data Business Entities | Type

(Internal use only) The Dynamic Value List is used manage information related with system value lists of master-detail type.

Overview


URL api/{tenantKey}/{orgKey}/businessCore/dynamicValueLists
Methods Supported GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Get Value List

(Internal use only) This service is used to get a value list based on a specified entity name.

The following elements are required:

entityName (string) EntityName.

Response:

When successful, the response body contains a list of resources of type 'DynamicValueResource'. See DynamicValueResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /businessCore/dynamicValueLists/getValueList/{entityName}

GET Get Value List Items

(Internal use only) This service is used to get a value list based on a specified entity name. This service is used to get a value list based on a specified entity name.This service is used to get a value list based on a specified entity name. This service is used by the webcomponent.

The following elements are required:

entityName (string) EntityName.

Response:

When successful, the response body contains a list of resources of type 'DynamicValueListItemResource'. See DynamicValueListItemResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /businessCore/dynamicValueLists/getValueListItems/{entityName}

Resources


DynamicValueListItemResource

The following elements are optional:

label (string) Label.
value (string) Value.


DynamicValueResource

The following elements are optional:

id (Guid) Id.
entityName (string) Entity Name.
dynamicValueKey (string) Dynamic Value Key.
title (string) Title.
isDefault (bool) Is Default.
naturalKey (string) Natural Key.