15.2.1 Retrieve a List of Objects

This endpoint is used to retrieve a list objects in EPC. This can apply to different scenarios of duplicating and displaying information like:

• Duplicating data onto a third-party platform
• Displaying an overview of important objects in an external system
• Creating filterable widgets for internal portals
• And more…

Code Example for 3 files found in the DB in a 2 files page size :

{
  "totalRecords": 3,
  "sortKey": "nodeId",
  "pageSize": 2,
  "currentPage": 1,
  "results": [
    {
      "documentCount": 0,
      "parent": null,
      "relatedResourceCount": 0,
      "roleCount": 0,
      "nodeSubTypeName": null,
      "userNodeSubType": null,
      "@type": "ListElement",
      "nodeVersionId": "E25E7A35-EE18-4607-924C-C743BAB04E4E",
      "relatedAssetCount": 0,
      "publishedNodeVersionId": null,
      "orgUnitCount": 0,
      "responsibilities": {
        "informed": false,
        "accountable": false,
        "verifier": false,
        "responsible": false,
        "signatory": false,
        "consulted": false,
        "support": false
      },
      "referenceNumber": null,
      "propertyValues": null,
      "assetCount": 0,
      "categories": null,
      "locked": false,
      "relatedRoleCount": 0,
      "relatedOrgUnitCount": 0,
      "locationListItemId": null,
      "productListItemId": null,
      "acronym": null,
      "hasDescription": false,
      "shortDescription": null,
      "nodeType": "TASK",
      "creationDate": "2022-06-15T12:11:37.470-04:00",
      "nodeStatus": "IN_PROGRESS",
      "version": "0.0002",
      "nodeSubType": null,
      "modificationDate": "2022-06-15T12:11:37.740-04:00",
      "extensions": null,
      "deleted": false,
      "system": false,
      "resourceCount": 0,
      "name": "Task 1",
      "lastModifiedByName": null,
      "nodeId": "3096BD45-BBA2-4745-B53C-0015A1A774C5",
      "favorite": false
    },
{
      "documentCount": 0,
      "parent": null,
      "relatedResourceCount": 0,
      "roleCount": 0,
      "nodeSubTypeName": null,
      "userNodeSubType": null,
      "@type": "ListElement",
      "nodeVersionId": "5AF78E44-15FA-48D9-9CCC-4B92E1997216",
      "relatedAssetCount": 0,
      "publishedNodeVersionId": "5AF78E44-15FA-48D9-9CCC-4B92E1997216",
      "orgUnitCount": 0,
      "responsibilities": {
        "informed": false,
        "accountable": false,
        "verifier": false,
        "responsible": false,
        "signatory": false,
        "consulted": false,
        "support": false
      },
      "referenceNumber": null,
      "propertyValues": null,
      "assetCount": 0,
      "categories": null,
      "locked": false,
      "relatedRoleCount": 0,
      "relatedOrgUnitCount": 0,
      "locationListItemId": null,
      "productListItemId": null,
      "acronym": null,
      "hasDescription": false,
      "shortDescription": null,
      "nodeType": "DOCUMENT_SET",
      "creationDate": "2022-06-15T12:11:03.767-04:00",
      "nodeStatus": "PUBLISHED",
      "version": "1.0000",
      "nodeSubType": null,
      "modificationDate": "2022-06-15T12:11:03.837-04:00",
      "extensions": null,
      "deleted": false,
      "system": false,
      "resourceCount": 0,
      "name": "DOC_SET__PUBLISH2022-06-15T12:11:03.744",
      "lastModifiedByName": null,
      "nodeId": "FABBF176-2982-44CC-B3CC-00731C18BA22",
      "favorite": false
    }
  ],
  "order": "ASC"
}

CURL Example:

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

Technical Information

• Endpoint URL: https://YOUREPC.interfacing.com/api/v1/list
• Swagger URL: https://YOUREPC.interfacing.com/api/v1/swagger/#/Common/list

It is possible to retrieve lists of objects specific to each EPC modules. All possibilities are listed here:

What is this feature in EPC?

The list view allows users to see all the objects types that they have access to. Viewing items in a list allows users to have a quick view of various objects in one place, facilitating navigation. It is also possible to filter and sort items in the list view, to find objects faster. To know more about the “List” feature, please click here.

Related Topics

• Authentication and token management
• API Reference