- Arena REST API
- API Format
- Licensing
- Note on Date/Time Handling
- Connecting and Permissions
- Overview
- Successes and Errors
- BOM and Workspace Settings
Before using our API, we recommend reviewing the following Export Notes and References:
- About Export Results and the JSON Format
- Export Options
- Export Criteria
- About Criteria and Options in API Export
- Criteria: Attributes and Operators
- GET Items (Search)
- DELETE Item
- PUT Item Update
- GET Items (Search) Criteria Parameter
- POST Item Create
- GET Item Specs
- GET Where Used
- PUT Item Source Relationship Update
- GET Item Source Relationships
- POST Item Source Relationship Create
- DELETE Item Source Relationship
- GET Item Source Relationship
- POST Item Specs Thumbnail Image Create From Files View
- DELETE Item Thumbnail Image
- GET Item Thumbnail Image Content
- POST Item Specs Thumbnail Image Create
- GET Item-To-Item Reference
- DELETE Item-To-Item Reference
- PUT Item-To-Item Reference Update
- POST Item-To-Item Reference Create
- GET Item-To-Item References
- GET Item File Associations
- POST Item File Content Update
- GET Item File Content
- GET Individual File Association for an Item
- POST Item File Create
- DELETE Item File Association
- PUT Item File Association Update
- POST Item File Add Existing
- PUT BOM Line Update
- POST BOM Line Create
- DELETE BOM Line
- GET BOM Line
- PUT BOM Settings Update
- GET BOM Settings
- GET BOM
- GET BOM Subsitutes
- GET BOM Subsitute
- PUT BOM Substitute Create
- DELETE BOM Substitute
- POST BOM Substitute Create
- GET Item Compliance Requirements
- PUT Item Compliance Update
- GET Item Compliance Requirement
- DELETE Item Compliance
- POST Item Compliance
- POST Request Item Add
- GET Request Items
- PUT Request Item Edit
- DELETE Request Item
- GET Request Affected Item
- POST Request File Markup Create
- DELETE Request File Markup
- GET Request File Markup
- GET Request File Markups
- GET Request File View Associations
- POST Request Files View Add Existing File
- DELETE Request File View Association
- GET Request Files View Association
- POST Requests Status Change (Deferred to Unsubmitted)
- POST Requests Status Change (Submitted to Closed)
- POST Requests Status Change (Submitted to Promoted)
- POST Requests Status Change (Promoted to Closed)
- POST Requests Status Change (Submitted to Unsubmitted)
- POST Requests Status Change (Closed to Promoted)
- GET Request Status Change Attributes
- POST Requests Status Change (Unsubmitted to Submitted)
- POST Requests Status Change (Deferred to Submitted)
- POST Requests Status Change (Submitted to Deferred)
- DELETE Remove a Request from a Change
- GET All Requests Associated with a Change
- GET A Specific Request Associated with a Change
- POST Add a Request to a Change
- GET Change Files View Associations
- GET Change Files View Association
- POST Change Files View Add Existing File
- DELETE Change File View Association
- GET Change File Markups
- POST Change File Markup Create
- DELETE Change File Markup
- GET Change File Markup
- POST Change Status (Submitting and Admin-Defined)
- POST Change Status (Withdraw)
- POST Change Status (Lock/Unlock)
- POST Change Status (Complete With Implementation Status)
- POST Change Status (Submitting and Auto-Routing)
- POST Change Status (Force Reject)
- GET Change Implementation Statuses
- POST Change Status (Unmarking as Complete)
- POST Change Status (Cancel)
- POST Change Status (Complete)
- GET Change Alerts
- POST Change Status (Submitting and User-Defined)
- POST Change Status (Reopen)
- POST Change Status (Force Expire Deviations)
- POST Change Status (Force Approve)
- POST Change Implementation Files View Add Existing File
- GET Change Implementation Files View Associations
- DELETE Change Implementation File View Association
- GET Change Implementation Files View Association
- POST Change Implementation Task File
- DELETE Change Implementation Task File
- GET Change Implementation Task File
- GET Change Implementation Task Files
- POST Change Implementation Task
- DELETE Change Implementation Task
- GET Change Implementation Tasks
- GET Change Implementation Task
- PUT Change Implementation Task
- POST Change Implementation Task Note
- PUT Change Implementation Task Note
- GET Change Implementation Task Notes
- DELETE Change Implementation Task Note
- GET Change Implementation Task Note
- DELETE Change Affected Item
- PUT Change Affected Item Edit
- GET Change Affected Item
- GET Change Affected Items
- POST Change Affected Item Add
- POST Supplier Profile Address Create
- DELETE Supplier Address
- GET Supplier Address
- PUT Supplier Profile Address Edit
- GET Supplier Addresses
- GET Supplier Profile Phone Numbers
- DELETE Supplier Phone Number
- POST Supplier Phone Number Create
- GET Supplier Phone Number
- PUT Supplier Phone Number Edit
- GET Supplier File Association
- POST Supplier File Add Existing
- GET Supplier File Associations
- DELETE Supplier File Association
- DELETE Supplier File
- PUT Supplier Item Update
- GET Supplier Items
- POST Supplier Item Create
- DELETE Supplier Item
- GET Supplier Item Specs
- GET Supplier Item Source Relationship
- GET Supplier Item Source Relationships
- PUT Supplier Item File Association Update
- POST Supplier Item File Content Update
- POST Supplier Item File Create
- GET Supplier Item File Association
- GET Supplier Item File Content
- DELETE Supplier Item File Association
- GET Supplier Item File Associations
- POST Supplier Item File Add Existing
- POST Supplier Item Specs Thumbnail Image Create From Files View
- GET Supplier Item Thumbnail Image Content
- POST Supplier Item Specs Thumbnail Image Create
- DELETE Supplier Item Thumbnail Image
- PUT Supplier Item Compliance Update
- GET Supplier Item Compliance Requirement
- GET Supplier Item Compliance
- DELETE Supplier Item Compliance
- POST Supplier Item Compliance
- PUT File Summary Update
- POST File Update
- DELETE File
- GET File Summary
- GET File Content
- POST File Content Update
- POST File Create
- GET Files Search
- GET File Markups
- GET File Markup
- GET File Markup Content
- PUT File Markup Update
- DELETE File Markup
- POST File Markup Create
- GET File Quality Process Association
- GET File Item Associations
- GET File Change Association
- GET File Request Association
- GET File Quality Process Associations
- GET File Supplier Association
- GET File Change Implementation Associations
- GET File Request Associations
- GET File Supplier Associations
- GET File Supplier Item Associations
- GET File Change Associations
- GET File Change Implementation Association
- GET File Supplier Item Association
- GET File Item Association
- PUT Quality Process Update
- POST Quality Process Complete
- POST Quality Process Reopen
- GET Quality Processes Search
- DELETE Quality Process
- POST Quality Process Create
- GET Quality Process Summary
- GET Quality Process Step Decisions
- PUT Quality Process Step Update (User Assignee)
- GET Quality Process Steps
- PUT Quality Process Step Update (User Group Assignee)
- GET Quality Process Step
- PUT Quality Process Step Update (Deprecated)
- POST Quality Process Step Reopen
- POST Quality Process Step Complete
- GET Quality Process Step Affected Object
- GET Quality Process Step Affected Objects
- PUT Quality Process Step Affected Object Update
- POST Quality Process Step Affected Object Add
- DELETE Quality Process Step Affected Object
- POST Training Plans Files View Add Existing File
- DELETE Training Plans Remove File Association
- GET Training Plan Files
- GET Training Plan File
- GET Training Plan Quality Process References
- POST Add Training Plan Quality Process
- GET Training Plan Quality Process Reference
- DELETE Training Plan Quality Process
- GET Training Plan User
- DELETE Training Plan Users
- POST Add Training Plan Users
- PUT Update Training Plan User
- GET Training Users
- PUT Training Plan Edit
- POST Training Plan Create
- GET Training Plan
- DELETE Training Plans
- POST Training Plans Status Change
- GET Training Plans (Search)
- GET Training Plan Items
- POST Add Training Plan Item
- GET Training Plan Item
- DELETE Training Plan Item
- POST Tickets Add Quality Process Reference
- DELETE Ticket Remove Quality Process Association
- GET Ticket Quality Processes
- GET Change Category Attributes
- GET Change Administrators
- GET Change Routings
- GET Change Attributes
- GET Change Categories
- GET Change Number Prefixes
- GET Change Item Attributes
- GET Change Administrator
- GET Quality Process Owners
- GET Quality Process Number Formats
- GET Quality Process Templates
- GET Quality Process Attributes
- GET Quality Process Step Attributes
- GET User Group Employee
- GET User Group User
- GET User Group
- GET User Group Employees
- GET User Group Partner
- GET User Group Partners
- GET User Group Users
- GET User Groups
- GET Tickets Templates
- GET Tickets Attributes
- GET Tickets Number Sequence Prefixes
- GET Tickets Number Sequences
- GET Tickets Templates Attributes
- GET Training Plan Number Sequences
- GET Training Manager
- GET Training Plan Number Sequence
- GET Training Managers
- GET Item Compliance Requirements
- GET Request Number Prefixes
- GET Request Administrators
- GET Requests Categories
- GET Request Evaluator Groups
- GET Request Item Attributes
- GET Request Number Sequences
- GET Request Attributes
- GET Request Category Attributes
- GET Item Number Formats
- GET Recent Activity - User Access
- GET Recent Activity - Exports
- GET Recent Activity - File Access
- GET Recent Activity - Report Runs
- Address
- Attribute
- BOM Settings
- Category
- Change Affected Item
- Change Compact
- Change Item Disposition Attribute
- Change Number Prefix
- Change Routing
- Change
- Compact Item Number Format
- Compliance Requirement
- Event Queue: Integration Administrators
- Event Queue: Integration Event Items
- Event Queue: Integration Event
- Event Queue: Integration Information
- Export Results: File Summary
- Export Results: Item BOM Substitutes
- Export Results: Item BOM
- Export Results: Item Files
- Export Results: Item Sourcing
- Export Results: Item Specs
- Export Results: Sourcing Supplier Item Files
- Export Results: Sourcing Supplier Item Specs
- Export Results: Sourcing Supplier Item Supplier Profile
- Export
- Extract Run File Association
- Extract Run
- Extract
- File Access Event
- File Assocation
- File Compact
- File
- Item BOM Line
- Item Compact
- Item Lifecycle Phase
- Item Number Format
- Item Revision
- Item View
- Item
- Login
- Markup
- Quality Affected Object
- Quality Affected
- Quality Process Number Format
- Quality Process Step Attribute
- Quality Process Step
- Quality Process Template Step
- Quality Process Template
- Quality Process
- Report Run
- Report
- Requirement
- Source Relationship
- Supplier Item
- Supplier
- User
- User Compact
- Where Used Line
- GET Export Run File Metadata
- POST Export Definition
- GET Export Run
- GET Export Definitions (Search)
- POST Export Run
- POST Export Run (Multiple Guids)
- GET Export Definition
- GET Export Runs
- GET Export Run File Content (Download)
- GET Extract Run
- GET Data Extract Latest
- GET Extract Run Files
- GET Extract Run File Content
- GET Extracts Search
- GET Extract Run File
- GET Extract Runs Search
- GET Extract
- GET Event Item
- GET Events (Search)
- GET Integrations (Search)
- PUT Event
- GET Integration Administrators
- GET Event Items
- GET Integrations
- GET Event Item Guids
- GET Event
- PUT Event Item
- About the Import Engine
- Import Options (Item Specs and Item BOM)
- Import Engine Source File
- Import Engine Modes
- Import Engine Mapping
- POST Item Definition
- GET Import Definitions (Search)
- GET Import Definition
- PUT Import Definition Edit
- GET Import Run Submit Content File Content
- GET Import Run Result Content
- GET Import Run
- GET Import Run Error Content
- POST Import Run
- PUT Import Commit
- GET Import Runs
- GET Outbound-Event Integrations
- GET Outbound-Event Integration Trigger
- GET Outbound-Events Integrations (Search)
- GET Outbound-Event Integration Triggers
- GET Integration Administrators
- GET Triggers
- GET Trigger
- GET Outbound-Events Integration Events
- GET Outbound-Event Integration Event
- PUT Outbound-Event Event Change Reconcile
- GET Outbound-Event Integration Requests Event
- GET Outbound-Event Integration Quality Event
- GET Outbound-Event Integration Items Event
- PUT Outbound-Event Event Quality Reconcile
- PUT Outbound-Event Event Item Reconcile
- GET Outbound-Event Integration Changes Event
- PUT Outbound-Event Event Requests Reconcile
- 0 to 2999 - Arena API Unique Error Codes
- 3000 to 3299 - Arena API Unique Error Codes
- 3300 to 3999 - Arena API Unique Error Codes
- 4000 to 4999 - Arena API Unique Error Codes
- 5000 to 5999 - Arena API Unique Error Codes
- 6000 and Beyond - Arena API Unique Error Codes
The Onshape Arena Connection is facilitated by Arena’s REST API. While the majority of the Onshape Arena Connection’s actions take place on Onshape, specifically the Properties dialog or the BOM table, any errors encountered are unique Arena REST API Errors.
The Authorization and Login endpoints must execute successfully prior to any Onshape Arena connection action. Once actions are completed, the Logout endpoint will be executed to terminate the session.
- Errors Encountered When Logging In
- Errors Encountered When Authorizing an Onshape User
- Errors Encountered When Logging Out in the Onshape-Arena Connection
BOM Management process errors occur when adding, removing, and updating items on new and existing Arena BOMs after a sync with an Onshape assembly. All parts on an Onshape assembly that don’t already exist in Arena are created and assigned a value of Yes to the BOM attribute OnshapeCreated. The Onshape Arena Connection only updates BOM items with the OnshapeCreated attribute value set to yes. If the part was removed from the Onshape assembly then the item will be removed from the Arena BOM.
- Errors When Removing an Item From a BOM
- Errors When Adding and Updating a BOM
- Errors Encountered When Reserving Item Numbers for Onshape
- Unknown Errors and System Errors
The File Management Process adds GLTF files to newly created items in Arena through the POST /items endpoint and replaces GTLF files in existing Arena items through a PUT /items endpoint. This process starts when an Onshape part is synced with Arena. If the part exists and already has the file assigned then the existing files will be removed prior to having the new one added. Each file requires a Title and a File Category.