TIF/ENOVIA Connector - Developer Tools

Testing via Curl or Postman

To be able to use the development endpoints for testing various configurations, you typically need to get a token that can be used to for each request.

The token can be fetched like the below example using curl illustrates.

TIF_BASE=http://localhost:8181/enovia/adminapi/v1
TIF_USER=admin
TIF_PWD=test
TIF_TOKEN=$(curl -X POST -H "Content-type: application/json" ${TIF_BASE}/auth/login \
    -d "{\"username\":\"${TIF_USER}\",\"password\":\"${TIF_PWD}\"}" | jq -r '.token.value')

Testing a Payload Configuration

It is possible to test the payload via the Admin API.

The following URL syntax can be used:

http://localhost:8181/enovia/adminapi/v1/dev-tools/test-payload

Accepted parameters are:

objectId

The ENOVIA/3DEXPERIENCE id of the object to create payload for

payloadCfg

The name of the payload configuration to test

Example using curl from command line (requires the tools curl and jq):

curl -X GET -H "Authorization: Bearer ${TIF_TOKEN}" \
  ${TIF_BASE}/dev-tools/test-payload?payloadCfg=PartBasic.xml\&objectId=53160.3064.28160.50821

Testing a Dataset Configuration

To test a dataset configuration, you can use the following URL from the Admin API:

http://localhost:8181/enovia/adminapi/v1/dev-tools/test-dataset

Accepted parameters are:

objectId

Optional ENOVIA/3DEXPERIENCE id of the context object

dataset

The name of the data-set configuration to test

The output from this endpoint contains the basic information from the object and relationships, such as:

  • Object:

    • ID

    • Type

    • Name

    • Revision

    • Current State

  • Relationship:

    • ID

    • Type

If the Accept request header is set to application/json, the response will be in JSON, otherwise XML.

Example using curl from command line (requires the tools curl and jq):

curl -X GET -H "Authorization: Bearer ${TIF_TOKEN}" \
    -H "Accept: application/json" \
    http://localhost:8181/enovia/adminapi/v1/dev-tools/test-dataset?dataset=EBOM.xml\&objectId=53160.3064.28160.50821 | jq