ROSE Developers - Web API Reference

Master Data Business Entities | Office Extension

The Office Extensions service allows to get required information about custom lists.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Get Lists

Gets product custom lists.

The following elements are required:

isShared (bool) If true returns custom lists of Rose AS and Payroll. Else only Payroll custom lists.

Response:

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

Response status codes:

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

Resource URL:

GET /businessCore/officeExtensions/getLists/{isShared}

GET Get List Metadata

Gets list metadata.

The following elements are required:

module (string) The module name.
service (string) The service name.
list (string) The list name.

Response:

When successful, the response body contains a string.

Response status codes:

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

Resource URL:

GET /businessCore/officeExtensions/getListMetadata/{module}/{service}/{list}

Resources


CustomListResource

The following elements are optional:

id (Guid) Id.
module (string) Module.
service (string) Service.
name (string) Name.
description (string) Description.
product (string) Product.