Skip to content

Arena REST API Changelog

Introduction

The Arena REST API lets you link your Arena workspace to other systems and exchange data using a RESTful framework. You'll find detailed information about all available objects and endpoints in the table of contents in the left pane.

If you have any comments or questions about the Arena REST API, contact us at Arenasupport@ptc.com.

December 6, 2025 (Release 2025.4)

  • Quality Management Attributes: New attributes were added to support Quality Workflow Controls. Quality Processes now include sequence_Mode and targetDateComment; Quality Steps include firstOpened and stepAssignComment; and Quality Templates include stepSequencing and multiple supplier settings.
  • Quality Validation Logic: The API now enforces stricter logic aligning with the UI. Errors will be returned if a Step Due Date is set later than the Target Completion Date, if sequencing rules are violated, if a process is completed before required steps are finished, or if a restricted Supplier is assigned as an Owner.
  • Automated Compliance: The GET Supplier Item Compliance endpoints now include a type field to distinguish between ADMIN_DEFINED (manual) and ARENA_DEFINED (automated) requirements.
  • Aggregate Compliance Logic: The logic for calculating compliance status has changed to Non-Compliant > Undetermined > Compliant. This may alter the status values returned by the API for Items and Supplier Items, even if the underlying data has not changed.
  • Error Handling: Error messages for Quality Processes are now more specific, permission checks are stricter, and deprecated response fields have been removed.

September 14, 2025 (Release 2025.3)

  • Category Search Filtering: A new includeChildCategories query parameter was added to endpoints for items, changes, requests, and files. Setting this to false returns resources assigned only to the specified parent category (default behavior remains true).
  • Sourcing via Import Engine: The API now supports bulk creation, editing, and deletion of item sourcing relationships via the Import Engine. Note: Adding potential source relationships is restricted to unlocked item versions only.
  • OpenAPI Standardization: API documentation has moved to GitHub and now uses the OpenAPI (Swagger) standard for real-time updates and machine readability.
  • Field Restrictions: The new "Country of Origin" attribute (for Supply Chain Risk) is read-only and cannot be modified via the API.

July 27, 2025

  • DataExtract endpoints updated to specify that the API user must be the DataExtract owner in order to access the file.

July 12, 2025

The following features released in 2025.1 are now documented: - GET Item and Item object now includes the isLocked attribute. - GET, POST, and DELETE Item number reservations have been added.

June 22, 2025 (Release 2025.2)

In conjunction with the Arena 2025.2 release: - The response to the endpoint GET Change Category Attributes now includes Change routing configuration. - The API now supports the ability for non-creator and non-administrator users to POST a Change Implementation Task and PUT and DELETE the Change Implementation Tasks they create. - To accommodate new Rich Text attributes in the Changes and Quality worlds, Rich Text-enabled Multi-Line Attributes are returned as plain text with field type RICH_TEXT. POST and PUT endpoints now accept rich text in raw HTML format. - Because User Groups can now be assigned to Training, GET, POST, and PUT endpoints for workspace user groups now include the value TRAINING for the Assignability property. - GET endpoints for Requests and Quality Processes now include attribute group information. - GET, PUT, and POST endpoints for attribute groups now support conditionally required and default values, and Item Attribute groups include the option to set Lifecycle Phase as a driving attribute.

April 21, 2025

  • We’ve added two previously undocumented Items History and Changes History endpoints.

March 14, 2025

  • Request Issues: Arena API users can now raise issues within Requests. Ten new endpoints allow for the searching, creating, and managing of Request issues and issue responses.
  • Features live with 2025.1 (previously undocumented):
    • Arena API users can now reserve an item number to assist in CAD integrations. Endpoints for reserving an item number and a numberreservations API object have been added.
    • The 'Any' Search is now available in the following worlds: Items, Requests, Suppliers, Supplier Items, Files, Quality Processes, Training, and Tickets.
    • A new isLocked attribute has been added to the GET Item Specs endpoint.

December 7, 2024

  • GET Changes: The general search for changes can now use Any as a searchable attribute. Any is equivalent to Arena’s ‘Any Search’ used within the user interface.
  • A new GET /settings/users/personal settings endpoint allows users to retrieve a user’s personal settings.
  • The File object attribute storageMethodName supports a new value named Microsoft_365. Files with storageMethodName set to Microsoft_365 exist in the cloud server.
  • A new boolean attribute, isInArena, appears in the Full file object. It only appears with Files that have a storageMethodName set to MICROSOFT_365. If set to true, then the file has been copied from the cloud system to Arena.
  • A new API object called attributeGroup has been added. It contains essential API attributes such as name, guid, and attributes, but also new attributes such as visibilityRules, cascadingRules, dependentAttributes, and drivingAttributes.
  • API users can now perform a general search and a specific search for all items, changes, and quality process attribute groups. API users can also perform a general search or a specific search in item categories, change categories, or quality templates for attribute groups.
  • The DataExtract API object now contains a new attribute labeled type. Possible values are FULL and FULL_AND_DELTA.
  • The DataExtract Run API object contains two new attributes type and viewsExtracted.

September 8, 2024

  • Arena API users can now retrieve all the attributes associated with a Quality Template through a new GET Quality Process Template Attributes endpoint.
  • The new Canceled status for the overall Implementation Status and individual task status is now supported in change and implementation tasks endpoints.
  • GET File with Watermark and GET Item File with watermark endpoints are now documented.

GUID Consistency (2024.2 Release)

With the 2024.2 release, DataExtract generated GUIDs for Items, BOMs, Requests, Changes, Suppliers, Supplier Items, and Quality Process custom attributes are now consistent with the same custom attribute GUIDs generated from the Arena REST API. As a result, custom attribute GUIDs for these resources may differ from the custom attribute GUIDs generated before the 2024.2 release.

As a policy, Arena does not claim that GUIDs are static. As a best practice, we advise developers to obtain the GUID through an application or an integration rather than 'hard coding' a specific GUID value.

June 15, 2024

  • The Workspace Settings > Recent Activity view contains a new subview labeled API Usage. API Usage logs the use of API endpoints within a workspace. API Usage can also be retrieved from a new Recent Activity endpoint: GET /settings/recentactivities/apiusages. For additional information, see the 2024.2 release notes.
  • API users with account administrator status can now search, create, and edit Employee and Machine users at the account level.
  • API users can now manage Employee, Partner, and Machine user access at the workspace level.
  • API users can now add and remove User Group membership for Employees, Partners, and Machine users.
  • API users can now add and remove Policy membership for Employee, Partner, and Machine users.
  • API users can create, edit, and delete a User Group within a workspace. Additional GET endpoints and query strings are now supported.
  • The pre-existing GET /settings/usergroups/{guid}/users and GET /settings/usergroups/{guid}/users/{guid} now include a GUID in a response. We advise any customers who have used these endpoints to review their integration to ensure there are no disruptions.
  • Arena API supports a new Arena-Usage-Reason attribute within the request header for the POST /login endpoint. The format should be {Integration Name}/{Product Version}. Arena-Usage-Reason replaces the recommended use of User-Agent which was advised in our Fall 2023 release.
  • Two new /settings/suppliers/approvalstatuses/ endpoints allow users to perform a general search and a GUID-specific search for Supplier Approval Statuses. Existing /suppliers endpoints now support a new attribute (and object) labeled approvalStatusSetting.

April 20, 2024

  • Arena integrations require at least Java 8 Update 101 (8u101) or more recent versions.

December 1, 2023

  • The Import Engine now supports the creation, editing, overwriting, and deletion of Item-Files associations. By extension, the Import Engine also supports the creation, editing, overwriting, and deletion of File resources.
  • API users can now approve quality process sign-off steps with the new PUT Quality Process Decisions endpoint.
  • API users can now add approvers to a quality process sign-off step with the new POST Quality Process Decisions endpoint.
  • The GET Items Specs endpoint now includes the material effectivity date, materialEffectivityDate, when the responseView is set to full.
  • API users can now search for the routings available for a specific change category through a new GET Settings Change Category Routings endpoint.
  • API users can now obtain the current Arena version through a new GET Settings Arena version endpoint.
  • To support the new restrict duplicate supplier item numbers settings, API users can now add a string, proceedOnWarning, to the POST Supplier Item and PUT Supplier Item endpoints. When proceedOnWarning is set to true, the Supplier Item endpoints will create a supplier item with a duplicate number even when workspace settings explicitly restrict the creation of duplicate supplier item numbers.
  • API users can now execute a DataExtract run at a time of their own choosing through a new POST Extracts endpoint.
  • As a best practice, we encourage all users to include a User-Agent within the header for each API call.

May 20, 2023

  • Attention: Following RFC 2616 section 4.2, Arena REST API HTTP header names will become case-insensitive in an imminent release. Please ensure your code can accept case-insensitive HTTP headers.
  • Users can now import item specs and item BOM information through the Import Engine. The Import Engine uses a POST Definition endpoint to configure an import. Next, a POST Run endpoint uses a Definition GUID and a source file with valid content to import the data into an Arena workspace. Supplementary GET and PUT endpoints for Definition and Run endpoints are also available.
  • Arena REST API now supports endpoints for searching, creating, editing (assignee and status), and removing Change Implementation Tasks. Additional endpoints that support searching, creating, editing, and removing of Change Implementation Task notes and Change Implementation Task files are also included.
  • To delineate between global Inventory Disposition settings and category-specific Inventory Disposition settings, the Change Item Attribute object now supports a new property labeled global. The property global is a boolean attribute. Core attributes and categories set to Global Requirements return a value of true for global. Attributes with one or more categories set to Category Specific Requirement Rules return a value of false for global. A new settings endpoint GET /settings/changes/categories/{guid}/items/attributes returns change category-specific item attributes.
  • In order to support customizable Abandoned, Deprecated, and Obsolete phases, the Item Lifecycle Phase object now uses a new property called type that primarily appears within the GET /settings/items/lifecyclephases endpoint. Additionally the POST /items/lifecyclephasechanges, POST /changes/{guid}/items, and the PUT /changes/{guid}/items/{guid} endpoints now support direct revisioning of the Abandoned, Deprecated, and Obsolete lifecycle phases.
  • The GET Tickets Templates and GET Quality Process Templates endpoints now support two new search attributes: name and active. The attribute name allows the user to search by the name of the template. The attribute active is a boolean attribute. If active is set to true, the endpoint searches for active templates.
  • The GET /items and GET /items/{guid} endpoints now support a new parameter labeled responseview. This allows users to customize the response data.
  • The GET, POST, and PUT endpoints that reference Change resources now return a new property labeled url. url returns two references that are direct URLs for the Change resource: api and app. app is the direct URL link to the Change resource in the main Arena user interface.
  • The POST changes/{guid}/items endpoint no longer requires the newLifecyclePhase attribute within the request body. Omitting the newLifecyclePhase attribute from this endpoint automatically selects the scheduled lifecycle phase based on its current phase.

January 8, 2023

  • Request View on Changes: Arena REST API capability expands to the Request view of a Change. New endpoints include:
    • Ability to perform a general search for the Requests to a specific Change.
    • Ability to perform a GUID search for a specific Request to a specific Change.
    • Ability to add a Request to a specific Change.
    • Ability to remove a Request from a specific Change.
  • Change Search via Request: Arena REST API now includes endpoints for searching Changes associated with a Request.
  • Event Engine for Requests: With Event Engine support for Requests, new endpoints include:
    • Ability to perform a general search for Request related events.
    • Ability to perform a search for a specific Request event from a specific event in a specific outbound-event integration.
    • Ability to reconcile or unreconcile a Request specific event.
  • Existing GET Triggers, GET Outbound-Event Integration Triggers, and GET Outbound-Events Integration Events endpoints now support the Request world.
  • To support the new "After Approval" option for Retrain when adding Training Plan Items to a Change, a new retraining attribute is now included in the Change Affected Item object used in GET Change Items, GET Change Item, POST Change Items, and PUT Change Items. The retraining attribute supports the values NO_RETRAIN, AFTER_APPROVED, and AFTER_EFFECTIVE.
  • GET Items now supports the assemblyType attribute in general Items search. Additionally, inAssembly and assemblyType are now included in the Item objects for the GET Items and the GUID specific GET Items search.
  • The GET Request Attributes and GET Request Category Attributes now include support for editable Request core attributes.

June 26, 2022

  • Training Plans: Arena REST API capability expands to Training Plans, including endpoints for:
    • Creating, editing, searching, deleting, and modifying the status of a Training Plan.
    • Managing Items, Users, Files, Quality Processes, and Records associated with a Training Plan.
    • Retrieving training managers and number sequences.
    • Finding training plans associated with specific Items or Files.
  • The existing GET Quality Process Step Affected Objects endpoints now return Training Plans that include the Quality Process as a reference.
  • Request Workflows: New endpoints for Request workflows include:
    • Submitting, Withdrawing, Deferring, Promoting, and Closing a Request.
    • Retrieving request attributes used during lifecycle status changes.
  • Change Workflows: New endpoints for Change workflow functions include:
    • Withdrawing, Force Approving, Force Rejecting, Canceling, Reopening, and Force Expiring (Deviations) a Change.
    • Completing an effective Change with an option to update the implementation status.
    • Unmarking a Change as completed.
    • Retrieving valid implementation statuses.
  • The GET BOM endpoint now includes a parameter labeled includeAdditionalAttributes. If set to true, additional BOM attributes are included in the response for each child item.
  • GET category attribute endpoints for Items, Changes, and Requests include a new attribute field labeled origin. origin returns information on the inheritance of an Attribute object (GUID and name).

April 17, 2022

  • The GET, POST, and PUT endpoints that reference Item resources now return a new property: url. url returns two references that are direct URLs for the Item resource: api and app. This affects endpoints for Item (Including Item Criteria), BOM, Item Revisions, Item Where Used, Item Lifecycle Phase Change, Change Items, Request Items, and Supplier Item Sourcing.

January 14, 2022

  • A new POST Status Changes endpoint allows users to Lock/Unlock a Change, Submit for Approval, and Submit for Routing.
  • A new GET Change Alerts endpoint allows users to look up errors and notices that occur when attempting to submit a Change.
  • A new GET Change Administrator endpoint retrieves all Change Administrators within a workspace.
  • A new GET Export Settings Attributes endpoint returns the export attributes supported when creating an Export Definition.
  • New endpoints allow retrieving decisions of all users in a Quality Process sign-off step, or a specific user's decision.
  • The GET Supplier Item Sourcing endpoint now includes the GUID for each source relationship.
  • New endpoints return Quality Processes associated with an Item, Supplier Item, Change, or Request.
  • New endpoints return Ticket objects appearing within the Tickets view of an Item or a Change.
  • Requests can now be added as affected objects for Quality Processes via API.
  • Triggers with edit actions now create events based on the pre-event state of the category, edited attributes, and conditions.

October 3, 2021

  • Requests: Arena API now supports Requests. Added endpoints for searching, creating, editing, and deleting Requests, as well as managing associated Items, Files, and administrative settings.
  • Tickets: Arena API now supports Tickets. Added endpoints for searching, creating, editing, deleting, and updating status, as well as managing Files and references (Changes, Items, Quality Processes).
  • Added two new endpoints for searching the future Changes of an Item (Future Changes subview).
  • BOM Substitutes: Added endpoints to search, create, update, and remove BOM Substitutes.
  • Events Engine: Added endpoints for searching Triggers, Outbound-Event Integrations, and queued events. Added support for reconciling/unreconciling resource-specific events.
  • Attributes & Categories: Added twenty endpoints for creating, updating, and deleting Item attributes and category attributes. Warning: Arena does not recommend using these endpoints regularly as they can have significant impact on product data.

August 22, 2021

  • Documentation added for the GET Items (Search) Criteria Parameter. This requires URL encoding of the query string and allows complex queries (e.g., by creation date) using the same attributes and operators as API Export.

April 24, 2021

  • Added four new endpoints for managing Change Files (Files view).
  • Added four new endpoints for managing Change Implementation Files (Implementation view).
  • Added six new endpoints for managing File Markups (retrieving content, creating, editing, deleting).
  • Added four new endpoints for managing Change File Markups.
  • Added five new endpoints for managing Supplier Files.
  • Added two new endpoints for completing and reopening a Quality Process step.
  • API Item Export now supports JSON format. A new export option format supports csv and json.

January 22, 2021

  • Added POST endpoints for File Check Out, Check In, and Cancel Check Out.
  • Added endpoints for applying and removing compliance requirements for Items and Supplier Items.
  • Added endpoints for creating, editing, and deleting Item and Supplier Item thumbnail images.
  • Added endpoints for retrieving User Groups and their members (employees, partners).
  • Added PUT endpoints for assigning users and User Groups to a Quality Process step.
  • Added endpoints for managing Supplier phone numbers and addresses.
  • Added support for updating storageMethodName when updating unlocked files.
  • The GET Export Runs endpoint now supports searchable attributes: completionDateTimeFrom, completionDateTimeTo, latestCompleted, number, and status.
  • A new API Export option header allows users to export Items with their attribute names instead of apiNames.
  • Export lifecycle status now supports the status of Downloaded.
  • API Item export now supports the ability to export multiple Items with a revision status of POTENTIAL.

October 4, 2020

  • Arena REST API now supports File corrections via GET (list corrections) and POST (execute correction) endpoints.
  • The Corrected attribute has been added to existing File endpoints.

September 20, 2020

  • GET Item Categories no longer includes deleted Categories by default. Use includeDeleted=true to include them.
  • The component fields within a numberFormat have been changed from apiName to GUID.

September 6, 2020

  • Added deletionDateTime, parentCategory, and structural fields to the Category Objects page. The description for assignable has been changed.
  • Updated GET Item Categories response examples.

August 2, 2020

  • Arena REST API now supports 22 additional Criteria attributes for Arena API Export.
  • Updated POST Export Definition:
    • modifiedBOM, modifiedSpecs, modifiedFiles, and modifiedSourcing always refer to the working revision.
    • Arena Export does not support export for category.guid using the GUID for "uncategorized". Use attribute = category.name, operator = IS_EQUAL_TO, and value = -uncategorized-.
    • An Item Export with revisionStatus set to WORKING or POTENTIAL will return the working revision even if effective versions exist.
  • POST Quality Process Step Affected Object Add now supports Items, Changes, Suppliers, Supplier Items, Files, Quality, and URLs.

April 5, 2020

  • Added 10 new endpoints to monitor status of outbound integrations and facilitate reconciliation.
  • Added 8 new endpoints for Item exports. Exports are defined in an Export definition (POST) and executed in an Export run (POST).
  • Added notes regarding newItemRevision GUID, affectedItemRevision GUID, and newRevision number behavior in Change Item associations.

January 12, 2020

  • Added support for Multi-Select custom attributes in Changes, Requests, and Quality Processes.
  • For BOM line numbers that are automatically generated, lineNumber will be set to null.

August 18, 2019

  • Ability to add Files and Changes as affected objects to Quality Processes.
  • Added support for Item-To-Item references.
  • Ability to complete and re-open Quality Processes.

May 12, 2019

  • Added support for searching Items, Supplier Items, Suppliers, Changes, and Quality Processes by custom attributes.

February 24, 2019

  • Added support for editable core Item attributes and core Change attributes.
  • Added support for non-revision controlled custom attributes for Items (currently only COST field type).
  • Modified meaning of "Required" for custom attributes to match application behavior (returns true even if a default value exists).
  • The deprecated apiName field will now have the value of the attribute GUID.

Previous Releases

  • November 18, 2018
  • September 16, 2018
  • August 12, 2018
  • July 29, 2018
  • April 1, 2018
  • March 18, 2018
  • March 11, 2018
  • December 3, 2017
  • September 24, 2017
  • July 23, 2017
  • July 8, 2017
  • June 18, 2017