enpi_api.l2
The enpi_api.l2 module contains higher level functions and utilities for comfortably interacting with the ENPICOM API.
Platform APIs
To interact with the ENPICOM Platform through the SDK/API, have a look at the enpi_api.l2.client.enpi_api_client.EnpiApiClient
class. You will need this class to access the various APIs available in the SDK.
Listening to Events
To listen to events from the ENPICOM Platform, have a look at the enpi_api.l2.events module. This module contains functions
that enable you to listen to events on the platform.
For more information about events, and the available events, have a look at the events documentation.
System tags
For a list of all system tags, separated by their contexts (e.g. collection, sequence, file, etc.), have a look at
the enpi_api.l2.tags module. These lists do not contain your own custom-made tags. If you need the ID of a custom tag
you can use the enpi_api.l2.client.api.tag_api.TagApi.get_tag_archetype_by_name function to find it.
1""" 2The `enpi_api.l2` module contains higher level functions and utilities for comfortably interacting with the ENPICOM API. 3 4### Platform APIs 5To interact with the ENPICOM Platform through the SDK/API, have a look at the `enpi_api.l2.client.enpi_api_client.EnpiApiClient` 6class. You will need this class to access the various APIs available in the SDK. 7 8### Listening to Events 9To listen to events from the ENPICOM Platform, have a look at the `enpi_api.l2.events` module. This module contains functions 10that enable you to listen to events on the platform. 11For more information about events, and the available events, have a look at the [events documentation](/public-api/v1/public/docs/events). 12 13### System tags 14For a list of all system tags, separated by their contexts (e.g. `collection`, `sequence`, `file`, etc.), have a look at 15the `enpi_api.l2.tags` module. These lists do not contain your own custom-made tags. If you need the ID of a custom tag 16you can use the `enpi_api.l2.client.api.tag_api.TagApi.get_tag_archetype_by_name` function to find it. 17"""