Arena REST API Overview¶
The Arena REST API allows you to programmatically exchange data with your workspaces. This documentation includes details about requests and responses from Arena servers and instructs developers on how to construct requests. Familiarity with APIs is assumed.
API Capabilities¶
| Resource | Search | Create | Read | Update | Delete |
|---|---|---|---|---|---|
| Item Summary Records | ✔ | ✔ | ✔ | ✔ | ✔ |
| Item BOM Lines | N/A | ✔ | ✔ | ✔ | ✔ |
| Item Source Relationships | N/A | ✔ | ✔ | ✔ | ✔ |
| Item Revisions* | N/A | ✔* | ✔ | N/A | N/A |
| Item Files Associations | N/A | ✔ | ✔ | ✔ | ✔ |
| Item Compliance Requirements | N/A | ✔ | ✔ | ✔ | |
| Item Where Used | N/A | N/A | ✔ | N/A | N/A |
| Item Lifecycle | ✔ | ||||
| Item Export | ✔ | ✔ | ✔ | N/A | N/A |
| Item Import | ✔ | ✔ | ✔ | N/A | N/A |
| Request Summary | ✔ | ✔ | ✔ | ✔ | ✔ |
| Request Items | ✔ | ✔ | ✔ | ✔ | ✔ |
| Request Files | ✔ | ✔ | ✔ | N/A | ✔ |
| Request File Markup | ✔ | ✔ | ✔ | N/A | ✔ |
| Request Changes | ✔ | N/A | ✔ | N/A | N/A |
| Request Quality | N/A | N/A | ✔ | N/A | N/A |
| Request Workflow | N/A | ✔ | N/A | N/A | N/A |
| Change Summary Records | ✔ | ✔ | ✔ | ✔ | ✔ |
| Change Implementation Tasks | ✔ | ✔ | ✔ | ✔ | ✔ |
| Change Affected Items | ✔ | ✔ | ✔ | ✔ | ✔ |
| Change Files | ✔ | ✔ | ✔ | N/A | ✔ |
| Change File Markups | ✔ | ✔ | ✔ | N/A | ✔ |
| Change Requests | ✔ | ✔ | ✔ | N/A | ✔ |
| Change Quality | N/A | N/A | ✔ | N/A | N/A |
| Supplier Profile | ✔ | ✔ | ✔ | ✔ | ✔ |
| Supplier Quality | ✔ | ||||
| Supplier Item Summary | ✔ | ✔ | ✔ | ✔ | ✔ |
| Supplier Item File Associations | N/A | ✔ | ✔ | ✔ | ✔ |
| Supplier Item Compliance Requirements | N/A | ✔ | ✔ | ✔ | |
| Supplier Item Sourcing | ✔ | ||||
| File Records | ✔ | ✔ | ✔ | ✔ | ✔ |
| File Editions | ✔ | ✔ | |||
| File Associations | ✔ | ||||
| Quality Process Summary | ✔ | ✔ | ✔ | ✔ | ✔ |
| Quality Process Details | N/A | - | ✔ | - | |
| Quality Process Step/Affected Objects | ✔ | ✔ | ✔ | ✔ | ✔ |
| DataExtract | ✔ | ||||
| Outbound Integrations | ✔ | ✔ | ✔ | ||
| Recent Activity | ✔ |
Note:
- *Item Revisions are created using the items/lifecyclephasechanges endpoint.