15.2.2 Retrieve an Object

This endpoint is used to retrieve objects from EPC’s database. This can apply to different scenarios of duplicating and displaying information like:

• Duplicating data onto a third-party platform
• Displaying important files, processes, etc in an external system
• Creating widgets for internal portals
• And more…

Code Example

public <T extends NodeElement> Mono<T> findElement(@NotNull String nodeId, Class<T> clazz) {
        return bpcClient.get()
                .uri(uriBuilder -> uriBuilder.path("/items/").queryParams(defaultQueryParams).queryParam("detail", true).build(nodeId))
                .retrieve()
                .bodyToMono(new ParameterizedTypeReference<>() {
                });
    }

CURL Example:

curl --request GET --url 'http://myepc.interfacing.com/api/v1/items/1450CEF9-89A3-4B48-98F7-09735BECD54B?draft=true' -b /tmp/cookie.tmp

Technical Information

To retrieve a specific object, you need to know to which module it belongs to and its ID that is always listed in the Details page of the object in EPC. See picture below.

*/capabilityId, /controlId, /documentId … = replace ID value of desired object.

What is this feature in EPC?

EPC objects are the items or content stored in the Web App. They can be a set, a folder, or module-specific items, such as tasks in the process module, KPIs in the performance module, terms in the glossary module, and so on. In an EPC system, thousands of objects can be stored in different modules, depending on the size and business needs of your organization. Objects can also be retrieved as a list to allow users to have a quick view of various objects at once.

Related Topics

• Authentication and token management
• API Reference