Skip to main content

nexiles.tools.api

http://nexiles.github.io/nexiles.tools.api/_static/gateway-logo.svg
Author:

Stefan Eletzhofer, nexiles GmbH

Date:

2024-02-27

Version:

0.5.1

License:

BSD

Abstract

This is the repository of the python HTTP API client to the nexiles.tools Windchill API of nexiles GmbH.

Features

  • Querying

  • read and write IBA Attributes

  • up- and download of content

  • create and delete Business Objects (WTPart, WTDocument, Products)

  • usage, used-by, references navigation of parts and epm documents

  • type information queries

  • team, role, user queries

  • no InfoEngine license needed!

Supported Business Objects

name

business object

actions available

organizations

wt.inf.Organization

products

wt.pdm.PDMLinkProduct

container attributes parts documents epmdocuments

libraries

wt.inf.library.WTLibrary

container attributes parts documents epmdocuments

projects

wt.projmgmt.admin.Project2

container attributes parts documents epmdocuments workpackages

cabinets

wt.folder.Cabinet

folders

wt.folder.SubFolder

epmdocuments

wt.epm.EPMDocument

container attributes history content uses references used_by

parts

wt.part.WTPart

container attributes history content uses

documents

wt.doc.WTDocument

container attributes history content

teams

wt.inf.team.ContainerTeam

roles participants

groups

wt.org.WTGroup

members

users

wt.org.WTUser

types

com.ptc.core.meta.type.mgmt.server.impl.WTTypeDefinition

attribute_names

reports

wt.query.template.ReportTemplate

execute

workpackages

com.ptc.windchill.wp.WorkPackage

content container attributes

Usage Example

For e.g. fetching all WTDocuments which match a certain number:

>>> from nexiles.tools.api import get_api
>>> api = get_api("http://www.example.com/Windchill", username="fred", password="kaputnik")
>>> docs = api.documents(number="1003*")

Fetching a certain document identified by it’s OID:

>>> doc = api.document("OR:wt.doc.WTDocument:2342344")
>>> doc.name, doc.number, doc.version
u'Test Document', u'12345345', u'A.3'

Fetching the PRIMARY CONTENT of a part:

>>> content = api.parts("OR:wt.epm.EPMDocument:4711").content.get(role="PRIMARY", filename="COVER.PRT")

For more examples, see the documentation.

Requirements

Server Side Requirements

To use the API, you need a recent version of the nexiles.tools installed on your Windchill server.

We currently support Windchill 11.1 and 12.0 .

Please contact info@nexiles.com for licensing and deployment information regarding the server-side package.

Client Side Requirements

To use the API on your clients, you need:

  • a recent python (testing is done with 3.11.7, Python 2.7 finally died)

  • The dependencies listed in the setup.py file. Note that these should be installed automatically.

Documentation

See http://nexiles.github.io/nexiles.tools.api/

Release files for nexiles.tools.api 0.5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nexiles.tools.api 0.5.1
File Size Uploaded
nexiles.tools.api-0.5.1.tar.gz 28.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for nexiles.tools.api 0.5.1
File Interpreter ABI Platform
nexiles.tools.api-0.5.1-py3-none-any.whl Python 3 none any Details

Total release size: 68.3 kB

Release files / nexiles.tools.api-0.5.1.tar.gz

Download URL nexiles.tools.api-0.5.1.tar.gz
Size 28.4 kB
Tags Source
SHA-256 checksum
How to use checksums
36f22be093e38136da1b890500d734e09c6d64611994158b08ab64f288d9deee
BLAKE2b-256 checksum
How to use checksums
bfe3fbfefef117eccc1fa0fddaa1b966fbee8b9ca5fdc234e7b0e22b431f355a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/4.0.2 CPython/3.11.8

Release files / nexiles.tools.api-0.5.1-py3-none-any.whl

Download URL nexiles.tools.api-0.5.1-py3-none-any.whl
Size 40.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6f3f0fcc562bb6bc1f7ac2950b9bae0e444ca053f005ef886868f690b9a540c8
BLAKE2b-256 checksum
How to use checksums
298c58e1a442125d88f62572a9d3cbe42b4bba19494df733d7464bf5318a69a0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/4.0.2 CPython/3.11.8
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page