Version 2.

22
Released on 6 May 2022

Restricted Rights

No part of this document may be reproduced, distributed or transmitted in any form or by

any means, electronic or mechanical, including photocopying and recording, without the
express written permission of Arena, A PTC Business.

The material in this manual is for information only and is subject to change without notice.
While reasonable efforts have been made to ensure accuracy of this material, Arena, A PTC
Business, does not assume any liability resulting from errors or omissions in this manual, or
from the use of the information in this manual.

Copyrights & Trademarks

Copyright © 2003-2022, Arena, A PTC Business. All rights reserved.

Arena and Arena PLM are trademarks of Arena, A PTC Business. All other company and product
names may be trademarks of their respective owners and are used for product and company
identification only.
 Arena REST API Developer Guide Arena REST API Developer Guide

Table of Contents
Change Log ............................................................................................................................. 12

Theory of Operation
Overview ........................................................................................................................ 20
API Format ..................................................................................................................... 22
Connecting and Permissions ......................................................................................... 23
Licensing ........................................................................................................................ 23
API Requests .................................................................................................................. 24
Responses ...................................................................................................................... 24
Successes and Errors ...................................................................................................... 25
API Sample Code ............................................................................................................ 26
BOM and Workspace Settings ....................................................................................... 26
Note on Date/Time Handling ......................................................................................... 27

Endpoints
POST Log In .................................................................................................................... 30
PUT Log Out ................................................................................................................... 32
GET Extracts Search ....................................................................................................... 33
GET Extract ..................................................................................................................... 35
GET Extract Runs Search ................................................................................................ 37
GET Extract Run ............................................................................................................. 41
GET Data Extract Latest ................................................................................................. 43
GET Extract Run Files ..................................................................................................... 45
GET Extract Run File ....................................................................................................... 48
GET Extract Run File Content ......................................................................................... 50
GET Files Search ............................................................................................................. 52
GET File Summary .......................................................................................................... 55
GET File Content ............................................................................................................ 57
POST File Create ............................................................................................................ 59
PUT File Summary Update ............................................................................................. 62
POST File Content Update ............................................................................................. 65
DELETE File .................................................................................................................... 67
GET File Associations ..................................................................................................... 69
GET File Editions ............................................................................................................ 73
GET File Corrections ....................................................................................................... 75
GET File Correction ........................................................................................................ 77
POST File Edition Create ................................................................................................ 79
POST File Correct ........................................................................................................... 82
POST File Check Out ...................................................................................................... 85
POST Cancel File Check Out ........................................................................................... 88
POST File Check In ......................................................................................................... 90
GET File Markups ........................................................................................................... 92

©2022 Arena, A PTC Business www.arenasolutions.com 2

 Arena REST API Developer Guide Arena REST API Developer Guide

GET File Markup ............................................................................................................. 95

GET File Markup Content ............................................................................................... 97
POST File Markup Create ............................................................................................... 99
PUT File Markup Update .............................................................................................. 103
DELETE File Markup ..................................................................................................... 106
GET Change File Associations ...................................................................................... 108
GET Change File Association ....................................................................................... 110
GET Change Implementation File Associations .......................................................... 112
GET Change Implementation File Association ............................................................ 114
GET Items (Search) ....................................................................................................... 116
GET Items (Search) Criteria Parameter ........................................................................ 122
GET Item Specs ............................................................................................................ 129
POST Item Create ......................................................................................................... 132
PUT Item Update .......................................................................................................... 141
GET Item Thumbnail Image Content ........................................................................... 147
POST Item Specs Thumbnail Image Create ................................................................. 149
POST Item Specs Thumbnail Image Create From Files View ....................................... 151
DELETE Item Thumbnail Image ................................................................................... 153
DELETE Item ................................................................................................................. 155
GET BOM ...................................................................................................................... 156
GET BOM Line .............................................................................................................. 159
GET BOM Settings ........................................................................................................ 162
POST BOM Line Create ................................................................................................. 164
PUT BOM Line Update ................................................................................................. 168
PUT BOM Settings Update ........................................................................................... 171
DELETE BOM Line ......................................................................................................... 173
GET BOM Subsitutes .................................................................................................... 175
GET BOM Subsitute ...................................................................................................... 177
POST BOM Substitute Create ....................................................................................... 179
PUT BOM Substitute Create ......................................................................................... 181
DELETE BOM Substitute .............................................................................................. 183
GET Item Compliance Requirements ........................................................................... 184
GET Item Compliance Requirement ............................................................................ 186
PUT Item Compliance Update ..................................................................................... 188
GET Item File Associations ........................................................................................... 190
GET Item File Association ............................................................................................ 192
GET Item File Content .................................................................................................. 194
POST Item File Create .................................................................................................. 196
POST Item File Add Existing ........................................................................................ 199
POST Item File Content Update ................................................................................... 202
POST File Update ......................................................................................................... 204
PUT Item File Association Update ............................................................................... 206
DELETE Item File Association ...................................................................................... 208
POST Item Lifecycle Phase Change .............................................................................. 209
GET Item Quality Processes ......................................................................................... 247
GET Item Revisions ...................................................................................................... 214

©2022 Arena, A PTC Business www.arenasolutions.com 3

 Arena REST API Developer Guide Arena REST API Developer Guide

GET Item Future Changes ............................................................................................ 217

GET Item Source Relationships .................................................................................... 220
GET Item Source Relationship ..................................................................................... 224
POST Item Source Relationship Create ........................................................................ 226
PUT Item Source Relationship Update ........................................................................ 229
DELETE Item Source Relationship ............................................................................... 231
POST Item Compliance ................................................................................................ 232
DELETE Item Compliance ............................................................................................. 234
GET Where Used .......................................................................................................... 236
GET Item-To-Item References ...................................................................................... 238
GET Item-To-Item Reference ....................................................................................... 240
POST Item-To-Item Reference Create .......................................................................... 242
PUT Item-To-Item Reference Update .......................................................................... 244
DELETE Item-To-Item Reference .................................................................................. 246
GET Item Quality Processes ......................................................................................... 247
GET Item Ticket References ......................................................................................... 249
About Criteria and Options in API Export ................................................................... 251
Export Options ............................................................................................................. 252
Export Criteria ............................................................................................................. 254
Criteria: Attributes and Operators .............................................................................. 257
About Export Results and the JSON Format ................................................................ 261
POST Export Definition ................................................................................................ 263
GET Export Definitions (Search) .................................................................................. 272
GET Export Definition .................................................................................................. 278
POST Export Run .......................................................................................................... 280
GET Export Run ............................................................................................................ 284
GET Export Run File Metadata ..................................................................................... 287
GET Export Run File Content (Download) ................................................................... 289
GET Export Runs .......................................................................................................... 291
GET Integrations (Search) ............................................................................................ 294
GET Integrations .......................................................................................................... 297
GET Integration Administrators .................................................................................. 299
GET Events (Search) ..................................................................................................... 301
GET Event ..................................................................................................................... 306
GET Event Item Guids .................................................................................................. 308
PUT Event ..................................................................................................................... 310
GET Event Items ........................................................................................................... 313
GET Event Item ............................................................................................................ 323
PUT Event Item ............................................................................................................ 325
GET Requests ............................................................................................................... 328
GET Request ................................................................................................................. 335
POST Request Create ................................................................................................... 337
PUT Request Edit ......................................................................................................... 339
DELETE Request ........................................................................................................... 341
GET Request Items ....................................................................................................... 342
GET Request Affected Item .......................................................................................... 344

©2022 Arena, A PTC Business www.arenasolutions.com 4

 Arena REST API Developer Guide Arena REST API Developer Guide

POST Request Item Add ............................................................................................... 346

PUT Request Item Edit ................................................................................................. 348
DELETE Request Item ................................................................................................... 350
GET Request File View Associations ............................................................................ 351
GET Request Files View Association ............................................................................ 354
POST Request Files View Add Existing File ................................................................. 356
DELETE Request File View Association ........................................................................ 358
GET Request File Markups ........................................................................................... 359
GET Request File Markup ............................................................................................. 362
POST Request File Markup Create ............................................................................... 364
DELETE Request File Markup ....................................................................................... 366
GET Request Quality Processes ................................................................................... 368
GET Changes ................................................................................................................ 371
GET Change .................................................................................................................. 378
GET Change Affected Items ......................................................................................... 384
GET Change Affected Item ........................................................................................... 389
GET Change Quality Processes .................................................................................... 393
POST Change Create .................................................................................................... 396
PUT Change Edit .......................................................................................................... 404
DELETE Change ............................................................................................................ 412
POST Change Affected Item Add ................................................................................. 413
PUT Change Affected Item Edit ................................................................................... 417
DELETE Change Affected Item ..................................................................................... 421
POST Change Status (Lock/Unlock) ............................................................................. 423
POST Change Status (Submitting and Admin-Defined) .............................................. 425
POST Change Status (Submitting and Auto-Routing) ................................................. 429
POST Change Status (Submitting and User-Defined) ................................................. 432
GET Change Alerts ....................................................................................................... 435
GET Change Files View Associations ........................................................................... 437
GET Change Files View Association ............................................................................. 440
POST Change Files View Add Existing File .................................................................. 442
DELETE Change File View Association ......................................................................... 444
GET Change Implementation Files View Associations ................................................ 445
GET Change Implementation Files View Association .................................................. 449
POST Change Implementation Files View Add Existing File ....................................... 451
DELETE Change Implementation File View Association ............................................. 453
GET Change File Markups ............................................................................................ 454
GET Change File Markup ............................................................................................. 457
POST Change File Markup Create ................................................................................ 459
DELETE Change File Markup ........................................................................................ 461
GET Changes Ticket References ................................................................................... 463
GET Quality Processes Search ...................................................................................... 465
GET Quality Process Summary .................................................................................... 469
POST Quality Process Create ....................................................................................... 471
PUT Quality Process Update ........................................................................................ 474
DELETE Quality Process ............................................................................................... 476

©2022 Arena, A PTC Business www.arenasolutions.com 5

 Arena REST API Developer Guide Arena REST API Developer Guide

POST Quality Process Complete .................................................................................. 477

POST Quality Process Reopen ..................................................................................... 479
GET Quality Process Step Affected Objects ................................................................. 481
GET Quality Process Step Affected Object .................................................................. 483
POST Quality Process Step Affected Object Add ......................................................... 485
PUT Quality Process Step Affected Object Update ..................................................... 490
DELETE Quality Process Step Affected Object ............................................................. 492
GET Quality Process Steps ........................................................................................... 493
GET Quality Process Step ............................................................................................. 498
GET Quality Process Step Decisions ............................................................................ 501
PUT Quality Process Step Update (User Assignee) ...................................................... 505
PUT Quality Process Step Update (User Group Assignee) ........................................... 508
PUT Quality Process Step Update (Deprecated) .......................................................... 511
POST Quality Process Step Complete .......................................................................... 514
POST Quality Process Step Reopen ............................................................................. 517
GET Tickets ................................................................................................................... 520
GET Ticket .................................................................................................................... 526
POST Ticket Create ...................................................................................................... 528
PUT Ticket Edit ............................................................................................................. 532
POST Ticket Status Change .......................................................................................... 535
DELETE Ticket .............................................................................................................. 537
GET Ticket Files ............................................................................................................ 538
POST Tickets Files View Add Existing File ................................................................... 542
DELETE Ticket Remove File Association ...................................................................... 544
GET Ticket Changes ..................................................................................................... 545
POST Tickets Add Change Reference .......................................................................... 547
DELETE Ticket Remove Change Association ............................................................... 549
GET Ticket Items .......................................................................................................... 550
POST Tickets Add Item Reference ............................................................................... 552
DELETE Ticket Remove Item Association .................................................................... 554
GET Ticket Quality Processes ....................................................................................... 555
POST Tickets Add Quality Process Reference .............................................................. 557
DELETE Ticket Remove Quality Process Association ................................................... 559
GET Ticket Tickets ........................................................................................................ 560
POST Tickets Add Ticket Reference ............................................................................. 562
DELETE Ticket Remove Ticket Association .................................................................. 564
GET Triggers ................................................................................................................ 565
GET Trigger .................................................................................................................. 569
GET Outbound-Events Integrations (Search) .............................................................. 571
GET Outbound-Event Integrations .............................................................................. 574
GET Outbound-Event Integration Triggers ................................................................. 576
GET Outbound-Event Integration Trigger ................................................................... 578
GET Integration Administrators .................................................................................. 580
GET Outbound-Events Integration Events .................................................................. 582
GET Outbound-Event Integration Event ..................................................................... 586
GET Outbound-Event Integration Items Event ........................................................... 588

©2022 Arena, A PTC Business www.arenasolutions.com 6

 Arena REST API Developer Guide Arena REST API Developer Guide

GET Outbound-Event Integration Changes Event ...................................................... 594

GET Outbound-Event Integration Quality Event ......................................................... 598
PUT Outbound-Event Event Item Reconcile ................................................................ 602
PUT Outbound-Event Event Change Reconcile ........................................................... 604
PUT Outbound-Event Event Quality Reconcile ........................................................... 606
GET Recent Activity - User Access ................................................................................ 608
GET Recent Activity - Exports ...................................................................................... 610
GET Recent Activity - Report Runs ............................................................................... 612
GET Recent Activity - File Access ................................................................................. 614
GET Item Attributes ..................................................................................................... 616
GET BOM Attributes ..................................................................................................... 623
GET Item Categories .................................................................................................... 626
GET Item Category Attributes ..................................................................................... 634
POST Items Category ................................................................................................... 639
POST Items Specs Attribute Cost ................................................................................. 642
POST Items Specs Attribute Date ................................................................................ 644
POST Items Specs Attribute Drop-Down ..................................................................... 646
POST Items Specs Attribute Fixed Drop-Down Single Selection ................................ 648
POST Items Specs Attribute Fixed Drop-Down Multiple Selection ............................. 650
POST Items Specs Attribute Multi Line Text ................................................................ 652
POST Items Specs Attribute Number ........................................................................... 654
POST Items Specs Attribute Single Line Text .............................................................. 656
DELETE Item Category Attribute ................................................................................. 658
DELETE Item Specs Attribute ....................................................................................... 659
PUT Items Specs Attribute Cost ................................................................................... 660
PUT Items Specs Attribute Date .................................................................................. 662
PUT Items Specs Attribute Drop-Down ....................................................................... 664
PUT Items Specs Attribute Fixed Drop-Down Single .................................................. 666
PUT Items Specs Attribute Fixed Drop-Down Multiple ............................................... 668
PUT Items Specs Attribute Single Line Text ................................................................ 670
PUT Items Specs Attribute Number ............................................................................. 672
PUT Items Specs Attribute Multi Line Text .................................................................. 674
PUT Item Category Attribute ....................................................................................... 676
PUT Item Category ....................................................................................................... 678
GET Item Number Formats .......................................................................................... 681
GET Item Lifecycle Phases ............................................................................................ 685
GET Item Compliance Requirements ........................................................................... 687
GET Export Setting Attributes ..................................................................................... 690
GET Requests Categories ............................................................................................. 694
GET Request Attributes ............................................................................................... 697
GET Request Category Attributes ................................................................................ 700
GET Request Item Attributes ....................................................................................... 702
GET Request Number Prefixes ..................................................................................... 704
GET Request Number Sequences ................................................................................ 706
GET Request Administrators ....................................................................................... 709
GET Request Evaluator Groups .................................................................................... 711

©2022 Arena, A PTC Business www.arenasolutions.com 7

 Arena REST API Developer Guide Arena REST API Developer Guide

GET Change Administrators ........................................................................................ 713

GET Change Attributes ................................................................................................ 715
GET Change Item Attributes ........................................................................................ 719
GET Change Number Prefixes ...................................................................................... 724
GET Change Category Attributes ................................................................................ 726
GET Change Categories ............................................................................................... 730
GET Change Routings .................................................................................................. 733
GET Supplier Attributes ............................................................................................... 735
GET Supplier Item Attributes ....................................................................................... 738
GET Supplier Item Compliance Requirements ............................................................ 741
GET File Attributes ....................................................................................................... 744
GET File Categories ...................................................................................................... 748
GET Quality Process Templates ................................................................................... 752
GET Quality Process Number Formats ......................................................................... 760
GET Quality Process Attributes ................................................................................... 763
GET Quality Process Step Attributes ........................................................................... 768
GET Quality Process Owners ........................................................................................ 771
GET Tickets Attributes ................................................................................................. 773
GET Tickets Number Sequence Prefixes ...................................................................... 776
GET Tickets Number Sequences .................................................................................. 778
GET Tickets Templates ................................................................................................. 780
GET Tickets Templates Attributes ............................................................................... 784
GET Users ..................................................................................................................... 786
GET User Groups .......................................................................................................... 790
GET User Group ............................................................................................................ 793
GET User Group Employees ......................................................................................... 795
GET User Group Employee ........................................................................................... 797
GET User Group Partners ............................................................................................. 799
GET User Group Partner ............................................................................................... 801
GET User Group Users .................................................................................................. 803
GET User Group User ................................................................................................... 805
GET Suppliers ............................................................................................................... 807
GET Supplier (Profile) .................................................................................................. 810
POST Supplier Create .................................................................................................. 813
PUT Supplier Update ................................................................................................... 817
DELETE Supplier .......................................................................................................... 821
GET Supplier Address .................................................................................................. 822
GET Supplier Addresses ............................................................................................... 824
GET Supplier Profile Phone Numbers .......................................................................... 826
GET Supplier Phone Number ....................................................................................... 828
POST Supplier Profile Address Create ......................................................................... 830
POST Supplier Phone Number Create ......................................................................... 832
PUT Supplier Profile Address Edit ............................................................................... 834
PUT Supplier Phone Number Edit ............................................................................... 836
DELETE Supplier Address ............................................................................................ 838
DELETE Supplier Phone Number ................................................................................. 839

©2022 Arena, A PTC Business www.arenasolutions.com 8

 Arena REST API Developer Guide Arena REST API Developer Guide

GET Supplier File Associations .................................................................................... 840

GET Supplier File Association ...................................................................................... 843
POST Supplier File Add Existing .................................................................................. 845
DELETE Supplier File Association ................................................................................ 847
DELETE Supplier File .................................................................................................... 848
GET Supplier Quality Processes ................................................................................... 849
GET Supplier Items ...................................................................................................... 851
GET Supplier Item Specs .............................................................................................. 854
POST Supplier Item Create .......................................................................................... 856
PUT Supplier Item Update ........................................................................................... 860
GET Supplier Item Thumbnail Image Content ............................................................. 863
POST Supplier Item Specs Thumbnail Image Create ................................................... 865
POST Supplier Item Specs Thumbnail Image Create From Files View ........................ 867
DELETE Supplier Item Thumbnail Image ..................................................................... 869
DELETE Supplier Item .................................................................................................. 871
GET Supplier Item Compliance .................................................................................... 872
GET Supplier Item Compliance Requirement .............................................................. 874
PUT Supplier Item Compliance Update ....................................................................... 876
GET Supplier Item File Associations ............................................................................ 878
GET Supplier Item File Association .............................................................................. 881
GET Supplier Item File Content ................................................................................... 883
POST Supplier Item File Create .................................................................................... 885
POST Supplier Item File Content Update .................................................................... 888
POST Supplier Item File Add Existing ......................................................................... 890
PUT Supplier Item File Association Update ................................................................. 892
DELETE Supplier Item File Association ........................................................................ 894
POST Supplier Item Compliance .................................................................................. 895
DELETE Supplier Item Compliance .............................................................................. 897
GET Supplier Item Quality Processes ........................................................................... 898
GET Supplier Item Source Relationships ..................................................................... 900
GET Supplier Item Source Relationship ....................................................................... 903

Objects
Address ........................................................................................................................ 906
Attribute ...................................................................................................................... 906
BOM Settings ............................................................................................................... 909
Category ...................................................................................................................... 909
Change ......................................................................................................................... 910
Change Compact ......................................................................................................... 912
Change Affected Item .................................................................................................. 912
Change Item Disposition Attribute ............................................................................. 913
Change Number Prefix ................................................................................................ 913
Change Routing ........................................................................................................... 914
Compliance Requirement ............................................................................................ 914
Export .......................................................................................................................... 914

©2022 Arena, A PTC Business www.arenasolutions.com 9

 Arena REST API Developer Guide Arena REST API Developer Guide

Extract .......................................................................................................................... 915

Extract Run ................................................................................................................... 915
Extract Run File Association ........................................................................................ 916
File ............................................................................................................................... 916
File Compact ................................................................................................................ 917
File Access Event .......................................................................................................... 917
File Assocation ............................................................................................................. 918
Item .............................................................................................................................. 918
Item Compact .............................................................................................................. 919
Item BOM Line ............................................................................................................. 920
Item Lifecycle Phase .................................................................................................... 920
Item Number Format ................................................................................................... 920
Compact Item Number Format .................................................................................... 921
Item Revision ............................................................................................................... 921
Item View ..................................................................................................................... 921
Export Results: Item Specs .......................................................................................... 922
Export Results: Item BOM ............................................................................................ 923
Export Results: Item BOM Substitutes ......................................................................... 923
Export Results: Item Sourcing ..................................................................................... 923
Export Results: Item Files ............................................................................................ 924
Export Results: File Summary ..................................................................................... 925
Export Results: Sourcing Supplier Item Specs ............................................................. 925
Export Results: Sourcing Supplier Item Supplier Profile ............................................. 926
Export Results: Sourcing Supplier Item Files ............................................................... 926
Event Queue: Integration Information ........................................................................ 927
Event Queue: Integration Administrators ................................................................... 927
Event Queue: Integration Event .................................................................................. 928
Event Queue: Integration Event Items ........................................................................ 928
Login ............................................................................................................................ 929
Markup ........................................................................................................................ 929
Quality Number Format ............................................................................................... 929
Quality Process ............................................................................................................ 929
Quality Process Step .................................................................................................... 930
Quality Process Template ............................................................................................ 931
Quality Process Template Step .................................................................................... 932
Quality Affected Object ............................................................................................... 932
Quality Affected ........................................................................................................... 932
Report .......................................................................................................................... 933
Report Run ................................................................................................................... 933
Requirement ................................................................................................................ 933
Source Relationship ..................................................................................................... 934
Quality Process Step Attribute .................................................................................... 934
Supplier ....................................................................................................................... 935
Supplier Item ............................................................................................................... 936
User .............................................................................................................................. 936
User Compact ............................................................................................................... 937

©2022 Arena, A PTC Business www.arenasolutions.com 10

 Arena REST API Developer Guide Arena REST API Developer Guide

Where Used Line .......................................................................................................... 937

©2022 Arena, A PTC Business www.arenasolutions.com 11

 Arena REST API Developer Guide Change Log

Change Log
Date Updates
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. App stands for application and is the direct url link to the
Item resource in the main Arena user interface application. The responses in the
following GET, POST, and PUT endpoints have been updated to reflect the new
url property: Item (Including Item Criteria), BOM (BOM Line), Item Revisions, Item
Where Used, Item Lifecycle Phase Change, Change Items, Request Items, and
Supplier Item Sourcing.
January 14, 2022 • Added two GET Quality Process Step Decisions endpoints. Returns the decisions
of all approvers or a single decision in a Quality Sign-Off Step.

• Added the POST Change Status endpoint. Allows users to lock and unlock a
change. Also allows users to submit a change for approval or for routing
depending on the configured routing method.

• Added a GET Change Alerts endpoints. Returns all possible submission errors
that appear when submitting a Change in the POST Change Status endpoint.

• Added two GET Change Administrator endpoints. Returns all change

administrators for a workspace or a specific one if the endpoint is appended
with a valid GUID.

• Added a new GET Export Settings Attributes endpoint. Returns the export
attributes supported when creating an export definition.

• The GET Supplier Item Sourcing endpoint now returns the GUID for each source
relationship in the response body. Also if appended with a valid GUID, the
endpoint now returns a specific source relationship.

• If appended with a valid GUID, the existing GET Item Quality, GET Supplier
Quality, & GET Supplier Item Quality endpoints now return a specific Quality
Process where each object was added as an affected object.

• GET Change Quality and GET Requests Quality endpoints now return Quality
Processes that contain each respective Change or Request has been added as
an affected object. If appended with a valid GUID, the endpoints return a specific
Quality Process.

• A GET Item Tickets and a GET Change Tickets have been added. They return
Tickets that appear within the Tickets of view of the respective Item or Change.
If appended with a valid GUID, they return a specific Ticket attached to an Item
or a Change. Additionally the GET Quality Process Step Affected Object endpoints
now returns Tickets if they have been added as an affected object on a specific
step.

• Existing GET Quality Process Step Affected, POST Quality Process Step Affected,
PUT Quality Process Step Affected, and DELETE Quality Process Step Affected
now support the searching, creating, editing, and removal of requests as affected
objects within a Quality Process step.

©2022 Arena, A PTC Business www.arenasolutions.com 12

 Arena REST API Developer Guide Change Log

Date Updates
• Triggers with edit actions now create events based on the pre-event state of
the category, edited attributes, and the conditions of the resource.

October 3, 2021 • Arena API now supports Requests. Added five new endpoints that support
searching, creating, editing, and deleting Requests. Added five new endpoints
that support the searching, adding, editing, and removal of Items from Requests.
Added 8 new endpoints for searching, adding, and removal of Files and File
Markups to Requests. Added eight new endpoints that return the administrative
settings of Requests.

• Arena API now supports Tickets. Added six new endpoints that support
searching, creating, editing, deleting, and updating the status of Tickets. Added
four new endpoints that support the searching, adding, and removing of Files
to tickets. Added sixteen new endpoints that support the searching, adding,
and removal of Changes, Items, Quality Processes, and other Tickets as references
to Tickets. Added five endpoints that return the administrative settings of Tickets.

• Added two new endpoints that allow users to search for the future Changes of
an Item.

• Arena API now supports BOM Substitutes modification. Added five new
endpoints that allow users to search, create, update, and remove BOM
Substitutes.

• Arena API supports the new Events Engine feature. Added two new endpoints
that support searching for Triggers. Added five new endpoints that support
searching for Outbound-Event Integrations, the triggers associated with the
Outbound-Event integration, and the Outbound-Event integration
administrators. Added two endpoints that support searching for events queued
by Outbound-Event integrations. Added six endpoints that search and specify
GUIDs of Items, Changes, and Quality Process of specific events. Added three
PUT endpoints that allow users to reconcile or unreconcile the resource specific
events.

• Arena API Help now documents twenty endpoints that allow for the creation,
update, and deletion of Item attributes and category attributes. Also included
are endpoints that allow creation and editing of categories.These endpoints
can be executed by an Account Administrator or a non-Account Administrator
user with the appropriate Workspace Settings access policies. Warning: While
supported and documented, Arena does not recommend using these
endpoints as it can have significant impact on the product data within your
workspace.

September 5, 2021 • The GET Events (Search) article contains two new search attributes:
creationDateTimeFrom and creationDateTimeTo. These search attributes replace
the search attribute creationDateTime.

• The GET Event Items article contains two new search attributes:
reconciledDateTimeFrom and reconciledDateTimeTo. These search attributes
replace the search attribute reconciledDateTime.

©2022 Arena, A PTC Business www.arenasolutions.com 13

 Arena REST API Developer Guide Change Log

Date Updates
August 21, 2021 • Arena Help now includes documentation for the GET Items (Search) Criteria
Parameter. The GET Items (Search) Criteria Parameter is a special variation of
GET Items (Search) that uses the criteria search parameter that merits its own
page. It requires URL encoding of the query string. It allows users to search by
creation date and create complex queries using the same attributes and
operators as API Export.

May 16, 2021 • For Data Extract Run calls, the attribute completionDate is now deprecated.
Please use completionDateTime moving forward.

• The Data Extract Run attributes scheduledDate and runDate are no longer
supported. Please replace scheduledDate with scheduledDateTime and runDate
with runDateTime.

• The GET Extract Run, GET Extract Run Latest, and Extract Run object articles have
been modified to reflect the two previous bullet points.

April 24, 2021 • Added four new endpoints that support searching for Change Files, searching
for a specific Change File, creating an association between an existing File and
a Change, and deleting an association between a Change and a File. These new
endpoints use Change GUIDs as a starting points to interact with files and should
not be confused with existing endpoints that use File GUIDs as starting points
to interact with Changes.

• Added four new endpoints that support searching for Change Implementation
Files, searching for a specific Change Implementation File, creating an association
between an existing File and the Implementation view of a Change, and deleting
an association between the Implementation view of a Change and a File. (Files
can be associated to Changes in two places: the Files view and the
Implementation view.)

• Added six new endpoints that support searching for File Markups, searching
for a specific File Markup, retrieving the content of a File Markup, creating a File
Markup, editing a File Markup, and deleting a File Markup.

• Added four new endpoints that support searching for Change File Markups,
searching for a specific Change File Markup, creating a Change File Markup, and
deleting a Change File Markup.

• Added five new endpoints that support searching for Supplier Files, searching
for a specific Supplier File, creating an association between an existing File and
a Supplier, deleting an association between a Supplier and a File, and deleting
a Supplier File.

• Added two new endpoints that support completing a Quality Process step and
reopening a Quality Process step.

• API Item Export now supports export files in JSON format. In order to facilitate
this, a new export option called format can be included when creating Export
Definitions. The new export option format supports two values: csv and json. If
format is omitted from the export definition, the export assumes a format of
csv.

©2022 Arena, A PTC Business www.arenasolutions.com 14

 Arena REST API Developer Guide Change Log

Date Updates
• API Item Exports in JSON format with a specific export option combinations can
result in an empty JSON file export. These situations are documented within a
new Arena API Help article titled About Export Results and the JSON Format.

• API Item Export option fileContent no longer supports a value of PRIMARY for
supplierItem.

• For Item objects, status is deprecated. Please use revisionStatus moving forward.
offTheShelf is depcreated. Please use procurementType mosing forward.

• For FIle objects, storageMethod is deprcated. Please use storageMethodName

moving forward.

• For Quality Process step objects, assignee is deprecated. Please use assignees.

• For Supplier Item objects, creationDateTime is deprecated with no replacement.

March 20, 2021 • POST Supplier Create and PUT Supplier Update now include examples of the
attribute supplierId within the request body and response body. GET Suppliers
now include the attribute supplierId within the Searchable Attributes table.

March 6, 2021 • GET Items, GET Changes, GET Quality, GET Suppliers, GET Supplier Items, and
GET Export Definitions include information for encoding the plus icon within
the last entry of the Notes section.

February 20, 2021 • Added documentation articles for GET Change File Associations, GET Change
File Association, GET Change Implementation File Associations, and GET Change
Implementation File Association. These are not new features, but an expansion
of the GET File Association article to better explain how to retrieve the two File
types associated with Changes.

January 30, 2021 • GET Quality Processes Search attribute table has been updated to include the
not operator (exclamation point) to search for not completed Quality Processes.

• PUT Event Item has been updated to clarify that the final GUID should be the
Event Item guid and not the Item revision GUID.

January 22, 2021 • Added three new endpoints for checking out and checking in Files. File Check
Out and Check In endpoints are executed by two POST endpoints. A third POST
endpoint, Cancel File Check Out, allows users to cancel a File Check Out.

• Added four new endpoints for Item and Supplier Item compliance. Two new
POST endpoints allow users to apply compliance requirements to Items and
Supplier Items respectively. Two new DELETE endpoints allow users to remove
compliance requirements from Items and Supplier Items.

• Added eight new endpoints for creating, editing, and deleting Item and Supplier
Item thumbnail images. For both Items and Supplier Item thumbnail image
creation, a second POST endpoint is available which allows users to create a
thumbnail image from an associated file.

©2022 Arena, A PTC Business www.arenasolutions.com 15

 Arena REST API Developer Guide Change Log

Date Updates
• Added eight new endpoints for retrieving all User Groups, a specific User Group,
employees in User Groups, specific individual employees in User Groups, partners
in User Groups, individual partners in User Groups, general users in a User Group,
and a specific user in a User Group.

• Added two new PUT endpoints for assigning users and assigning User Groups
to a Quality Process step. The previous endpoint for assigning a user to a Quality
Process step is deprecated.

• Added ten new endpoints for retrieving, creating, editing and deleting Supplier
phone numbers and Supplier addresses.

• Added support for updating the storageMethodName when updating unlocked

files.

• The GET Export Runs endpoint now supports four new searchable attributes:
completionDateTimeFrom, completionDateTimeTo, latestCompleted, number,
and status.

• A new API Export option called header allows users to export Items with their
attribute names. Previously, all custom attributes were exported by their
apiNames.

• Export lifecycle status now supports the status of Downloaded. Downloaded

indicates that the API export has been downloaded by a user.

• 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. Two new GET endpoints allow
users to obtain all the corrections to a File or a single specific correction of a
File. A File correction can be executed through a POST File Correction endpoint.

• The Corrected attribute has been added to existing File endpoints.

September 20, 2020 • GET Item Categories no longer includes deleted Categories by default. To include
deleted categories a new search parameter, includeDeleted=true, can be used
with the call.

• The component fields within a numberFormat has been changed from apiName
to GUID. The numberFormat from GET settings/items/categories/<GUID> can
be used to directly create the Item in POST Item Create.

September 6, 2020 GET Item Categories endpoint sample response body examles have been updated
with the following fields: parentCategory and structural. The third result in the
first example contains an example of a deleted category with the addition of the
field deletionDateTime.
August 2, 2020 • Arena REST API now supports 22 additional Criteria attributes for Arena API
Export. The Criteria: Attributes and Operators article has been updated with
these additional attributes. A list is also available within Arena's Summer 2020
Release Notes.

©2022 Arena, A PTC Business www.arenasolutions.com 16

 Arena REST API Developer Guide Change Log

Date Updates
• POST Export Definition endpoint article has been updated with the following:

—modifiedBOM, modifiedSpecs, modifiedFiles, and modifiedSourcing always

refers to the working revision since only the working revision is editable.

—Arena Export currently doesn't support export for category.guid using the
GUID for uncategorized. The category.guid works for all other categorized
GUIDs. To run an export for uncategorized Items use the following criteria:
attribute is euqal to category.name, operator is IS_EQUAL_TO, and value is
-uncategorized-.

—An Item Export with revisionStatus set to WORKING or POTENTIAL, will return
the working revision of the Items even if these Items contain an efffective,
released version.

• The POST Quality Process Step Affected Object Add has been updated and
clarified. Items, Changes, Suppliers, Supplier Items, Files, Quality, and URLs can
be added as an affected object to a Quality Process Step.

February 24, 2019 • Added support for non-revision controlled custom attributes for Items and
support for editable core Item attributes. This affects the following endpoints:
Settings GET Attributes, Settings GET Category Attributes, GET Items, GET Item,
POST Create Item, PUT Edit Item.

• Modified meaning of "Required" for custom attributes to match application

behavior. Required will now return true for attributes required fin the Arena
application, even if a default value exists.

• The deprecated apiName field will now have the value of attribute GUID.

November 18, 2018 Added support for Allow/Disallow Duplicate and Allow/Disallow Manual Revision
Entry by Change category. This affects GET Change Categories.
September 16, 2018 Added support for Enforce Default options for Effectivity and Numbering Sequence
in Change Categories. This affects GET Change Categories, POST Create Change,
PUT Update Change.
August 12, 2018 Updated GET Supplier Attributes and GET Supplier Item Attributes endpoints.
Removed multiSelect indicator from custom attributes on non-Item endpoints
July 29, 2018 • Added endpoints for creating, editing, searching, and deleting custom attributes
for Suppliers and Supplier Items

• Additional Attributes of type NUMBER now accept and return a numeric value
(with no quotes) in GET, PUT, and POST endpoints

• The type attribute in Item and BOM additional attributes is now fieldType;
Support for new multi-select attributes

• When retrieving Item and Change Additional Attributes via a Settings GET
endpoint, the API now returns "required" and "defaultValue" attributes that
reflect whether an attribute is global or category-specific

• Improved error checking for additional attributes

©2022 Arena, A PTC Business www.arenasolutions.com 17

 Arena REST API Developer Guide Change Log

Date Updates
April 1, 2018 Added Affected object for Quality. Fixed typo in sample response of PUT Change
Affected Item Edit.
March 18, 2018 Small updates from March 11 release. Added more detail about how Change
effectivity affects attributes, and how lifecycle phase governs availability of some
actions. Reorganized request and response examples in POST Change Create, PUT
Change Edit. Separated Table of Contents into Change and Change Item. Various
typos etc.
March 11, 2018 Added new endpoints to search, create, update, and delete Changes and Change
Affected Items.
December 10, 2017 Small updates from December 3 release, including Path parameter example in
GET File Categories endpoint, sample respons body in GET Quality Process Summary
Attributes endpoint, GET Supplier Item Compliance Requirement endpoint was
missing, update to Item Number Format object and Requirement object.
December 3, 2017 Added new GET endpoints to search Changes, Change categories, Change
attributes, Change inventory disposition settings, Change routings.
September 24, 2017 Minor updates to GET Items and GET Item Categories.
July 23, 2017 Updated metadata definition for Supplier, Supplier Item, and Quality endpoints.
Updated endpoint documentation format to remove redundant
Successful/Unsuccessful Response Body sections.
July 8, 2017 Fixed some content from June 18 release, including custom attributes of type
NUMBER must be submitted as text. Bad URL given for GET Supplier Item Quality
Processes and POST Item File Create. Clarified content-type in file creation
endpoints.
June 18, 2017 Updated settings endpoints and introduced new tabular format for all endpoints
March 19, 2017 Fixed Get BOM and Get Individual BOM Line endpoints to include child Item
creationDateTime
March 5, 2017 Added File search, create, update, delete, endpoints
February 19, 2017 Clarified Item and Supplier Item File Upload endpoints
December 11, 2016 Added Get Recent Activity endpoints
November 13, 2016 Added Get User and Get Users endpoints
August 21, 2016 Added more Arena Quality endpoints
April 24, 2016 Added Arena Quality Endpoints and Objects; Converted Overview to table; Added
/settings/ addition in setting URLs; Replaced apiName with guid in most responses
September 20, 2015 Updated Arena DataExtract run endpoints; Added Item and Supplier Item
compliance edit endpoints; Expanded Release Item Revision endpoint
June 21, 2015 Updated formatting; Modified title from API to REST API
May 30, 2015 Updated endpoint formatting
May 17, 2015 Added Item Revision release endpoints
February 15, 2015 Fixed ModifedBom attribute to camelcase
January 31, 2015 Added effectiveDateTime parameter to Get Items endpoint

©2022 Arena, A PTC Business www.arenasolutions.com 18

 Arena REST API Developer Guide Change Log

Date Updates
December 21, 2014 Added Supplier Item sourcing, compliance, and file endpoints
November 2, 2014 Added some fixes around searchable attributes in GET calls
Added Supplier, Supplier Item, and Source Relationship EDIT and DELETE endpoints.
October 26, 2014
Added Arena DataExtract endpoints.
August 3, 2014 Added Supplier, Supplier Item, and Source Relationship endpoints
April 30, 2014 Added Monitoring & Licensing
June 22, 2014 Added Where Used endpoints
• Optimized JSON formatting in responses
January 15, 2014
• Added BOM editing endpoints

©2022 Arena, A PTC Business www.arenasolutions.com 19

 Arena REST API Developer Guide Theory of Operation

Theory of Operation

Overview
The Arena REST API (Application Programming Interface) allows you to programmatically exchange data with
your workspaces. This documentation includes details about requests and responses from Arena servers, and
instructs developers in how to construct requests. This documentation assumes some familiarity with APIs in
general.

The table below details specific capabilties of the API.

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
Change Summary Records ✔ ✔ ✔ ✔ ✔
Change Affected Items ✔ ✔ ✔ ✔ ✔
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 ✔ ✔ ✔ ✔ ✔

©2022 Arena, A PTC Business www.arenasolutions.com 20

 Arena REST API Developer Guide Theory of Operation

Search Create Read Update Delete

Quality Process Details N/A - ✔ - -
Quality Process Step/Affected Objects ✔ ✔ ✔ ✔ ✔
DataExtract ✔
Outbound Integrations ✔ ✔ ✔
Recent Activity ✔

NOTES

* Item Revisions are created using the items/lifecyclephasechanges endpoint.

©2022 Arena, A PTC Business www.arenasolutions.com 21

 Arena REST API Developer Guide Theory of Operation

API Format
The Arena API is based on a REST architecture and transfers JSON content exclusively (except for file content
operations, which are JSON and multipart/form-data.)

A user's base API URL can differ depending on what URL they use to access their workspace.

If the user's workspace is accessed through https://app.bom.com, the base API URL is
https://api.arenasolutions.com/[version].

For example, a request to return all Items in a workspace would be

https://api.arenasolutions.com/v1/items.

If the user's workspace is accessed through https://app.arenagov.com, the base API URL is
https://api.arenagov.com/v1/[version].

For example, a request to return all Items in a workspace would be

https://api.arenagov.com/v1/v1/items.

The user constructs JSON requests to specific URL endpoints on the Arena API service. The API service responds
with data, in the case of a GET request, or updates the workspace in the case of a POST request. You can also
perform PUT and DELETE requests to specific URLs.

This document includes details about requests and responses from Arena servers, and instructs developers in
how to construct requests. This document assumes some familiarity with APIs in general.

A Note on JSON inputs: When constructing Requests to the API service, please follow best practices for JSON
data types:

• Text values should be in quotes ("text")

• Numeric values should not be in quotes (42)

• Null values should not be in quotes (null)

• Boolean values should be only true or false (true)

• Internal quotes in values should be escaped with the \ character (18\").

• Dates (2012-01-12T19:22:27Z)

• GUID values should be in quotes ("2K4N1Y24FWFN6LDUC67B")

Each Arena object is represented by a GUID (Globally Unique IDentifier). When you perform a GET, you receive
object GUIDs in return, and use those GUIDs to specify objects on which you perform actions.

So, you might perform a GET to determine the GUID of a particular Item, and then perform a PUT specifying
that Item’s GUID to update its specification data.

©2022 Arena, A PTC Business www.arenasolutions.com 22

 Arena REST API Developer Guide Theory of Operation

Arena’s approach to a REST API distinguishes between two types of entities: an object itself (such as an item
or file) and the relationship between two objects (such as a BOM line or file association.) This approach allows
users to specify attributes both for the object and for the relationship.

For example, the attributes of an item might include, name, number, etc—but when that item is being added
to a BOM, you need to specify attributes about the relationship between the item and its parent (which might
include quantity, reference designators, etc.)

All Date and Time formats in the Arena REST API are Zulu format: "2014-07-07T23:19:46Z”
YYYY-MM-DDTHH-mm-ssZ (YYYY is 4 digit year, MM is two digit month, DD is two digit day, HH is 2 digit 24 hr
hour, mm is 2 digit minute, ss is 2 digit second)

Connecting and Permissions

Connect to the Arena API service by providing your Arena login credentials (username and password) in a Log
In request. The API service returns an access token which must be included in the header of all subsequent
requests for the session. A session will timeout 90 minutes after the last action and the token will thereafter
be invalid.

The privileges of a user logging into the API service are the same as when logging into Arena. That is, a
read-only user cannot write any information to a PLM workspace, so a read-only user cannot write any
information to the workspace via the API service. All requests (except Healthcheck and Log Out) are subject
to privilege verification.

Recommended best practices for connecting to the Arena API:

• Use a dedicated user to access the Arena API. And more broadly, use a dedicated user for each integration
connected to your Arena workspace.

• Don’t log in twice as the same user at the same time. Logging in a second time will cancel the first session
and the first access token will not work.

• Log in to the API, perform whatever actions you desire, then log out of the API when you are done.

Note:

1. Only Employee and Partner users can access the Arena REST API. Supplier users do not have access privileges.

2. If your company uses Single Sign-On (SSO) to access Arena, you should use a dedicated Integration or Partner
user to access the Arena REST API.

Licensing
To enable the Arena REST API for your account, contact [email protected].

Most accounts are allowed a maximum number of requests to the API per 24 hour period, starting at midnight
Pacific Time. After the total allowed number of requests is reached, the service will return an error. All API
requests (except login), whether successful or not, are counted toward the total. The number of requests
allowed varies per workspace. If you feel you need more API requests, contact your Account Executive.

The http headers of all API responses include the remaining number of API requests for the current period and
the scheduled time for resetting of the count are included in the header. For example:

©2022 Arena, A PTC Business www.arenasolutions.com 23

 Arena REST API Developer Guide Theory of Operation

X-Arena-Next-Request-Limit-Reset: Fri, 02-May-2014 14:22:13 GMT-0700 (PDT)

X-Arena-Requests-Remaining: 2

And each response to the Log In request includes the total number of API requests for the period. For example:

"workspaceRequestLimit": 10000

Arena recommends setting up the calling program to read licensing information from response headers, and
not make any additional calls when X-Arena-Requests-Remaining gets to 0 until after the Next Request Limit
Reset.

API Requests
The Arena REST API provides methods for accessing a resource, such as an Item or a category of Item, at a
canonical URL. You can then perform an action upon that resource by specifying an endpoint URL, such as

https://api.arenasolutions.com/<version>/items/<item_GUID>/revisions

which returns all revisions for a given Item resource. Note that the version takes the format e.g. v1 (no decimal
places). The API version does not necessarily change with Arena releases.

The header of all requests must include:

• an access token "arena_session_id" for user authentication (except Log In, which grants a token)

• a content type declaration ("application/json", except for file POST endpoints with content, where the file
metadata is JSON and the file payload itself is "multipart/form-data")

• an HTTP method declaration (GET, POST, PUT, DELETE)

Requests must be sent uncompressed. Responses may be returned uncompressed or compressed using gzip
encoding.

Responses
For calls that return responses (and not arbitrary binary data), responses will look roughly like:

{
"<object_field>":"<field_value>"
…
}

When the request returns multiple objects, responses look generally like:

{
"count": 20,
"results": [
{
"<object_field>":"<field_value>"
},
…
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 24

 Arena REST API Developer Guide Theory of Operation

When a request returns one or more errors:

{
"errors": [
{
"code": <error_code>,
"message": "<error_message>"
}
],
"status": <error_class>
}

To make responses more human-readable, the first level shows all attributes—attributes with no value will
show a default empty value (e.g., "null", 0). Second-level objects are shown in a compact version. In the Get
Item response example shown below, the second-level object "category" includes only the attribute "guid".
(The exception to this rule is the File object, which includes the full version when shown in the second level
of a fileAssocation GET.)

{
"additionalAttributes": [],
"category": {
"guid": "5N6P8RAK3MY6UNTA"
},
"creationDateTime": "2011-08-09T22:19:25Z",
"creator": {
"fullName": "Heidi Walker"
},
"description": "Board Assembly...",
"guid": "0I2LQGHHQXGXGVRR5XND",
"isAssembly": true,
"lifecyclePhase": {
"name": "In Design"
},
"name": "PCBA, EveryRoad, Model 500",
"number": "830-00002",
"offTheShelf": false,
"owner": {
"fullName": "Toshiro Makamuri"
},
"productionCost": 108.578,
"prototypeCost": null,
"revisionNumber": "3",
"shared": true,
"standardCost": 38.505,
"uom": "each"
}

Successes and Errors

As much as possible, Arena attempts to use appropriate HTTP status codes to indicate the general class of
problem, and this status code is repeated in the response. The following two tables give supported success
status codes and their meanings, and supported error status codes and their meanings.

©2022 Arena, A PTC Business www.arenasolutions.com 25

 Arena REST API Developer Guide Theory of Operation

Success Code Meaning

200 OK default success message
201 Created success and new entity created
204 No content Success but no content in response (e.g. DELETE Item)

Error Code Meaning

400 Bad request returned if there is a syntax error in the request
403 Forbidden returned if the user doesn’t have proper privileges to perform them
401 Unauthorized returned if the requests require valid access token, but no valid access
token is specified in http headers
404 Resource not found returned if the endpoint of a request is not supported
409 Item number already exists returned if the item number already exists and duplicate item numbers
are not allowed in the workspace.
415 Unsupported media type returned if no content-type/wrong content-type is specified in http
headers
429 Too may requests returned if the maximum API requests limit has been reached for 24-hour
period

API Sample Code

You can download a set of API sample requests, along with instructions for installation, from the Downloads
page in Arena. Use it to familiarize yourself with request and response formatting.

Note: Arena recommends using the sample code with the free Postman app. Download

BOM and Workspace Settings

When constructing requests to the Arena REST API, it’s important to understand how settings in the target
Arena workspace can affect how the request is handled. This is particularly true for requests to create or update
BOM Lines.

BOM Settings are set per BOM in the BOM view of an Item in Arena; workspace settings are workspace-wide
and are set in the Account Administration tool of Arena. If settings are not specified for a BOM, the BOM uses
the workspace settings.

Setting Type
Reference Designator BOM Setting When this is set to ON for a BOM, Arena enforces that:
Checking
1. the quantity for a row must match the number of references
designators specified.

2. duplicate reference designators are not allowed. When set to

OFF for a BOM, no check is performed.

When set to OFF for a BOM, no check is performed.

©2022 Arena, A PTC Business www.arenasolutions.com 26

 Arena REST API Developer Guide Theory of Operation

Setting Type
Automatic Line BOM Setting When this is set to ON for a BOM, Items added to the BOM are
Number Generation sorted by Item Number, and a line number is assigned
automatically. When set to OFF for a BOM, you can specify a
persistent line number for each BOM Item.
Reference Designator Workspace Setting When this is set to ON for a workspace, Arena enforces the
Checking for New following when creating a new assembly:
Assemblies
1. the quantity for a row must match the number of references
designators specified.

2. duplicate reference designators are not allowed.

When set to OFF for a workspace, no check is performed when

creating a new assembly.
Negative Quantities Workspace Setting When this is set to YES for a workspace, you can specify a negative
Allowed quantity for a BOM Line. When set to NO for a workspace, negative
quantities will result in an error.

Note on Date/Time Handling

All date/time fields in the API are UTC (Zulu time). The Arena application is based on Pacific Time, so Arena
converts the date/time values to Pacific Time by subtracting the equivalent number of hours that UTC Time is
ahead of Pacific. This is especially important for editable fields effectivityPlannedDateTime, expirationDateTime
and approvalDateTime in the Change object .

effectivityPlannedDateTime and expirationDateTime occur at 00:00:00 of the specified date after that conversion.

approvalDateTime occurs at 23:59:59 of the specified date after the conversion.

Examples:

Specifying an expirationDateTime value of 2018-02-20T12:00:00Z would be converted to 2018/12/20, 04:00:00

Pacific Time, and the Change would expire at the first second of February 20, 2018.

Specifying an approvalDateTime value of 2018-02-20T12:00:00Z would be converted to 2018/12/20, 04:00:00

Pacific Time, and the Change approval deadine would pass at the last second of February 20, 2018.

©2022 Arena, A PTC Business www.arenasolutions.com 27

 Arena REST API Developer Guide Endpoints

Endpoints

Resource Actions Resource Actions

Access POST Log In Item Files GET Item File Associations
PUT Log Out GET Item File Association
Data Extract GET Extracts Search GET Item File Content
GET Extract POST Item File Create
GET Extract Runs Search POST Item File Add Existing
GET Extract Run POST Item File Content Update
GET Data Extract Latest PUT Item File Association Update
GET Extract Run Files DELETE Item File Association
GET Extract Run File
GET Extract Run File Content
Files GET Files Search Item POST Item Lifecycle Phase Change
GET File Summary Lifecycle
GET File Content Phase
POST File Create Change
PUT File Summary Update Item Quality GET Item Quality
POST File Content Update
DELETE File Item GET Item Revisions
Revisions
File GET File Associations Item GET Item Source Relationships
Associations Sourcing GET Item Source Relationship
File Editions GET File Editions POST Item Source Relationship Create
POST File Edition Create PUT Item Source Relationship Update
DELETE Item Source Relationship
Item GET Items Search Item Where GET Where Used
GET Item Specs Used
POST Item Create Item GET Item Compliance Requirements
POST Item Update Compliance GET Item Compliance Requirement
DELETE Item PUT Item Compliance Update
Item BOM GET BOM Change GET Changes
GET BOM Line GET Change
GET BOM Settings POST Change Create
POST BOM Line Create PUT Change Edit
PUT BOM Line Update DELETE Change
PUT BOM Settings Update
DELETE BOM Line

©2022 Arena, A PTC Business www.arenasolutions.com 28

 Arena REST API Developer Guide Endpoints

Resource Actions Resource Actions

Quality GET Quality Process Search Change GET Change Affected Items
Process GET Quality Process Summary Affected GET Change Affected Item
POST Quality Process Create Item POST Change Affected Item Add
PUT Quality Process Update PUT Change Affected Item Edit
DELETE Quality Process DELETE Change Affected Item
Quality GET Quality Process Step Aff Objs Supplier GET Suppliers
Process GET Quality Process Step Aff Obj GET Supplier Profile
Affected POST Quality Process Step Aff Obj Add POST Supplier Create
PUT Quality Process Step Aff Obj PUT Supplier Update
Update DELETE Supplier
DELETE Quality Process Step Aff Obj
Quality GET Quailty Process Steps Supplier GET Supplier Quality Processes
Process GET Quality Process Step Quality
Steps PUT Quality Process Step Update
Recent GET Recent Activity - User Access Supplier GET Supplier Items
Activity GET Recent Activity - Exports Item GET Supplier Item
GET Recent Activity - Report Runs POST Supplier Item Create
GET Recent Activity - File Access PUT Supplier Item Update
DELETE Supplier Item
Settings GET Item Attributes Supplier GET Supplier Item Compliance
GET BOM Attributes Item GET Supplier Item Compliance
GET Item Categories Compliance Requirement
GET Item Category Attributes PUT Supplier Item Compliance Update
GET Item Number Formats Supplier GET Supplier Item File Associations
GET Item Lifecycle Phases Item Files GET Supplier Item File Association
GET Item Compliance Requirements GET Supplier Item File Content
GET Change Attributes POST Supplier Item File Create
GET Change Item Attributes POST Supplier Item File Content
GET Change Categories Update
GET Change Category Attributes POST Supplier Item File Add Existing
GET Change Number Prefixes PUT Supplier Item File Association
GET Change Routings Update
GET Supplier Attributes DELETE Supplier Item File Association
GET Supplier Item Attributes
GET Supplier Item Compliance Supplier GET Supplier Item Quality Processes
Requirements Item Quality
GET File Attributes Supplier GET Supplier Item Source Relationships
GET File Categories Item
GET Quality Process Templates Sourcing
GET Quality Process Number Formats
GET Quality Process Attributes
GET Quality Process Step Attributes
GET Quality Process Owners
GET Users

©2022 Arena, A PTC Business www.arenasolutions.com 29

 Arena REST API Developer Guide Endpoints

POST Log In
/login

This logs a valid user into the Arena System and once the authentication is successful, a JSON response with
an access token is returned. The token needs to be set in the headers of all subsequent requests for them to
be processed successfully. The API client should add an HTTP header with name "arena_session_id", the same
cookie name as in the Arena Web Application. Note that if you do not specify a workspace_id value in the call,
the API user will log in to its current workspace, or whichever it was last logged into.

The response to each Log In request includes the value "workspaceRequestLimit" which is the maximum
number of API requests allowed for your workspace during a 24-hour period. For all responses in the session,
the remaining number of API requests for the current period and the scheduled time for resetting of the count
are included in the http headers.

Note:

1. The access token has the same expiration behavior for the cookie token in the Arena web application.

2. If your company uses Single Sign-On (SSO) to access Arena, you should use a dedicated Integration or Partner
user to access the Arena REST API.

Request Header

Name Value Description

content-type application/json

Sample Request Body

{
"email":"[email protected]",
"password":"xxxx",
"workspaceId":123456789
}

Optional Field

workspaceId If a valid workspace ID is provided and the user has access to this workspace, the active
workspace after successful login will be the one identified by this ID. Arena recommends
using the workspace ID to ensure connection to the expected workspace.

Response Codes

Code Description
200 Success
400 Failure

©2022 Arena, A PTC Business www.arenasolutions.com 30

 Arena REST API Developer Guide Endpoints

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

/login

{
"arena_session_id":"LABS-MXQKenjxWmyUIlJTKwQDfimkZksjpkO0|",
"workspaceId":123456789,
"workspaceName":"EveryRoad GPS",
"workspaceRequestLimit":1000
}

Request with bad username, password, or workspace ID

{
"status":400,
"errors":[
{
"code":4001,
"message":"The username, password or workspace ID is not valid or you are
not allowed to log in due to IP restriction."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 31

 Arena REST API Developer Guide Endpoints

PUT Log Out

/logout

This invalidates the access token. Once this is processed successfully, the user cannot use this token to perform
any further actions.

Headers

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
401 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

/logout

no JSON response

©2022 Arena, A PTC Business www.arenasolutions.com 32

 Arena REST API Developer Guide Endpoints

GET Extracts Search

/extracts

Returns a collection of Extract objects (but not the extract run content) matching the given search criteria.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all
extracts where results should begin. All
extracts before the offset in the search
results are ignored. The default value is 0.
limit integer Specifies the number of results that should
be returned. By default the maximum
number of extracts is 20. Can return up 400
extracts.

Searchable Attributes

Name Value Description

name string Data Extract name
creator.fullName string The integration user which is specified in
the Setup view for the Extract in the account
administration tool in Arena
enabled true or false whether or not the Extract is enabled in the
workspace

Note: Search behavior in the Arena REST API differs from search behavior in the Arena application. In the API, a
trailing asterisk (wildcard) is required to return results that start with a string; in the Arena application, a trailing
asterisk is always implied.

Response Codes

Code Description
200 Success
400 Failure

©2022 Arena, A PTC Business www.arenasolutions.com 33

 Arena REST API Developer Guide Endpoints

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all extracts (note that only 1 extract can be defined per workspace)

GET /extracts

{
"count":1,
"results":[
{
"creationDateTime":"2015-03-19T15:33:43Z",
"creator":{
"fullName":"Heidi Walker"
},
"enabled":true,
"guid":"N5P8RZ6S8GZRATCVEXEL",
"name":"October Change Cycle Time"
}
]
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 34

 Arena REST API Developer Guide Endpoints

GET Extract
/extracts/<GUID>

Returns a single Extract object (but not the extract run content) for an extract with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a single extract with a given GUID

GET /extracts/N5P8RZ6S8GZRATCVEXEL

{
"creationDateTime":"2015-03-19T15:33:43Z",
"creator":{
"fullName":"Everyroad API"
},
"enabled":true,
"guid":"N5P8RZ6S8GZRATCVEXEL",
"name":"October Change Cycle Time"
}

©2022 Arena, A PTC Business www.arenasolutions.com 35

 Arena REST API Developer Guide Endpoints

Request with invalid GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 36

 Arena REST API Developer Guide Endpoints

GET Extract Runs Search

/extracts/<GUID>/runs

Returns Extract Run objects for an extract with a given GUID. Appending a run GUID returns the run with that
GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all runs
where results should begin. All runs before
the offset in the search results are ignored.
The default value is 0.
limit integer Specifies the number of results that should
be returned. By default the maximum
number of runs is 20. Can return up 400
runs.

Searchable Attributes

Name Value Description

status string status of the Extract. Values can be
InProcess, Completed, Failed, or Aborted.
scheduledDateTimeFrom string Include runs scheduled after this date and
time
scheduledDateTimeTo string Include runs scheduled before this date and
time
runDateTimeFrom string Include runs executed after this date and
time
runDateTimeTo string Include runs executed before this date and
time
completionDateTimeFrom string Include runs completed after this date and
time
completionDateTimeTo string Include runs completed before this date
and time

©2022 Arena, A PTC Business www.arenasolutions.com 37

 Arena REST API Developer Guide Endpoints

Name Value Description

downloadDateTimeFrom string Include runs downloaded after this date
and time (download date and time
attributes refer to when the run was first
downloaded, either by a user in the
application or by the API)
downloadDateTimeTo string Include runs downloaded after this date
and time (download date and time
attributes refer to when the run was first
downloaded, either by a user in the
application or by the API)

Note: Search behavior in the Arena REST API differs from search behavior in the Arena application. In the API, a
trailing asterisk (wildcard) is required to return results that start with a string; in the Arena application, a trailing
asterisk is always implied.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get extracts which ran between April 19, 2015, 11:59pm and 59 seconds and September 30, 2015, 11:59pm and
59 seconds (inclusive).

GET
/extracts/<GUID>/runs?runDateTimeFrom="2015-04-19T23:59:59Z"&runDateTo="2015-09-30T23:59:59Z"

{
"count":5,
"results":[
{

©2022 Arena, A PTC Business www.arenasolutions.com 38

 Arena REST API Developer Guide Endpoints

"completionDate":"2015-04-20T20:14:21Z",
"completionDateTime":"2015-04-20T20:14:21Z",
"creator":{
"fullName":"Extract Extraction"
},
"guid":"BTDWA7BDO5OFYH0J2L22",
"runDateTime":"2015-04-20T20:14:15Z",
"scheduledDateTime":null,
"status":"COMPLETED"
},
{
"completionDate":"2015-07-08T21:21:48Z",
"completionDateTime":"2015-07-08T21:21:48Z",
"creator":{
"fullName":"Extract Extraction"
},
"guid":"WEYHVSWY9Q90J2L4N6EP",
"runDateTime":"2015-07-08T21:21:45Z",
"scheduledDateTime":null,
"status":"COMPLETED"
},
{
"completionDate":"2015-07-28T21:24:32Z",
"completionDateTime":"2015-07-28T21:24:32Z",
"creator":{
"fullName":"Extract Extraction"
},
"guid":"P7RAOLPR2J2TCVEXGZ48",
"runDateTime":"2015-07-28T21:24:29Z",
"scheduledDateTime":null,
"status":"COMPLETED"
},
{
"completionDate":"2015-09-29T17:50:52Z",
"completionDateTime":"2015-09-29T17:50:52Z",
"creator":{
"fullName":"Extract Extraction"
},
"guid":"1J3M0X13EVE5O7Q9SB70",
"runDateTime":"2015-09-29T17:50:47Z",
"scheduledDateTime":null,
"status":"COMPLETED"
},
{
"completionDate":"2015-09-29T17:54:45Z",
"completionDateTime":"2015-09-29T17:54:45Z",
"creator":{
"fullName":"Extract Extraction"
},
"guid":"2K4N1Y24FWF6P8RATC8T",
"runDateTime":"2015-09-29T17:54:43Z",
"scheduledDateTime":null,
"status":"COMPLETED"
}

©2022 Arena, A PTC Business www.arenasolutions.com 39

 Arena REST API Developer Guide Endpoints

]
}

Get a specific run

GET /extracts/<GUID>/runs/BTDWA7BDO5OFYH0J2L22

{
"completionDate":"2015-04-20T20:14:21Z",
"completionDateTime":"2015-04-20T20:14:21Z",
"creator":{
"fullName":"Extract Extraction"
},
"guid":"BTDWA7BDO5OFYH0J2L22",
"runDateTime":"2015-04-20T20:14:15Z",
"scheduledDateTime":null,
"status":"COMPLETED"
}

An error is returned if:

1. the GUID is not valid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

2. An error is thrown by the file server

{
"status":400,
"errors":[
{
"code":3017,
"message":"The file with guid \"7P60AQ9P8RAS7F6J\" cannot be downloaded
at this time."
}
]
}

*If the file server is inaccessible, it may return a 400 status with no message.

©2022 Arena, A PTC Business www.arenasolutions.com 40

 Arena REST API Developer Guide Endpoints

GET Extract Run

/extracts/<GUID>/runs/<GUID>

Returns an Extract Run object for a run with a given GUID for an extract with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a single data extract run.

GET /extracts/<GUID>/runs/BTDWA7BDO5OFYH0J2L22

{
"completionDate":"2015-04-20T20:14:21Z",
"creationDateTime":null,
"creator":{
"fullName":"Extract Extraction"
},
"guid":"BTDWA7BDO5OFYH0J2L22",
"runDate":"2015-04-20T20:14:15Z",
"scheduledDate":null,

©2022 Arena, A PTC Business www.arenasolutions.com 41

 Arena REST API Developer Guide Endpoints

"status":"COMPLETED"
}

An error is returned if:

1. the GUID is not valid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

2. An error is thrown by the file server

{
"status":400,
"errors":[
{
"code":3017,
"message":"The file with guid \"7P60AQ9P8RAS7F6J\" cannot be downloaded
at this time."
}
]
}

*If the file server is inaccessible, it may return a 400 status with no message.

©2022 Arena, A PTC Business www.arenasolutions.com 42

 Arena REST API Developer Guide Endpoints

GET Data Extract Latest

/extracts/<GUID>/runs/latestCompleted

Returns a single Extract object (but not the extract run content) for the most recently completed Extract.

You can choose to include run file association information in the response. For example:

GET <url>/extracts/<GUID>/runs/latestCompleted?view=withFiles

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

view string This includes run file association
information in the response. The only value
avaialble is withFiles.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get the latest data extract, including file information

©2022 Arena, A PTC Business www.arenasolutions.com 43

 Arena REST API Developer Guide Endpoints

GET /extracts/<GUID>/runs/latestCompleted?view=withFiles

{
"completionDate":"2015-09-29T17:54:45Z",
"completionDateTime":"2015-09-29T17:54:45Z",
"creator":{
"fullName":"Extract Extraction"
},
"files":[
{
"downloadDateTime":"2015-09-29T17:55:20Z",
"guid":"1J3M0X13EVE4N6P66T44"
}
],
"guid":"2K4N1Y24FWF6P8RATC8T",
"runDateTime":"2015-09-29T17:54:43Z",
"scheduledDateTime":null,
"status":"COMPLETED"
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 44

 Arena REST API Developer Guide Endpoints

GET Extract Run Files

/extracts/<GUID>/runs/<GUID>/files

Returns Extract Run File Association objects for a run with a given GUID of an extract with a given GUID.
Appending a file association GUID returns the file association with that GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all file
associations where results should begin. All
runs before the offset in the search results
are ignored. The default value is 0.
limit integer Specifies the number of results that should
be returned. By default the maximum
number of associations is 20. Can return up
400 associations.

Searchable Attributes

Name Value Description

downloadDateTimeFrom string Include runs downloaded after this date
and time (download date and time
attributes refer to when the run was first
downloaded, either by a user in the
application or by the API)
downloadDateTimeTo string Include runs downloaded after this date
and time (download date and time
attributes refer to when the run was first
downloaded, either by a user in the
application or by the API)

Note: Search behavior in the Arena REST API differs from search behavior in the Arena application. In the API, a
trailing asterisk (wildcard) is required to return results that start with a string; in the Arena application, a trailing
asterisk is always implied.

©2022 Arena, A PTC Business www.arenasolutions.com 45

 Arena REST API Developer Guide Endpoints

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all file associations for a Data Extract run

/extracts/<GUID>/runs/<GUID>/files

{
"count":1,
"results":[
{
"downloadDateTime":null,
"file":{
"author":null,
"category":{

},
"creationDateTime":"2015-08-17T16:48:30Z",
"description":null,
"edition":null,
"format":"zip",
"guid":"VDXGURVX8P8O7QH2PO36",
"hasMarkup":false,
"lastModifiedDateTime":"2015-08-17T16:48:30Z",
"latest":false,
"location":null,
"mimeType":null,
"name":"Extract_20150817_164826Z_FXH0EBFHS9SK3M5O7QS1.zip",
"number":null,
"private":false,
"size":8989,
"storageMethod":0,
"title":null

©2022 Arena, A PTC Business www.arenasolutions.com 46

 Arena REST API Developer Guide Endpoints

},
"guid":"3L5O2Z35GXG6P8R88MYW"
}
]
}

An error is returned if:

1. the GUID is not valid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

2. An error is thrown by the file server

{
"status":400,
"errors":[
{
"code":3017,
"message":"The file with guid \"7P60AQ9P8RAS7F6J\" cannot be downloaded
at this time."
}
]
}

*If the file server is inaccessible, it may return a 400 status with no message.

©2022 Arena, A PTC Business www.arenasolutions.com 47

 Arena REST API Developer Guide Endpoints

GET Extract Run File

/extracts/<GUID>/runs/<GUID>/files/<GUID>

Returns an Extract Run File Association object with a given GUID for a run with a given GUID of an extract with
a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get a file association with a specific GUID for a Data Extract run

/extracts/<GUID>/runs/<GUID>/files/<GUID>

{
"downloadDateTime":null,
"file":{
"author":null,
"category":{},
"creationDateTime":"2015-08-17T16:48:30Z",
"description":null,
"edition":null,
"format":"zip",

©2022 Arena, A PTC Business www.arenasolutions.com 48

 Arena REST API Developer Guide Endpoints

"guid":"VDXGURVX8P8O7QH2PO36",
"hasMarkup":false,
"lastModifiedDateTime":"2015-08-17T16:48:30Z",
"latest":false,
"location":null,
"mimeType":null,
"name":"Extract_20150817_164826Z_FXH0EBFHS9SK3M5O7QS1.zip",
"number":null,
"private":false,
"size":8989,
"storageMethod":0,
"title":null
},
"guid":"3L5O2Z35GXG6P8R88MYW"
}

An error is returned if:

1. the GUID is not valid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

2. An error is thrown by the file server

{
"status":400,
"errors":[
{
"code":3017,
"message":"The file with guid \"7P60AQ9P8RAS7F6J\" cannot be downloaded
at this time."
}
]
}

*If the file server is inaccessible, it may return a 400 status with no message.

©2022 Arena, A PTC Business www.arenasolutions.com 49

 Arena REST API Developer Guide Endpoints

GET Extract Run File Content

/extracts/<GUID>/runs/<GUID>/files/<run_ GUID>/content

Returns file content from a run file association with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get content of a file associated with a run of an extract

GET /extracts/<GUID>/runs/<GUID>/files/<run_ GUID>/content

No JSON response. Returns the content of the File as an InputStream.

An error is returned if:

1. the GUID is not valid.

{
"status":400,
"errors":[
{
"code":3011,

©2022 Arena, A PTC Business www.arenasolutions.com 50

 Arena REST API Developer Guide Endpoints

"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."

}
]
}

2. An error is thrown by the file server

{
"status":400,
"errors":[
{
"code":3017,
"message":"The file with guid \"7P60AQ9P8RAS7F6J\" cannot be downloaded
at this time."
}
]
}

*If the file server is inaccessible, it may return a 400 status with no message.

©2022 Arena, A PTC Business www.arenasolutions.com 51

 Arena REST API Developer Guide Endpoints

GET Files Search

/files

Returns a collection of Compact Files matching the given search criteria. The editions returned are the latest
editions for each matching file.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all files
where results should begin. All files before
the offset in the search results are ignored.
The default value is 0.
limit integer Specifies the number of results that should
be returned. By default the maximum
number of files is 20. Can return up 400
compact files.

Searchable Attributes

Name Value Description

title string file title
number string file number
category.guid string category unique ID
format string file format
name string file name

Note: Search behavior in the Arena REST API differs from search behavior in the Arena application. In the API, a
trailing asterisk (wildcard) is required to return results that start with a string; in the Arena application, a trailing
asterisk is always implied.

Response Codes

Code Description
200 Success
400 Failure

©2022 Arena, A PTC Business www.arenasolutions.com 52

 Arena REST API Developer Guide Endpoints

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get PDF format files whose title begins with the string "everyroad"

GET <url>/files?title=everyroad*&format=pdf

{
"count":20,
"results":[
{
"category":{
"guid":"M4O7QY5R7FY8RATAYXNX",
"name":"Design Drawing",
"path":"File\\Engineering\\Design Drawing"
},
"checkedOut": false,
"corrected": false,
"creationDateTime":"2006-09-21T21:51:11Z",
"edition":"01",
"format":"pdf",
"guid":"ASCVEMTFV3M2L4NWYCGO",
"name":"everyroad-500-mpi-1.pdf",
"number":"FILE-000172",
"title":"500 board image for MPI"
},
{
"category":{
"guid":"M4O7QY5R7FY8RATAYXNX",
"name":"Design Drawing",
"path":"File\\Engineering\\Design Drawing"
},
"checkedOut": false,
"creationDateTime":"2006-09-21T20:49:34Z",
"edition":"01",
"format":"pdf",
"guid":"J1L4NV2O4CVBUDW57LPY",
"name":"everyroad-500-footprint.pdf",
"number":"FILE-000145",
"title":"500 board footprint"
},

©2022 Arena, A PTC Business www.arenasolutions.com 53

 Arena REST API Developer Guide Endpoints

...
]
}

Get a file with a given GUID

GET <url>/files/<GUID>

{
"author":{
"fullName":"Heidi Walker"
},
"category":{
"guid":"M4O7QY5R7FY8RATAYXNX",
"name":"Design Drawing",
"path":"File\\Engineering\\Design Drawing"
},
"chekedOut": false,
"corrected": true,
"creationDateTime":"2006-09-21T20:49:34Z",
"description":"500 Board MPI",
"edition":"01",
"format":"pdf",
"guid":"P7RAT18UAI1H0J2BDRVF",
"hasMarkup":false,
"lastModifiedDateTime":"2006-09-21T20:49:34Z",
"latest":true,
"location":null,
"locked":false,
"mimeType":"application/pdf",
"name":"308-0345-a.pdf",
"number":"FILE-000151",
"private":false,
"size":82121,
"storageMethodName":"FILE",
"title":"308-0345-a"
}

Returns an error if a parameter is not a valid search attribute.

{
"status":400,
"errors":[
{
"code":3019,
"message":"The attribute \"edition\" is not searchable."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 54

 Arena REST API Developer Guide Endpoints

GET File Summary

/files/<GUID>

Returns a File object with a given GUID. This is the latest edition of the File.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get a file with a given GUID

GET <url>/files/<GUID>

{
"author":{
"fullName":"Heidi Walker"
},
"category":{
"guid":"M4O7QY5R7FY8RATAYXNX",
"name":"Design Drawing",
"path":"File\\Engineering\\Design Drawing"
},
"checkedOut": false,

©2022 Arena, A PTC Business www.arenasolutions.com 55

 Arena REST API Developer Guide Endpoints

"corrected": false,
"creationDateTime":"2006-09-21T20:49:34Z",
"description":"500 Board MPI",
"edition":"01",
"format":"pdf",
"guid":"P7RAT18UAI1H0J2BDRVF",
"hasMarkup":false,
"lastModifiedDateTime":"2006-09-21T20:49:34Z",
"latest":true,
"location":null,
"locked":false,
"mimeType":"application/pdf",
"name":"308-0345-a.pdf",
"number":"FILE-000151",
"private":false,
"size":82121,
"storageMethodName":"FILE",
"title":"308-0345-a"
}

Returns an error if a parameter is not a valid search attribute.

{
"status":400,
"errors":[
{
"code":3019,
"message":"The attribute \"edition\" is not searchable."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 56

 Arena REST API Developer Guide Endpoints

GET File Content

/files/<GUID>/content

Returns file content belonging to a file with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get the content of a File.

/files/<GUID>/content

No JSON response. Returns the content of the File as an Input Stream.

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."

©2022 Arena, A PTC Business www.arenasolutions.com 57

 Arena REST API Developer Guide Endpoints

}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 58

 Arena REST API Developer Guide Endpoints

POST File Create

/files

Creates a new File object.

If you wish to create a File record and upload file content to the Arena servers, construct a request that is
content type multipart/form-data (specified in the header) and has a storageMethodName of FILE (stored on
Arena servers.)

If you wish to create a File record with no uploaded content, construct a JSON request with a
storageMethodName of FTP (stored on user FTP server), WEB (web link), or PLACE_HOLDER (will upload content
later).

When the storageMethod is FTP or WEB, the location attribute should be the web or ftp address where the file
resides. For Files with storageMethodName FILE, the location attribute is not used.

Currently, only Files less than 2GB can be uploaded through this endpoint.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type multipart/form-data

Sample Request Body - with uploaded content

Text attributes:

author.fullName: Heidi Walker

category.guid: WEYHMCDDMTCM5O08WPWY
description: Assembly Instructions
edition: 2
format: txt
private:false
storageMethodName: FILE
title: Assembly Instructions for 324-0263

File attribute:

content: [physical file]

Sample Request Body - no uploaded content

{
"author":{
"fullName":"John Parker"
},
"category":{
"guid":"ZH0J2L4EXGS0NF91"
},

©2022 Arena, A PTC Business www.arenasolutions.com 59

 Arena REST API Developer Guide Endpoints

"description":"500 board early spec",

"edition":"2",
"location":"www.everyroadgps.com/files",
"format":"PDF",
"title":"500 board spec",
"storageMethodName":"WEB"
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-FileGuid GUID string GUID for new file - only when including
content
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
• When creating a File object with uploaded content:

no JSON response. Please refer to the response header for file information.

• When creating a file with no uploaded content:

{
"author":{
"fullName":"John Parker"
},
"category":{
"guid":"ZH0J2L4EXGS0NF91"
},
"creationDateTime":"2014-02-24T22:41:19Z",
"description":"500 board early spec",
"edition":"2",
"format":"PDF",
"guid":"GYI16WW251K0J2TITQ1O",
"hasMarkup":false,
"lastModifiedDateTime":"2014-02-24T22:41:19Z",

©2022 Arena, A PTC Business www.arenasolutions.com 60

 Arena REST API Developer Guide Endpoints

"latest":true,
"location":"www.everyroadgps.com/files",
"mimeType":null,
"name":null,
"number":"FILE-000005",
"private":false,
"size":null,
"storageMethodName":"WEB",
"title":"some title",
"locked":false
}

Returns an error if a required metadata attribute is missing.

{
"status":400,
"errors":[
{
"code":3001,
"message":"The attribute \"edition\" is required."
}
]
}

Returns an error if File size is 2GB or higher.

{
"status":400,
"errors":[
{
"code":3033,
"message":"The file content is missing."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 61

 Arena REST API Developer Guide Endpoints

PUT File Summary Update

/files/<GUID>

Updates a File object.

Also supports updating File storageMethodName from FILE, FTP, WEB, or PLACE_HOLDER to FTP, WEB, or
PLACE_HOLDER. This update can only be performed on unlocked Files.

Updating storageMethodName to FTP, WEB, or PLACE_HOLDER also requires including the attribute location.

This endpoint does not support updating the storageMethodName from FTP, WEB, or PLACE_HOLDER to FILE.
This requires a POST call. See POST File Update.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

Note: This example shows all editable attributes.

{
"author":{
"fullName":"John Parker"
},
"category":{
"guid":"EWGZDAEGR8R1K3J1LPP3"
},
"description":"Assembly Instructions",
"edition":"B-1",
"format":"PDF",
"title":"Assembly Instructions for 324-0263"
}

Sample Request Body - Updating storageMethodName

In this example, the existing File has a storageMethodName of FILE and through the PUT endpoint we're
updating it to storageMethodName of WEB.

{
"author":{
"fullName":"George Lewis"
},
"category":{
"guid":"7P9S6379K1KUDWCUEIJG"
},
"description":"Arena Solutions Corporate Link",
"edition":"1",

©2022 Arena, A PTC Business www.arenasolutions.com 62

 Arena REST API Developer Guide Endpoints

"format":"url",
"location":"https://www.arenasolutions.com/345634.html",
"storageMethodName": "WEB",
"private":false,
"title":"Link to Assembly Instructions for 324-0263"
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Update the details of a file

files/<GUID>

{
"author":{
"fullName":"John Parker"
},
"category":{
"guid":"EWGZDAEGR8R1K3J1LPP3"
},
"creationDateTime":"2013-03-14T23:19:28Z",
"description":"Assembly Instructions",
"edition":"B-1",
"format":"PDF",
"guid":"GYI16WXX6DVYH0J2LEVZ ",
"hasMarkup":false,
"lastModifiedDateTime":"20170123132756",
"latest":true,
"location":null,
"locked":false,
"mimeType":null,

©2022 Arena, A PTC Business www.arenasolutions.com 63

 Arena REST API Developer Guide Endpoints

"name":"324-0263-a.pdf",
"number":"FILE-000544",
"private":false,
"size":125083,
"storageMethodName":"FILE",
"title":"Assembly Instructions for 324-0263"
}

Updates the storageMethodName of a File from FILE to WEB.

{
"author":{
"fullName":"George Lewis"
},
"category":{
"guid":"7P9S6379K1KUDWCUEIJG"
"name":"
"path":"
},
"creationDateTime": "2020-08-28T17:40:08Z",
"description":"Arena Solutions Corporate Link",
"edition":"1",
"format":"url",
"guid": "9RBU859BM3M2L4UF7BRK",
"hasMarkup": false,
"lastModifiedDateTime": "2020-08-29T12:27:84Z",
"latest": true,
"location":"https://www.arenasolutions.com/345634.html",
"locked": false,
"mimeType": null,
"name": null,
"number": "FILE-045893",
"private": false,
"size": 0,
"storageMethodName": "WEB",
"private":false,
"title":"Link to Assembly Instructions for 324-0263"
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"EWGZDAEGR8R1K3J1LPP3\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 64

 Arena REST API Developer Guide Endpoints

POST File Content Update

/files/<GUID>/content

Updates the content of a File edition, replacing the previous content.

Construct a request with content-type "multipart/form-data" (in the header of the request) and file content.

Currently, only Files less than 2GB can be uploaded through this endpoint.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login

Sample Request Body

File attribute:

content: [physical file]

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
no JSON response

An error is returned if:

1. the GUID is not valid.

©2022 Arena, A PTC Business www.arenasolutions.com 65

 Arena REST API Developer Guide Endpoints

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

2. A required metadata attribute is missing.

{
"status":400,
"errors":[
{
"code":3001,
"message":"The attribute \"edition\" is required."
}
]
}

3. Returns an error if File size is 2GB or higher.

{
"status":400,
"errors":[
{
"code":3033,
"message":"The file content is missing."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 66

 Arena REST API Developer Guide Endpoints

DELETE File
/files/<GUID>

Deletes the latest edition of a file with a given GUID. When a File has more than one edition, only the latest,
unlocked edition can be deleted--to delete an entire file, repeat the DELETE request for all editions.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response.

Request with bad GUID

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}

©2022 Arena, A PTC Business www.arenasolutions.com 67

 Arena REST API Developer Guide Endpoints

]
}

©2022 Arena, A PTC Business www.arenasolutions.com 68

 Arena REST API Developer Guide Endpoints

GET File Associations

/files/<GUID>/<object_type>

/files/<GUID>/<object_type>/<file_association_GUID>

Returns a list of file association GUIDs (and information about the associated objects) for a File with a given
GUID.

Can be used to return File associations with Items, Supplier Items, Suppliers, Changes (Files), Changes
(Implementation), Requests, and Quality Processes by appending the corresponding parameter to the url. For
example: GET <url>/files/M4O7QY5R7FY8RATAYXNX/items returns all associations to Items for the
file with GUID M4O7QY5R7FY8RATAYXNX. To return a specific File association for a File, append the GUID of
the association. For example: GET
<url>/files/M4O7QY5R7FY8RATAYXNX/items/QAS271BHFNDPUCZMH792

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

• Item Associations (note that the response is a file assocation GUID for each item with which the file is
associated, and a list of revisions of that Item that are associated with the file.)

©2022 Arena, A PTC Business www.arenasolutions.com 69

 Arena REST API Developer Guide Endpoints

{
"count":2,
"results":[
{
"guid":"7P9SXNOOX4NRATE1TMVN",
"items":[
{
"guid":"1J3MRHIIRYHRAT5D1U08",
"number":"100-91",
"revisionNumber":"A",
"status":2
},
{
"guid":"J1L49Z009GY1K3M5OHYM",
"number":"100-91",
"revisionNumber":"B",
"status":1
},
{
"guid":"FXH05VWW5CV4N6MNGHDF",
"number":"100-91",
"revisionNumber":"C",
"status":0
}
]
},
{
"guid":"HZJ2LT22ZGZBUDWCJBAM",
"items":[
{
"guid":"L3N6PX663K3K3HOBORT3",
"number":"110-0001",
"revisionNumber":"1",
"status":2
}
]
}
]
}

• Supplier Item Associations

{
"count":2,
"results":[
{
"guid":"O6Q9E455EL37Q95FRH30",
"supplierItem":{
"guid":"O6Q9E455EL49SBB1KF69",
"number":"AQW454A",
"supplier":{
"guid":"I0K38YZZ8FY4N6B122AL",
"name":"Aromat"
}
}
},
...
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 70

 Arena REST API Developer Guide Endpoints

• Supplier Associations

{
"count":2,
"results":[
{
"guid":"5N7QVLMMV2JRATA2GJ6E",
"supplier":{
"guid":"UCWFKABBKRAGZINDEEM1",
"name":"Avnet"
}
},
...
]
}

• Change Reference Associations

{
"count":3,
"results":[
{
"change":{
"guid":"3L5OTJKKT0JM5N38SVUY",
"number":"ECO-000016"
},
"guid":"HZJ27XYY7EV2L40LMHPE"
},
...
]
}

• Change Implementation Associations

{
"count":2,
"results":[
{
"change":{
"guid":"3L5OTJKKT0JM5N38SVUY",
"number":"ECO-000016"
},
"guid":"3I3EKBHNRTIHU5PH3A4X"
},
...
]
}

• Request Associations

{
"count":2,
"results":[
{
"guid":"4S1JM4YCFHIWJ45QNWJ0",
"request":{
"guid":"Z2M6BZX2ZJAYI06T6RCG",

©2022 Arena, A PTC Business www.arenasolutions.com 71

 Arena REST API Developer Guide Endpoints

"number":"ECR-000004"
}
},
...
]
}

• Quality Process Associations

{
"count":1,
"results":[
{
"guid":"9RBUZPQQZ6N3M5O79TKC",
"qualityProcess":{
"guid":"4M6PUKLLU1KGZI1KYBRS",
"number":"NCMR-000002",
"step":{
"guid":"6O8RWMNNW3MI1K3M0DT2",
"name":"Action Taken"
}
}
}
]
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 72

 Arena REST API Developer Guide Endpoints

GET File Editions

/files/<GUID>/editions

Returns a collection of File objects for a File with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

{
"count":3,
"results":[
{
"author":{
"fullName":"Heidi Walker"
},
"category":{
"guid":"D3O7QY5R7FY8RATAYXNX",
"name":"Design Drawing",
"path":"File\\Engineering\\Instructions"
},
"checkedOut": false,
"creationDateTime":"2016-02-01T22:28:10Z",

©2022 Arena, A PTC Business www.arenasolutions.com 73

 Arena REST API Developer Guide Endpoints

"description":"Assembly instructions",
"edition":"3",
"format":"pdf",
"guid":"9ASCVEMTFV3M2L4NWYCGO",
"hasMarkup":false,
"lastModifiedDateTime":"2016-02-01T22:28:10Z",
"latest":true,
"location":null,
"locked":true,
"mimeType":"text/plain",
"name":"everyroad-500-schematic.pdf",
"number":"FILE-000593",
"private":false,
"size":14081,
"storageMethodName":"FILE",
"title":"500 board schematic"
},
...
]
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 74

 Arena REST API Developer Guide Endpoints

GET File Corrections

/files/<GUID>/corrections

Returns a collection of corrected File objects for a File with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

{
"count": 5,
"results":[
{
"correctedDateTime": "2020-09-16-T14:26:45Z",
"correctedUser": {
"guid": "608R5268J0JZI1RPMHYM",
"fullName":"Helen Rodgers"
"email": "[email protected]"
},
"file":{
"author":{
"fullName":"Heidi Walker"
},

©2022 Arena, A PTC Business www.arenasolutions.com 75

 Arena REST API Developer Guide Endpoints

"category":{
"guid":"M4O7QY5R7FY8RATAYXNX"
},
"corrected": true,
"creationDateTime":"2016-02-01T22:28:10Z",
"description":"Assembly instructions",
"edition":"3",
"format":"pdf",
"guid":"9ASCVEMTFV3M2L4NWYCGO",
"hasMarkup":false,
"lastModifiedDateTime":"2020-09-16-T14:26:45Z",
"latest":true,
"location":null,
"locked":true,
"mimeType":"text/plain",
"name":"everyroad-500-schematic.pdf",
"number":"FILE-000593",
"private":false,
"size":14081,
"storageMethodName":"FILE",
"title":"500 board schematic"
},
"guid": "9RBU859BM3K3M507915S",
"notes": "Original File upload was incorrect. These are the correct
documents."
},
...
]
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 76

 Arena REST API Developer Guide Endpoints

GET File Correction

/files/<GUID>/corrections/<guid>

Returns a correction of File object for a File with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

{
"correctedDateTime": "2020-09-16-T14:26:45Z",
"correctedUser": {
"guid": "608R5268J0JZI1RPMHYM",
"fullName":"Helen Rodgers"
"email": "[email protected]"
},
"file":{
"author":{
"fullName":"Heidi Walker"
},
"category":{
"guid":"M4O7QY5R7FY8RATAYXNX"
},

©2022 Arena, A PTC Business www.arenasolutions.com 77

 Arena REST API Developer Guide Endpoints

"corrected": true,
"creationDateTime":"2016-02-01T22:28:10Z",
"description":"Assembly instructions",
"edition":"3",
"format":"pdf",
"guid":"9ASCVEMTFV3M2L4NWYCGO",
"hasMarkup":false,
"lastModifiedDateTime":"2020-09-16-T14:26:45Z",
"latest":true,
"location":null,
"locked":true,
"mimeType":"text/plain",
"name":"everyroad-500-schematic.pdf",
"number":"FILE-000593",
"private":false,
"size":14081,
"storageMethodName":"FILE",
"title":"500 board schematic"
},
"guid": "9RBU859BM3K3M507915S",
"notes": "Original File upload was incorrect. These are the correct documents."

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 78

 Arena REST API Developer Guide Endpoints

POST File Edition Create

/files/<GUID>/editions

Creates a new edition for a File with a given GUID.

If you wish to create an edition with no uploaded content, construct a JSON request with a storageMethodName
of FTP (stored on user FTP server) or WEB (web link). When the storageMethodName is FTP or WEB, the location
attribute should be the web or ftp address where the file resides.

If you wish to create an edition and upload file content to the Arena servers, construct a request that is content
type multipart/form-data (specified in the header) and has a storageMethodName of FILE (stored on Arena
servers.)

For File editions with storageMethodName FILE, the location attribute is not used.

When a file is checked out this call will return a 400 (Bad Request) error.

When posting multipart with file content, Arena does not return any JSON response so you must rely on the
status of 400. The calling program should check for File checkout ("locked" : true) and respond accordingly.

Currently, only Files less than 2GB can be uploaded through this endpoint.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type multipart/form-data

Sample Request Body - with uploaded content

Text attributes:

author.fullName: Heidi Walker

category.guid: WEYHMCDDMTCM5O08WPWY
description: Assembly Instructions
edition: 2
format: txt
private:false
storageMethodName: FILE
title: Assembly Instructions for 324-0263

File attribute:

content: [physical file]

Sample Request Body - no uploaded content

{
"file":{
"author":{

©2022 Arena, A PTC Business www.arenasolutions.com 79

 Arena REST API Developer Guide Endpoints

"fullName":"John Parker"
},
"category":{
"guid":"ZH0J2L4EXGS0NF91"
},
"description":"500 board early spec",
"edition":"2",
"format": "url",
"location":"www.everyroadgps.com/files",
"name":"Arena",
"private":false,
"storageMethodName":"WEB",
"title":"500 board spec"
}
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-FileGuid GUID string GUID for new file - only when including
content
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
• When creating a File object with uploaded content:

no JSON response. Please refer to the response header for file information.

• When creating a file with no uploaded content:

{
"author":{
"fullName":"John Parker"
},
"category":{

©2022 Arena, A PTC Business www.arenasolutions.com 80

 Arena REST API Developer Guide Endpoints

"guid":"ZH0J2L4EXGS0NF91"
},
"creationDateTime":"2014-02-24T22:41:19Z",
"description":"500 board early spec",
"edition":"2",
"format":"PDF",
"guid":"GYI16WW251K0J2TITQ1O",
"hasMarkup":false,
"lastModifiedDateTime":"2014-02-24T22:41:19Z",
"latest":true,
"location":"www.everyroadgps.com/files",
"mimeType":null,
"name":null,
"number":"FILE-000005",
"private":false,
"size":null,
"storageMethodName":"WEB",
"title":"some title",
"locked":false
}

An error is returned if a required metadata attribute is missing.

{
"status":400,
"errors":[
{
"code":3001,
"message":"The attribute \"edition\" is required."
}
]
}

Returns an error if File size is 2GB or higher.

{
"status":400,
"errors":[
{
"code":3033,
"message":"The file content is missing."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 81

 Arena REST API Developer Guide Endpoints

POST File Correct

/files/<guid>/corrections

Creates a corrected File object.

To correct a File, the Corrections to Files Allowed setting must be set to Yes, and allow removal of original content
or Yes, but don't allow removal of original content. File corrections will not be supported if the Corrections to Files
Allowed setting is set to No.

The removeOriginalContent attribute can only be set to true if the Corrections to Files Allowed setting is set to
Yes, and allow removal of original content.

Only locked Files can be corrected.

Only Files that are not checked out can be corrected.

User needs a full license to correct a File.

Access Policy users require an edit File summary rule to correct a File.

Currently, only Files less than 2GB can be uploaded through this endpoint.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type multipart/form-data

Sample Request Body - with uploaded content

Text attributes:

comments: "Previous upload contained an incorrect drawing. Uploading the correct File
in this call.",
storageMethodName: "FILE",
removeOriginalContent: true,

File attribute:

content: [physical file]

Sample Request Body - no uploaded content

{
"comments": "Correcting typo in File Title.",
"storageMethodName":"WEB",
"removeOriginalContent": false,
"location": "https://www.everyroadgps.com/products/9828395"
}

©2022 Arena, A PTC Business www.arenasolutions.com 82

 Arena REST API Developer Guide Endpoints

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-File-Guid GUID string GUID for correct file - only when including
content
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
• When correcting a File object with uploaded content:

no JSON response. Please refer to the response header for file information.

• When correcting a file with no uploaded content:

{
"correctedDateTime": "2020-09-12-T12:00:05Z",
"correctedUser": {
"email": "[email protected]",
"fullName":"Helen Rodgers",
"guid": "938R5268J0JZI1RPMHYM"
},
"file":{
"author":{
"fullName":"John Parker"
},
"category":{
"guid":"ZH0J2L4EXGS0NF91"
},
"corrected": true,
"creationDateTime":"2014-02-24T22:41:19Z",
"description":"500 board early spec",
"edition":"2",
"format":"PDF",
"guid":"GYI16WW251K0J2TITQ1O",
"hasMarkup":false,
"lastModifiedDateTime":"2020-09-12-T12:00:05Z",
"latest":true,

©2022 Arena, A PTC Business www.arenasolutions.com 83

 Arena REST API Developer Guide Endpoints

"location":"www.everyroadgps.com/files",
"locked":false,
"mimeType":null,
"name":null,
"number":"FILE-000005",
"private":false,
"size":null,
"storageMethodName":"WEB",
"title":"some title",
},
"guid": "4ZYU859BM3K3M507915S",
"notes": null
}

Returns an error if File Correction is a JSON request and the location attribute is missing.

{
"status":400,
"errors":[
{
"code":3001,
"message":"The attribute \"location\" is required."
}
]
}

Returns an error if File size is 2GB or higher.

{
"status":400,
"errors":[
{
"code":3033,
"message":"The file content is missing."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 84

 Arena REST API Developer Guide Endpoints

POST File Check Out

/files/checkoutstatuschanges

Checks out a File Edition. Note that only the latest edition can be checked out and only files of storageMethod
"FILE" can be checked out.

Checking Out a File occurs with the expectation to make changes to the File. File Check Out is more of a
workflow than the editing of an existing File resoruce. Due to this workflow nature, existing File endpoints
cannot be used and a POST with a files/statuschanges endpoint is utilized. The File Edition guid is submitted
within the request body.

Users must have a Full license to perform a File Check Out. Access Policies users must have access to an Edit
File Policy rule.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"checkedOut": true,
"comment": "Checking Out For Review",
" file": {
"guid": "K2M501MD03M2L47YKQ5B"
}
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions

©2022 Arena, A PTC Business www.arenasolutions.com 85

 Arena REST API Developer Guide Endpoints

Name Value Description

X-Arena-FileGuid GUID string GUID for new file - only when including
content
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
• Checking Out a File that has not been Checked Out:

{
"checkedOut": true,
"comment": "Checking Out File for Review",
"file": {
"author": {
"fullName": "Heidi Walker"
},
"category": {
"guid": "3L507K5WJM5FYHW334R7"
",
"checkedOut": true,
"checkoutDateTime": "2020-10-30T19:20:11Z",
"checkoutUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "DVFYHUF6TWDWFYH01WZB"
},
"corrected": false,
"creationDateTime": "2018-06-02T19:30:28Z",
"description": null,
"edition": "2",
"format": "pdf",
"guid": "K2M501MD03M2L47YKQ5B",
"hasMarkup": false,
"lastModifiedDateTime": "2019-06-02T19:30:28Z",
"latest": true,
"location": null
"locked": true,
"mimeType": application/pdf
"name": USB Cable A-A Datasheet.pdf",
"number": "FILE-000867",
"private": false,
"size": 12326,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "USB CABLE A-A Datasheet"

An error is returned if a user attempts to Check Out a File that is already Checked Out.

{
"status":400,
"errors":[

©2022 Arena, A PTC Business www.arenasolutions.com 86

 Arena REST API Developer Guide Endpoints

{
"code":3133,
"message":"The File cannot be updated."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 87

 Arena REST API Developer Guide Endpoints

POST Cancel File Check Out

POST /files/checkoutstatuschanges

Cancels the check out process for a checked out File. Note that only the user who checked out the File or an
Account administrator can cancel a File Check Out

Users must have a Full license to perform a File Check Out. Users must have access to an Edit File Policy rule.

Users must also have full access and have access to the file category.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"checkedOut": false,
"newEdition": null,
"comment": "Cancelling File Check Out",
" file": {
"guid": "K2M501MD03M2L47YKQ5B"
}
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-FileGuid GUID string GUID for new file - only when including
content
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count

©2022 Arena, A PTC Business www.arenasolutions.com 88

 Arena REST API Developer Guide Endpoints

Name Value Description

X-Arena-Requests-Remaining number how many calls left

Sample Responses
• Cancel the File Checkout:

{
"checkedOut": false,
"comment": "Test Cancel Checkout",
"file": {
"author": {
"fullName": "George C Lewis"
},
"category": {
"guid": "3L507K5WJM5FYHW334R7"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2011-06-02T19:30:28Z",
"description": null,
"edition": "1",
"format": "pdf",
"guid": "K2M501MD03M2L47YKQ5B",
"hasMarkup": false,
"lastModifiedDateTime": "2011-06-02T19:30:28Z",
"latest": true,
"location": null
"locked": true,
"mimeType": application/pdf
"name": USB Cable A-A Datasheet.pdf",
"number": "FILE-000867",
"private": false,
"size": 12326,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "USB CABLE A-A Datasheet"
}
}

An error is returned if a user attempts to cancel a Check Out is already Checked In.

{
"status":400,
"errors":[
{
"code":3132,
"message":"\"This action cannot be completed. Cancelling a check out can
only be performed on checked out Files.\""
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 89

 Arena REST API Developer Guide Endpoints

POST File Check In

POST /files/checkoutstatuschanges

Only the user who checked out the File or an Account administrator can cancel the checkout.

The existing edition of the File can not be checked in if the edition is locked (for example it is associated with
an effective item).

A new edition of the File can be checked in even if the existing edition is locked. Only Files of storageMethod
File can be checked in.

User must have a Full license to perform the File checkin. User must also have access to edit the File and full
access to the File category.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body - Creating a new edition.

checkedOut: false
comment: check in the file
newEdition: true
file.author.fullName: Heidi Walker
file.category.guid: 3L507K5WJM5FYHW334R7
file.description: A design file
file.edition: 2
file.format": pdf
file.guid: K2M501MD03M2L47YKQ5B
file.private: false
file.storageMethodName: FILE
file.title: New Design File
file.content: [the physical file]

Sample Request Body - Check In and edit the existing edition.

checkedOut: false
comment: check the file in
new edition: false
file.author.fullName: Heidi Walker
file.category.guid: 3L507K5WJM5FYHW334R7
file.description: A design file
file.edition: 2
file.format": pdf
file.guid: 2K4N1Y24FWFVEXN0XFLX
file.private: false
file.storageMethodName: FILE

©2022 Arena, A PTC Business www.arenasolutions.com 90

 Arena REST API Developer Guide Endpoints

file.title: New Design File

file.content: [the physical file]

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-FileGuid GUID string GUID for new file - only when including
content
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response.

• Response Header will contain the guid of the new file dition that was checked in.

• For File Check Ins where the existing edition is checked in, the response header will contain the guid of the
existing file condition.

Request invalid if File is already checked in.

{
"status":400,
"errors":[
{
"code":3133,
"message":"The File cannot be updated."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 91

 Arena REST API Developer Guide Endpoints

GET File Markups

/files/<GUID>/markups

Returns a collection of Markup Files associated with a specific File.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get File Markups of a File with a given GUID

GET <url>/files/<GUID>/markups

{
"count": 5,
"results": [
{
"guid": "XFZI1EZQDGUJ2LN69BYZ",
"markup": {
"author": {
"fullName": "Tony Shaftoe"
},
"category": {

©2022 Arena, A PTC Business www.arenasolutions.com 92

 Arena REST API Developer Guide Endpoints

"guid": "0I2L4H2TGJ2CVET001OY"
},
"creationDateTime": "2011-07-25T22:38:18Z",
"format": "doc",
"guid": "1J3M5I3UHK3J2LN69BYY",
"lastModifiedDateTime": "2011-07-25T22:38:18Z",
"locked": true,
"mimeType": "application/msword",
"name": "mount-instructions-07-25-2011.doc",
"size": 27136,
"storageMethodName": "FILE",
"title": "mount-instructions-07-25-2011"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"request": {
"guid": "Q8SBU7SJ69SRAT0L94BE",
"number": "ECR-000001"
},
"reserved": false
},
{
"guid": "2K4N1Y24FWFN6LDUC67B",
"markup": {
"author": {
"fullName": "Heidi Walker"
},
"category": {
"guid": "3L507K5WJM5FYHW334R7"
},
"creationDateTime": "2020-11-25T12:38:18Z",
"format": "PDF",
"guid": "WEYH0DYPCFYEXG6DWC0X",
"lastModifiedDateTime": "2020-12-12T11:21:18Z",
"locked": true,
"mimeType": "application/PDF",
"name": "mount-instructions-VARIANT-Winter-2020.doc",
"size": 45136,
"storageMethodName": "FILE",
"title": "mount-instructions-10-25-2020"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"change": {
"guid": "TBVESPTV6N6ILKFS6B7N",
"number": "ECo-000042"
},
"reserved": false
},

©2022 Arena, A PTC Business www.arenasolutions.com 93

 Arena REST API Developer Guide Endpoints

...
]
}

Returns an error if a parameter is not a valid search attribute.

{
"status":400,
"errors":[
{
"code":3019,
"message":"The attribute \"edition\" is not searchable."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 94

 Arena REST API Developer Guide Endpoints

GET File Markup

/files/<GUID>/markups/<GUID>

Returns a File Markup object with a given GUID. This is the latest edition of the File.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get a file with a given GUID

GET <url>/files/<GUID>/markups/<GUID>

{
"guid": "XFZI1EZQDGUJ2LN69BYZ",
"markup": {
"author": {
"fullName": "Tony Shaftoe"
},
"category": {
"guid": "0I2L4H2TGJ2CVET001OY"
},
"creationDateTime": "2011-07-25T22:38:18Z",

©2022 Arena, A PTC Business www.arenasolutions.com 95

 Arena REST API Developer Guide Endpoints

"format": "doc",
"guid": "1J3M5I3UHK3J2LN69BYY",
"lastModifiedDateTime": "2011-07-25T22:38:18Z",
"locked": true,
"mimeType": "application/msword",
"name": "mount-instructions-07-25-2011.doc",
"size": 27136,
"storageMethodName": "FILE",
"title": "mount-instructions-07-25-2011"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"request": {
"guid": "Q8SBU7SJ69SRAT0L94BE",
"number": "ECR-000001"
},
"reserved": false
}

Returns an error if a parameter is not a valid search attribute.

{
"status":400,
"errors":[
{
"code":3019,
"message":"The attribute \"edition\" is not searchable."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 96

 Arena REST API Developer Guide Endpoints

GET File Markup Content

/files/<GUID>/markups/<GUID>/content

Returns file content belonging to a file markup with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get the content of a File Markup.

/files/<GUID>/markups/<GUID>/content

No JSON response. Returns the content of the File as an Input Stream.

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."

©2022 Arena, A PTC Business www.arenasolutions.com 97

 Arena REST API Developer Guide Endpoints

}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 98

 Arena REST API Developer Guide Endpoints

POST File Markup Create

/files/<GUID>/markups

Creates a File Markup File object.

If you wish to create a File record and upload file content to the Arena servers, construct a request that is
content type multipart/form-data (specified in the header) and has a storageMethodName of FILE (stored on
Arena servers.)

If you wish to create a File record with no uploaded content, construct a JSON request with a
storageMethodName of FTP (stored on user FTP server), WEB (web link), or PLACE_HOLDER (will upload content
later).

When the storageMethod is FTP or WEB, the location attribute should be the web or ftp address where the file
resides. For Files with storageMethodName FILE, the location attribute is not used.

Currently, only Files less than 2GB can be uploaded through this endpoint.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type multipart/form-data

Sample Request Body - with uploaded content

Text attributes:

reserved:true
markup.author.fullName:James Yan
markup.format:pdf
markup.title:Checkin Endpoint Test Update
markup.storageMethodName:FILE
markup.category.guid:0I2L4H2TGJ2CVET001OY

File attribute:

content: [physical file]

Sample Request Body - no uploaded content

{
"markup": {
"storageMethodName": "WEB",
"location":"www.arenasolutions.com/winter_tour_2021.com",
"title":"Winter 2021 Tour",
"format":"pdf",
"author": {
"fullName":"James Deckard"
}

©2022 Arena, A PTC Business www.arenasolutions.com 99

 Arena REST API Developer Guide Endpoints

},
"reserved": true
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-FileGuid GUID string GUID for new file - only when including
content
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
• When creating a File object with uploaded content:

{
"guid": "M4O7Q3OF25J8RA07P9FJ",
"markup": {
"author": {
"fullName": "James Yan"
},
"category": {
"guid": "0I2L4H2TGJ2CVET001OY"
},
"creationDateTime": "2021-01-22T19:51:01Z",
"format": "pdf",
"guid": "Q8SBU7SJ69S8RA07P9F9",
"lastModifiedDateTime": "2021-01-22T19:51:01Z",
"locked": false,
"mimeType": "application/pdf",
"name": "Checkin Endpoint Test.pdf",
"size": 15148,
"storageMethodName": "FILE",
"title": "Checkin Endpoint Test Update"
},
"markupOf": {
"edition": "1",

©2022 Arena, A PTC Business www.arenasolutions.com 100

 Arena REST API Developer Guide Endpoints

"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"reserved": true,
"reservedUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
}

• When creating a file with no uploaded content:

{
"guid": "ASCVERC3QT7WFYOVDX3P",
"markup": {
"author": {
"fullName": "James Desckard"
},
"category": {
"guid": "2K4N6J4VIL4EXGV223PR"
},
"creationDateTime": "2021-01-22T03:22:20Z",
"format": "pdf",
"guid": "EWGZIVG7UXGWFYOVDX3G",
"lastModifiedDateTime": "2021-01-22T03:22:20Z",
"location": "www.ftp.com",
"locked": false,
"storageMethodName": "WEB",
"title": "Winter 2021 Tour"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"reserved": true,
"reservedUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
}

Returns an error if a required metadata attribute is missing.

{
"status":400,
"errors":[
{
"code":3001,
"message":"The attribute \"edition\" is required."
}
]
}

Returns an error if File size is 2GB or higher.

©2022 Arena, A PTC Business www.arenasolutions.com 101

 Arena REST API Developer Guide Endpoints

{
"status":400,
"errors":[
{
"code":3033,
"message":"The file content is missing."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 102

 Arena REST API Developer Guide Endpoints

PUT File Markup Update

/files/<GUID>/markups/<GUID>

Updates a File object.

Also supports updating File storageMethodName from FILE, FTP, WEB, or PLACE_HOLDER to FTP, WEB, or
PLACE_HOLDER. This update can only be performed on unlocked Files.

Updating storageMethodName to FTP, WEB, or PLACE_HOLDER also requires including the attribute location.

This endpoint does not support updating the storageMethodName from FTP, WEB, or PLACE_HOLDER to FILE.
This requires a POST call. See POST File Update.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

Note: This example shows all editable attributes.

markup.storageMethodName: FILE
markup.content: <file stream>
markup.category.guid: Q8SBPMQS3K3J2LC0SX84
markup.title: SmartWall 3000 Updated Drawing
markup.format: PDF
markup.author.fullName: John Sneath
reserved: false

Sample Request Body - Updating storageMethodName

In this example, the existing File has a storageMethodName of FILE and through the PUT endpoint we're
updating it to storageMethodName of WEB.

{
"markup": {
"storageMethodName": "WEB",
"location":"www.everyroadgps.com/en_US/2021-update-file.html",
"title":"Proposed 2021 Update",
"format":"pdf",
"author": {
"fullName":"Rachel Borger"
}
},
"reserved": false
}

©2022 Arena, A PTC Business www.arenasolutions.com 103

 Arena REST API Developer Guide Endpoints

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Update the details of a file

files/<GUID>/markups/<GUID>

{
"guid": "ASCVERC3QT7WFYOVDX3P",
"markup": {
"author": {
"fullName": "John Sneath"
},
"category": {
"guid": "Q8SBPMQS3K3J2LC0SX84"
},
"creationDateTime": "2021-01-22T03:22:20Z",
"format": "PDF",
"guid": "EWGZIVG7UXGWFYOVDX3G",
"lastModifiedDateTime": "2021-01-22T03:32:58Z",
"locked": false,
"storageMethodName": "FILE",
"title": "SmartWall 3000 Updated Drawing"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"reserved": false
}

Updates the storageMethodName of a File from FILE to WEB.

©2022 Arena, A PTC Business www.arenasolutions.com 104

 Arena REST API Developer Guide Endpoints

{
"guid": "ASCVERC3QT7WFYOVDX3P",
"markup": {
"author": {
"fullName": "Rachel Borger"
},
"category": {
"guid": "2K4N6J4VIL4EXGV223PR"
},
"creationDateTime": "2021-01-22T03:22:20Z",
"format": "pdf",
"guid": "EWGZIVG7UXGWFYOVDX3G",
"lastModifiedDateTime": "2021-01-22T03:32:58Z",
"location":"www.everyroadgps.com/en_US/2021-update-file.html",
"locked": false,
"storageMethodName": "WEB",
"title": "Proposed 2021 Update"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"reserved": false
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"EWGZDAEGR8R1K3J1LPP3\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 105

 Arena REST API Developer Guide Endpoints

DELETE File Markup

/files/<GUID>/markups/<GUID>

Deletes a File Markup with a given GUID. When a File has more than one Markup, only the latest, unlocked
edition can be deleted--to delete an entire file, repeat the DELETE request for all editions.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response.

Request with bad GUID

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}

©2022 Arena, A PTC Business www.arenasolutions.com 106

 Arena REST API Developer Guide Endpoints

]
}

©2022 Arena, A PTC Business www.arenasolutions.com 107

 Arena REST API Developer Guide Endpoints

GET Change File Associations

/files/<GUID>/changereferences

Returns a list of file association GUIDs (and limited information about the associated Changes) for a File with
a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Change Reference Associations

GET <url>/files/<GUID>/changereferences

{
"count": 3,
"results": [
{
"change": {
"guid": "5N7QVLNO10JM5N3XEDYU",
"number": "ECO-001442"
},
"guid": "1J3MRHJKXWDK3MH0VGMC"

©2022 Arena, A PTC Business www.arenasolutions.com 108

 Arena REST API Developer Guide Endpoints

},
{
"change": {
"guid": "BTDW1RTU76PSBT9CU3U5",
"number": "ECO-000562"
},
"guid": "ZH1KPFHIVUBI1KFYTEKU"
},
{
"change": {
"guid": "CUEX2SUV87QTCUA2CVF8",
"number": "ECO-001452"
},
"guid": "I0K38Y01EDU1K3YHEUEL"
}
]
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 109

 Arena REST API Developer Guide Endpoints

GET Change File Association

/files/<GUID>/changereferences/<GUID>

Returns a Change File association GUID (and information about the associated Change) for a File with a given
GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Change Reference Association

GET <url>/files/<GUID>/changereferences/<GUID>

{
"change": {
"guid": "CUEX2SUV87QTCUA2CVF8",
"number": "ECO-001452"
},
"guid": "I0K38Y01EDU1K3YHEUEL"
}

Request with bad GUID

©2022 Arena, A PTC Business www.arenasolutions.com 110

 Arena REST API Developer Guide Endpoints

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 111

 Arena REST API Developer Guide Endpoints

GET Change Implementation File Associations

/files/<GUID>/changeimplementations

Returns a list of file association GUIDs (and limited information about the associated Change) for a File with a
given GUID.

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Change Implementation Associations

GET <url>/files/<GUID>/changeimplementations

{
"count": 3,
"results": [
{
"change": {
"guid": "5N7QVLNO10JM5N36I97P",
"number": "ECO-000621"
},
"guid": "J1L49Z12FEV2L4G0BHZW"
},
{
"change": {

©2022 Arena, A PTC Business www.arenasolutions.com 112

 Arena REST API Developer Guide Endpoints

"guid": "CUEX2SUV87QTCUA2CVF8",
"number": "ECO-001452"
},
"guid": "VDXGLBDERQ7EXGSCNLHO"
},
{
"change": {
"guid": "O6Q9E467KJ25O6MG49QC",
"number": "ECO-001446"
},
"guid": "TBVEJ9BCPO5CVEQAM4SC"
}
]
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 113

 Arena REST API Developer Guide Endpoints

GET Change Implementation File Association

/files/<GUID>/changeimplementations/<GUID>

Returns a Change File ile association GUID (and limited information about the associated Change) for a File
with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Change Implementation Association

GET <url>/files/<GUID>/changeimplementations/<GUID>

{
"change": {
"guid": "CUEX2SUV87QTCUA2CVF8",
"number": "ECO-001452"
},
"guid": "VDXGLBDERQ7EXGSCNLHO"
}

Request with bad GUID

©2022 Arena, A PTC Business www.arenasolutions.com 114

 Arena REST API Developer Guide Endpoints

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 115

 Arena REST API Developer Guide Endpoints

GET Items (Search)

/items

Returns a collection of Compact Item objects matching the given search criteria.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all items
where results should begin. All items before
the offset in the search results are ignored.
The default value is 0.
limit integer Specifies the number of results that should
be returned. By default the maximum
number of items is 20. Can return up to 400
compact items.
criteria url encoded string The criteria search parameter uses the same
criteria format used in API Item Exports.
Passing this criteria through a query string
requires url encoding of the characters. For
additional information See GET Items
(Search) Criteria Parameter.

Searchable Attributes

Name Value Description

[additional attribute guid value] string This special search permits searching for
strings in additional attribute values. For
example GET
/items?VDXGZ7E0GO5N6P8PR55G=*100pF
where VDXGZ7E0GO5N6P8PR55G is the
GUID of a custom attribute and we are
searching for all items whose value for this
attribute include the string "100pF". The
ability to search for more than one value is
available for the following attribute field
types: DROP_DOWN, FIXED_DROPDOWN,
& FIXED_DROPDOWN (where multi-select

©2022 Arena, A PTC Business www.arenasolutions.com 116

 Arena REST API Developer Guide Endpoints

Name Value Description

is true). See note below this table for
additional details.

Additional attributes, also known as custom

attributes, support the date field type. Users
can perform searches by additional
attributes with a date field type by using
the format yyyy-mm-dd. In the following
example, the user is using the following to
search for a date field type custom attribute
with a value of April 1, 2019:

GET
/items?4M6PUJNPNM3L4N25ZZ5F=2019-04-01
category.guid string category unique ID
creator.fullName string the full name (first and last) of the creator
of the item
creator.guid string creator unique ID
name string item name
number string item number
revisionNumber string revision number
description string item description
owner.fullName string item owner full name
effectiveDateTimeFrom Date-Formatted String the date and time (in Zulu format) the
effective revision of an item was made
effective
effectiveDateTimeTo Date-Formatted String the date and time (in Zulu format) a revision
of an item was superseded
inAssembly true or false true indicates an item is included in at least
one assembly (appears on a BOM)
lifecyclePhase.guid string lifecyclePhase unique ID
modifiedBom true or false true indicates the BOM of the item includes
modifications to the working revision
modifiedFiles true or false true indicates the Files view of the item
includes modifications to the working
revision
modifiedSourcing true or false true indicates the Sourcing view of the item
includes modifications to the working
revision
modifiedSpecs true or false true indicates the Specs view of the item
includes modifications to the working
revision

©2022 Arena, A PTC Business www.arenasolutions.com 117

 Arena REST API Developer Guide Endpoints

Note: Search behavior in the Arena REST API differs from search behavior in the Arena application. In the API, a
trailing asterisk (wildcard) is required to return results that start with a string; in the Arena application, a trailing
asterisk is always implied.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all items

GET /items

{
"count":20,
"results":[
{
"category":{
"guid":"5N6P8RAK3MY6UNTA"
},
"creationDateTime":"2011-06-02T19:23:31Z",
"guid":"VDXGLBCCLSBSBQMM0SJU",
"lifecyclePhase":{
"guid":"7G6P3WAD3MG6GNFD",
"name":"In Production"
},
"name":"PCBA, EveryRoad, Model 300",
"number":"830-00001",
"revisionNumber":"D",
"url": {
"api": "https://api.arenasolutions.com/v1/items/VDXGLBCCLSBSBQMM0SJU",

"app": "https://app.bom.com/VDXGLBCCLSBSBQMM0SJU"
},

©2022 Arena, A PTC Business www.arenasolutions.com 118

 Arena REST API Developer Guide Endpoints

...
]
}

Get items with owner "James Deckard" and in category "Subassembly"

GET <url>/items?owner.fullName=James
Deckard&category.guid=UCWFKABBKRAK3MY6UNTU

{
"count":4,
"results":[
{
"category":{
"guid":"ZH1K3K3JFSBL4N6O1ZQS"
},
"creationDateTime":"2011-02-11T16:52:40Z",
"guid":"FXH0J0JZV8R8RASMLCR5",
"lifecyclePhase":{
"guid":"FXH0J0JZV8QTCVEXGZM5",
"name":"In Production"
},
"name":"Subassembly, EveryRoad, Front Bezel",
"number":"090-0001",
"revisionNumber":"A",
"url": {
"api": "https://api.arenasolutions.com/v1/items/FXH0J0JZV8R8RASMLCR5",

"app": "https://app.bom.com/FXH0J0JZV8R8RASMLCR5"
},
{
"category":{
"guid":"ZH1K3K3JFSBL4N6O1ZQS"
},
"creationDateTime":"2011-02-11T16:52:40Z",
"guid":"VDXGZGZFBO7O7Q821S54",
"lifecyclePhase":{
"guid":"FXH0J0JZV8QTCVEXGZM5",
"name":"In Production"
},
"name":"Documentation Package, Everyroad Model 300/500",
"number":"090-0003",
"revisionNumber":"A",
"url": {
"api": "https://api.arenasolutions.com/v1/items/VDXGZGZFBO7O7Q821S54",

"app": "https://app.bom.com/VDXGZGZFBO7O7Q821S54"
},
...
]
}

Get effective revisions of items where the revisions were made effective between 4pm February 11, 2013 and
4pm March 11, 2013.

©2022 Arena, A PTC Business www.arenasolutions.com 119

 Arena REST API Developer Guide Endpoints

GET
/items?effectiveDateTimeFrom=2013-02-11T16:00:00Z&effectiveDateTimeTo=2013-03-11T16:00:00Z

{
"count":2,
"results":[
{
"category":{
"guid":"N5P8R8R73GZ9SBUCNG61"
},
"creationDateTime":"2011-02-11T16:52:40Z",
"guid":"GYI1K1K0W9S9SBSLE716",
"lifecyclePhase":{
"guid":"0I2L4L4KGTBEXGZI1H01",
"name":"Design Verification"
},
"name":"Circuit Board, EveryRoad, Model 500",
"number":"040-0002",
"revisionNumber":"2",
"url": {
"api": "https://api.arenasolutions.com/v1/items/GYI1K1K0W9S9SBSLE716",

"app": "https://app.bom.com/GYI1K1K0W9S9SBSLE716"
},
{
"category":{
"guid":"ZH1K3K3JFSBL4N6O1ZQS"
},
"creationDateTime":"2011-02-11T16:52:40Z",
"guid":"1J3M5M5LHUDUDWE86ARW",
"lifecyclePhase":{
"guid":"EWGZIZIYU7PSBUDWFV6U",
"name":"Eng Verification"
},
"name":"Subassembly, Connector, Stormwatch",
"number":"090-0006",
"revisionNumber":"3",
"url": {
"api": "https://api.arenasolutions.com/v1/items/1J3M5M5LHUDUDWE86ARW",

"app": "https://app.bom.com/1J3M5M5LHUDUDWE86ARW"
}
}
]
}

Request with an invalid search attribute.

GET /items?owner.Name=*Walker

{
"status":400,
"errors":[
{
"code":3019,

©2022 Arena, A PTC Business www.arenasolutions.com 120

 Arena REST API Developer Guide Endpoints

"message":"The attribute \"owner.Name\" is not searchable."

}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 121

 Arena REST API Developer Guide Endpoints

GET Items (Search) Criteria Parameter

/items?criteria=<URL encoded criteria>

This article describes a special variation of the GET Items (Search) endpoint that uses the criteria search
parameter.

Using the Criteria parameter requires URL encoding of the query string. URL encoding, also known as
Percent-encoding, encodes data in using only the limited US-ASCII characters. Typically special characters are
encoded with percentages and numbers.

The Criteria search parameter utilizes the same attributes and operators used in API Item Export. See Criteria:
Attributes and Operators for a full list of attributes and operators that can be used for the Criteria parameter.

Additional information on criteria structure is available in Export Criteria.

Warning: In order to protect product data, we advise users to URL encode their data using functions
within their programming languages and to avoid using third party sites to encode their data.

Criteria Parameter Search Examples

Get all items with a creation date between 2001-07-12T10:00:01Z and 2030-07-12T20:23:59Z.

Below is the non url encoded version. This should not be used but is included here for instructional purposes.

GET /items?criteria=[[ { "attribute": "creationDateTime", "value": ["2001-07-12T10:00:01Z" ,"2030-07-12T20:23:59Z"

], "operator": "IS_BETWEEN" } ] ]

Below is the url encoded criteria parameter search version that should be used.

GET
etm
i aets?=
icr%5B%5B%20%20%7B%20%22bairtuet%22%3A%20%22cero
aitnDaetTm
i e%22%2C%20%22vu
ale%22%3A%20%5B%2220150-71-2T10%3A00%3A01Z%22%20%2C%222020-71-2T20%3A23%3A59Z%22%20%5D%2C%20%22opearo
t%
r 22%3A%20%22SI_BETWEEN%22%20%7D%20%5D%20%5D

Example Response

{
"count": 16,
"results": [
{
"category": {
"guid": "ASCVERC3QTCM5O07B6HP"
},
"creationDateTime": "2016-09-02T18:48:29Z",
"effectiveDateTime": "2016-09-02T19:20:10Z",
"guid": "1J3M5I3UHK3BU9XRO93Q",
"lifecyclePhase": {
"guid": "DVFYHUF6TWEH0J2L4EYV",
"name": "In Production"
},
"name": "Policy, Quality",
"number": "001-00001",
"revisionNumber": "A",
"url": {

©2022 Arena, A PTC Business www.arenasolutions.com 122

 Arena REST API Developer Guide Endpoints

"api": "https://api.arenasolutions.com/v1/items/1J3M5I3UHK3BU9XRO93Q",

"app": "https://app.bom.com/1J3M5I3UHK3BU9XRO93Q"
},
{
"category": {
"guid": "CUEXGTE5SVEO7Q29D8JI"
},
"creationDateTime": "2016-09-02T18:49:25Z",
"effectiveDateTime": "2016-09-02T19:20:10Z",
"guid": "6O8RAN8ZMP8GZE2WTE76",
"lifecyclePhase": {
"guid": "DVFYHUF6TWEH0J2L4EYV",
"name": "In Production"
},
"name": "Everyroad Employee Handbook",
"number": "010-00001",
"revisionNumber": "A",
"url": {
"api": "https://api.arenasolutions.com/v1/items/6O8RAN8ZMP8GZE2WTE76",

"app": "https://app.bom.com/6O8RAN8ZMP8GZE2WTE76"
},
...
]
}

Get items with a lifecycle phase guid of 9RBUDQB2PSADWFYH0AUY.

Below is the non url encoded version. This should not be used but is included here for instructional purposes.

GET /items?criteria=[ [ { "attribute": "lifecyclePhase.guid", "value": [

"9RBUDQB2PSADWFYH0AUY"], "operator": "IS_IN" } ] ]

Below is the url encoded criteria parameter search version that should be used.

GET
te/ims?cteriari=%5B%20%5B%20%7B%20%22ab
triute%22%3A%20%2e2ficlycelPhaseg.udi%22%2C%20%22vaule%22%3A%20%5B%20%229RBUDQB2PSADWFYH0AUY%22%5D%2C%20%22operator%22%3A%20%22SI_N
I%22%20%7D%20%5D%20%5D

Example Response

{
"count": 20,
"results": [
{
"category": {
"guid": "J1L4N0LCZ2LVEXCJJK6K"
},
"creationDateTime": "2011-06-02T19:23:22Z",
"effectiveDateTime": "2011-07-19T16:28:45Z",
"guid": "DVFYHUF6TWFN6OYHTN2A",
"lifecyclePhase": {
"guid": "DVFYHUF6TWEH0J2L4EYV",
"name": "In Production"
},

©2022 Arena, A PTC Business www.arenasolutions.com 123

 Arena REST API Developer Guide Endpoints

"name": "Socket, Molex D50-L RA 20pin",

"number": "125-00006",
"revisionNumber": "A",
"url": {
"api": "https://api.arenasolutions.com/v1/items/DVFYHUF6TWFN6OYHTN2A",

"app": "https://app.bom.com/DVFYHUF6TWFN6OYHTN2A"
},
{
"category": {
"guid": "J1L4N0LCZ2LVEXCJJK6K"
},
"creationDateTime": "2011-06-02T19:23:25Z",
"effectiveDateTime": "2011-07-19T16:28:45Z",
"guid": "I0K3MZKBY1KSBT3MYS65",
"lifecyclePhase": {
"guid": "DVFYHUF6TWEH0J2L4EYV",
"name": "In Production"
},
"name": "Plug, Molex D50-L Straight, 20pin",
"number": "125-00007",
"revisionNumber": "A",
"url": {
"api": "https://api.arenasolutions.com/v1/items/I0K3MZKBY1KSBT3MYS65",

"app": "https://app.bom.com/I0K3MZKBY1KSBT3MYS65"
},
{
"category": {
"guid": "J1L4N0LCZ2LVEXCJJK6K"
},
"creationDateTime": "2011-06-02T19:23:27Z",
"effectiveDateTime": "2011-07-19T16:28:45Z",
"guid": "N5P8R4PG36PXGY8R3XAH",
"lifecyclePhase": {
"guid": "DVFYHUF6TWEH0J2L4EYV",
"name": "In Production"
},
"name": "Connector, Molex KK 3 cond straight",
"number": "125-00008",
"revisionNumber": "A",
"url": {
"api": "https://api.arenasolutions.com/v1/items/N5P8R4PG36PXGY8R3XAH",

"app": "https://app.bom.com/N5P8R4PG36PXGY8R3XAH"
},
...
]
}

Get Items that have a value equal to WEYH0DYPCFWFYH0JSIPD for creator guid OR were created by a user
who has an email that contains the value [email protected].

Below is the non url encoded version. This should not be used but is included here for instructional purposes.

©2022 Arena, A PTC Business www.arenasolutions.com 124

 Arena REST API Developer Guide Endpoints

GET /items?criteria=[ [ { "attribute": "creator.guid", "value":

"WEYH0DYPCFWFYH0JSIPD", "operator": "IS_EQUAL_TO" } ], "OR", [ { "attribute":
"creator.email", "value": "[email protected]", "operator": "CONTAINS"
} ] ]

Below is the url encoded criteria parameter search version that should be used.

GET
a=ie%
m
rti5/cr?B
s%20%5B%20%7B%20%
bu
ei%
t2
rtat2%3A%20%
g
d2
u%
eo
.iacrt2%2C%20%2uvea%
l 2%3A%20%2WEYH0DYPCFWFYH
PD
0SIJ%2%2C%20%2op
o
%
aetr2%3A%20%S2_EQ
IUAL_TO%2%20%7D%20%5D%2C%20%2OR%2%2C%20%5B%20%7B%20%
bu
ei%
t2
rtat2%3A%20%
em
2
%
eo
.acrtla2i%2C%20%2uvea%
l 2%3A%20%2hw
k%
eral40eovyeradg
cop
m
.s%2%2C%20%2op
o
%
aetr2%3A%20%2CONTN
AIS%2%20%7D%20%5D%20%5D

Example Response

{
"count": 20,
"results": [
{
"category": {
"guid": "I0K3MZKBY1KUDWBIIJ49"
},
"creationDateTime": "2012-03-07T19:54:07Z",
"effectiveDateTime": "2012-03-07T19:56:04Z",
"guid": "2K4N6J4VIL4CVA8EYV18",
"lifecyclePhase": {
"guid": "EWGZIVG7UXFI1K3M5FZN",
"name": "In Design"
},
"name": "Voltage Regulator, Low-dropout, 5.0V, 90µA",
"number": "160-00007",
"revisionNumber": "1",
"url": {
"api": "https://api.arenasolutions.com/v1/items/2K4N6J4VIL4CVA8EYV18",

"app": "https://app.bom.com/2K4N6J4VIL4CVA8EYV18"
},
{
"category": {
"guid": "5N7Q9M7YLO7H0JY556R1"
},
"creationDateTime": "2012-04-04T18:25:22Z",
"guid": "XFZI1EZQDGZ7Q535R6XM",
"lifecyclePhase": {
"guid": "9RBUDQB2PSADWFYH0AUY",
"name": "Unreleased"
},
"name": "Resistor, Surface Mount, 240ohm, 1/10W, 0603",
"number": "180-00013",
"revisionNumber": "01",
"url": {
"api": "https://api.arenasolutions.com/v1/items/XFZI1EZQDGZ7Q535R6XM",

"app": "https://app.bom.com/XFZI1EZQDGZ7Q535R6XM"
},
{
"category": {
"guid": "WEYH0DYPCFY8RAPWWXIF"

©2022 Arena, A PTC Business www.arenasolutions.com 125

 Arena REST API Developer Guide Endpoints

},
"creationDateTime": "2011-08-09T22:19:25Z",
"effectiveDateTime": "2013-03-13T18:58:37Z",
"guid": "3L5O7K5WJM5DWB91YGJ7",
"lifecyclePhase": {
"guid": "EWGZIVG7UXFI1K3M5FZN",
"name": "In Design"
},
"name": "PCBA, EveryRoad, Model 500",
"number": "830-00002",
"revisionNumber": "3",
"url": {
"api": "https://api.arenasolutions.com/v1/items/3L5O7K5WJM5DWB91YGJ7",

"app": "https://app.bom.com/3L5O7K5WJM5DWB91YGJ7"
},
...
]
}

Search for Items that have a Category GUID value of CUEXGTE5SVEO7Q29D8JI or a Category GUID value of
BTDWFSD4RUDN6P18C7I6. OR a Category GUID value of J1L4N0LCZ2LVEX9H2599 or a Lifecycle Phase GUID
value of BTDWFSD4RUCFYH0J2CWA. Or a Lifecycle Phase GUID of ASCVERC3QTBEXGZI1BVF or an Item number
that starts with a value of 8.

Below is the non url encoded version. This should not be used but is included here for instructional purposes.

GET /items?criteria=[ [ {"attribute": "category.guid","value": "CUEXGTE5SVEO7Q29D8JI","operator":

"IS_EQUAL_TO"},"OR",{"attribute": "category.guid","value": "BTDWFSD4RUDN6P18C7I6","operator":
"IS_EQUAL_TO"} ], "OR", [{"attribute": "category.guid","value": "J1L4N0LCZ2LVEX9H2599","operator":
"IS_EQUAL_TO"}], "OR", [{"attribute": "lifecyclePhase.guid","value": "BTDWFSD4RUCFYH0J2CWA","operator":
"IS_EQUAL_TO"}], "OR", [ {"attribute": "lifecyclePhase.guid","value": "ASCVERC3QTBEXGZI1BVF","operator":
"IS_EQUAL_TO"},"OR",{"attribute": "number","value": "8","operator": "STARTS_WITH"} ] ]

Below is the url encoded criteria parameter search version that should be used.

GET
=
a%
i5
B
%
ret2
0
%i5
%
B
eb
m
eu
rtc2
%
t?0d
i%
sg
ri3
A
u
7
B
%
2t/.yt2
a0
%
g
eC
u
o
rta2
cla%
v3
A
%2
0
%2
C
U
X
EG
V
5
SO
ET%
7
Q
2
9
D
I%
8
J%
2
C
o
%
r2
%
ta2
o
p
re3
A
%Q
E2
0
%
_SU
2
IA
O
T_L%
2
%7
D
%2
C%
2
OR
%2
%
eb
u
t2
C
%
d
i%
g
r3
A
u
7
B
i%
2t.yt2
a0
%
g
eC
u
o
rta2
cla%
v3
A
%2
0
%2
B
D
TW
D
SF4
R
U
D6
%
N
6
P
1
8
C7
I2
%
%2
C
o
%
r2
%
ta2
o
p
re3
A
%Q
E2
0
%
_SU
2
IA
O
T_L%
2
%7
D
%2
0
%5
D
%2
C%
2
0
%2
0
%2
O
R
%2
%2
C
%2
%
0
eb
u
t2
5
%
Bd
i%
g
r3
A
u
7
B
i%
2t.yt2
a0
%
g
eC
u
o
rta2
cla%
v3
A
%2
0
%
4N
1
LC
0
L2
JZ
V
X
E9
H
2
5
9
%2
%%
2
C
o
%
r2
%
ta2
o
p
re3
A
%Q
E2
0
%
_SU
2
IA
O
T_L%
2
%7
D
%5
D%
2
C%
2
0
%2
O
R
%2
%d
%
2
C
g
u
%
i2.e2
%
0P
h
sb
C
au
%
et2
5
%
B
licya2
%
vcer3
A
7
B
%
ft3
A
%
t2
a0
%
i2
0
%
2
l2
B
D
TW
D
SF4
R
U
C
Y
FH
2W
0
JA
%2
%
%2
C
o
%
r2
%
ta2
o
p
re3
A
%Q
E2
0
%
_SU
2
IA
O
T_L%
2
%7
D
%5
D%
2
C%
2
0
%2
O
R
%2
%2
C
%
dg
u
2
0
%
i.e5
%
B
P
h
sb
2
C
au
%
et2
%
l0icya2
%
vcer3
A
7
B
%
ft3
A
%
t2
a0
%
i2
0
%
2
l2
A
C
SV
R
EC
3
Q
1
B
TX
V
E%
FG
Z
I2
%
%2
C
o
%
r2
%
ta2
o
p
re3
A
%Q
E2
0
%
_SU
2
IA
O
T_L%
2
%7
D
%2
C%
2
OR
%2
%
eb
u
t2
C
%
ir3
A
7
B
%
tt2
a0
%2
n
u
m%
b
re2
%2
C
u
%
ela2
%
v3
A
%2
0
%2
8
%2
%
%2
C
o
%
r2
%
ta2
o
p
re3
A
%2
0
%A
T2
SW
_R
TH
%
I2
%7
D
%2
0
%5
D
%2
0
%5
D

Example Response

{
"count": 20,
"results": [
{
"category": {
"guid": "VDXGZCXOBEX7Q9OVVWHR"
},
"creationDateTime": "2011-06-02T19:23:30Z",
"effectiveDateTime": "2011-07-26T06:54:20Z",
"guid": "HZJ2LYJAX0JRAS1RLQS5",
"lifecyclePhase": {
"guid": "DVFYHUF6TWEH0J2L4EYV",
"name": "In Production"

©2022 Arena, A PTC Business www.arenasolutions.com 126

 Arena REST API Developer Guide Endpoints

},
"name": "Documentation Package, Everyroad Model 300/500",
"number": "820-00003",
"revisionNumber": "A",
"url": {
"api": "https://api.arenasolutions.com/v1/items/HZJ2LYJAX0JRAS1RLQS5",

"app": "https://app.bom.com/HZJ2LYJAX0JRAS1RLQS5"
},
{
"category": {
"guid": "VDXGZCXOBEX7Q9OVVWHR"
},
"creationDateTime": "2011-06-02T19:23:31Z",
"effectiveDateTime": "2012-01-12T23:55:37Z",
"guid": "BTDWFSD4RUDL4MK9ZROI",
"lifecyclePhase": {
"guid": "DVFYHUF6TWEH0J2L4EYV",
"name": "In Production"
},
"name": "Subassembly, EveryRoad, Front Assembly",
"number": "820-00001",
"revisionNumber": "C",
"url": {
"api": "https://api.arenasolutions.com/v1/items/BTDWFSD4RUDL4MK9ZROI",

"app": "https://app.bom.com/BTDWFSD4RUDL4MK9ZROI"
},
{
"category": {
"guid": "VDXGZCXOBEX7Q9OVVWHR"
},
"creationDateTime": "2011-06-02T19:23:31Z",
"effectiveDateTime": "2012-01-12T23:55:37Z",
"guid": "M4O7Q3OF25OWFWL0UWAS",
"lifecyclePhase": {
"guid": "DVFYHUF6TWEH0J2L4EYV",
"name": "In Production"
},
"name": "Subassembly, EveryRoad, Rear Assembly",
"number": "820-00002",
"revisionNumber": "F",
"url": {
"api": "https://api.arenasolutions.com/v1/items/M4O7Q3OF25OWFWL0UWAS",

"app": "https://app.bom.com/M4O7Q3OF25OWFWL0UWAS"
},
{
"category": {
"guid": "FXH0JWH8VYHRAT8FFG2G"
},
"creationDateTime": "2011-06-02T19:23:30Z",
"effectiveDateTime": "2015-09-21T23:45:20Z",
"guid": "7P9SBO90NQ9H0H64Z4M0",
"lifecyclePhase": {

©2022 Arena, A PTC Business www.arenasolutions.com 127

 Arena REST API Developer Guide Endpoints

"guid": "DVFYHUF6TWEH0J2L4EYV",
"name": "In Production"
},
"name": "Assembly, GPS, EveryRoad Car Navigation Unit - Model 300",
"number": "810-00001",
"revisionNumber": "E",
"url": {
"api": "https://api.arenasolutions.com/v1/items/7P9SBO90NQ9H0H64Z4M0",

"app": "https://app.bom.com/7P9SBO90NQ9H0H64Z4M0"
},
...
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 128

 Arena REST API Developer Guide Endpoints

GET Item Specs

/items/<GUID>

Returns an Item object with a given GUID. Note that while the standard practice is to retrieve an item GUID
using the GET Items endpoint and then use an item GUID here (returning the effective revision), you can also
use a GUID for a specific revision of an item here.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

includeEmptyAdditionalAttributes true or false If this is true, the response returns empty
additional attributes. The default is false.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a single item (including empty additional attributes).

GET /items/GUID?includeEmptyAdditionalAttributes=true

©2022 Arena, A PTC Business www.arenasolutions.com 129

 Arena REST API Developer Guide Endpoints

{
"additionalAttributes":[
{
"apiName":"1I35WWQQSEKPOHOKXUMU",
"fieldType":"NUMBER",
"guid":"1I35WWQQSEKPOHOKXUMU",
"name":"EOQ",
"value":1000
},
{
"apiName":"N5P8RZ885M3L4N6NS8Z0",
"fieldType":"SINGLE_LINE_TEXT",
"guid":"N5P8RZ885M3L4N6NS8Z0",
"name":"Material",
"value":"silicon - non-exempt"
},
{
"apiName":"ZH1K3BKKHYFXGZIZ31DJ",
"fieldType":"DATE",
"guid":"ZH1K3BKKHYFXGZIZ31DJ",
"name":"Yearly service check",
"value":"2018-12-02T07:59:59Z"
},
{
"apiName":"YG0J2AJJGXEWFYHY0FSA",
"fieldType":"FIXED_DROP_DOWN",
"guid":"YG0J2AJJGXEWFYHY0FSA",
"multiSelect":true,
"name":"Affected Countries",
"value":[
"China",
"Latveria",
"USA"
]
}
],
"category":{
"guid":"P7RAT1AA7O7H0J2J7J83"
},
"creationDateTime":"2011-02-11T16:52:40Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker"
},
"description":"Circuit board for the EveryRoad product - Model 500",
"deviated":false,
"effectiveDateTime":"2018-04-06T22:33:27Z",
"guid":"L3N6PX663K3K3HOBOOT0",
"isAssembly":false,
"lifecyclePhase":{
"guid":"BTDWFNWWTASVEXGZIXDY",
"name":"In Design"
},
"modifiedBom":false,
"modifiedFiles":true,

©2022 Arena, A PTC Business www.arenasolutions.com 130

 Arena REST API Developer Guide Endpoints

"modifiedSourcing":false,
"modifiedSpecs":true,
"name":"Circuit Board, EveryRoad, Model 500",
"number":"040-0002",
"offTheShelf":false,
"owner":{
"fullName":"John Parker"
},
"procurementType":"OTS",
"productionCost":null,
"prototypeCost":null,
"revisionNumber":"2",
"shared":true,
"standardCost":null,
"status":1,
"supersededDateTime":null,
"targetCost":null,
"targetPrice":null,
"uom":"each",
"url": {
"api": "https://api.arenasolutions.com/v1/items/L3N6PX663K3K3HOBOOT0",
"app": "https://app.bom.com/L3N6PX663K3K3HOBOOT0"
}

request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 131

 Arena REST API Developer Guide Endpoints

POST Item Create

/items

Creates a new Item object. You can specify no number format, the basic number format, or a valid number
format for the workspace (with or without an auto-generating sequence), in which case you must specify valid
values for each field type in the number format. Each case is shown below.

NOTES:

1. The values you specify for attributes must match the attribute types specified in the workspace. For example,
when specifying a value for a predefined list, the value must be one of the allowed values.

2. Category and other IDs must exist in the workspace.

3. A category GUID is required.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

• Create Item with No Number

{
"category":{
"guid":"1J3MRHIIRYHRAT5D1U08"
},
"description":"New Part",
"name":"New Part",
"offTheShelf":true,
"owner": {
"fullName": "James Deckard"
},
"productionCost":1.1,
"prototypeCost":2.2,
"revisionNumber":"A",
"shared":false,
"standardCost":3.3,
"targetCost":4.4,
"targetPrice":5.5,
"uom":"Each"
}

• Create Item with Autogenerating Number

{
"category":{
"guid":"ZH1K3K3JFSBL4N6O1ZQS"
},

©2022 Arena, A PTC Business www.arenasolutions.com 132

 Arena REST API Developer Guide Endpoints

"description":"New Part",
"name":"New Part",
"numberFormat":{
"guid":"L3N6B044Z4NWFYEEF2YCH",
"fields":[
{
"guid":"J1L4N4N3ZCV4N6P7QKMR",
"value":"081"
}
]
},
"offTheShelf":true,
"owner": {
"fullName": "James Deckard"
},
"productionCost":1.1,
"prototypeCost":2.2,
"revisionNumber":"A",
"shared":false,
"standardCost":3.3,
"targetCost":4.4,
"targetPrice":5.5,
"uom":"Each"
}

• Create Item with Autogenerating Number and Additional Attributes

Note: When submitting values for Additional Attributes of type NUMBER, the value must be submitted as a number
(not wrapped in quotes.)

{
"additionalAttributes":[
{
"guid":"M4O7QY774L2K3M5MR7YT",
"value":"5000"
},
{
"guid":"N5P8RZ885M3L4N6NS8Z0",
"value":"Silicon"
}
],
"category":{
"guid":"2K4N6ENNK1KUDWFWKWKO"
},
"description":"New PCBA",
"name":"PCBA, EveryHome 2046",
"numberFormat":{
"guid":"VDXGZ7GGDUDM5O7OL7R3",
"fields":[
{
"guid":"5N7Q9HQQN4L8RATAIVF4",
"value":"110"
}
]
},
"offTheShelf":true,
"owner":{
"fullName":"Heidi Walker"
},

©2022 Arena, A PTC Business www.arenasolutions.com 133

 Arena REST API Developer Guide Endpoints

"productionCost":1.1,
"prototypeCost":2.2,
"revisionNumber":"1",
"shared":false,
"standardCost":3.3,
"targetCost":4.4,
"targetPrice":5.5,
"uom":"Each"
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Create Item with no number

{
"additionalAttributes":[

],
"category":{
"guid":"1J3MRHIIRYHRAT5D1U08"
},
"creationDateTime":"2017-04-05T22:41:53Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker"
},
"description":"New Part",
"deviated":false,
"effectiveDateTime":null,
"guid":"0I2L4L4KGTCTCQVZVP97",
"isAssembly":false,

©2022 Arena, A PTC Business www.arenasolutions.com 134

 Arena REST API Developer Guide Endpoints

"lifecyclePhase":{
"guid":"BTDWFWFVR4MP8RATCVII",
"name":"Unreleased"
},
"modifiedBom":false,
"modifiedFiles":false,
"modifiedSourcing":false,
"modifiedSpecs":true,
"name":"New Part",
"number":null,
"offTheShelf":true,
"owner": {
"fullName": "James Deckard"
},
"procurementType":"MTS",
"productionCost":1.1,
"prototypeCost":2.2,
"revisionNumber":"A",
"shared":false,
"standardCost":3.3,
"status":0,
"supersededDateTime":null,
"targetCost":4.4,
"targetPrice":5.5,
"uom":"each",
"url": {
"api": "https://api.arenasolutions.com/v1/items/0I2L4L4KGTCTCQVZVP97",
"app": "https://app.bom.com/0I2L4L4KGTCTCQVZVP97"
}

Create Item with Autogenerating Number

{
"additionalAttributes":[

],
"category":{
"guid":"1J3MRHIIRYHRAT5D1U08"
},
"creationDateTime":"2017-04-05T22:41:53Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker"
},
"description":"New Part",
"deviated":false,
"effectiveDateTime":null,
"guid":"0I2L4L4KGTCTCQVZVP97",
"isAssembly":false,
"lifecyclePhase":{
"guid":"BTDWFWFVR4MP8RATCVII",
"name":"Unreleased"
},
"modifiedBom":false,
"modifiedFiles":false,

©2022 Arena, A PTC Business www.arenasolutions.com 135

 Arena REST API Developer Guide Endpoints

"modifiedSourcing":false,
"modifiedSpecs":true,
"name":"New Part",
"number":"10-0002",
"offTheShelf":true,
"owner": {
"fullName": "James Deckard"
},
"procurementType":"MTS",
"productionCost":1.1,
"prototypeCost":2.2,
"revisionNumber":"A",
"shared":false,
"standardCost":3.3,
"status":0,
"supersededDateTime":null,
"targetCost":4.4,
"targetPrice":5.5,
"uom":"each",
"url": {
"api": "https://api.arenasolutions.com/v1/items/0I2L4L4KGTCTCQVZVP97",
"app": "https://app.bom.com/0I2L4L4KGTCTCQVZVP97"
}

Create Item with Autogenerating Number and Additional Attributes

{
"additionalAttributes":[
{
"apiName":"M4O7QY774L2K3M5MR7YT",
"fieldType":"SINGLE_LINE_TEXT",
"guid":"M4O7QY774L2K3M5MR7YT",
"name":"MOQ",
"value":"5000"
},
{
"apiName":"N5P8RZ885M3L4N6NS8Z0",
"fieldType":"SINGLE_LINE_TEXT",
"guid":"N5P8RZ885M3L4N6NS8Z0",
"name":"Material",
"value":"Silicon"
}
],
"category":{
"guid":"2K4N6ENNK1KUDWFWKWKO"
},
"creationDateTime":"2019-02-04T19:49:50Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker"
},
"description":"New PCBA",
"deviated":false,
"effectiveDateTime":null,
"guid":"9RBUDLUUR8RZIW11GB9L",

©2022 Arena, A PTC Business www.arenasolutions.com 136

 Arena REST API Developer Guide Endpoints

"isAssembly":false,
"lifecyclePhase":{
"guid":"6O8RAIRRO5NQ9SBUDS87",
"name":"Unreleased"
},
"modifiedBom":false,
"modifiedFiles":false,
"modifiedSourcing":false,
"modifiedSpecs":true,
"name":"PCBA, EveryHome 2046",
"number":"110-0005",
"offTheShelf":true,
"owner":{
"fullName":"Heidi Walker"
},
"procurementType":"OTS",
"productionCost":1.1,
"prototypeCost":2.2,
"revisionNumber":"1",
"shared":false,
"standardCost":3.3,
"status":0,
"supersededDateTime":null,
"targetCost":4.4,
"targetPrice":5.5,
"uom":"each",
"url": {
"api": "https://api.arenasolutions.com/v1/items/9RBUDLUUR8RZIW11GB9L",
"app": "https://app.bom.com/9RBUDLUUR8RZIW11GB9L"
}

The request is validated to make sure it doesn’t violate any business rules. Any violation will result in an error
response:

1. An attribute included in the request is not recognizable.

{
"status":400,
"errors":[
{
"code":4004,
"message":"The attribute \"name1\" is not recognized."
}
]
}

2. The category GUID is not valid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"J1ICM2LVEXGZIR4\" is not valid."

©2022 Arena, A PTC Business www.arenasolutions.com 137

 Arena REST API Developer Guide Endpoints

}
]
}

3. An option is not valid value for a fixed (non-user-editable) dropdown list.

{
"status":400,
"errors":[
{
"code":3006,
"message":"The specified value \"ea\" is not a valid option for the
attribute \"uom\"."
}
]
}

4. The value exceeds the maximum length for an attribute.

{
"status":400,
"errors":[
{
"code":3005,
"message":"The specified value \"1.234567891111111E20\" is too big for
the attribute \"productionCost\"."
}
]
}

5. An improper type of value is given to an attribute. For example if a string value is given to a double attribute.

{
"status":400,
"errors":[
{
"code":400,
"message":"The format of the request is not valid. Please check the syntax."

}
]
}

6. One or more additional attributes are not recognized.

{
"status":400,
"errors":[
{
"code":3004,
"message":"The attribute \"custom1637239\" is not recognized."
}

©2022 Arena, A PTC Business www.arenasolutions.com 138

 Arena REST API Developer Guide Endpoints

]
}

7. A number format is invalid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"FXE8IYHQ9SBUDTLK1\" is not valid."
}
]
}

8. A required entry for a valid NumberFormat is not given.

{
"status":400,
"errors":[
{
"code":3009,
"message":"The field \"SM Analog Type Code\" is required for the number
format \"410-SM Analog Voltage Regulator\"."
}
]
}

9. A required attribute is missing.

{
"status":400,
"errors":[
{
"code":3001,
"message":"The attribute \"uom\" is required."
}
]
}

10. A free text NumberFormat is used, and the given item number exceeds the maximum length.

{
"status":400,
"errors":[
{
"code":3015,
"message":"The given item number is too long. The max length of the free
text number format \"FreeText\" is \"10\"."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 139

 Arena REST API Developer Guide Endpoints

11. The category is structural.

{
"status":400,
"errors":[
{
"code":3007,
"message":"This category is structural; objects may not be assigned to
it."
}
]
}

12. The given item number exists in the workspace and the workspace does not allow item number duplication.

{
"status":400,
"errors":[
{
"code":3025,
"message":"A revision of an Item already exists (or has been reserved by
an integration) with the item number you selected. Item numbers may not be
duplicated in this workspace."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 140

 Arena REST API Developer Guide Endpoints

PUT Item Update

/items/<GUID>

Updates the metadata of an item with a given GUID.

Editable attributes: Additional attribute values, category, description, name, offTheShelf, owner, shared,
standardCost, targetCost, targetPrice, uom.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

Update description, owner, and additional attributes

{
"additionalAttributes":[
{
"guid":"YG0J2AJJGXEWFYHY0FSA",
"value":[
"China",
"Latveria",
"USA"
]
},
{
"guid": "I0K3MU330HYGZI1IKZSB",
"value": 1000
}
],
"description":"updated description"
"owner": {
"fullName": "James Deckard"
}
}

Update item number

{
"numberFormat":{
"guid":"DVFY3TUU3AT2L4KLEFBE",
"fields":[
{
"apiName":"DVFY3TUU3AT2L4KLEFBE",
"value":"10-0002-01"
}
]

©2022 Arena, A PTC Business www.arenasolutions.com 141

 Arena REST API Developer Guide Endpoints

}
}

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

{
"additionalAttributes":[
{
"apiName":"N5P8RZ885M3L4N6NS8Z0",
"guid":"N5P8RZ885M3L4N6NS8Z0",
"name":"Material",
"fieldType":"SINGLE_LINE_TEXT",
"value":"silicon - non-exempt"
},
{
"apiName":"ZH1K3BKKHYFXGZIZ31DJ",
"guid":"ZH1K3BKKHYFXGZIZ31DJ",
"name":"Yearly service check",
"fieldType":"DATE",
"value":"2018-12-02T07:59:59Z"
},
{
"apiName":"YG0J2AJJGXEWFYHY0FSA",
"guid":"YG0J2AJJGXEWFYHY0FSA",
"multiSelect":true,
"name":"Affected Countries",
"fieldType":"FIXED_DROP_DOWN",
"value":[
"China",
"Latveria",
"USA"

©2022 Arena, A PTC Business www.arenasolutions.com 142

 Arena REST API Developer Guide Endpoints

]
},
{
"apiName":"I0K3MU330HYGZI1IKZSB",
"guid":"I0K3MU330HYGZI1IKZSB",
"name":"Warn when below",
"fieldType":"NUMBER",
"value":1000
}
],
"category":{
"guid":"P7RAT1AA7O7H0J2J7J83"
},
"creationDateTime":"2011-02-11T16:52:40Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker"
},
"description":"updated description",
"deviated":false,
"effectiveDateTime":null,
"guid":"VDXGZ7GGDUDUDRWY7URV",
"isAssembly":false,
"lifecyclePhase":{
"guid":"BTDWFNWWTASVEXGZIXDY",
"name":"In Design"
},
"modifiedBom":false,
"modifiedFiles":false,
"modifiedSourcing":false,
"modifiedSpecs":true,
"name":"Circuit Board, EveryRoad, Model 500",
"number":"040-0002",
"offTheShelf":false,
"owner":{
"fullName":"James Deckard"
},
"procurementType":"MTS",
"productionCost":null,
"prototypeCost":null,
"revisionNumber":null,
"shared":false,
"standardCost":null,
"status":0,
"supersededDateTime":null,
"targetCost":null,
"targetPrice":null,
"uom":"each",
"url": {
"api": "https://api.arenasolutions.com/v1/items/VDXGZ7GGDUDUDRWY7URV",
"app": "https://app.bom.com/VDXGZ7GGDUDUDRWY7URV"
}

Requests return an error if:

©2022 Arena, A PTC Business www.arenasolutions.com 143

 Arena REST API Developer Guide Endpoints

1. An attribute included in the request is not recognizable.

{
"status":400,
"errors":[
{
"code":4004,
"message":"The attribute \"name1\" is not recognized."
}
]
}

2. The category GUID is not valid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"J1ICM2LVEXGZIR4\" is not valid."
}
]
}

3. An option is not valid value for a fixed (non-user-editable) dropdown list.

{
"status":400,
"errors":[
{
"code":3006,
"message":"The specified value \"ea\" is not a valid option for the
attribute \"uom\"."
}
]
}

4. The value exceeds the maximum length for an attribute.

{
"status":400,
"errors":[
{
"code":3005,
"message":"The specified value \"1.234567891111111E20\" is too big for
the attribute \"productionCost\"."
}
]
}

5. An improper type of value is given to an attribute. For example if a string value is given to a double attribute.

©2022 Arena, A PTC Business www.arenasolutions.com 144

 Arena REST API Developer Guide Endpoints

{
"status":400,
"errors":[
{
"code":400,
"message":"The format of the request is not valid. Please check the syntax."

}
]
}

6. One or more additional attributes are not recognized.

{
"status":400,
"errors":[
{
"code":3004,
"message":"The attribute \"custom1637239\" is not recognized."
}
]
}

7. A number format is invalid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"FXE8IYHQ9SBUDTLK1\" is not valid."
}
]
}

8. A required entry for a valid NumberFormat is not given.

{
"status":400,
"errors":[
{
"code":3009,
"message":"The field \"SM Analog Type Code\" is required for the number
format \"410-SM Analog Voltage Regulator\"."
}
]
}

9. A free text NumberFormat is used, and the given item number exceeds the maximum length.

{
"status":400,

©2022 Arena, A PTC Business www.arenasolutions.com 145

 Arena REST API Developer Guide Endpoints

"errors":[
{
"code":3015,
"message":"The given item number is too long. The max length of the free
text number format \"FreeText\" is \"10\"."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 146

 Arena REST API Developer Guide Endpoints

GET Item Thumbnail Image Content

GET /items/<GUID>/image/content

Returns the Item Thumbnail Image content with a given Item GUID. The Item Thumbnail Image (also known
as the Specs Image) is located within the Specs view of an Item.

Request Header Body

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response. Returns the content of the File as an Input Stream.

An error is returned if:

1. the GUID is not valid.

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}

©2022 Arena, A PTC Business www.arenasolutions.com 147

 Arena REST API Developer Guide Endpoints

]
}

2. An error is thrown by the file server

{
"status": 400,
"errors": [
{
"code": 3017,
"message": "The file with guid \"7P60AQ9P8RAS7F6J\" cannot be downloaded at
this time."
}
]
}

*If the file server is inaccessible, it may return a 400 status with no message.

©2022 Arena, A PTC Business www.arenasolutions.com 148

 Arena REST API Developer Guide Endpoints

POST Item Specs Thumbnail Image Create

POST /items/<GUID>/image

This endpoint uploads an image to the Item's Specs view.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type multipart/form-data

Sample Request Body

File attribute:

content: [physical file]

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
• When uploading a File as an Items Specs Image (also known as a Thumbnail Image):

no JSON response if successful.

An error message is returned if the file is not a valid image file. In the example below, the error message was
encountered after attempting to upload an audio file as a thumbnail.

©2022 Arena, A PTC Business www.arenasolutions.com 149

 Arena REST API Developer Guide Endpoints

{
"status":400,
"errors": [
{
"code": 3094,
"message": "The specified file is not a valid image."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 150

 Arena REST API Developer Guide Endpoints

POST Item Specs Thumbnail Image Create From Files View

POST /items/<GUID>/image

This endpoint uploads an image to the Specs view thumbnail from the Files view of the same Item.

The guid must be an image file on the Files view of the Item.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"guid":"YG0J2F0REH0GZI8FYY2C"
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
If the File from the FIles view is successfully uploaded as the Specs Image this is the response:

{
"guid":"YG0J2F0REH0GZI8FYY2C"
}

©2022 Arena, A PTC Business www.arenasolutions.com 151

 Arena REST API Developer Guide Endpoints

Returns an error if the guid of the File is not associated with the Item..

{
"status":400,
"errors":[
{
"code":3094,
"message":"The file must be associated with the item (supplier item)."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 152

 Arena REST API Developer Guide Endpoints

DELETE Item Thumbnail Image

DELETE /items/<GUID>/image

Deletes the Item Image Thumbnail Image of an Item with a specific GUID. The Item Thumbnail Image is located
in the Specs view of an Item.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response.

Request with bad GUID

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}

©2022 Arena, A PTC Business www.arenasolutions.com 153

 Arena REST API Developer Guide Endpoints

]
}

©2022 Arena, A PTC Business www.arenasolutions.com 154

 Arena REST API Developer Guide Endpoints

DELETE Item
/items/<GUID>

Deletes an item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response

Request with invalid GUID

{
"status":404,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 155

 Arena REST API Developer Guide Endpoints

GET BOM
/items/<GUID>/bom

Returns an array of BOM Line objects, the immediate children of an assembly with a given GUID (with no filters.)

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses Body

Get the BOM of an Item with a specific GUID

/items/ASCVEMVVS9S9S6D0DDZ5/bom

{
"count":40,
"results":[
{
"guid":"P7RAF566FM5CVE8ZLBJ5",
"item":{
"guid":"ASCV0QRR07Q7Q511F8Z3",
"name": "Bezel, Front, EveryRoad",
"number": "432-00001",
"revisionNumber": "C",

©2022 Arena, A PTC Business www.arenasolutions.com 156

 Arena REST API Developer Guide Endpoints

"revisionStatus": "EFFECTIVE",
"url": {
"api": "https://api.arenasolutions.com/v1/items/ASCV0QRR07Q7Q511F8Z3",

"app": "https://app.arenasolutions.com/ASCV0QRR07Q7Q511F8Z3",
},
},
"lineNumber":1,
"notes":null,
"quantity":5,
"refDes":"C15,C6,C10-12"
},
{
"guid":"3L5OTJKKT0JQ9SMDZP5Z",
"item":{
"guid":"Q8SBG677GN6N6LHHVP7Y",
"name": "Bezel, Front, EveryRoad",
"number": "432-00001",
"revisionNumber": "C",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "https://api.arenasolutions.com/v1/items/Q8SBG677GN6N6LHHVP7Y",

"app": "https://app.arenasolutions.com/Q8SBG677GN6N6LHHVP7Y",
},
},
"lineNumber":2,
"notes":null,
"quantity":1,
"refDes":"C3"
},
{
"guid":"4M6PUKLLU1KRATNE0Q4O",
"item":{
"guid":"VDXGLBCCLSBSBQMM0UZ1"
"name": "Side Bezel, Front, EveryRoad",
"number": "432-00005",
"revisionNumber": "C",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "https://api.arenasolutions.com/v1/items/VDXGLBCCLSBSBQMM0UZ1",

"app": "https://app.arenasolutions.com/VDXGLBCCLSBSBQMM0UZ1",
},
},
"lineNumber":3,
"notes":null,
"quantity":3,
"refDes":"C9,C13-14"
},
…
]
}

Request with invalid GUID

©2022 Arena, A PTC Business www.arenasolutions.com 157

 Arena REST API Developer Guide Endpoints

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"ASCVEMVVS9S9S6D0DDZ3\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 158

 Arena REST API Developer Guide Endpoints

GET BOM Line

/items/<GUID>/bom/<GUID>

Returns a BOM Line object with a given GUID, the immediate child of an assembly with a given GUID (with no
filters.)

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/x-www-form-urlencoded

Parameters

Name Value Description

includeEmptyAdditionalAttributes true or false If this is true, the response returns empty
additional attributes. The default is false.
includeBOMSubstitutes true or false if this is true, the response returns BOM
Substitutes

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get BOM line (including empty additional attributes)

/items/ASCVEMVVS9S9S6D0DDZ5/bom/WEYH08HHEVEL4N6F52SC?includeEmptyAdditionalAttributes=true

©2022 Arena, A PTC Business www.arenasolutions.com 159

 Arena REST API Developer Guide Endpoints

{
"additionalAttributes":[
{
"apiName":"custom325",
"fieldType":"SINGLE_LINE_TEXT",
"guid":"4M6P8GPPM3K2L4N6P8I6",
"name":"Bin #",
"value":null
}
],
"guid":"YG0J2AJJGXGN6P8H74SP",
"item":{
"guid":"K2M5OW552J2AT7E1EHJN"
"name": "Bezel, Side, EveryHome",
"number": "248-00001",
"revisionNumber": "C",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "https://api.arenasolutions.com/v1/items/K2M5OW552J2AT7E1EHJN",
"app": "https://app.arenasolutions.com/K2M5OW552J2AT7E1EHJN",
},
},
"lineNumber":null,
"notes":null,
"quantity":1,
"refDes":null
}

Get BOM line (include any BOM Substitutes)

/items/<GUID>/bom/<GUID>?includeBOMSubstitutes=true

{
"guid": "WEG45O7EXG7QK9SD",
"item": {
"guid": "I02QRAT1KZPMDPDW",
"number": "T78-437-99431",
"revisionNumber": "A",
"name": "Capacitor, Tantalum, 10uF@16V, B pkg",
"revisionStatus" : "Working",
"url": {
"api": "https://api.arenasolutions.com/v1/items/I02QRAT1KZPMDPDW",
"app": "https://app.arenasolutions.com/I02QRAT1KZPMDPDW",
},
},
"lineNumber": 8,
"notes": "BOM notes",
"quantity": 1,
"refDes": "J1"
"additionalAttributes": [
{
"apiName": "2KMABUBTCVEXGZIF",
"fieldType": "NUMBER",
"guid": "2KMABUBTCVEXGZIF",
"name": "Classification",

©2022 Arena, A PTC Business www.arenasolutions.com 160

 Arena REST API Developer Guide Endpoints

"value": 1
},
...
],
"substitutes": [ <-- new
{
"guid": "M4O7LIMOZGZ7Q5TUPZDB",
"item": {
"guid": "J1L4IFJLWDW3M5WM1UTZ",
"number": "T78-437-98442",
"revisionNumber": "A",
"name": "Capacitor, Tantalum, 10uF@24V, B pkg",
"revisionStatus" : "EFFECTIVE",
"url": {
"api": "https://api.arenasolutions.com/v1/items/I02QRAT1KZPMDPDW",

"app": "https://app.arenasolutions.com/I02QRAT1KZPMDPDW",
},
}
"notes": "A substitute",
"quantity": 1,
"rank": 2
},
...
]
}

Request with a bad GUID.

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"WEYH08HHEVEL4N6F52Sf\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 161

 Arena REST API Developer Guide Endpoints

GET BOM Settings

/items/<GUID>/bom/settings

Returns BOM Settings for the BOM of an Item with a given GUID. The two settings available for BOMs are:

• automaticallyGenerateLineNumbers (true/false)

• checkReferenceDesignators (true/false)

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get BOM settings

/items/ASCVEMVVS9S9S6D0DDZ5/bom/settings

{
"automaticallyGenerateLineNumbers":true,
"checkReferenceDesignators":true
}

Request with bad GUID

©2022 Arena, A PTC Business www.arenasolutions.com 162

 Arena REST API Developer Guide Endpoints

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"ASCVEMVVS9S9S6D0DDZ51\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 163

 Arena REST API Developer Guide Endpoints

POST BOM Line Create

/items/<GUID>/bom

Creates a new BOM Line for an item with a given GUID. A BOMLine consists of an item and the reference
designator, quantity, and notes that appear on its line in a BOM.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

Add BOM Line

{
"refDes":"R3-R5",
"quantity":3,
"notes":"BOM Notes",
"item":{
"guid":"L3N6PX663K3K3HOBORNT"
}
}

Add BOM Line with Additional Attribute

{
"additionalAttributes":[
{
"guid": "VZJ875P0VFCDDOFMHRMW",
"value": 3001
}
],
"refDes":"R3-R5",
"quantity":3,
"notes":"some notes",
"item":{
"guid":"L3N6PX663K3K3HOBORNT"
}
}

Response Codes

Code Description
201 Success
400 Failure

©2022 Arena, A PTC Business www.arenasolutions.com 164

 Arena REST API Developer Guide Endpoints

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Add BOM line with additional attribute

/items/<GUID>/bom

{
"additionalAttributes":[
{
"value":"3001",
"name":"Stocking Bin",
"apiName":"Stocking Bin",
"type":"NUMBER"
}
],
"guid":"O6Q9E44AD9SZI1U6RIAQ",
"item":{
"guid":"M4O7C228B7Q7Q50Y5C18"
"name": "Resistor, 47 Ohm, 1/10W, 5%, 0603, SMD",
"number": "248-00001",
"revisionNumber": "C",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "https://api.arenasolutions.com/v1/items/M4O7C228B7Q7Q50Y5C18",
"app": "https://app.arenasolutions.com/M4O7C228B7Q7Q50Y5C18", },
},
"lineNumber":1,
"notes":"some notes",
"quantity":3,
"refDes":"R3-R5"
}

An error is returned if:

1. The user does not have access to the Item they are trying to add to a BOM.

{
"status": 400,
"errors": [
{
"code": 3024,

©2022 Arena, A PTC Business www.arenasolutions.com 165

 Arena REST API Developer Guide Endpoints

"message": "Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

2. The BOM is locked to editing by inclusion on a locked Change/locked by a Change Admin.

{
"status": 400,
"errors": [
{
"code": 3034,
"message": "The item is locked."
}
]
}

3. User trying to add superseded revision to BOM (only effective revision can be added)

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"ASCVEMVVS9S9S6D0DDZ51\" is not valid."
}
]
}

4. A reference designator is incorrectly formatted.

{
"status": 400,
"errors": [
{
"code": 3036,
"message": "Invalid BOM Line: Invalid reference descriptor: c."
}
]
}

5. A reference designator range is incorrectly formatted.

{
"status": 400,
"errors": [
{
"code": 3036,
"message": "Invalid BOM Line: Invalid reference designator range: c3-c1."
}
]
}

6. A reference designator is a duplicate (and reference designator checking is enabled in the workspace)

©2022 Arena, A PTC Business www.arenasolutions.com 166

 Arena REST API Developer Guide Endpoints

{
"status": 400,
"errors": [
{
"code": 3036,
"message": "Invalid BOM Line: Duplicated reference designators: [c3]."
}
]
}

7. Quantity does not match number of reference designators (and reference designator checking is enabled
in the workspace)

{
"status": 400,
"errors": [
{
"code": 3036,
"message": "Invalid BOM Line: Quantity (2.0) doesn't match number of reference
designators."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 167

 Arena REST API Developer Guide Endpoints

PUT BOM Line Update

/items/<GUID>/bom/<GUID>

Updates an existing BOM Line with a given GUID for an item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"refDes":"u1",
"quantity":1,
"notes":"New chip"
}

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Update a BOM line

/items/<GUID>/bom/<GUID>

{
"additionalAttributes":[

©2022 Arena, A PTC Business www.arenasolutions.com 168

 Arena REST API Developer Guide Endpoints

{
"value":3,
"name":"Pins",
"apiName":"custom329",
"type":"NUMBER"
}
],
"guid":"O6Q9E44AD9SZI1U6RIAQ",
"item":{
"guid":"M4O7C228B7Q7Q50Y5C18"
"name": "Resistor, 47 Ohm, 1/10W, 5%, 0603, SMD",
"number": "248-00001",
"revisionNumber": "C",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "https://api.arenasolutions.com/v1/items/M4O7C228B7Q7Q50Y5C18",
"app": "https://app.arenasolutions.com/M4O7C228B7Q7Q50Y5C18", },
},
"lineNumber":1,
"notes":"New chip",
"quantity":1,
"refDes":"u1"
}

An error is returned if:

1. The user does not have access to the Item they are trying to add to a BOM.

{
"status": 400,
"errors": [
{
"code": 3024,
"message": "Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

2. The BOM is locked to editing by inclusion on a locked Change/locked by a Change Admin.

{
"status": 400,
"errors": [
{
"code": 3034,
"message": "The item is locked."
}
]
}

3. A reference designator is incorrectly formatted.

{
"status": 400,
"errors": [

©2022 Arena, A PTC Business www.arenasolutions.com 169

 Arena REST API Developer Guide Endpoints

{
"code": 3036,
"message": "Invalid BOM Line: Invalid reference descriptor: c."
}
]
}

4. A reference designator range is incorrectly formatted.

{
"status": 400,
"errors": [
{
"code": 3036,
"message": "Invalid BOM Line: Invalid reference designator range: c3-c1."
}
]
}

5. A reference designator is a duplicate (and reference designator checking is enabled in the workspace)

{
"status": 400,
"errors": [
{
"code": 3036,
"message": "Invalid BOM Line: Duplicated reference designators: [c3]."
}
]
}

6. Quantity does not match number of reference designators (and reference designator checking is enabled
in the workspace)

{
"status": 400,
"errors": [
{
"code": 3036,
"message": "Invalid BOM Line: Quantity (2.0) doesn't match number of reference
designators."
}
]
}

7. The BOM line does not exist.

{
"status": 400,
"errors": [
{
"code": 3024,
"message": "Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 170

 Arena REST API Developer Guide Endpoints

PUT BOM Settings Update

/items/<GUID>/bom/settings

Updates BOM Settings for the BOM of an Item with a given GUID. The two settings available for BOMs are:

• automaticallyGenerateLineNumbers

• checkReferenceDesignators

You can edit one or both settings with the same request.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

/items/ASCVEMVVS9S9S6D0DDZ5/bom/settings

{
"automaticallyGenerateLineNumbers":false
}

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 171

 Arena REST API Developer Guide Endpoints

Sample Response Body

Update BOM settings

/items/ASCVEMVVS9S9S6D0DDZ5/bom/settings

{
" automaticallyGenerateLineNumbers ":false,
" checkReferenceDesignators ":true
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"CUB5FVEN6P8RAQI\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 172

 Arena REST API Developer Guide Endpoints

DELETE BOM Line

/items/<GUID>/bom/<GUID>

Deletes a BOM Line with a given GUID from an Item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response.

An error is returned if:

1. The user does not have access to the Item they are trying to add to a BOM.

{
"status": 400,
"errors": [
{
"code": 3024,
"message": "Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 173

 Arena REST API Developer Guide Endpoints

2. The BOM is locked to editing by inclusion on a locked Change/locked by a Change Admin.

{
"status": 400,
"errors": [
{
"code": 3034,
"message": "The item is locked."
}
]
}

3. The BOM Line does not exist.

{
"status": 400,
"errors": [
{
"code": 3024,
"message": "Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 174

 Arena REST API Developer Guide Endpoints

GET BOM Subsitutes

/items/<GUID>/bom/<GUID>/substitutes

Returns a BOM Substitute object with a given GUID, the immediate child of an assembly with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/x-www-form-urlencoded

Parameters

Name Value Description

includeEmptyAdditionalAttributes true or false If this is true, the response returns empty
additional attributes. The default is false.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all the BOM Substitutes in within a BOM Line

/items/<GUID>/bom/<GUID>/substitutes

{
"count": 2,
"results": [

©2022 Arena, A PTC Business www.arenasolutions.com 175

 Arena REST API Developer Guide Endpoints

{
"guid": "2K4N6J4VIL3L4N09ONJK",
"item": {
"guid": "2K4N6J4VIL4CVA8EYV18",
"name": "Voltage Regulator, Low-dropout, 5.0V, 90µA",
"number": "160-00007",
"revisionNumber": "1",
"revisionStatus": "EFFECTIVE"
},
"notes": "This regulator is more costly but has a better dropout.",
"quantity": 1,
"rank": 1
},
{
"guid": "7P9SBO90NQ8Q9S5ETQ3G",
"item": {
"guid": "7P9SBO90NQ9H0ISBNH69",
"name": "Voltage Regulator, Low-dropout, 5.0V, 100mA",
"number": "160-00004",
"revisionNumber": "01",
"revisionStatus": "EFFECTIVE"
},
"notes": null,
"quantity": 1,
"rank": 2
}
]
}

Request with a bad GUID.

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"WEYH08HHEVEL4N6F52Sf\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 176

 Arena REST API Developer Guide Endpoints

GET BOM Subsitute

/items/<GUID>/bom/<GUID>/substitutes/<GUID>

Returns a BOM Substitute object with a given GUID, the immediate child of an assembly with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/x-www-form-urlencoded

Name Value Description

includeEmptyAdditionalAttributes true or false If this is true, the response returns empty
additional attributes. The default is false.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all the BOM Substitutes in within a BOM Line.

/items/<GUID>/bom/<GUID>/substitutes/<GUID>

{
"guid": "2K4N6J4VIL3L4N09ONJK",
"item": {
"guid": "2K4N6J4VIL4CVA8EYV18",
"name": "Voltage Regulator, Low-dropout, 5.0V, 90µA",

©2022 Arena, A PTC Business www.arenasolutions.com 177

 Arena REST API Developer Guide Endpoints

"number": "160-00007",
"revisionNumber": "1",
"revisionStatus": "EFFECTIVE"
},
"notes": "This regulator is more costly but has a better dropout.",
"quantity": 1,
"rank": 1
}

Request with a bad GUID.

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"WEYH08HHEVEL4N6F52Sf\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 178

 Arena REST API Developer Guide Endpoints

POST BOM Substitute Create

/items/<GUID>/bom/<GUID>/substitutes

Creates a new BOM Substitute for an item with a given GUID. Only the working reivision of the parent Item
can be modified with BOM Substitutes. Items must be released to be specified as a subtitute. BOM Substitutes
can be superseded revisions of the child Item. Existing BOM Substitutes can not be added again to the same
BOM Line.

Rank is a positive integeter between one and the total number of substitutes. If the user specifies a rank that
already exists, the new BOM Substitute will be assigned that rank and the ranks of all other substitutes that
have a higher rank value (including the BOM Substitute that previously had the specified rank value) will be
incremented by one. If rank is not specified in the POST, it is set to the last rank.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

Add BOM Substitute

{
"quantity": 1,
"rank": 1,
"notes": "Only when primary supply is exhausted",
"item":{
"guid":"DVFYHUF6TWFN6K28U3ZP"
}
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions

©2022 Arena, A PTC Business www.arenasolutions.com 179

 Arena REST API Developer Guide Endpoints

Name Value Description

X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Add BOM Substitute

/items/<GUID>/bom/<GUID>/substitutes

{
"guid": "L3N6P2NE14M4N6JQ5ORH",
"item": {
"guid": "DVFYHUF6TWFN6K28U3ZP",
"name": "Voltage Regulator, Low-dropout, 5.0V, 90µA",
"number": "160-00009",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE"
},
"notes": "Only when primary supply is exhausted",
"quantity": 1,
"rank": 1
}

Attempting to add BOM Substitute to locked BOM

{
"status": 400,
"errors": [
{
"code": 3034,
"message": "The item is locked."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 180

 Arena REST API Developer Guide Endpoints

PUT BOM Substitute Create

/items/<GUID>/bom/<GUID>/substitutes/<GUID>

Edits an existing BOM Substitute for an item with a given GUID. Only the working reivision of the parent Item
can be modified with BOM Substitutes. Items must be released to be specified as a subtitute. BOM Substitutes
can be superseded revisions of the child Item. Existing BOM Substitutes can not be added again to the same
BOM Line.

Rank is a positive integeter between one and the total number of substitutes. If the user specifies a rank that
already exists, the new BOM Substitute will be assigned that rank and the ranks of all other substitutes that
have a higher rank value (including the BOM Substitute that previously had the specified rank value) will be
incremented by one. If rank is not specified in the POST, it is set to the last rank.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

Edit an existing BOM Substitute

{
"notes":"Only use when all vendors are out of stock",
"rank":2
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 181

 Arena REST API Developer Guide Endpoints

Sample Response Body

Edit BOM Substitute

/items/<GUID>/bom/<GUID>/substitutes/<GUID>

{
"guid": "L3N6P2NE14M4N6JQ5ORH",
"item": {
"guid": "DVFYHUF6TWFN6K28U3ZP",
"name": "Voltage Regulator, Low-dropout, 5.0V, 90µA",
"number": "160-00009",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE"
},
"notes": null,
"quantity": 1,
"rank": 3
}

Attempting to edit a BOM Substitute to locked BOM

{
"status": 400,
"errors": [
{
"code": 3034,
"message": "The item is locked."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 182

 Arena REST API Developer Guide Endpoints

DELETE BOM Substitute

/items/<GUID>/bom/<GUID>/substitutes/<GUID>

Deletes a BOM Substitute with a BOM Line.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response.

Request with invalid GUID

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 183

 Arena REST API Developer Guide Endpoints

GET Item Compliance Requirements

/items/<GUID>/compliance

Returns all Compliance Requirement objects for an item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all Compliance Requirements applied to an item

GET /items/GUID/compliance

{
"count":2,
"results":[
{
"evidenceType":"AML_AND_FILES",
"guid":"9RBUZPQQZ6OO7QV0DS6B",
"lastModifiedBy":{
"email":"[email protected]",
"fullName":"John Parker"
},

©2022 Arena, A PTC Business www.arenasolutions.com 184

 Arena REST API Developer Guide Endpoints

"lastModifiedDateTime":"2016-09-23T18:12:12Z",
"mark":"RoHS stamp",
"propagated":false,
"rationale":"All off-the-shelf manufacturer parts qualified under this Item
Number have been verified to meet the RoHS requirement.",
"requirement":{
"guid":"5N7QVLMMV2KK3M4ZHAO8",
"name":"2011/65/EU RoHS"
},
"status":"COMPLIANT"
},
{
"evidenceType":"DIRECT_FILES",
"guid":"9RBUZPQQZ6OO7QV0DS6B",
"lastModifiedBy":{
"email":"[email protected]",
"fullName":"Heidi Walker"
},
"lastModifiedDateTime":"2016-09-23T18:12:12Z",
"mark":"none",
"propagated":false,
"rationale":"First article verified by Everyroad",
"requirement":{
"guid":"5N7QVLMMV2KK3M4ZHAO8",
"name":"First Article Inspection"
},
"status":"COMPLIANT"
}
]
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 185

 Arena REST API Developer Guide Endpoints

GET Item Compliance Requirement

GET /items/<GUID>/compliance/<GUID>

Returns a Compliance Requirement object with a given GUID for an item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a single item compliance requirement

GET /items/<GUID>/compliance/<GUID>

{
"evidenceType":"AML_AND_FILES",
"guid":"9RBUZPQQZ6OO7QV0DS6B",
"lastModifiedBy":{
"email":"[email protected]",
"fullName":"John Parker"
},
"lastModifiedDateTime":"2016-09-23T18:12:12Z",
"mark":"RoHS stamp",
"propagated":false,

©2022 Arena, A PTC Business www.arenasolutions.com 186

 Arena REST API Developer Guide Endpoints

"rationale":"All off-the-shelf manufacturer parts qualified under this Item Number

have been verified to meet the RoHS requirement.",
"requirement":{
"guid":"5N7QVLMMV2KK3M4ZHAO8",
"name":"2011/65/EU RoHS"
},
"status":"COMPLIANT"
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 187

 Arena REST API Developer Guide Endpoints

PUT Item Compliance Update

PUT /items/<GUID>/compliance/<GUID>

Updates a Compliance Requirement object with a given GUID for an item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"mark":"blue checkmark on packaging",
"rationale":"evidence provided by files attached to item",
"evidenceType":"DIRECT_FILES",
"status":"UNKNOWN"
}

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Update a compliance requirement for an Item

PUT /items/<GUID>/compliance/<GUID>

©2022 Arena, A PTC Business www.arenasolutions.com 188

 Arena REST API Developer Guide Endpoints

{
"evidenceType":"DIRECT_FILES",
"guid":"6O8RAIPBRZHH0J2J0ZY0",
"lastModifiedBy":{
"fullName":"Heidi Walker"
},
"lastModifiedDateTime":"2015-08-01T00:47:41Z",
"mark":"blue checkmark on packaging",
"propagated":true,
"rationale":"evidence provided by files attached to item",
"requirement":{
"guid":"3L5O7FM8OWEEXGZHNPBN",
"name":"2011/65/EU RoHS"
},
"status":"UNKNOWN"
}

Request with invalid evidence type or status

{
"status":400,
"errors":[
{
"code":3082,
"message":"Invalid evidence type."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 189

 Arena REST API Developer Guide Endpoints

GET Item File Associations

/items/<GUID>/files

Returns a collection of File objects belonging to an item with a given GUID. To return a specific File association
for an Item, append the GUID of the association.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

GET all files associated with an item

GET /items/VDXGZ7GGDUDUDRYLY132/files

{
"count":4,
"results":[
{
"file":{
"author":{
"fullName":"George Lewis"
},
"category":{

©2022 Arena, A PTC Business www.arenasolutions.com 190

 Arena REST API Developer Guide Endpoints

"guid":"Q5O7QY5R7FY8RATAYXNX",
"name":"Design Drawing",
"path":"File\\Engineering\\Schematic"
},
"checkedOut": false,
"corrected": false,
"creationDateTime":"2011-06-02T19:30:28Z",
"description":"OrCAD native design file.",
"edition":"1",
"format":"DSN",
"guid":"N5P8D344DK3J2LC3T0OM",
"hasMarkup":false,
"lastModifiedDateTime":"2011-06-02T19:30:28Z",
"latest":true,
"location":null,
"locked":true,
"mimeType":"application/octet-stream",
"name":"OrcadCapture.DSN",
"number":"FILE-000825",
"private":false,
"size":463360,
"storageMethod":0,
"storageMethodName":"FILE",
"title":"OrCAD Schematic File"
},
"guid":"N5O7Q9SYH0W6I7OW",
"latestEditionAssociation":true,
"primary":false
},
...
]
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 191

 Arena REST API Developer Guide Endpoints

GET Item File Association

/items/<GUID>/files/<GUID>

Returns a File Association object with a given GUID belonging to an item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

GET a specific file associated with an item

GET /items/VDXGZ7GGDUDUDRYLY132/files/3L5O7FOOL2LXGZIY5X2M

{
"file":{
"author":{
"fullName":"George C Lewis"
},
"category":{
"guid":"Z9O7QY5R7FY8RATAYWBF",
"name":"Design Drawing",
"path":"File\\Engineering\\Model File"
},

©2022 Arena, A PTC Business www.arenasolutions.com 192

 Arena REST API Developer Guide Endpoints

"checkedOut": false,
"creationDateTime":"2011-02-11T17:54:40Z",
"description":null,
"edition":"1",
"format":"pdf",
"guid":"VDXGZ7GGDUDTCVENSKLI",
"hasMarkup":false,
"lastModifiedDateTime":"2011-02-12T01:54:40Z",
"latest":true,
"location":null,
"locked":true,
"mimeType":"application/pdf",
"name":"EveryRoad PCBA Model 500.pdf",
"number":"FILE-000059",
"private":false,
"size":416233,
"smartLink":"https://files.sand.bom.com:8041/p/ Q7Q6-P8RA-QO30-O53P-SCDY-CYF3",

"storageMethod":0,
"storageMethodName":"FILE",
"title":"EveryRoad PCBA Model 500"
},
"guid":"3L5O7FOOL2LXGZIY5X2M",
"latestEditionAssociation":true,
"primary":true
}

Produces an error if the GUID is not valid.

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 193

 Arena REST API Developer Guide Endpoints

GET Item File Content

/items/<GUID>/files/<GUID>/content

Returns file content belonging to a file with a given GUID, which is associated with an item with a given GUID.

Request Header Body

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response. Returns the content of the File as an Input Stream.

An error is returned if:

1. the GUID is not valid.

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 194

 Arena REST API Developer Guide Endpoints

2. An error is thrown by the file server

{
"status": 400,
"errors": [
{
"code": 3017,
"message": "The file with guid \"7P60AQ9P8RAS7F6J\" cannot be downloaded at
this time."
}
]
}

*If the file server is inaccessible, it may return a 400 status with no message.

©2022 Arena, A PTC Business www.arenasolutions.com 195

 Arena REST API Developer Guide Endpoints

POST Item File Create

/items/<GUID>/files

Creates a new File Association object and associates it with an item with a given GUID.

If you wish to create a File record with no uploaded content, construct a JSON request with a
storageMethodName of PLACE_HOLDER, FTP, or WEB. When the storageMethodName is FTP or WEB, the
location attribute should be the web or ftp address where the file resides.

If you wish to create a File record and upload file content to the Arena servers, construct a request that is
content type multipart/form-data and has a storageMethodName of FILE.

For File editions with storageMethodName FILE, the location attribute should be null.

NOTES:

1. Only Item files are supported for this endpoint. Files associated with sourced Supplier Items use
/supplieritems/<GUID>/files.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type multipart/form-data

Sample Request Body

• Creating a File and uploading content to Arena servers (text format):

Text attributes:

file.author.fullName: Heidi Walker

file.category.guid: WEYHMCDDMTCM5O08WPWY
file.description: Assembly Instructions
file.edition: 1
file.format: txt
file.private:false
file.storageMethodName: FILE
file.title: Assembly Instructions for 324-0263
latestEditionAssociation:true
primary:true

File attribute:

content: [physical file]

• Creating a File with no uploaded content (Web or FTP location/Placeholder):

{
"file": {
"location": "www.everyroadgps.com/files/300-traces.pdf",
"category": {

©2022 Arena, A PTC Business www.arenasolutions.com 196

 Arena REST API Developer Guide Endpoints

"guid ": "ZH0J2L4EXGS0NF91"

},
"storageMethodName": "WEB",
"title": "traces for Everyroad 300 board",
"edition": "1",
"author": {
"fullName": "Heidi Walker"
},
"format": "pdf"
}
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-ItemFileAssociation-Guid GUID string GUID for new file association - only when
including content
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
• When creating a File object with uploaded content:

No JSON Response. Please refer to the response header for file information.

• When creating a file with no uploaded content:

{
"file":{
"author":{
"fullName":"Heidi Walker"
},
"category":{
"guid":"ZH0J2L4EXGS0NF91"
},
"creationDateTime":"2014-02-24T22:41:19Z",

©2022 Arena, A PTC Business www.arenasolutions.com 197

 Arena REST API Developer Guide Endpoints

"description":null,
"edition":"1",
"format":"url",
"guid":"GYI16WW251K0J2TITQ1O",
"hasMarkup":false,
"lastModifiedDateTime":"2014-02-24T22:41:19Z",
"latest":true,
"location":"http://www.everyroadgps.com",
"locked":false,
"mimeType":null,
"name":"300-traces.pdf",
"number":"FILE-000005",
"private":false,
"size":null,
"storageMethod":3,
"storageMethodName":"WEB",
"title":"traces for everyroad 300 board"
},
"guid":"ASBUDWFRATPYJAGV",
"latestEditionAssociation":true,
"primary":false
}

An error is returned if:

1. The GUID is not valid.

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

2. a required metadata attribute is missing.

{
"status": 400,
"errors": [
{
"code": 3001,
"message": "The attribute \"file.edition\" is required."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 198

 Arena REST API Developer Guide Endpoints

POST Item File Add Existing

/items/<GUID>/files

Associates an existing File Association object with an item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Sample Request Body

{
"latestEditionAssociation":true,
"primary":false,
"file":{
"guid":" GYI16WXX6DVYH0J2LEV8"
}
}

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Associate an existing file with an item

/items/<GUID>/files

©2022 Arena, A PTC Business www.arenasolutions.com 199

 Arena REST API Developer Guide Endpoints

{
"file":{
"author":{
"fullName":"George Lewis"
},
"category":{
"guid":"K2L4N6PZI1DL92AR"
},
"creationDateTime":"2011-06-02T19:30:28Z",
"description":"OrCAD native design file.",
"edition":"1",
"format":"DSN",
"guid":"N5P8D344DK3J2LC3T0OM",
"hasMarkup":false,
"lastModifiedDateTime":"2011-06-02T19:30:28Z",
"latest":true,
"location":null,
"locked":false,
"mimeType":"application/octet-stream",
"name":"OrcadCapture.DSN",
"number":"FILE-000825",
"private":false,
"size":463360,
"storageMethod":0,
"storageMethodName":"FILE",
"title":"OrCAD Schematic File"
},
"guid":"N5O7Q9SYH0W6I7OW",
"latestEditionAssociation":true,
"primary":false
}

An error is returned if:

1. The GUID is not valid.

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

2. a required metadata attribute is missing.

{
"status": 400,
"errors": [
{
"code": 3001,
"message": "The attribute \"edition\" is required."
}

©2022 Arena, A PTC Business www.arenasolutions.com 200

 Arena REST API Developer Guide Endpoints

]
}

©2022 Arena, A PTC Business www.arenasolutions.com 201

 Arena REST API Developer Guide Endpoints

POST Item File Content Update

/items/<GUID>/files/<GUID>/content

Updates file content for an existing File with a given GUID associated with an item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login

Sample Request Body

File attribute:

content: [physical file]

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
no JSON response

An error is returned if:

1. The GUID is not valid.

{
"status": 400,
"errors": [
{

©2022 Arena, A PTC Business www.arenasolutions.com 202

 Arena REST API Developer Guide Endpoints

"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

2. a required metadata attribute is missing.

{
"status": 400,
"errors": [
{
"code": 3001,
"message": "The attribute \"edition\" is required."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 203

 Arena REST API Developer Guide Endpoints

POST File Update

/files/<GUID>

Updates an existing File with storageMethodName FTP, WEB, or PLACE_HOLDER to FILE .

To update an existing File with a storageMethodName of FILE to FTP, WEB, or PLACE_HOLDER please refer to
the PUT File Summary Update endpoint.

Construct a request with content-type "multipart/form-data" (in the header of the request) and file content.

Currently, only Files less than 2GB can be uploaded through this endpoint.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login

Sample Request Body

Starting with an existing File with a storageMethodName of FTP, WEB, or PLACE_HOLDER:

author.fullName: George Lewis

category.guid: 7P9S6379K1KUDWCUEIJG
description: Schematic Drawing
edition: 1
format: pdf
private: false
storageMethodName: FILE
title: Drawing for Model 3000
content: <file stream>

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions

©2022 Arena, A PTC Business www.arenasolutions.com 204

 Arena REST API Developer Guide Endpoints

Name Value Description

X-Arena-File-GUID GUID string GUID for new file - only when including
content.
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
no JSON response

An error is returned if:

1. the GUID is not valid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

2. A required metadata attribute is missing.

{
"status":400,
"errors":[
{
"code":3001,
"message":"The attribute \"edition\" is required."
}
]
}

3. Returns an error if File size is 2GB or higher.

{
"status":400,
"errors":[
{
"code":3033,
"message":"The file content is missing."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 205

 Arena REST API Developer Guide Endpoints

PUT Item File Association Update

/items/<GUID>/files/<GUID>

Updates the details of an existing File association with a given GUID.

This endpoint can only be used to update whether the latest edition of the File should be associated to the
Item (latestEditionAssociation) or whether the associated File should be the primary File in the relationship
(primary). For updating File Summary information, use File endpoints such as PUT File Summary Update, POST
File Edition, POST File Correct, etc.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"latestEditionAssociation":true,
"primary":false
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Update the details of a file associated with an item

©2022 Arena, A PTC Business www.arenasolutions.com 206

 Arena REST API Developer Guide Endpoints

/items/<GUID>/files/<GUID>

{
"file":{
"author":{
"fullName":"John Parker"
},
"category":{
"guid":"9RBUZPQQZ6PZI1DL92A2"
},
"creationDateTime":"2011-06-02T19:30:28Z",
"description":"OrCAD native design file.",
"edition":"1",
"format":"DSN",
"guid":"N5P8D344DK3J2LC3T0OM",
"hasMarkup":false,
"lastModifiedDateTime":"2011-06-02T19:30:28Z",
"latest":true,
"location":null,
"locked":true,
"mimeType":"application/octet-stream",
"name":"OrcadCapture.DSN",
"number":"FILE-000825",
"private":false,
"size":463360,
"storageMethod":0,
"storageMethodName":"FILE",
"title":"OrCAD Schematic File"
},
"guid":"J1L49Z009GZBUD95YPP0",
"latestEditionAssociation":true,
"primary":false
}

Returns an error if the GUID is not valid.

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 207

 Arena REST API Developer Guide Endpoints

DELETE Item File Association

/items/<GUID>/files/<GUID>

Removes a File association from an Item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response.

Produces an error if the requested file association does not exist.

{
"status": 400,
"errors": [
{
"code": 3029,
"message": "The file association does not exist between object
\"Q8SBG6CHGDWDWB7W8EJG\" and object \"EWGZ4U0541K0J2TJSQGG\"."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 208

 Arena REST API Developer Guide Endpoints

POST Item Lifecycle Phase Change

/items/lifecyclephasechanges

Releases a new revision of an item with a given GUID to a target lifecycle phase specified within the request.
Returns revision GUIDs for effective, superseded, and working revisions of the item.

The following phase transitions are allowed:

1. Release to Design (move an unreleased Item to a Design stage lifecycle phase.)

2. Make Effective in Design (make working modifications effective in a new revision while remaining in the
same Design phase.)

3. Release to Production (move a Design stage Item to a Production stage lifecycle phase.)

4. Make Effective in Production (make working modifications effective in a new revision while remaining in
the same Production phase.)

Of these phase transitions, Release to Design, Make Effective in Design, and Make Effective in Production
require the working revision of the item because these endpoints operate on the working revision. Release to
Production requires that the item GUID be the effective revision. The target lifecycle phase can be any defined
for the workspace, including custom phases.

Note: This API request can generate errors, warnings, and notices. The request will fail if there is at least one error or
warning. If the value for “proceedOnNotice” is True, the request will continue if it generates notices.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"item":{
"guid":"Q8SBG677GN6N6LE4IPZ2"
},
"proceedOnNotice":true,
"toLifecyclePhase":{
"guid":"K2M5AO11AHZ2L4N6PIZ6"
},
"notes":"Ready for release",
"revisionNumber":"3"
}

©2022 Arena, A PTC Business www.arenasolutions.com 209

 Arena REST API Developer Guide Endpoints

Optional Fields

Name Value Description

proceedOnNotice true or false This field, when set to true, forces the
operation to continue even if there are
errors.
notes string This field enters a comment in the item
record
revisionNumber string This field specifies a target revision number
for the transition. If this field is not included,
and a revision sequence is defined for the
target lifecycle stage (and if the current
revision number appears in that sequence)
the next revision in the sequence will be
selected.)

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
{
"effectiveRevItem": {
"guid":"M4O7QY5R7FYFYCHZ27X0",
"url": {
"api": "https://api.arenasolutions.com/v1/items/M4O7QY5R7FYFYCHZ27X0",
"app": "https://app.arenasolutions.com/M4O7QY5R7FYFYCHZ27X0" }
},
"supersededRevItem": {
"guid":"CUEXGOVHX5O5O27PSXND",
"url": {

©2022 Arena, A PTC Business www.arenasolutions.com 210

 Arena REST API Developer Guide Endpoints

"api": "https://api.arenasolutions.com/v1/items/CUEXGOVHX5O5O27PSXND",
"app": "https://app.arenasolutions.com/CUEXGOVHX5O5O27PSXND" }
},
"workingRevItem": {
"guid":"WEYH08F1HP8P8MR9CH77",
"url": {
"api": "https://api.arenasolutions.com/v1/items/M4O7QY5R7FYFYCHZ27X0",
"app": "https://app.arenasolutions.com/M4O7QY5R7FYFYCHZ27X0" }
}
}

Returns an error if the item GUID is not valid

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 211

 Arena REST API Developer Guide Endpoints

GET Item Quality Processes

GET /items/<GUID>/quality

GET /items/<GUID>/quality/<GUID>

Returns a collection of Quality Process objects for an item with a given GUID (all Quality Processes in which
the Item is an affected object). If the endpoint is apprended with a valid GUID, it returns a specific Quality
Process and the step information where a specific Item has been added as an affected object.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get all quality processes that include a given item

GET /items/0I2LQGHHQXGXGVRR5XND/quality

{
"count":1,
"results":[
{
"guid":"L3N6B0HVI1IYH0J2B57U",
"notes":"This is the related Quality process",

©2022 Arena, A PTC Business www.arenasolutions.com 212

 Arena REST API Developer Guide Endpoints

"qualityProcess":{
"creationDateTime":null,
"guid":"SAUDI7O2P8RN6P8R57B7",
"name":"Quality Issue on 500 board",
"number":"8D-000002",
"step":{
"guid":"TBVEJ8P3Q9SO7Q9S68C4",
"name":"Form Team"
},
"type":"8D"
}
}
]
}

Return a specific Quality Process and specific step where a specific Item has been added as an affected object.

GET /items/<GUID>/quality/<GUID>

{
"guid": "XFZI1EZQDGY9SBUCQ8JJ",
"notes": null,
"qualityProcess": {
"guid": "M4O7Q3OF25OK3M5OHUQ2",
"name": "Manufacturing flaws on 175-00001 boards",
"number": "CAR-000007",
"step": {
"guid": "N5P8R4PG36PL4N6PIVRR",
"name": "Problem Description"
},
"type": null
}
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 213

 Arena REST API Developer Guide Endpoints

GET Item Revisions

GET /items/<GUID>/revisions

Returns all Item Revision objects for an item with a given GUID. The revision type is specified by the value of
the "status" attribute. 0 is working revision, 1 is effective revision, 2 is past revisions.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get all revisions for an item

GET /items/Q8SBU2BB8P8P8MTGTTHH/revisions

{
"count":4,
"results":[
{
"change":{
"creationDateTime":"2011-02-16T01:15:39Z",
"deviated":false,
"guid":null
},

©2022 Arena, A PTC Business www.arenasolutions.com 214

 Arena REST API Developer Guide Endpoints

"guid":"ASCVEMVVS9S9S6D0DDX3",
"lifecyclePhase":{
"guid":"ASCVEMVVS9RUDWFYHWC3",
"name":"In Production"
},
"notes":null,
"number":null,
"status":0,
"supersededDateTime":null,
"url": {
"api": "https://api.arenasolutions.com/v1/items/ASCVEMVVS9S9S6D0DDX3",
"app": "https://app.bom.com/ASCVEMVVS9S9S6D0DDX3"
},
{
"change":{
"creationDateTime":"2011-02-16T00:12:28Z",
"deviated":false,
"effectiveDateTime":"2011-02-16T01:15:39Z",
"guid":null,
"number":"ECO-000006"
},
"guid":"Q8SBU2BB8P8P8MTGTTHH",
"lifecyclePhase":{
"guid":"ASCVEMVVS9RUDWFYHWC3",
"name":"In Production"
},
"notes":null,
"number":"B",
"status":1,
"supersededDateTime":null,
"url": {
"api": "https://api.arenasolutions.com/v1/items/Q8SBU2BB8P8P8MTGTTHH",
"app": "https://app.bom.com/Q8SBU2BB8P8P8MTGTTHH"
},
{
"change":{
"creationDateTime":"2011-02-14T23:13:50Z",
"deviated":false,
"effectiveDateTime":"2011-02-16T00:12:28Z",
"guid":null,
"number":"ECO-000003"
},
"guid":"5N7Q9HQQN4N4N18V8836",
"lifecyclePhase":{
"guid":"ASCVEMVVS9RUDWFYHWC3",
"name":"In Production"
},
"notes":null,
"number":"A",
"status":2,
"supersededDateTime":"2011-02-16T01:15:39Z",
"url": {
"api": "https://api.arenasolutions.com/v1/items/5N7Q9HQQN4N4N18V8836",
"app": "https://app.bom.com/5N7Q9HQQN4N4N18V8836"
},

©2022 Arena, A PTC Business www.arenasolutions.com 215

 Arena REST API Developer Guide Endpoints

{
"change":{
"creationDateTime":"2011-02-11T16:52:39Z",
"deviated":false,
"effectiveDateTime":"2011-02-14T23:13:50Z",
"guid":null
},
"guid":"BTDWFNWWTATAT7E1EHR7",
"lifecyclePhase":{
"guid":"ASCVEMVVS9RUDWFYHWC3",
"name":"In Production"
},
"notes":null,
"number":"1",
"status":2,
"supersededDateTime":"2011-02-16T00:12:28Z",
"url": {
"api": "https://api.arenasolutions.com/v1/items/BTDWFNWWTATAT7E1EHR7",
"app": "https://app.bom.com/BTDWFNWWTATAT7E1EHR7"
}
]
}

Produces an error if the GUID is not valid.

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 216

 Arena REST API Developer Guide Endpoints

GET Item Future Changes

/items/<GUID>/futurechanges

/items/<GUID>/futurechanges/<GUID>

Returns the future changes of an Item object. These are Changes that may affect the Item in the future.
Appending a GUID to the URL returns the future change with that GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all the future changes associated with an Item of a given GUID.

GET /items/<GUID>/futurechanges

{
"count": 4,
"results": [
{
"change": {
"creationDateTime": "2021-09-07T19:02:13Z",
"effectivityType": "PERMANENT_ON_APPROVAL",

©2022 Arena, A PTC Business www.arenasolutions.com 217

 Arena REST API Developer Guide Endpoints

"guid": "I0K3MZKBY1KN6O446611",
"number": "ECO-000024",
"title": "BOM Mods"
},
"guid": "ZH1K3G1SFI04N6T4J21G"
},
{
"change": {
"creationDateTime": "2021-09-07T19:04:03Z",
"effectivityType": "PERMANENT_ON_APPROVAL",
"guid": "K2M5O1MD03MP8Q66883X",
"number": "ECO-000026",
"title": "Files View"
},
"guid": "1J3M5I3UHK26P8V6L43J"
},
{
"change": {
"creationDateTime": "2021-09-07T19:01:18Z",
"effectivityType": "PERMANENT_ON_APPROVAL",
"guid": "HZJ2LYJAX0JM5N33550D",
"number": "ECO-000023",
"title": "PCB Specs View"
},
"guid": "YG0J2F0REHZ3M5S3I10S"
},
{
"change": {
"creationDateTime": "2021-09-07T19:03:00Z",
"effectivityType": "PERMANENT_ON_APPROVAL",
"guid": "J1L4N0LCZ2LO7P55772G",
"number": "ECO-000025",
"title": "Files View"
},
"guid": "0I2L4H2TGJ15O7U5K32Z"
}
]
}

Get a single future change with a specific GUID associated with an Item with a specific GUID.

GET /items/<GUID>/futurechanges/<GUID>

{
"change": {
"creationDateTime": "2021-09-07T19:02:13Z",
"effectivityType": "PERMANENT_ON_APPROVAL",
"guid": "I0K3MZKBY1KN6O446611",
"number": "ECO-000024",
"title": "BOM Mods"
},
"guid": "ZH1K3G1SFI04N6T4J21G"
}

request with bad GUID

©2022 Arena, A PTC Business www.arenasolutions.com 218

 Arena REST API Developer Guide Endpoints

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 219

 Arena REST API Developer Guide Endpoints

GET Item Source Relationships

/items/<GUID>/sourcing

Returns an array of Source Relationship objects for an item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all source
relationships where results should begin.
All relationships before the offset in the
search results are ignored. The default value
is 0.
limit integer Specifies the maximum number of returned
results. The default value (no specified limit)
is 20, the maximum is 400.

Response Codes

Code Description
200 Success
400 Failure

Response Headers

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 220

 Arena REST API Developer Guide Endpoints

Sample Responses
Get all source relationships for an item, limit results to 25

GET /items/Q8SBU2BB8P8P8MTGTTHH/sourcing?limit=25

{
"count":5,
"results":[
{
"activeProduction":true,
"activePrototype":false,
"amlRank":null,
"amlSplit":null,
"approved":true,
"guid":"TBVEJ9AAJQ9DWF0UVMSW",
"makeItem":false,
"mfrItem":{
"guid":"I0K38YZZ8FY3M55VE9WI"
},
"notes":"3/23/2000",
"vendorItem":{
"guid":"I0K38YZZ8FY3M55VE9WI"
},
"vendorItemConversionFactor":1
},
{
"activeProduction":false,
"activePrototype":true,
"amlRank":null,
"amlSplit":null,
"approved":true,
"guid":"UCWFKABBKRAEXG1VWNTK",
"makeItem":false,
"mfrItem":{
"guid":"J1L49Z009GZ4N66WFAXA"
},
"notes":"4/17/2000",
"vendorItem":{
"guid":"J1L49Z009GZ4N66WFAXA"
},
"vendorItemConversionFactor":1
},
{
"activeProduction":false,
"activePrototype":false,
"amlRank":null,
"amlSplit":null,
"approved":false,
"guid":"VDXGLBCCLSBFYH2WXOUN",
"makeItem":false,
"mfrItem":{
"guid":"K2M5A011AH05O77XGBYE"
},
"notes":"Disapproved for repeated late delivery.",

©2022 Arena, A PTC Business www.arenasolutions.com 221

 Arena REST API Developer Guide Endpoints

"vendorItem":{
"guid":"K2M5A011AH05O77XGBYE"
},
"vendorItemConversionFactor":1
},
{
"activeProduction":false,
"activePrototype":false,
"amlRank":null,
"amlSplit":null,
"approved":true,
"guid":"WEYHMCDDMTCGZI3XYPVB",
"makeItem":false,
"mfrItem":{
"guid":"L3N6B122BI16P88YHCZ9"
},
"notes":"The relationship has been re-approved. The new factory is now online
and the parts are approved.",
"vendorItem":{
"guid":"L3N6B122BI16P88YHCZ9"
},
"vendorItemConversionFactor":1
},
{
"activeProduction":false,
"activePrototype":false,
"amlRank":null,
"amlSplit":null,
"approved":true,
"guid":"ZH1KPFGGPWFJ2L601SYY",
"makeItem":false,
"mfrItem":{
"guid":"M4O7C233CJ27Q99ZID0U"
},
"notes":"Adding Trilby as our main source.",
"vendorItem":{
"guid":"M4O7C233CJ27Q99ZID0U"
},
"vendorItemConversionFactor":1
}
]
}

Returns an error if:

1. the format of the request is incorrect:

{
"status": 400,
"errors": [
{
"code": 400,
"message": "The format of the request is not valid. Please check the syntax."

©2022 Arena, A PTC Business www.arenasolutions.com 222

 Arena REST API Developer Guide Endpoints

]
}

2. the Item GUID is invalid:

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"6O8RAIPBRZIZIW2J7TL83\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 223

 Arena REST API Developer Guide Endpoints

GET Item Source Relationship

/items/<GUID>/sourcing/<GUID>

Returns a Source Relationship object with a given GUID for an item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get a source relationship for a given item

/items/<GUID>/sourcing/<GUID>

{
"activeProduction":true,
"activePrototype":false,
"amlRank":null,
"amlSplit":null,
"approved":true,
"guid":"TBVEJ9AAJQ9DWF0UVMSW",
"makeItem":false,
"mfrItem":{
"guid":"I0K38YZZ8FY3M55VE9WI"

©2022 Arena, A PTC Business www.arenasolutions.com 224

 Arena REST API Developer Guide Endpoints

},
"notes":"3/23/2000",
"vendorItem":{
"guid":"I0K38YZZ8FY3M55VE9WI"
},
"vendorItemConversionFactor":1
}

Returns an error if:

1. the format of the request is incorrect:

{
"status": 400,
"errors": [
{
"code": 400,
"message": "The format of the request is not valid. Please check the syntax."

}
]
}

2. a GUID is invalid:

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"6O8RAIPBRZIZIW2J7TL83\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 225

 Arena REST API Developer Guide Endpoints

POST Item Source Relationship Create

/items/<GUID>/sourcing

Creates a new Source Relationship for an item with a given GUID. Note that you can create two different types
of source relationship:

• In a direct relationship, you get a manufacturer Item directly from the manufacturer. The manufacturer and
vendor items are the same. You can also specify a Make-Item relationship (where your own company makes
the part) by setting MakeItem to True.

• In an indirect relationship, you buy a manufacturer item from a vendor. The manufacturer and vendor items
are different. You can choose not to specify the manufacturer or vendor item in an indirect source relationship,
to create an "any" relationship (source to any manufacturer or vendor.)

NOTES:

1. The suppliers and supplier items named in the source relationship must already exist in the workspace. Find
their GUIDs with Get Supplier and Get Supplier Item requests.

2. The values you specify for attributes must match the attribute types specified in the workspace. For example,
when specifying a value for a predefined list, the value must be one of the allowed values.

3. Number values must appear in quotation marks.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

• Create Indirect Source Relationship

{
"amlRank":2,
"approved":true,
"mfrItem":{
"guid":" FXH05VR083MRATTHJD8A "
},
"notes":"api-sourcing-relationship1",
"vendorItem":{
"guid":" BTDW1RNW4ZIN6PPBP28X"
},
"vendorItemConversionFactor":2,
"makeItem":false
}

• Create Direct Source Relationship (note that the mfrItem and vendorItem GUIDs are the same)

{
"amlRank":2,

©2022 Arena, A PTC Business www.arenasolutions.com 226

 Arena REST API Developer Guide Endpoints

"approved":true,
"mfrItem":{
"guid":" FXH05VR083MRATTHJD8A "
},
"notes":"api-sourcing-relationship1",
"vendorItem":{
"guid":" FXH05VR083MRATTHJD8A "
},
"vendorItemConversionFactor":2,
"makeItem":false
}

• Create Make-Item Source Relationship (where your company makes the Item)

{
"amlRank":2,
"approved":true,
"notes":"api-sourcing-relationship1",
"vendorItemConversionFactor":null,
"makeItem":true
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Create a new source relationship for a given item

/items/<GUID>/sourcing

{
"activeProduction":false,
"activePrototype":false,

©2022 Arena, A PTC Business www.arenasolutions.com 227

 Arena REST API Developer Guide Endpoints

"amlRank":2,
"amlSplit":null,
"approved":true,
"creationDateTime":null,
"guid":"EWGZ4UQZ72LP8RC2ZDXS",
"makeItem":false,
"mfrItem":{
"guid":"BTDW1RNW4ZIN6PPBP28X"
},
"notes":"api-sourcing-relationship1",
"offTheShelf":false,
"vendorItem":{
"guid":"BTDW1RNW4ZIN6PPBP28X"
},
"vendorItemConversionFactor":2
}

Returns an error if:

1. the format of the request is incorrect:

{
"status": 400,
"errors": [
{
"code": 400,
"message": "The format of the request is not valid. Please check the syntax."

}
]
}

2. the vendorItemConversionFactor attribute is not null in a Make-Item Source Relationship or when there is
no Vendor Item:

{
"status": 400,
"errors": [
{
"code": 3040,
"message": "Conversion factor must be null if no vendor item or is make
myself."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 228

 Arena REST API Developer Guide Endpoints

PUT Item Source Relationship Update

/items/<GUID>/sourcing/<GUID>

Updates a Source Relationship object with a given GUID for an item with a given GUID. Note that updating a
source relationship modifies the existing Source Relationship GUID on the working revision.

Request Headers

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"amlRank":2
}

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Update a source relationship for a given item

/items/<GUID>/sourcing/<GUID>

{
"activeProduction":false,
"activePrototype":false,

©2022 Arena, A PTC Business www.arenasolutions.com 229

 Arena REST API Developer Guide Endpoints

"amlRank":2,
"amlSplit":null,
"approved":true,
"guid":"I0K38YU3B6PTCVG5OV8P",
"makeItem":false,
"mfrItem":{
"guid":"ASCV0QMV3YHM5OOAA1AL"
},
"notes":"api-sourcing-relationship1",
"vendorItem":{
"guid":"3L5OTJFOWRAFYHH33U59"
},
"vendorItemConversionFactor":2
}

Returns an error if:

1. the format of the request is incorrect:

{
"status": 400,
"errors": [
{
"code": 400,
"message": "The format of the request is not valid. Please check the syntax."

}
]
}

2. a general error occurs:

{
"status": 400,
"errors": [
{
"code": 4000,
"message": "Sorry, a system error occurred, please try again."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 230

 Arena REST API Developer Guide Endpoints

DELETE Item Source Relationship

/items/<GUID>/sourcing/<GUID>

Deletes a source relationship with a given GUID for an item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response

Returns an error if the GUID is not valid

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 231

 Arena REST API Developer Guide Endpoints

POST Item Compliance

POST /items/<GUID>/compliance

Creates a Compliance Requirement object with a given GUID for an item with a given GUID.

Only one of each Compliance Requirement can be added to an Item. Any Item revision can have compliance
added.

If the Compliance Requirement is added to the effective revision, it is also added to the working revisions of
the Item..

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"evidenceType":"AML_AND_FILES",
"mark":"RoHS stamp",
"rationale":"All off-the-shelf manufacturer parts qualified under this Item Number
have been verified to meet the RoHS requirement.",
"requirement": { "guid": "5N7QVLMMV2KK3M4ZHAO8"},
"status":"COMPLIANT"
}

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 232

 Arena REST API Developer Guide Endpoints

Sample Response Body

Apply a compliance requirement to an Item

POST /items/<GUID>/compliance/<GUID>

{
"evidenceType":"AML_AND_FILES",
"guid":"9RBUZPQQZ6OO7QV0DS6B",
"lastModifiedBy":{
"email":"[email protected]",
"fullName":"John Parker"
},
"lastModifiedDateTime":"2020-09-23T18:12:12Z",
"mark":"RoHS stamp",
"propagated":false,
"rationale":"All off-the-shelf manufacturer parts qualified under this Item Number
have been verified to meet the RoHS requirement.",
"requirement":{
"guid":"5N7QVLMMV2KK3M4ZHAO8",
"name":"2011/65/EU RoHS"
},
"status":"COMPLIANT"
}

Request with invalid evidence type or status

{
"status":400,
"errors":[
{
"code":3082,
"message":"Invalid evidence type."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 233

 Arena REST API Developer Guide Endpoints

DELETE Item Compliance

DELETE /items/<GUID>/compliance/<GUID>

Deletes a Compliance Requirement object with a given GUID for an item with a given GUID.

Propagated Compliance Requirements (where the propagated attribute is true) cannot be removed.

The Compliance Requirement is removed from the specified revision only and is not removed from any other
revisions.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response.

Returns an error if the GUID is not valid.

{
"status":400,

©2022 Arena, A PTC Business www.arenasolutions.com 234

 Arena REST API Developer Guide Endpoints

"errors":[
{
"code":3082,
"message":"Invalid evidence type."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 235

 Arena REST API Developer Guide Endpoints

GET Where Used

/items/<GUID>/whereused

Returns an array of Item objects in which the given Item appears as a BOM line, along with the line number
and other attributes. Note that when "lineNumber" is null for an assembly line, (a) line number generation is
set to manual but the user has not yet entered line numbers, or (b) line number generation is set to automatic.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get where used results for an item

/items/<GUID>/whereused

{
"count":2,
"results":[
{
"guid":"I0K3MU1N3BU1K3MU8IT0",
"item":{
"guid":"M4O7QY5R7FYFYCILCQJX"
"name": "Resistor, 43 Ohm",

©2022 Arena, A PTC Business www.arenasolutions.com 236

 Arena REST API Developer Guide Endpoints

"number": "248-00031",
"revisionNumber": "C",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "https://api.arenasolutions.com/v1/items/M4O7QY5R7FYFYCILCQJX",

"app": "https://app.arenasolutions.com/M4O7QY5R7FYFYCILCQJX"
}

},
"lineNumber":4,
"notes":"paren 1 child 1",
"quantity":1,
"refDes":"c3"
},
{
"guid":"J1L4NV2O4CV2L4NV9JUI",
"item":{
"guid":"WEYH08F1HP8P8MSVM0T4"
"name": "Resistor, 50 Ohm",
"number": "248-00033",
"revisionNumber": "C",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "https://api.arenasolutions.com/v1/items/WEYH08F1HP8P8MSVM0T4",

"app": "https://app.arenasolutions.com/WEYH08F1HP8P8MSVM0T4"
}
},
"lineNumber":null,
"notes":"paren 1 child 1",
"quantity":1,
"refDes":"c3"
}
]
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"I0K3MU1N3BU1K3MU8IT0\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 237

 Arena REST API Developer Guide Endpoints

GET Item-To-Item References

/items/<GUID>/items

Returns an array of Item references for an item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get Item References for a given item

/items/<GUID>/items/

{
"count": 1,
"results": [
{
"guid": "TBVEXAVM9CTFYH0IXE17",
"item": {
"guid": "R9TCV8TK7AT1KZNA8V1W"
},
"note": "some note"
}

©2022 Arena, A PTC Business www.arenasolutions.com 238

 Arena REST API Developer Guide Endpoints

]
}

Returns an error if:

1. the format of the request is incorrect:

{
"status": 400,
"errors": [
{
"code": 400,
"message": "The format of the request is not valid. Please check the syntax."

}
]
}

2. a GUID is invalid:

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"X9TCV8TK7AT1KZNA8V1Q\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 239

 Arena REST API Developer Guide Endpoints

GET Item-To-Item Reference

/items/<GUID>/items/<GUID>

Returns an Item reference with a given GUID for an item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get an Item Reference for a given item

/items/<GUID>/items/<GUID>

{
"guid": "0I2LQGHHQXGXGVRR5XND",
"item": {
"guid": "ASCV0QRR07Q7Q511F7V0",
},
"notes": "the notes"
}

Returns an error if:

©2022 Arena, A PTC Business www.arenasolutions.com 240

 Arena REST API Developer Guide Endpoints

1. the format of the request is incorrect:

{
"status": 400,
"errors": [
{
"code": 400,
"message": "The format of the request is not valid. Please check the syntax."

}
]
}

2. a GUID is invalid:

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"X9TCV8TK7AT1KZNA8V1Q\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 241

 Arena REST API Developer Guide Endpoints

POST Item-To-Item Reference Create

/items/<GUID>/items

Creates a new Item-to-Item reference for an item with a given GUID.

NOTES:

1. Item references are bidirectional. Creating an Item reference between Items means that that both Items
will appear in each others Items view.

2. References are not revision controlled or revision specific., and can only be created between released Items.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

• Create Item-To-Item Reference

{
"item": {
"guid": "R9TCV8TK7AT1KZNA8V1W"
},
"note": "Item Reference Notes"
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count

©2022 Arena, A PTC Business www.arenasolutions.com 242

 Arena REST API Developer Guide Endpoints

Name Value Description

X-Arena-Requests-Remaining number how many calls left

Sample Responses
Create a new Item-to-Item reference.

/items/<GUID>/items

{
"guid": "TBVEXAVM9CTFYH0IXE17",
"item": {
"guid": "R9TCV8TK7AT1KZNA8V1W"
},
"note": "Item Reference Notes"
}

Returns an error if:

1. the format of the request is incorrect:

{
"status": 400,
"errors": [
{
"code": 400,
"message": "The format of the request is not valid. Please check the syntax."

}
]
}

2. the GUID is not valid:

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"R9TCV8TK7AT1KZNA8V1Y\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 243

 Arena REST API Developer Guide Endpoints

PUT Item-To-Item Reference Update

/items/<GUID>/items/<GUID>

Updates the metadata of an Item-To-Item reference with a given GUID

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"note": "update notes"
}

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Update a given Item-To-Item Reference.

/items/<GUID>/items/<GUID>

{
"guid": "TBVEXAVM9CTFYH0IXE17",
"item": {
"guid": "R9TCV8TK7AT1KZNA8V1W"

©2022 Arena, A PTC Business www.arenasolutions.com 244

 Arena REST API Developer Guide Endpoints

},
"note": "update notes"
}

Returns an error if:

1. the format of the request is incorrect:

{
"status": 400,
"errors": [
{
"code": 400,
"message": "The format of the request is not valid. Please check the syntax."

}
]
}

2. a GUID is invalid:

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"X9TCV8TK7AT1KZNA8V1Q\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 245

 Arena REST API Developer Guide Endpoints

DELETE Item-To-Item Reference

/items/<GUID>/items/<GUID>

Deletes an source Item reference with a given GUID for an item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response

Returns an error if the GUID is not valid

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"JBPQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 246

 Arena REST API Developer Guide Endpoints

GET Item Quality Processes

GET /items/<GUID>/quality

GET /items/<GUID>/quality/<GUID>

Returns a collection of Quality Process objects for an item with a given GUID (all Quality Processes in which
the Item is an affected object). If the endpoint is apprended with a valid GUID, it returns a specific Quality
Process and the step information where a specific Item has been added as an affected object.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get all quality processes that include a given item

GET /items/0I2LQGHHQXGXGVRR5XND/quality

{
"count":1,
"results":[
{
"guid":"L3N6B0HVI1IYH0J2B57U",
"notes":"This is the related Quality process",

©2022 Arena, A PTC Business www.arenasolutions.com 247

 Arena REST API Developer Guide Endpoints

"qualityProcess":{
"creationDateTime":null,
"guid":"SAUDI7O2P8RN6P8R57B7",
"name":"Quality Issue on 500 board",
"number":"8D-000002",
"step":{
"guid":"TBVEJ8P3Q9SO7Q9S68C4",
"name":"Form Team"
},
"type":"8D"
}
}
]
}

Return a specific Quality Process and specific step where a specific Item has been added as an affected object.

GET /items/<GUID>/quality/<GUID>

{
"guid": "XFZI1EZQDGY9SBUCQ8JJ",
"notes": null,
"qualityProcess": {
"guid": "M4O7Q3OF25OK3M5OHUQ2",
"name": "Manufacturing flaws on 175-00001 boards",
"number": "CAR-000007",
"step": {
"guid": "N5P8R4PG36PL4N6PIVRR",
"name": "Problem Description"
},
"type": null
}
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 248

 Arena REST API Developer Guide Endpoints

GET Item Ticket References

/items/<GUID>/tickets

/items/<GUID>/tickets/<GUID>

Returns the Ticket References of an Item object. If the endpoint is appended with a valid GUID, it returns a
single specific Item Ticket Reference.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all the Ticket References associated with an Item of a given GUID.

GET /items/<GUID>/tickets

{
"count": 3,
"results": [
{
"guid": "0I2L4H2TGJ0UDWFXCXR5",
"ticket": {
"guid": "5N7Q9M7YLO5K3M5O7PAS",

©2022 Arena, A PTC Business www.arenasolutions.com 249

 Arena REST API Developer Guide Endpoints

"number": "REQ-000004"
}
},
{
"guid": "ZH1K3G1SFIZTCVEWBWQV",
"ticket": {
"guid": "ASCVERC3QTAP8RATCUF0",
"number": "REQ-000005"
}
},
{
"guid": "1J3M5I3UHK1VEXGYDYSE",
"ticket": {
"guid": "GYI1KXI9WZGVEXGZI0K9",
"number": "DEF-000002"
}
}
]
}

Get a single Ticket Reference with a specific GUID associated with an Item with a specific GUID.

GET /items/<GUID>/tickets/<GUID>

{
"guid": "1J3M5I3UHK1VEXGYDYSE",
"ticket": {
"guid": "GYI1KXI9WZGVEXGZI0K9",
"number": "DEF-000002"
}
}

request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 250

 Arena REST API Developer Guide Endpoints

About Criteria and Options in API Export

In API Export, export options determine which details of an Item is returned. Export options can only be defined
in the export definition. Similar to Item export settings within the user interface, options determine which Item
views, BOM levels, and revisions of Items are exported.

Export criteria determine which Items are exported. If export options resemble the export settings, criteria
would most resemble Arena Advanced Search. Similar to Advanced Search, users can build complex criteria
connected to each other in groups through logical operators.

Export criteria can be specified in the export definition call or in the export run call, but it cannot be specified
in both. If an export definition contains specified criteria, then it cannot be edited because export definitions
cannot be edited. If an export definition does not specify criteria, then criteria can be specified in the export
run call. You can specify multiple source relationships for an Item in the Relationships subview of the Sourcing
view. See export endpoints for examples of export definition and export run calls.

©2022 Arena, A PTC Business www.arenasolutions.com 251

 Arena REST API Developer Guide Endpoints

Export Options
Export options determine what Item views and attributes are included in an export.

Export Views table displays which views of an Item can be included in an export.

exportViews Description
SPECS Specs data for all Items.
BOM BOM Lines for all Items
BOM_SUBSTITUTES BOM Substitutes for all Items
SOURCING Sourcing relationships for all Items
FILES File Associations for all Items
FILES_FILE_SUMMARY File summary for all Files on Item Files
SOURCING_SUPPLIERITEM_SPECS Supplier Item Specs for all Supplier Items on Item sourcing
SOURCING_SUPPLIERITEM_SUPPLIER_PROFILE Supplier Item Specs for all Supplier Items on Item sourcing
SOURCING_SUPPLIERITEM_FILES Supplier Item File associations for all Supplier Items on Item sourcing
SOURCN
I G_SUPPLEIRTIEM_FLIES_FLIE_SUMMARY File summary for all files on Supplier Items on Item Sourcing

fileContent Description
NONE Export does not include any physical files. Can be used for Items and Supplier Items.
PRIMARY Export includes only the Primary physical Files. Can be used ONLY for Items.
ALL Export includes all Files. Can be used for Items and Supplier Items.

bomLevels Description
NONE Does not add child Items to the results
SINGLE Adds the Items on the single level BOM of matching Items to the results
FULL Add s the Items on the fully exploded BOM of matching Items to the results

header Description
apiName The apiName is the GUID for the Item, BOM, Supplier and Supplier Item custom attribute. Example:
"DVFYHPYYVCTBUDWDIYP0". API name is the default setting if not specified.
name The name is the name of the custom attribute as it appears in the Worksapce Settings of the graphic
user interface. Example: "Capacitance".

revisionStatus Description
LATEST Returns the effective revision of the items matching the cirteria if the Item is effective,
otherwise return the working revision of the Items matching the criteria. For BOMs, returns
the latest revisions for all levels.
WORKING Returns the working revisions of the Items matching the criteria, even if the Item is effective.
For BOMs, returns the working revision of the parent Item, but returns the latest revision for
all other levels.

©2022 Arena, A PTC Business www.arenasolutions.com 252

 Arena REST API Developer Guide Endpoints

revisionStatus Description
POTENTIAL Returns the working revisions of the Items matching the criteria, even if the Item is effective.
For BOMs, returns the working revision for all levels, including the parent Item.

format Description
json Returns the export data in JSON file format. If Files are included the JSON file format is included with
the Files in a zip file.
csv Returns the export data in CSV file format. If Files are included the CSV file format is included with
the Files in a zip file.

©2022 Arena, A PTC Business www.arenasolutions.com 253

 Arena REST API Developer Guide Endpoints

Export Criteria
Export Criteria determine which Items are included in an API Export. Through creating criteria, users can create
complex searches similar to Advanced Search.

The simplest form of a criteria is a criterion. A criterion consists of an Arena attribute , a value associated with
an attribute, and an operator that links the attribute to the value.

NOTES:

1. Export Definitions cannot be edited or deleted.

2. Criteria can be specified in the Export Definition or in the Export Run.

3. Criteria cannot be specified in both the Export Definition and in the Export Run. It also cannot be specified
in neither.

4. See Criteria: Attribute and Operators for list of supported attributes and operators.

Criterion Definitions

Name Description
Attribute An Arena attribute
Value An Arena attribute value associated with an
attribute
Operator A comparison of the attribute to a value
Criterion An object containing one attribute, one
operator, and one value.
Criterion Logic Boolean logic combining Criterion such as
"OR" and "AND"
Criterion Group A collection of one or more criterions
separted by criterion logic
Criterion Group Logic Boolean logic combining Criterion Groups
Criteria A collection of one or more criterion groups
separated by criterion group logic

Criteria Examples
• A Criterion

"criteria":[
{
"attribute":"number",
"operator":"IS_EQUAL_TO",
"value":"20-0001"
}
]

• Two Criterion separated with criterion logic

©2022 Arena, A PTC Business www.arenasolutions.com 254

 Arena REST API Developer Guide Endpoints

"criteria":[
[
{
"attribute":"number",
"operator":"STARTS_WITH",
"value":"20-"
},
"AND",
{
"attribute":"effectiveDateTime",
"operator":"IS_AFTER",
"value":"2020-03-02T12:01:07Z"
}
]
}

• Three criterions seprated with criterion logic.

"criteria":[
[
{
"attribute":"number",
"operator":"STARTS_WITH",
"value":"1"
},
"AND",
{
"attribute":"effectiveDateTime",
"operator":"IS_EQUAL_TO",
"value":"2020-03-02T12:01:07Z"
},
"OR",
{
"attribute":"effectiveDateTime",
"operator":"IS_BEFORE",
"value": "2016-01-01T12:00:00Z"
}
]
}

• Two Criterion groups separated by criterion gorup logic.

"criteria":[
[
{
"attribute":"number",
"operator":"STARTS_WITH",
"value":"9"
},
"AND",
{
"attribute":"effectiveDateTime",
"operator":"IS_BEFORE",
"value":"2019-04-01T12:00:00Z"
}
],
"OR",
[

©2022 Arena, A PTC Business www.arenasolutions.com 255

 Arena REST API Developer Guide Endpoints

{
"attribute":"number",
"operator":"STARTS_WITH",
"value":"7"
},
"AND",
{
"attribute":"effectiveDateTime",
"operator":"IS_AFTER"
"value":"2019-04-01T12:00:00Z"
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 256

 Arena REST API Developer Guide Endpoints

Criteria: Attributes and Operators

Item Attributes that can be used in criteria.

©2022 Arena, A PTC Business www.arenasolutions.com 257

 Arena REST API Developer Guide Endpoints

Table 1. Supported Criteria Attributes and Their Supported Operators

Attribute Field Type Operators
number SINGLE_LINE_TEXT IS_EQUAL TO, IS_NOT_EQUAL_TO, CONTAINS,
DOES_NOT_CONTAIN, STARTS_WITH,
DOES_NOT_START_WITH
guid GUID IS_EQUAL_TO, IS_IN
effectiveDateTime DATETIME IS_BEFORE, IS_AFTER, IS_BETWEEN
revisionNumber SINGLE_LINE_TEXT IS_EQUAL TO, IS_NOT_EQUAL_TO, CONTAINS,
DOES_NOT_CONTAIN, STARTS_WITH,
DOES_NOT_START_WITH
description SINGLE_LINE_TEXT IS_EQUAL TO, IS_NOT_EQUAL_TO, CONTAINS,
DOES_NOT_CONTAIN, STARTS_WITH,
DOES_NOT_START_WITH
category.guid* GUID IS_EQUAL_TO, IS_IN
category.name FIXED_DROP_DOWN (Single IS_EQUAL TO, IS_NOT_EQUAL_TO, CONTAINS,
Select) DOES_NOT_CONTAIN, STARTS_WITH,
DOES_NOT_START_WITH
owner.fullName SINGLE_LINE_TEXT IS_EQUAL TO, IS_NOT_EQUAL_TO, CONTAINS,
DOES_NOT_CONTAIN, STARTS_WITH,
DOES_NOT_START_WITH
creator.guid GUID IS_EQUAL_TO
creator.fullName SINGLE_LINE_TEXT IS_EQUAL TO, IS_NOT_EQUAL_TO, CONTAINS,
DOES_NOT_CONTAIN, STARTS_WITH,
DOES_NOT_START_WITH
creator.email SINGLE_LINE_TEXT IS_EQUAL TO, IS_NOT_EQUAL_TO, CONTAINS,
DOES_NOT_CONTAIN, STARTS_WITH,
DOES_NOT_START_WITH
lifecyclePhase.guid GUID IS_EQUAL_TO, IS_IN
lifecyclePhase.name FIXED_DROP_DOWN (Single IS_EQUAL_TO, IS_NOT_EQUAL_TO
Select)
lifecyclePhase.stage FIXED_DROP_DOWN (Single IS_EQUAL_TO, IS_NOT_EQUAL_TO
Select)
creationDateTime DATETIME IS_EQUAL_TO, IS_BEFORE, IS_AFTER, IS_BETWEEN
modifiedBOM* BOOLEAN IS_EQUAL_TO
modifiedSpecs* BOOLEAN IS_EQUAL_TO
modifiedSourcing* BOOLEAN IS_EQUAL_TO
modifiedFiles* BOOLEAN IS_EQUAL_TO
any SINGLE_LINE_TEXT CONTAINS
supplier.name SINGLE_LINE_TEXT IS_EQUAL TO, IS_NOT_EQUAL_TO, CONTAINS,
DOES_NOT_CONTAIN, STARTS_WITH,
DOES_NOT_START_WITH

©2022 Arena, A PTC Business www.arenasolutions.com 258

 Arena REST API Developer Guide Endpoints

Attribute Field Type Operators

supplier.guid GUID IS_EQUAL_TO
supplierItem.name SINGLE_LINE_TEXT IS_EQUAL TO, IS_NOT_EQUAL_TO, CONTAINS,
DOES_NOT_CONTAIN, STARTS_WITH,
DOES_NOT_START_WITH
supplierItem.guid GUID IS_EQUAL_TO
Additional Attributes SINGLE_LINE_TEXT IS_EQUAL TO, IS_NOT_EQUAL_TO, CONTAINS,
(Various Types) DOES_NOT_CONTAIN, STARTS_WITH,
DOES_NOT_START_WITH
MULTI_LINE_TEXT IS_EQUAL TO, IS_NOT_EQUAL_TO, CONTAINS,
DOES_NOT_CONTAIN, STARTS_WITH,
DOES_NOT_START_WITH
FIXED_DROP_DOWN IS_IN, IS_NOT_IN
FIXED_DROP_DOWN IS_IN, IS_NOT_IN
(Pre-defined, Single Select)
FIXED_DROP_DOWN IS_IN, IS_NOT_IN
(Pre-defined, Multi-Select)
DATETIME IS_EQUAL_TO, IS_BEFORE, IS_AFTER, IS_BETWEEN
NUMBER IS_EQUAL_TO, IS_NOT_EQUAL_TO,
IS_LESS_THAN_OR_EQUAL_TO, IS_LESS_THAN,
IS_GREATOR_THAN_OR_EQUAL_TO,
IS_GREATOR_THAN

fieldType Operators Data Type

SINGLE_LINE_TEXT IS_EQUAL TO, IS_NOT_EQUAL_TO, CONTAINS, String
DOES_NOT_CONTAIN, STARTS_WITH,
DOES_NOT_START_WITH
GUID IS_IN Array of Strings
DATETIME IS_EQUAL_TO, IS_BEFORE, IS_AFTER String (Date)
DATETIME IS_BETWEEN Array of 2 Strings (Date). Dates
must be in chronological order.
BOOLEAN IS_EQUAL_TO Boolean
DATE IS_BEFORE, IS_AFTER String (Date)
DATE IS_BETWEEN Array of 2 Strings (Date). Dates
must be in chronological order.
DROP_DOWN IS_EQUAL_TO, IS_NOT_EQUAL_TO Array of Strings
FIXED_DROP_DOWN, IS_EQUAL_TO, IS_NOT_EQUAL_TO Array of Strings
multi-select
FIXED_DROP_DOWN, IS_EQUAL_TO, IS_NOT_EQUAL_TO Array of Strings
single select

©2022 Arena, A PTC Business www.arenasolutions.com 259

 Arena REST API Developer Guide Endpoints

fieldType Operators Data Type

MULTI_LINE_TEXT IS_EQUAL_TO, IS_LESS_THAN_OR EQUAL_TO, String
CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH,
DOES_NOT_START_WITH
NUMBER IS_EQUAL_TO, IS_LESS_THAN_OR_EQUAL_TO, Number
IS_LESS_THANK,
IS_GREATER_THAN_OR_EQUAL_TO,
IS_GREATER_THAN
POSITIVE_DOUBLE IS_EQUAL_TO, IS_LESS_THAN_OR_EQUAL_TO, Number
IS_LESS_THAN,
IS_GREATER_THAN_OR_EQUAL_TO

Note:

1. Searches for "SINGLE_LINE_TEXT": "IS_EQUAL_TO" and "IS_NOT_EQUAL_TO" user astrisk literally and not as a
wildcard.

2. Searches for "SINGLE_LINE_TEXT": "CONTAINS", "DOES_NOT_CONTAIN", "STARTS_WITH",

"DOES_NOT_START_WITH" use astrisk as a wild card.

3. All other fieldTypes do not support the use of asterisk as wild cards.

4. Searching field types DROP_DOWN and FIXED_DROPDOWN (both single and multiple select) permit submission
of multiple values. The multiple values are separated by a semi-colon.

5. If fieldType GUID is included in the criteria, only one criterion is supported. In other words, if GUID is included, no
other criterion or criterion groups are permitted.

6. Arena Export currently doesn't support export for category.guid using the GUID for uncategorized. The
category.guid works for all other categorized GUIDs. To run an export for uncategorized Items use the following
criteria: attribute is euqal to category.name, operator is IS_EQUAL_TO, and value is -uncategorized-.

7. For an Item Export with revisionStatus set to LATEST used in conjunction with modfieidBOM equals true or
modifiedBOM equals false, the modifiedBOM attribute refers to the working revision for those released Items.
The reason for this is because released, effective revisions can't have a modified BOM. Only working revision Items
can have a modified BOM. In other words, if you run an export for modifiedBOM equals true and revisionStatus
equals LATEST and you're results show released Items with modifiedBOM set to false then it is an indicator that
the modifiedBOM is in the working revision of that Item. This behavior extends to exports that use modifiedSpecs,
modifiedSourcing, and modifiedFiles used in conjunction with revisionStatus set to LATEST.

©2022 Arena, A PTC Business www.arenasolutions.com 260

 Arena REST API Developer Guide Endpoints

About Export Results and the JSON Format

Export definitions with the format option set to json results in export results in the JSON file format. Certain
export definitions with a specific combination of export options will result in an empty JSON export file.

Note: In addition to the examples below, API results include an attribute named status for the GET Item endpoint.
For status, values of 0 corresponded to WORKING, values of 1 corresponded to EFFECTIVE, and values of 2 corresponded
to SUPERSEDED. Later on the attribute revisionStatus was introduced with the possible values of WORKING, EFFECTIVE,
and SUPERSEDED. Status is now deprecated. Status is not included in API Exports with a JSON format.

Empty JSON Export File Examples

• If BOM is the only export view included and BOM levels are set to none, the JSON export file will be empty
since bomLevels set to none prevents any child Items from being included.

"options":{
"exportViews": [
"BOM"
],
"bomLevels":"NONE",
"revisionStatus":"WORKING",
"format":"json"
}

• In order to export BOM substitutes, it's required to include the BOM export view. If BOM_SUBSTITUTES is
included without BOM, then the JSON export file will be empty.

"options":{
"exportViews": [
"BOM_SUBSTITUTES"
],
"bomLevels":"FULL",
"revisionStatus":"WORKING",
"format":"json"
}

• If FILES is included as an export view, but file content for Items and Supplier Items are set to NONE, the JSON
export results file will be empty.

"options":{
"exportViews": [
"FILES"
],
"fileContent": {
"item": "NONE",
"supplierItem": "NONE"
}
"bomLevels":"FULL",
"revisionStatus":"WORKING",
"format":"json"
}

• If SOURCING_SUPPLIERITEM_FILES is included as an export view, but file content is set to NONE, the JSON
export results file will be empty.

©2022 Arena, A PTC Business www.arenasolutions.com 261

 Arena REST API Developer Guide Endpoints

"options":{
"exportViews": [
"SOURCING_SUPPLIERITEM_FILES"
],
"fileContent": {
"item": "NONE",
"supplierItem": "NONE"
}
"bomLevels":"FULL",
"revisionStatus":"WORKING",
"format":"json"
}

©2022 Arena, A PTC Business www.arenasolutions.com 262

 Arena REST API Developer Guide Endpoints

POST Export Definition

/exports

Creates a new Export Definition object. Each case is shown below.

NOTES:

1. Export Definitions cannot be edited or deleted.

2. Criteria can be specified in the Export Definition or in the Export Run.

3. Criteria cannot be specified in both the Export Definition and in the Export Run. It also cannot be specified
in neither.

4. Export results are saved in Arena and expire after 60 days. Once expired, the results files are deleted in Arena
and are no longer available.

5. Export Limits: If the criteria return more than 20,000 items, then an error shall be returned. If the criteria
return more than 5,000 item, and BOM and FILES view are included as exportViews, then an error shall be
returned.

6. For an Item Export with revisionStatus set to LATEST used in conjunction with modifiedBOM equals true or
modifiedBOM equals false, the modifiedBOM attribute refers to the working revision for those released
Items. The reason for this is because released, effective revisions can't have a modified BOM. Only working
revision Items can have a modified BOM. In other words, if you run an export for modifiedBOM equals true
and revisionStatus equals LATEST and you're results show released Items with modifiedBOM set to false
then it is an indicator that the modifiedBOM is in the working revision of that Item. This behavior extends
to exports that use modifiedSpecs, modifiedSourcing, and modifiedFiles used in conjunction with
revisionStatus set to LATEST.

7. Arena Export currently doesn't support export for category.guid using the GUID for uncategorized. The
category.guid works for all other categorized GUIDs. To run an export for uncategorized Items use the
following criteria: attribute is euqal to category.name, operator is IS_EQUAL_TO, and value is -uncategorized-.

8. An Item Export with revisionStatus set to WORKING or POTENTIAL, will return the working revision of the
Items even if these Items contain an efffective, released version.

9. A full list of Export Options can be found in Export Options.

10. If an export has a JSON format and certain Export Options selected it can result in a JSON export file without
any content. See About Export Results and the JSON Format.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

• Create Export Definition with no Criteria

©2022 Arena, A PTC Business www.arenasolutions.com 263

 Arena REST API Developer Guide Endpoints

{
"name":"Sample Potential Export",
"description":"Sample Potential Export Description",
"world":"ITEMS",
"options":{
"exportViews":[
"SPECS",
"BOM",
"SOURCING",
"FILES",
"FILES_FILE_SUMMARY",
"SOURCING_SUPPLIERITEM_SPECS",
"SOURCING_SUPPLIERITEM_SPECS_PROFILE",
"SOURCING_SUPPLIERITEM_FILES",
"SOURCING_SUPPLIERITEM_FILES_FILE_SUMMARY"
],
"bomLevels":"FULL",
"fileContent":{
"item":"PRIMARY",
"supplierItem":"ALL"
},
"header": "apiName",
"revisionStatus": "Working",
"format": "json"
},
"criteria":null,
}

• Create Export Definition with a single Criterion

{
"name":"Sample Potential Export with single Criterion",
"description":"Sample Potential Export with single Criterion description",
"world":"ITEMS",
"options":{
"exportViews":[
"SPECS",
"BOM",
"SOURCING",
"FILES",
"FILES_FILE_SUMMARY",
"SOURCING_SUPPLIERITEM_SPECS",
"SOURCING_SUPPLIERITEM_SPECS_PROFILE",
"SOURCING_SUPPLIERITEM_FILES",
"SOURCING_SUPPLIERITEM_FILES_FILE_SUMMARY"
],
"bomLevels": "FULL",
"fileContent":{
"item":"PRIMARY",
"supplierItem":"ALL"
}
"header":"name",
"revisionStatus": "POTENTIAL",
"format": "csv"
},
"criteria":[[
{
"attribute": "number",
"operator": "IS_EQUAL_TO",

©2022 Arena, A PTC Business www.arenasolutions.com 264

 Arena REST API Developer Guide Endpoints

"value": "20-0001"
}
]]
}

• Create Export Definition with two Criterion separated with criterion logic

{
"name":"Sample Effective Export with two criterion separated with criterion
logic",
"description":"Sample Effective Export with two criterion separated with criterion
logic Description",
"world":"ITEMS",
"options":{
"exportViews":[
"SPECS",
"BOM",
"SOURCING",
"FILES",
"FILES_FILE_SUMMARY",
"SOURCING_SUPPLIERITEM_SPECS",
"SOURCING_SUPPLIERITEM_SPECS_PROFILE",
"SOURCING_SUPPLIERITEM_FILES",
"SOURCING_SUPPLIERITEM_FILES_FILE_SUMMARY"
],
"bomLevels":"FULL",
"fileContent":{
"item":"PRIMARY",
"supplierItem":"ALL"
}
"header":"name"
"revisionStatus":"LATEST",
"format": "json"
},
"criteria":[
[
{
"attribute":"number",
"operator":"STARTS_WITH",
"value":"20-"
},
"AND",
{
"attribute":"effectiveDateTime",
"operator":"IS_AFTER",
"value":"2016-01-02T12:01:07Z"
}
]]
}

• Create Export Definition with two Criterion groups separated by criterion group logic.

{
"name":"An example of an export definition with two Criterion groups",
"description":"Description of an export definition with two criterion groups",
"world":"ITEMS",
"options":{
"exportViews":[

©2022 Arena, A PTC Business www.arenasolutions.com 265

 Arena REST API Developer Guide Endpoints

"SPECS",
"BOM",
"SOURCING",
"FILES",
"FILES_FILE_SUMMARY",
"SOURCING_SUPPLIERITEM_SPECS",
"SOURCING_SUPPLIERITEM_SPECS_PROFILE",
"SOURCING_SUPPLIERITEM_FILES",
"SOURCING_SUPPLIERITEM_FILES_FILE_SUMMARY"
],
"bomLevels":"FULL",
"fileContent":{
"item":"PRIMARY",
"supplierItem":"ALL"
}
"header":"name",
"revisionStatus":"LATEST",
"format": "json"
},
"criteria":[
[
{
"attribute":"number",
"operator":"STARTS_WITH",
"value":"20-"
},
"AND",
{
"attribute":"effectiveDateTime",
"operator":"IS_AFTER",
"value":"2015-05-02T12:00:00Z"
}
],
"OR",
[
{
"attribute":"number",
"operator":"STARTS_WITH",
"value":"2"
},
"AND",
{
"attribute":"effectiveDateTime",
"operator":"IS_BEFORE",
"value":"2019-11-02T12:00:00Z"
}
]
]
}

Response Codes

Code Description
201 Success
400 Failure

©2022 Arena, A PTC Business www.arenasolutions.com 266

 Arena REST API Developer Guide Endpoints

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Create Export Definition with no Criteria

{
"creationDateTime":"2020-03-01T14:32:25Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P3046HYFYH0J258QJ"
},
"criteria":null,
"description":"Sample Potential Export Description",
"guid":"HZJ2GDHJUBRATCQ5TNJX",
"name":"Sample Potential Export Description",
"number":12,
"options":{
"bomLevels":"FULL",
"exportViews":[
"SPECS",
"BOM",
"SOURCING",
"FILES",
"FILES_FILE_SUMMARY",
"SOURCING_SUPPLIERITEM_SPECS",
"SOURCING_SUPPLIERITEM_SPECS_PROFILE",
"SOURCING_SUPPLIERITEM_FILES",
"SOURCING_SUPPLIERITEM_FILES_FILE_SUMMARY",
],
"fileContent":{
"item":"PRIMARY",
"supplierItem":"ALL"
},
"header":"apiName",
"revisionStatus":"POTENTIAL",
"format": "json"
},
"world":"ITEMS"
}

©2022 Arena, A PTC Business www.arenasolutions.com 267

 Arena REST API Developer Guide Endpoints

Create Export Definition with a single criterion

{
"creationDateTime":"2020-03-02T12:05:06Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P3046HYFYH0J258QJ"
},
"criteria":[[
{
"attribute":"number",
"operator":"IS_EQUAL_TO",
"value":"20-0001"
}
]],
"description":"Sample Potential Export with single Criterion description",
"guid":"HZJ2GDHJUBRATCQ5TNJX",
"name":"Sample Potential Export with single Criterion",
"number":12,
"options":{
"bomLevels":"FULL",
"exportViews":[
"SPECS",
"BOM",
"SOURCING",
"FILES",
"FILES_FILE_SUMMARY",
"SOURCING_SUPPLIERITEM_SPECS",
"SOURCING_SUPPLIERITEM_SPECS_PROFILE",
"SOURCING_SUPPLIERITEM_FILES",
"SOURCING_SUPPLIERITEM_FILES_FILE_SUMMARY",
],
"fileContent":{
"item":"PRIMARY",
"supplierItem":"ALL"
},
"header":"apiName",
"revisionStatus":"POTENTIAL",
"format": "csv"
},
"world":"ITEMS"
}

Create Export Definition with two Criterion separated with criterion logic

{
"creationDateTime":"2020-03-04T16:30:25Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P3046HYFYH0J258QJ"
},
"criteria":[
[

©2022 Arena, A PTC Business www.arenasolutions.com 268

 Arena REST API Developer Guide Endpoints

{
"attribute":"number",
"operator":"STARTS_WITH",
"value":"20-"
},
"AND",
{
"attribute":"effectiveDateTime",
"operator":"IS_EQUAL_TO",
"value":"2018-03-16T12:00:00Z"
}
]
},
"description":"Sample Effective Export with two criterion separated with criterion
logic Description",
"guid":"HZJ2GDHJUBRATCQ5TNJX",
"name":"Sample Effective Export with two criterion separated with criterion logic
Description",
"number":12,
"options":{
"bomLevels":"FULL",
"exportViews":[
"SPECS",
"BOM",
"SOURCING",
"FILES",
"FILES_FILE_SUMMARY",
"SOURCING_SUPPLIERITEM_SPECS",
"SOURCING_SUPPLIERITEM_SPECS_PROFILE",
"SOURCING_SUPPLIERITEM_FILES",
"SOURCING_SUPPLIERITEM_FILES_FILE_SUMMARY",
],
"fileContent":{
"item":"PRIMARY",
"supplierItem":"ALL"
},
"header":"apiName",
"revisionStatus":"LATEST",
"format":"json"
},
"world":"ITEMS"
}

Create Export Definition with two Criterion groups separated by criterion gorup logic

{
"creationDateTime":"2020-03-05T10:30:35Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P3046HYFYH0J258QJ"
},
"criteria":[
[
{

©2022 Arena, A PTC Business www.arenasolutions.com 269

 Arena REST API Developer Guide Endpoints

"attribute":"number",
"operator":"STARTS_WITH",
"value":"20-"
},
"AND",
{
"attribute":"effectiveDateTime",
"operator":"IS_EQUAL_TO",
"value":"2018-02-24T12:00:00Z"
}
],
"OR",
[
{
"attribute":"number",
"operator":"STARTS_WITH",
"value":"5"
},
"AND",
{
"attribute":"effectiveDateTime",
"operator":"IS_EQUAL_TO"
"value":"2015-05-02T12:00:00Z"
}
]
},
"description":"Sample Effective Export with two criterion separated with criterion
logic Description",
"guid":"HZJ2GDHJUBRATCQ5TNJX",
"name":"Sample Effective Export with two criterion separated with criterion logic
Description",
"number":12,
"options":{
"bomLevels":"FULL",
"exportViews":[
"SPECS",
"BOM",
"SOURCING",
"FILES",
"FILES_FILE_SUMMARY",
"SOURCING_SUPPLIERITEM_SPECS",
"SOURCING_SUPPLIERITEM_SPECS_PROFILE",
"SOURCING_SUPPLIERITEM_FILES",
"SOURCING_SUPPLIERITEM_FILES_FILE_SUMMARY",
],
"fileContent":{
"item":"PRIMARY",
"supplierItem":"ALL"
},
"header":"apiName",
"revisionStatus":"LATEST",
"format": "json"
},
"world":"ITEMS"
}

©2022 Arena, A PTC Business www.arenasolutions.com 270

 Arena REST API Developer Guide Endpoints

The request is validated to make sure it doesn’t violate any business rules. Any violation will result in an error
response:

1. A field is not creatable.

{
"status":400,
"errors":[
{
"code":4004,
"message":"The attribute \"name1\" is not creatable."
}
]
}

2. A value in the export definition is invalid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The specified value \"Changes\" is not a valid option for the
attribute \"world\"."
}
]
}

3. A required field is missing.

{
"status":400,
"errors":[
{
"code":3006,
"message":"The attribute \"Description\" is required."
}
]
}

4. An invalid export option is used such as inputting PRIMARY for supplierItem when defining fileContent.

{
"status":400,
"errors":[
{
"code":4003,
"message":"The value for the attribute \"supplierItem\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 271

 Arena REST API Developer Guide Endpoints

GET Export Definitions (Search)

/exports?query_string

Returns a collection of Export Definition objects matching the given search criteria..

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all export definitions where results should begin. All export
definitions before the offset in the search results are ignored. The default value is 0.
limit integer Specifies the number of results that should be returned. The default limit is 20. The maximum
limit is 400.

Searchable Attributes

Name Value Description

name string A user defined name for the export. it must
be provided on creation and does not need
to be unique.
number string A system generated number starting at 1
and incrementing with each export.
description string description of the export definition
creator.guid GUID The unique identifier for the creator of the
Export Definition.
creator.email string The email address of the user account that
created the Export Definition.
creator.fullName string The full name of the user that created the
Export Definition.

Note: GET calls that include Object numbers that include a percentage character, %, must encode the percentage
as %25 in order to return results. Similarly, the plus character, +, can be encoded as %2b in order to return results.

Response Codes

Code Description
200 Success

©2022 Arena, A PTC Business www.arenasolutions.com 272

 Arena REST API Developer Guide Endpoints

Code Description
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all export definitions

GET /exports

{
"count": 3,
"results":[
{
"creationDateTime": "2020-03-09T21:17:44Z"
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"criteria": [
[
{
"attribute": "number",
"value": "900-00001",
"operator": "IS_EQUAL_TO"
}
]
],
"description": "March 9",
"guid": "L3N6P2NE14K3M5JYNZFB",
"name": "Model 300",
"number": 1,
"options": {
"bomLevels": "NONE",
"exportViews": [
"SPECS",
"BOM",
"FILES"

©2022 Arena, A PTC Business www.arenasolutions.com 273

 Arena REST API Developer Guide Endpoints

],
"header": "name",
"revisionStatus": "POTENTIAL",
"format": "csv"
},
"world": "ITEMS"
},
{
"creationDateTime": "2020-03-10T17:08:27Z"
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"criteria": [
[
{
"attribute": "number",
"value": "900-00001",
"operator": "IS_EQUAL_TO"
}
]
],
"description": "Test Export Definition",
"guid": "SAUDW9UL8BRATCQ5U6HL",
"name": "Potential Model 300",
"number": 2,
"options": {
"bomLevels": "NONE",
"exportViews": [
"SPECS",
"BOM",
"FILES"
],
"header":"apiName",
"revisionStatus": "POTENTIAL",
"format": "csv"
},
"world": "ITEMS"
},
{
"creationDateTime": "2020-03-10T17:30:17Z"
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"criteria": [
[
{
"attribute": "number",
"value": "800-000300",
"operator": "IS_EQUAL_TO"
}
]

©2022 Arena, A PTC Business www.arenasolutions.com 274

 Arena REST API Developer Guide Endpoints

],
"description": "800 Export Definition",
"guid": "TBVEXAVM9CSBUDR6V7IW",
"name": "800 BOM Export",
"number": 3,
"options": {
"bomLevels": "FULL",
"exportViews": [
"SPECS",
"BOM",
"FILES"
],
"header":"apiName",
"revisionStatus": "LATEST",
"format": "json"
},
"world": "ITEMS"
},
}

Get export definitions named "EFFECTIVE PCBAs"

GET <url>/export?name=EFFECTIVE PCBAs

{
"count": 3,
"results": [
{
"creationDateTime": "2020-03-10T21:15:04Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"criteria": [
[
{
"attribute": "number",
"value": "8",
"operator": "STARTS_WITH"
}
]
],
"description": "Effective Revision of 8 series",
"guid": "WEYH0DYPCFVEXGU9YALQ",
"name": "EFFECTIVE PCBAs",
"number": 4,
"options": {
"bomLevels": "FULL",
"exportViews": [
"SPECS",
"BOM",
"FILES"
],
"fileContent": {

©2022 Arena, A PTC Business www.arenasolutions.com 275

 Arena REST API Developer Guide Endpoints

"item": "PRIMARY",
"supplierItem": "NONE"
},
"header": "apiName",
"revisionStatus": "LATEST",
"format": "csv"
},
"world": "ITEMS"
},
{
"creationDateTime": "2020-03-10T21:18:54Z",
"creator": {
"email": "[email protected]",
"fullName": "Eleanor Canard",
"guid": "1J3M5I3UHK1K3M5OXNUV"
},
"criteria": [
[
{
"attribute": "number",
"value": "8",
"operator": "STARTS_WITH"
}
]
],
"description": "Effective Revision of 8 series",
"guid": "XFZI1EZQDGWFYHVAZBMU",
"name": "EFFECTIVE PCBAs",
"number": 5,
"options": {
"bomLevels": "FULL",
"exportViews": [
"SPECS",
"BOM",
"FILES"
],
"fileContent": {
"item": "PRIMARY",
"supplierItem": "NONE"
},
"header": "name",
"revisionStatus": "LATEST",
"format": "csv"
},
"world": "ITEMS"
},
{
"creationDateTime": "2020-03-10T21:19:14Z",
"creator": {
"email": "[email protected]",
"fullName": "Eleanor Canard",
"guid": "1J3M5I3UHK1K3M5OXNUV"
},
"criteria": [
[

©2022 Arena, A PTC Business www.arenasolutions.com 276

 Arena REST API Developer Guide Endpoints

{
"attribute": "number",
"value": "9",
"operator": "STARTS_WITH"
}
]
],
"description": "Effective Revision of 9 series",
"guid": "YG0J2F0REHXGZIWB0CNE",
"name": "EFFECTIVE PCBAs",
"number": 6,
"options": {
"bomLevels": "FULL",
"exportViews": [
"SPECS",
"BOM",
"FILES"
],
"fileContent": {
"item": "PRIMARY",
"supplierItem": "NONE"
},
"header": "apiName",
"revisionStatus": "LATEST",
"format": "csv"
},
"world": "ITEMS"
}
]
}

Request with an invalid search attribute.

GET /export?creator.Name=Heidi Walker

{
"status":400,
"errors":[
{
"code":3019,
"message":"The attribute \"creator.Name\" is not searchable."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 277

 Arena REST API Developer Guide Endpoints

GET Export Definition

/exports/<GUID>

Returns an Export Definition with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get an export definition.

GET /exports/GUID

{
"creationDateTime":"2020-03-02T12:05:06Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P3046HYFYH0J258QJ"
},
"criteria":[[
{
"attribute":"number",

©2022 Arena, A PTC Business www.arenasolutions.com 278

 Arena REST API Developer Guide Endpoints

"operator":"IS_EQUAL_TO",
"value":"20-0001"
}
]],
"description":"Sample Potential Export with single Criterion description",
"guid":"HZJ2GDHJUBRATCQ5TNJX",
"name":"Sample Potential Export with single Criterion",
"number":12,
"options":{
"bomLevels":"FULL",
"exportViews":[
"SPECS",
"BOM",
"SOURCING",
"FILES",
"FILES_FILE_SUMMARY",
"SOURCING_SUPPLIERITEM_SPECS",
"SOURCING_SUPPLIERITEM_SPECS_PROFILE",
"SOURCING_SUPPLIERITEM_FILES",
"SOURCING_SUPPLIERITEM_FILES_FILE_SUMMARY",
],
"fileContent":{
"item":"PRIMARY",
"supplierItem":"ALL"
},
"header":"apiName",
"revisionStatus":"POTENTIAL",
"format": "csv"
},
"world":"ITEMS"
}

request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 279

 Arena REST API Developer Guide Endpoints

POST Export Run

/exports/<GUID>/runs

Initiates an Export run based on an existing Export Definition. Each case is shown below.

NOTES:

1. The export run endpoint executes an export definition.

2. If the criteria was specified in the export definition, that criteria will be used in the run and cannot be specified
in the export run.

3. If the criteria was not specified in the export definition, a criteria must be specified in the export run.

4. Export results are saved in Arena and expire after 60 days. Once expired, the results files are deleted in Arena
and are no longer available.

5. Export Limits: If the criteria return more than 20,000 items, then an error shall be returned. If the criteria
return more than 5,000 item, and BOM and FILES view are included as exportViews, then an error shall be
returned.

6. Export Status Description

CREATED The export run has been created and is queued for processing.
RUNNING The export run is processing.
COMPLETE The export file is completed and is ready to be downloaded.
DOWNLOADED The export file has been downloaded by a user.
FAILED The export failed at runtime and there are no results.
ABORTED The export run was manually aborted by Arena Technical Support.

7. If an export has a JSON format and certain Export Options selected it can result in a JSON export file without
any content. See About Export Results and the JSON Format.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

• Run Export Definition (Criteria not specified in the export definition so it must be specified in the run)

"criteria":[
{
"attribute":"number",
"operator":"IS_EQUAL_TO",
"value":"20-0001"
}
]

©2022 Arena, A PTC Business www.arenasolutions.com 280

 Arena REST API Developer Guide Endpoints

• Run Export Definition (Criterion specified in the export definition so it is not necessary to specify it in the
run)

{}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Export Run is processing

{
"completionDateTime":null,
"creationDateTime":"2020-03-07T09:32:25Z",
"creator": {
"guid":"ASCV96ACN4L4N6P6BG6H"
},
"criteria":[
{
"attribute":"number",
"operator":"IS_EQUAL_TO",
"value":"20-0001"
}
]
"criteriaResultsCount": 1,
"guid":"Q8SBPMQS3K0IKBD56MW",
"number":12,
"status":"RUNNING"
}

Export Run completed

©2022 Arena, A PTC Business www.arenasolutions.com 281

 Arena REST API Developer Guide Endpoints

{
"completionDateTime":"2020-03-07T09:32:30Z",
"creationDateTime":"2020-03-07T09:32:25Z",
"creator": {
"guid":"ASCV96ACN4L4N6P6BG6H"
},
"criteria":[
{
"attribute":"number",
"operator":"IS_EQUAL_TO",
"value":"20-0001"
}
]
"criteriaResultsCount": 1,
"files": [
{
"guid": "1J3M0X13EVEUDWMBT049",
"title": null
}
],
"guid":"Q8SBPMQS3K0IKBD56MW",
"number":12,
"status":"COMPLETE"
}

The request is validated to make sure it doesn’t violate any business rules. Any violation will result in an error
response:

1. A field is not creatable.

{
"status":400,
"errors":[
{
"code":4004,
"message":"The attribute \"name1\" is not creatable."
}
]
}

2. A value in the export definition is invalid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The specified value \"Changes\" is not a valid option for the
attribute \"world\"."
}
]
}

3. A required field is missing.

©2022 Arena, A PTC Business www.arenasolutions.com 282

 Arena REST API Developer Guide Endpoints

{
"status":400,
"errors":[
{
"code":3006,
"message":"The attribute \"Description\" is required."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 283

 Arena REST API Developer Guide Endpoints

GET Export Run

/exports/<GUID>/runs/<GUID>

Returns an Export Run with a given GUID.

Note: For security reasons, only the user who ran the specific export (via the POST Export run), can use this endpoint
to obtain information about this specific export. Users who attempt to access the unique and specific export will
encounter an error.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get an export definition.

GET /exports/GUID

{
"creationDateTime":"2020-03-02T12:05:06Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P3046HYFYH0J258QJ"

©2022 Arena, A PTC Business www.arenasolutions.com 284

 Arena REST API Developer Guide Endpoints

},
"criteria":[[
{
"attribute":"number",
"operator":"IS_EQUAL_TO",
"value":"20-0001"
}
]],
"description":"Sample Potential Export with single Criterion description",
"guid":"HZJ2GDHJUBRATCQ5TNJX",
"name":"Sample Potential Export with single Criterion",
"number":12,
"options":{
"bomLevels":"FULL",
"exportViews":[
"SPECS",
"BOM",
"FILES",
"SOURCING",
"FILES",
"FILES_FILE_SUMMARY",
"SOURCING_SUPPLIERITEM_SPECS",
"SOURCING_SUPPLIERITEM_SPECS_PROFILE",
"SOURCING_SUPPLIERITEM_FILES",
"SOURCING_SUPPLIERITEM_FILES_FILE_SUMMARY",
],
"fileContent":{
"item":"PRIMARY",
"supplierItem":"ALL"
},
"header":"name"
"revisionStatus":"POTENTIAL",
"format":"csv"
},
"world":"ITEMS"
}

request made by a user who did not initiate the export run.

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

request with bad GUID

{
"status":400,
"errors":[

©2022 Arena, A PTC Business www.arenasolutions.com 285

 Arena REST API Developer Guide Endpoints

{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 286

 Arena REST API Developer Guide Endpoints

GET Export Run File Metadata

/exports/<GUID>/runs/<GUID>/files/<GUID>

Returns the metadata of an export file generated from an export run with a given GUID.

Note: For security reasons, only the user who ran the specific export (via the POST Export run), can use this endpoint
to obtain information about this specific export. Users who attempt to access the unique and specific export will
encounter an error.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get the metadata of an export run.

GET /exports/<export definition GUID>/runs/<export run GUID>/files/<export

file GUID>

{
"author": null
"category: {}
"creationDateTime":"2020-03-09T21:18:46Z",
"description": null,

©2022 Arena, A PTC Business www.arenasolutions.com 287

 Arena REST API Developer Guide Endpoints

"edition": null,
"format": null,
"guid": "VDXGZX0BEXDWF5CV9RE",
"hasMarkup": false,
"lastModifiedDateTime": "2020-03-09T21:18.46Z"
"latest": false,
"location": null,
"locked": true,
"mimeType": "application/zip",
"name": "Model 300 Export Results.zip",
"number": null,
"private": false,
"size": 1419,
"storageMethodName": "FILE",
"title": null
}

request made by a user who did not initiate the export run

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 288

 Arena REST API Developer Guide Endpoints

GET Export Run File Content (Download)

/exports/<GUID>/runs/<GUID>/files/<GUID>/content

Streams the content of an export file generated from an export run with a given GUID.

Note:

1. Export results are saved in Arena and expire after 60 days. Once expired, the results files are deleted in Arena and
are no longer available.

2. Export Limits: If the criteria return more than 20,000 items, then an error shall be returned. If the criteria return
more than 5,000 item, and BOM and FILES view are included as exportViews, then an error shall be returned

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Downloads the export file.

GET /exports/<export definition GUID>/runs/<export run GUID>/files/<export

file GUID>/content

Streams a zip file containing the CSV or JSON export files.

©2022 Arena, A PTC Business www.arenasolutions.com 289

 Arena REST API Developer Guide Endpoints

request made by a user who did not initiate the export run

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 290

 Arena REST API Developer Guide Endpoints

GET Export Runs

/exports/<GUID>/runs

Returns the runs executed by an export definition with a given GUID.

Export Status Description

CREATED The export run has been created and is queued for processing.
RUNNING The export run is processing.
COMPLETE The export file is completed and is ready to be downloaded.
DOWNLOADED The export file has been downloaded by a user.
FAILED The export failed at runtime and there are no results.
ABORTED The export run was manually aborted by Arena Technical Support.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

completionDateTimeFrom Date-Formatted String The date and time (in Zulu format) from which an API
export was completed.
completionDateTimeTo Date-Formatted String The date and time (in Zulu format) from which an API
export was completed.
latestCompleted true or false The last export run completed for the specified export
definition. Set to true to return the last completed run.
number integer The specific numbered export run of an Export definition.
This number is generated by Arena.
status String The lifecycle status of the export run.

Response Codes

Code Description
200 Success
400 Failure

©2022 Arena, A PTC Business www.arenasolutions.com 291

 Arena REST API Developer Guide Endpoints

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Downloads the export file.

GET /exports/<export definition GUID>/runs

{
"count": 2,
"results": {
{
"completionDateTime": "2020-03-09T21:18:46Z",
"creationDateTime": "2020-03-09T21:18:43Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFH0JS1PD"
},
"criteria": [
[
{
"attribute": "number",
"value": 900-00001",
"operator": "IS_EQUAL_To"
}
]
],
"criteriaResultsCount": 1,
"files": [
{
"guid": "VDXGZCX0BEXDWF5CV9RE",
"title": null
}
"guid": "M407Q30F25L3M5WZUF9M",
"number": 1,
"status": "COMPLETE"
},
{
"completionDateTime": "2020-03-09T22:39:03Z",
"creationDateTime": "2020-03-09T22:39:02Z",
"creator": {

©2022 Arena, A PTC Business www.arenasolutions.com 292

 Arena REST API Developer Guide Endpoints

"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFH0JS1PD"
},
"criteria": [
[
{
"attribute": "number",
"value": 900-00001",
"operator": "IS_EQUAL_To"
}
]
],
"criteriaResultsCount": 1,
"files": [
{
"guid": "L3N6P2NE14N3M5V2LZFC",
"title": null
}
"guid": "Q8SBU7SJ69P7Q903YJD6",
"number": 2,
"status": "COMPLETE"
},

request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 293

 Arena REST API Developer Guide Endpoints

GET Integrations (Search)

/outboundintegrations

Returns a collection of outbound integrations objects matching the given search criteria.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Searchable Attributes

Name Value Description

enabled string Indicates if an Integration is enabled. The
value is true if the integration is enabled.
The value is false if the integration is
disabled.
name string The name of the outbound integration.

Note: Search behavior in the Arena REST API differs from search behavior in the Arena application. In the API, a
trailing asterisk (wildcard) is required to return results that start with a string; in the Arena application, a trailing
asterisk is always implied.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 294

 Arena REST API Developer Guide Endpoints

Sample Response Body

Get all outbound integrations

GET /outboundintegrations

{
"count": 3,
"results": [
{
"guid": "5N7Q9M7YLOZ6P8RATFCH",
"name": "ERP Integration",
"enable": true,
"status": "OUTBOUND_MANAGED",
"type": "UP_TO_DATE",
"transferType": "ITEM_REVISION"
},
{
"guid": "7P9SBO90NQ18RATCVHE1",
"name": "XYZ Integration",
"enable": true,
"status": "OUTBOUND_MANAGED",
"type": "UP_TO_DATE",
"transferType": "ITEM_REVISION"
},
{
"guid": "8QATCPA1OR29SBUDWIF4",
"name": "Deactivated Integration",
"enable": false,
"status": "OUTBOUND_MANAGED",
"type": "DISABLED",
"transferType": "ITEM_REVISION"
}
]
}

Get outbound integrations that are enabled

GET <url>/outboundintegrations?enabled=true

{
"count": 2,
"results": [
{
"guid": "5N7Q9M7YLOZ6P8RATFCH",
"name": "ERP Integration",
"enable": true,
"status": "OUTBOUND_MANAGED",
"type": "UP_TO_DATE",
"transferType": "ITEM_REVISION"
},
{
"guid": "7P9SBO90NQ18RATCVHE1",
"name": "XYZ Integration",
"enable": true,

©2022 Arena, A PTC Business www.arenasolutions.com 295

 Arena REST API Developer Guide Endpoints

"status": "OUTBOUND_MANAGED",
"type": "UP_TO_DATE",
"transferType": "ITEM_REVISION"
}
]
}

Request with an invalid search attribute.

GET /outboundintegrations?transferType=Item Revision

{
"status":400,
"errors":[
{
"code":3003,
"message":"The value for the attribute \"trasnferType\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 296

 Arena REST API Developer Guide Endpoints

GET Integrations
/outboundintegrations/<guid>

Returns a specific outbound integrations object matching the given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a specific outbound integration.

GET /outboundintegrations/<GUID>

{
"guid": "5N7Q9M7YLOZ6P8RATFCH",
"name": "ERP Integration",
"enabled": true,
"status": "UP_TO_DATE",
"type": "OUTBOUND_MANAGED",
"transferType": "ITEM_REVISION",
"creator": {
"email": "[email protected]",
"fullName": "Dennis Coronel",

©2022 Arena, A PTC Business www.arenasolutions.com 297

 Arena REST API Developer Guide Endpoints

"guid": "FXH0JWH8VYFYH0J25014"
},
"creationDateTime": "2020-03-10T22:21:31Z",
"modifyUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"modifyDateTime": "2020-03-10T23:35:29Z"
}

Request with an invalid GUID.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"5N7Q9M7YL0Z6P8RATFCI\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 298

 Arena REST API Developer Guide Endpoints

GET Integration Administrators

/outboundintegrations/<guid>/administrators

Returns all the integration administrators of a specific outbound integrations objects matching the given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get the integration administrators of a specific outbound integration.

GET /outboundintegrations/<GUID>/administrators

{
"count": 2,
"results": [
{
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
{
"email": "[email protected]",

©2022 Arena, A PTC Business www.arenasolutions.com 299

 Arena REST API Developer Guide Endpoints

"fullName": "Eleanor Canard",

"guid": "1J3M5I3UHK1K3M5OXNUV"
}
]
}

Request with an invalid GUID.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"5D7Q9M7YL0Z6P8RATBDS\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 300

 Arena REST API Developer Guide Endpoints

GET Events (Search)

/outboundintegrations/<GUID>/events

Returns unreconciled event objects matching the given search criteria.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all events
where results should begin. All events
before the offset in the search results are
ignored. The default value is 0.
limit integer Specifies the number of results that should
be returned. The default limit is 20. The
maximum limit is 400.

Searchable Attributes

Name Value Description

itemsReconciled string True returns all events that are reconciled.
False returns all events that are not
reconciled. Any returns events that are both
reconciled and not reconciled.
creationDateTimeFrom Date-Formatted String The date in which the integration event was
created. Typically coincides with the
effective date of a Change or a revisioning
event. Often combined with
creationDateTimeTo to create a range.
creationDateTimeTo Date-Formatted String The date in which the integration event was
created. Typically coincides with the
effective date of a Change or a revisioning
event. Often combined with
creationDateTimeFrom to create a range.

Note: Search behavior in the Arena REST API differs from search behavior in the Arena application. In the API, a
trailing asterisk (wildcard) is required to return results that start with a string; in the Arena application, a trailing
asterisk is always implied.

©2022 Arena, A PTC Business www.arenasolutions.com 301

 Arena REST API Developer Guide Endpoints

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

GET <url>/outboundintegrations/<GUID>/events

{
"count": 4,
"results": [
{
"change": {
"approvedOnDateTime": "2020-03-13T22:42:31Z",
"effectiveDateTime": "2020-03-13T22:42:37Z",
"effectivityType": "PERMANENT",
"guid": "WEYH0DYPCFY1K2IIMYQ7",
"number": "ECO-000022",
"title": "Critical Changes"
},
"creationDateTime": "2020-03-13T22:42:37Z",
"eventType": "CHANGE",
"guid": "1J3M5I3UHKV1K2IIMYQ7",
"itemsReconciled": false,
"status": "NEEDS_UPDATE"
},
{
"change": {
"approvedOnDateTime": "2020-03-13T22:47:34Z",
"effectiveDateTime": "2020-03-13T22:47:36Z",
"effectivityType": "PERMANENT",
"guid": "ZH1K3G1SFI14N5LLP1TU",
"number": "ECO-000023",
"title": "Critical Resistor Changes - Batch A"
},
"creationDateTime": "2020-03-13T22:47:36Z",

©2022 Arena, A PTC Business www.arenasolutions.com 302

 Arena REST API Developer Guide Endpoints

"eventType": "CHANGE",
"guid": "4M6P8L6XKNY4N5LLP1T3",
"itemsReconciled": false,
"status": "NEEDS_UPDATE"
},
{
"change": {
"approvedOnDateTime": "2020-03-13T22:51:34Z",
"effectiveDateTime": "2020-03-13T22:51:35Z",
"effectivityType": "PERMANENT",
"guid": "1J3M5I3UHK36P7NNR3VD",
"number": "ECO-000024",
"title": "Critical Changes Resistors - Batch 2"
},
"creationDateTime": "2020-03-13T22:51:35Z",
"eventType": "CHANGE",
"guid": "6O8RAN8ZMP06P7NNR3VZ",
"itemsReconciled": false,
"status": "NEEDS_UPDATE"
},
{
"change": {
"approvedOnDateTime": "2020-03-13T23:51:14Z",
"effectiveDateTime": "2020-03-13T23:51:15Z",
"effectivityType": "PERMANENT",
"guid": "4X7Q9B4WCS48G1USM7FL",
"number": "ECO-000025",
"title": "Critical Changes Resistors - Batch 3"
},
"creationDateTime": "2020-03-13T23:51:15Z",
"eventType": "CHANGE",
"guid": "612BDU3RQK72X2WOW3VQ",
"itemsReconciled": true,
"status": "NEEDS_UPDATE"
}
]
}

Get events that are not reconciled with a limit of 400 results

GET <url>/outboundintegrations/<GUID>/events?itemsReconciled=false&limit=400

{
"count": 3,
"results": [
{
"change": {
"approvedOnDateTime": "2020-03-13T22:42:31Z",
"effectiveDateTime": "2020-03-13T22:42:37Z",
"effectivityType": "PERMANENT",
"guid": "WEYH0DYPCFY1K2IIMYQ7",
"number": "ECO-000022",
"title": "Critical Changes"
},
"creationDateTime": "2020-03-13T22:42:37Z",

©2022 Arena, A PTC Business www.arenasolutions.com 303

 Arena REST API Developer Guide Endpoints

"eventType": "CHANGE",
"guid": "1J3M5I3UHKV1K2IIMYQ7",
"itemsReconciled": false,
"status": "NEEDS_UPDATE"
},
{
"change": {
"approvedOnDateTime": "2020-03-13T22:47:34Z",
"effectiveDateTime": "2020-03-13T22:47:36Z",
"effectivityType": "PERMANENT",
"guid": "ZH1K3G1SFI14N5LLP1TU",
"number": "ECO-000023",
"title": "Critical Resistor Changes - Batch A"
},
"creationDateTime": "2020-03-13T22:47:36Z",
"eventType": "CHANGE",
"guid": "4M6P8L6XKNY4N5LLP1T3",
"itemsReconciled": false,
"status": "NEEDS_UPDATE"
},
{
"change": {
"approvedOnDateTime": "2020-03-13T22:51:34Z",
"effectiveDateTime": "2020-03-13T22:51:35Z",
"effectivityType": "PERMANENT",
"guid": "1J3M5I3UHK36P7NNR3VD",
"number": "ECO-000024",
"title": "Critical Changes Resistors - Batch 2"
},
"creationDateTime": "2020-03-13T22:51:35Z",
"eventType": "CHANGE",
"guid": "6O8RAN8ZMP06P7NNR3VZ",
"itemsReconciled": false,
"status": "NEEDS_UPDATE"
}
]
}

Get events created within a specific time frame.

GET
<url>/outboundintegrations/<GUID>/events?creationDateTimeFrom=2020-10-25T10:00:00Z&creationDateTimeTo=2020-11-11T12:20:00Z

{
"count": 3,
"results": [
{
"change": {
"approvedOnDateTime": "2020-10-31T22:42:31Z",
"effectiveDateTime": "2020-10-31T22:42:37Z",
"effectivityType": "PERMANENT",
"guid": "QWEDH0DYPCFY1K2IIMYQ7",
"number": "ECO-000029",
"title": "Critical Changes"
},

©2022 Arena, A PTC Business www.arenasolutions.com 304

 Arena REST API Developer Guide Endpoints

"creationDateTime": "2020-10-26T22:42:37Z",
"eventType": "CHANGE",
"guid": "BP9M5I3UHKV1K2IIMYQ7",
"itemsReconciled": false,
"status": "NEEDS_UPDATE"
},
{
"change": {
"approvedOnDateTime": "2020-10-31T22:47:34Z",
"effectiveDateTime": "2020-10-31T22:47:36Z",
"effectivityType": "PERMANENT",
"guid": "QN4P3G1SFI14N5LLP1TU",
"number": "ECO-000030",
"title": "Critical Resistor Changes - Batch B"
},
"creationDateTime": "2020-10-28T22:47:36Z",
"eventType": "CHANGE",
"guid": "8J3C8L6XKNY4N5LLP1T3",
"itemsReconciled": false,
"status": "NEEDS_UPDATE"
},
...
]
}

Request with an invalid GUID.

GET /outboundintegrations/<GUID>/events

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"7D9W6F3TH0J3D9RATCFI\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 305

 Arena REST API Developer Guide Endpoints

GET Event
/outboundintegrations/<GUID>/events/<GUID>

Returns an Event object matching the GUID..

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Example below is from a revisioning event generated by a Change.

GET <url>/outboundintegrations/<GUID>/events/<GUID>

{
"change": {
"approvedOnDateTime": "2020-03-13T22:47:34Z",
"category": {
"categoryName": "Engineering Change Order",
"categoryPath": "Change\\Change Order\\Engineering Change Order",
"guid": "7P9SBO90NQ9J2L0778WO"
},
"effectiveDateTime": "2020-03-13T22:47:36Z",
"effectivityType": "PERMANENT",

©2022 Arena, A PTC Business www.arenasolutions.com 306

 Arena REST API Developer Guide Endpoints

"guid": "ZH1K3G1SFI14N5LLP1TU",
"number": "ECO-000023",
"title": "Critical Resistor Changes - Batch A"
},
"creationDateTime": "2020-03-13T22:47:36Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"eventType": "CHANGE",
"guid": "4M6P8L6XKNY4N5LLP1T3",
"itemsReconciled": false,
"status": "NEEDS_UPDATE"
}

Get Example below is from a revisioning event generated by the release or make effective commands.

GET <url>/outboundintegrations/<GUID>/events/<GUID>

{
"creationDateTime": "2020-03-14T06:46:36Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"eventType": "REVISIONING_EVENT",
"guid": "J1L4N0LCZ2DJ2K004G8V",
"itemsReconciled": false,
"revisioningEvent": {
"guid": "EWGZIVG7UXGJ2K004G84",
"number": "BCV2390803479",
"performedOnDateTime": "2020-03-14T06:46:35Z"
},
"status": "NEEDS_UPDATE"
}

Request with an invalid GUID.

GET /outboundintegrations/<GUID>/events

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"J1L4N0LCZDJ2K004G*D\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 307

 Arena REST API Developer Guide Endpoints

GET Event Item Guids

/outboundintegrations/<GUID>/events/<GUID>/itemguids

Returns a list of Item revision GUIDs from an integration event.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Searchable Attributes

Name Value Description

reconciled string Reconciled can equal true, false, or any. Any will return GUIDs for reconciled and
non-reconciled Items. If reconciled is omitted from the query string then the endpoint will
assume a default value of false.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get the Item GUIDs of reconciled and non-reconciled Items from a specific event from a specific integration.

GET <url>/outboundintegrations/<GUID>/events/<GUID>/itemguids?reconciled=any

©2022 Arena, A PTC Business www.arenasolutions.com 308

 Arena REST API Developer Guide Endpoints

{
"count": 7,
"results": [
"DVFYHUF6TWFN6OYHTLOY",
"N5P8R4PG36PXGY8R3VYR",
"XFZI1EZQDGZ7Q8I1D58C",
"8QATCPA1ORAI1JTCOGIQ",
"I0K3MZKBY1KSBT3MYQSN",
"SAUDW9UL8BU2L3DW8029",
"2K4N6J4VIL4CVDN6IAC0"
]
}

Get the Item GUIDs of non-reconciled Items from a specific event from a specific integration.

GET <url>/outboundintegrations/<GUID>/events/<GUID>/itemguids?reconciled=false

{
"count": 4,
"results": [
"DVFYHUF6TWFN6OYHTLOY",
"XFZI1EZQDGZ7Q8I1D58C",
"I0K3MZKBY1KSBT3MYQSN",
"2K4N6J4VIL4CVDN6IAC0"
]
}

Get the Item GUIDs of reconciled Items from a specific event from a specific integration.

GET /outboundintegrations/<GUID>/events/<GUID>/itemguids?reconciled=true

{
"count": 3,
"results": [
"N5P8R4PG36PXGY8R3VYR",
"8QATCPA1ORAI1JTCOGIQ",
"SAUDW9UL8BU2L3DW8029"
]
}

Request with an invalid GUID.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"4M6P8L6XKNY4N5LLP1T4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 309

 Arena REST API Developer Guide Endpoints

PUT Event
/outboundintegrations/<GUID>/events/<GUID>

Updates the reconciliation status for all Items in an event with a given GUID.

The user must be an integration administrator for the integration in order to perform this activity.

When the event's itemsReconciled property is set to true, then all the event's items reconciled flags are set to
true.

When the event's itemsReconciled property is set to false, then all the event's items reconciled flags are set to
false.

If the itemsReconciled is already set to the desired value (i.e. set to true, but it is already true), then the return
response code will be 200, but the action will not be performed.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"itemsReconciled": true
}

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 310

 Arena REST API Developer Guide Endpoints

Sample Responses
Updates the reconcilation status for all Items in a specific event when itemsReconciled is true.

/outboundintegrations/<GUID>/events/<GUID>

{
"change": {
"approvedOnDateTime": "2020-03-13T22:47:34Z",
"category": {
"categoryName": "Engineering Change Order",
"categoryPath": "Change\\Change Order\\Engineering Change Order",
"guid": "7P9SBO90NQ9J2L0778WO"
},
"effectiveDateTime": "2020-03-13T22:47:36Z",
"effectivityType": "PERMANENT",
"guid": "ZH1K3G1SFI14N5LLP1TU",
"number": "ECO-000023",
"title": "Critical Resistor Changes - Batch A"
},
"creationDateTime": "2020-03-13T22:47:36Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"eventType": "CHANGE",
"guid": "4M6P8L6XKNY4N5LLP1T3",
"itemsReconciled": true,
"status": "RECONCILED"
}

If the request body has an itemsReconciled value of false, the response would resemble below.

{
"change": {
"approvedOnDateTime": "2020-03-13T22:47:34Z",
"category": {
"categoryName": "Engineering Change Order",
"categoryPath": "Change\\Change Order\\Engineering Change Order",
"guid": "7P9SBO90NQ9J2L0778WO"
},
"effectiveDateTime": "2020-03-13T22:47:36Z",
"effectivityType": "PERMANENT",
"guid": "ZH1K3G1SFI14N5LLP1TU",
"number": "ECO-000023",
"title": "Critical Resistor Changes - Batch A"
},
"creationDateTime": "2020-03-13T22:47:36Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"eventType": "CHANGE",

©2022 Arena, A PTC Business www.arenasolutions.com 311

 Arena REST API Developer Guide Endpoints

"guid": "4M6P8L6XKNY4N5LLP1T3",
"itemsReconciled": false,
"status": "NEEDS_UPDATE"
}

Returns an error if:

1. the format of the request is incorrect:

{
"status": 400,
"errors": [
{
"code": 400,
"message": "The format of the request is not valid. Please check the syntax."

}
]
}

2. a GUID is invalid:

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"X9TCV8TK7AT1KZNA8V1Q\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 312

 Arena REST API Developer Guide Endpoints

GET Event Items

/outboundintegrations/<GUID>/events/<GUID>/items

Returns items of an outbound integrations matching the given search criteria.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all event items where results should begin. All event items
before the offset in the search results are ignored. The default value is 0.
limit integer Specifies the number of results that should be returned. The default limit is 20. The maximum
limit is 400.

Searchable Attributes

Name Value Description

reconciled string Reconciled can equal true, false, or any. Any
will return GUIDs for reconciled and
non-reconciled Items. If reconciled is
omitted from the query string then the
endpoint will assume a default value of
false.
reconciledDateTimeFrom Date-Formatted String The date in which the items in an event
were reconciled. Often combined with
reconciledDateTimeTo to search within a
range. The search attribute assumes that
reconciled is equal to true. If user provides
both
reconciledDateTimeFrom/reconciledDateTimeTo
with the search attribute reconciled, then
reconciled will not be assumed to be true
but will be the value set by the user.
reconciledDateTimeTo Date-Formatted String The date in which the items in an event
were reconciled. Often combined with
reconciledDateTimeFrom to search within
a range. The search attribute assumes that
reconciled is equal to true. If user provides
both

©2022 Arena, A PTC Business www.arenasolutions.com 313

 Arena REST API Developer Guide Endpoints

Name Value Description

reconciledDateTimeFrom/reconciledDateTimeTo
with the search attribute reconciled, then
reconciled will not be assumed to be true
but will be the value set by the user.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all non-reconciled Items associated with an event.

GET <URL>/outboundintegrations/<GUID>/events/<GUID>/items?reconciled=false

{
"count": 4,
"results": [
{
"effectiveItemRevision": {
"guid": "DVFYHUF6TWFN6OYHTLMW",
"name": "Resistor, 1M Ohm, 1/16W, 5%, 0402, SMD",
"number": "180-00008",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
},
"modifiedSpecs": false,
"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false

©2022 Arena, A PTC Business www.arenasolutions.com 314

 Arena REST API Developer Guide Endpoints

},
"guid": "O6Q9S5QH47IN6P8JA41O",
"reconciled": false,
"supersededItemRevision": {
"guid": "8QATCPA1ORAI1JTCOHOD",
"number": "180-00008",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
}
}
},
{
"effectiveItemRevision": {
"guid": "XFZI1EZQDGZ7Q8I1D56A",
"name": "Resistor, 3K Ohm, 1/16W, 5%, 0603, SMD",
"number": "180-00010",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
},
"modifiedSpecs": false,
"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false
},
"guid": "UCWFYBWNADOTCVEPGA7A",
"reconciled": false,
"supersededItemRevision": {
"guid": "I0K3MZKBY1KSBT3MYRQA",
"number": "180-00010",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
}
}
},
{
"effectiveItemRevision": {
"guid": "7P9SBO90NQ9H0ISBNFGV",
"name": "Resistor, 2M Ohm, 1/16W, 5%, 0603, SMD",
"number": "180-00011",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
},
"modifiedSpecs": false,

©2022 Arena, A PTC Business www.arenasolutions.com 315

 Arena REST API Developer Guide Endpoints

"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false
},
"guid": "XFZI1EZQDGRWFYHSJDAA",
"reconciled": false,
"supersededItemRevision": {
"guid": "7P9SBO90NQ9H0ISBNGAO",
"number": "180-00011",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
}
}
},
{
"effectiveItemRevision": {
"guid": "XFZI1EZQDGZ7Q535R6XM",
"name": "Resistor, Surface Mount, 240ohm, 1/10W, 0603",
"number": "180-00013",
"revisionNumber": "01",
"lifecyclePhase": {
"name": "Concept",
"stage": "DESIGN",
"guid": "4M6P8L6XKN58RATCU9I6"
},
"modifiedSpecs": true,
"modifiedBom": true,
"modifiedSourcing": true,
"modifiedFiles": true
},
"guid": "3L5O7K5WJMX2L4NYPJGP",
"reconciled": false
}
]
}

Get all reconciled |Items associated with an event.

GET <url>/outboundintegrations/<GUID>/events/<GUID>/items?reconciled=true

{
"count": 2,
"results": [
{
"effectiveItemRevision": {
"guid": "N5P8R4PG36PXGY8R3VWP",
"name": "Resistor, 47 Ohm, 1/10W, 5%, 0603, SMD",
"number": "180-00009",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",

©2022 Arena, A PTC Business www.arenasolutions.com 316

 Arena REST API Developer Guide Endpoints

"guid": "DVFYHUF6TWEH0J2L4EYV"
},
"modifiedSpecs": false,
"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false
},
"guid": "R9TCV8TK7ALQ9SBMD74N",
"reconciled": true,
"reconciledDateTime": "2020-03-16T01:40:30Z",
"reconciledUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"supersededItemRevision": {
"guid": "8QATCPA1ORAI1JTCOHK9",
"number": "180-00009",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
}
}
},
{
"effectiveItemRevision": {
"guid": "I0K3MZKBY1KSBT3MYQQB",
"name": "Resistor, 2.7K Ohm, 1/16W, 5%, 0402, SMD",
"number": "180-00012",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
},
"modifiedSpecs": false,
"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false
},
"guid": "0I2L4H2TGJUZI1KVMGDQ",
"reconciled": true,
"reconciledDateTime": "2020-03-16T01:40:30Z",
"reconciledUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"supersededItemRevision": {
"guid": "2K4N6J4VIL4CVDN6IBY3",
"number": "180-00012",
"revisionNumber": "A",
"lifecyclePhase": {

©2022 Arena, A PTC Business www.arenasolutions.com 317

 Arena REST API Developer Guide Endpoints

"name": "In Production",

"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
}
}
}
]
}

Get all Items (reconciled or non-reconciled) associated with an event.

GET <url>/outboundintegrations/<GUID>/events/<GUID>/items?reconciled=any

{
"count": 6,
"results": [
{
"effectiveItemRevision": {
"guid": "DVFYHUF6TWFN6OYHTLMW",
"name": "Resistor, 1M Ohm, 1/16W, 5%, 0402, SMD",
"number": "180-00008",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
},
"modifiedSpecs": false,
"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false
},
"guid": "O6Q9S5QH47IN6P8JA41O",
"reconciled": false,
"supersededItemRevision": {
"guid": "8QATCPA1ORAI1JTCOHOD",
"number": "180-00008",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
}
}
},
{
"effectiveItemRevision": {
"guid": "N5P8R4PG36PXGY8R3VWP",
"name": "Resistor, 47 Ohm, 1/10W, 5%, 0603, SMD",
"number": "180-00009",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"

©2022 Arena, A PTC Business www.arenasolutions.com 318

 Arena REST API Developer Guide Endpoints

},
"modifiedSpecs": false,
"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false
},
"guid": "R9TCV8TK7ALQ9SBMD74N",
"reconciled": true,
"reconciledDateTime": "2020-03-16T01:40:30Z",
"reconciledUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"supersededItemRevision": {
"guid": "8QATCPA1ORAI1JTCOHK9",
"number": "180-00009",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
}
}
},
{
"effectiveItemRevision": {
"guid": "XFZI1EZQDGZ7Q8I1D56A",
"name": "Resistor, 3K Ohm, 1/16W, 5%, 0603, SMD",
"number": "180-00010",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
},
"modifiedSpecs": false,
"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false
},
"guid": "UCWFYBWNADOTCVEPGA7A",
"reconciled": false,
"supersededItemRevision": {
"guid": "I0K3MZKBY1KSBT3MYRQA",
"number": "180-00010",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
}
}
},
{

©2022 Arena, A PTC Business www.arenasolutions.com 319

 Arena REST API Developer Guide Endpoints

"effectiveItemRevision": {
"guid": "7P9SBO90NQ9H0ISBNFGV",
"name": "Resistor, 2M Ohm, 1/16W, 5%, 0603, SMD",
"number": "180-00011",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
},
"modifiedSpecs": false,
"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false
},
"guid": "XFZI1EZQDGRWFYHSJDAA",
"reconciled": false,
"supersededItemRevision": {
"guid": "7P9SBO90NQ9H0ISBNGAO",
"number": "180-00011",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
}
}
},
{
"effectiveItemRevision": {
"guid": "I0K3MZKBY1KSBT3MYQQB",
"name": "Resistor, 2.7K Ohm, 1/16W, 5%, 0402, SMD",
"number": "180-00012",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
},
"modifiedSpecs": false,
"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false
},
"guid": "0I2L4H2TGJUZI1KVMGDQ",
"reconciled": true,
"reconciledDateTime": "2020-03-16T01:40:30Z",
"reconciledUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"supersededItemRevision": {
"guid": "2K4N6J4VIL4CVDN6IBY3",
"number": "180-00012",

©2022 Arena, A PTC Business www.arenasolutions.com 320

 Arena REST API Developer Guide Endpoints

"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
}
}
},
{
"effectiveItemRevision": {
"guid": "XFZI1EZQDGZ7Q535R6XM",
"name": "Resistor, Surface Mount, 240ohm, 1/10W, 0603",
"number": "180-00013",
"revisionNumber": "01",
"lifecyclePhase": {
"name": "Concept",
"stage": "DESIGN",
"guid": "4M6P8L6XKN58RATCU9I6"
},
"modifiedSpecs": true,
"modifiedBom": true,
"modifiedSourcing": true,
"modifiedFiles": true
},
"guid": "3L5O7K5WJMX2L4NYPJGP",
"reconciled": false
}
]
}

Get all Items (reconciled or non-reconciled) associated with an event within a specific date and time.

GET
<url>/outboundintegrations/<GUID>/events/<GUID>/items?reconciledDateTimeFrom=2020-12-16T12:29:00Z&reconciledDateTimeTo=2020-12-18T23:59:59Z

{
"count": 2,
"results": [
{
"effectiveItemRevision": {
"guid": "Q7B3R4PG36PXGY8R3VWP",
"name": "Resistor, 48 Ohm, 1/10W, 5%, 0603, SMD",
"number": "180-00019",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
},
"modifiedSpecs": false,
"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false
},
"guid": "F5KJQ8TK7ALQ9SBMD74N",

©2022 Arena, A PTC Business www.arenasolutions.com 321

 Arena REST API Developer Guide Endpoints

"reconciled": true,
"reconciledDateTime": "2020-12-17T01:40:30Z",
"reconciledUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"supersededItemRevision": {
"guid": "9DHWTE1ORAI1JTCOHK9",
"number": "180-00019",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
}
}
},
...
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 322

 Arena REST API Developer Guide Endpoints

GET Event Item

Returns an Item from an integration event with a given GUID.

/outboundintegrations/<GUID>/events/<GUID/items/<GUID>

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get an Item from an integration event.

GET /outboundintegrations/<GUID>/events/<GUID>/items/<GUID>

{
"effectiveItemRevision": {
"guid": "N5P8R4PG36PXGY8R3VWP",
"name": "Resistor, 47 Ohm, 1/10W, 5%, 0603, SMD",
"number": "180-00009",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"

©2022 Arena, A PTC Business www.arenasolutions.com 323

 Arena REST API Developer Guide Endpoints

},
"modifiedSpecs": false,
"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false
},
"guid": "R9TCV8TK7ALQ9SBMD74N",
"reconciled": true,
"reconciledDateTime": "2020-03-16T01:40:30Z",
"reconciledUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"supersededItemRevision": {
"guid": "8QATCPA1ORAI1JTCOHK9",
"number": "180-00009",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
}
}
}

request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 324

 Arena REST API Developer Guide Endpoints

PUT Event Item

/outboundintegrations/<GUID>/events/<GUID>/items/<GUID>

The final GUID in the above URL refers to the Event Item GUID and not the revision Item GUID.

Updates the reconciliation status for a specific event Item with a GUID in an event with a given GUID.

The user must be an integration administrator for the integration in order to perform this activity.

The event's itemsReconciled property depends on the event item's reconciled property. Changing the event
item reconciled property may change the event's itemsReconciled property.

If the item's Reconciled property is already set to the desired value (i.e. set to true, but it is already true), then
the return response code will be 200, but the action will not be performed.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"reconciled": true
}

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 325

 Arena REST API Developer Guide Endpoints

Sample Responses
Below is the response when the Request Body has a reonciled value of true.

/outboundintegrations/<GUID>/events/<GUID>/items/<GUID>

{
"effectiveItemRevision": {
"guid": "N5P8R4PG36PXGY8R3VWP",
"name": "Resistor, 47 Ohm, 1/10W, 5%, 0603, SMD",
"number": "180-00009",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
},
"modifiedSpecs": false,
"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false
},
"guid": "R9TCV8TK7ALQ9SBMD74N",
"reconciled": true,
"reconciledDateTime": "2020-03-16T04:33:21Z",
"reconciledUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"supersededItemRevision": {
"guid": "8QATCPA1ORAI1JTCOHK9",
"number": "180-00009",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
}
}
}

If the request body has an itemsReconciled value of false, the response would resemble below.

/outboundintegrations/<GUID>/events/<GUID>/items/<GUID>

{
"effectiveItemRevision": {
"guid": "N5P8R4PG36PXGY8R3VWP",
"name": "Resistor, 47 Ohm, 1/10W, 5%, 0603, SMD",
"number": "180-00009",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",

©2022 Arena, A PTC Business www.arenasolutions.com 326

 Arena REST API Developer Guide Endpoints

"guid": "DVFYHUF6TWEH0J2L4EYV"
},
"modifiedSpecs": false,
"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false
},
"guid": "R9TCV8TK7ALQ9SBMD74N",
"reconciled": false,
"supersededItemRevision": {
"guid": "8QATCPA1ORAI1JTCOHK9",
"number": "180-00009",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
}
}
}

Returns an error if:

1. the format of the request is incorrect:

{
"status": 400,
"errors": [
{
"code": 400,
"message": "The format of the request is not valid. Please check the syntax."

}
]
}

2. a GUID is invalid:

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"X9TCV8TK7AT1KZNA8V1Q\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 327

 Arena REST API Developer Guide Endpoints

GET Requests
/requests

Returns a collection of Requests objects matching the given search criteria. Note that the Requests returned
here are a compact version. For a full Request object, use the GET Request endpoint GET/requests/guid.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all
changes where results should begin. All
changes before the offset in the search
results are ignored. The default value is 0.
limit integer Specifies the number of results that should
be returned. By default the maximum
number of items is 20. Can return up 400
changes.

Searchable Attributes

Name Value Description

[additional attribute guid value] string This special search permits searching for
strings in additional attribute values. For
example GET
/items?VDXGZ7E0GO5N6P8PR55G=*100pF
where VDXGZ7E0GO5N6P8PR55G is the
GUID of a custom attribute and we are
searching for all items whose value for this
attribute include the string "100pF". The
ability to search for more than one value is
available for the following attribute field
types: DROP_DOWN & FIXED_DROPDOWN
(where multi-select is true). See note below
this table for additional details.

Additional attributes, also known as custom

attributes, support the date field type. Users
can perform searches by additional
attributes with a date field type by using

©2022 Arena, A PTC Business www.arenasolutions.com 328

 Arena REST API Developer Guide Endpoints

Name Value Description

the format yyyy-mm-dd. In the following
example, the user is using the following to
search for a date field type custom attribute
with a value of April 1, 2019:

GET
/requests?4M6PUJNPNM3L4N25ZZ5F=2019-04-01
category.guid string category unique ID
creator.guid string creator user unique ID
deferralCode string Denotes the nature of a deferred Request.
Values can be customized within Workspace
Settings.
lifecycleStatus.type string lifecycle status of the request. Values can
be UNSUBMITTED, SUBMITTED, DEFERRED,
PROMOTED, or CLOSED
number string number of the request
requestCode string Denotes the nature of the request. Set at
Request creation. Possible values can be
customized within Workspace Settings.
resolutionCode string Denotes the nature of a Promoted or Closed
Request. Values can be customized within
Workspace Settings.
submissionDateTimeFrom Date-Formatted String the date and time (in Zulu format) a request
is submitted. Returns all Requests that are
submitted after this date.
submissionDateTimeTo Date-Formatted String the date and time (in Zulu format) a request
was submitted. Returns all Requests
submitted before this date.
title string title of the Request.

Note: Search behavior in the Arena REST API differs from search behavior in the Arena application. In the API, a
trailing asterisk (wildcard) is required to return results that start with a string; in the Arena application, a trailing
asterisk is always implied.

Response Codes

Code Description
200 Success
400 Failure

©2022 Arena, A PTC Business www.arenasolutions.com 329

 Arena REST API Developer Guide Endpoints

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all Requests

GET /requests

{
"count": 9,
"results": [
{
"category": {
"guid": "I0K3MZKBY1KUDWBIIJ7C",
"name": "Manufacturing Change Request"
},
"creationDateTime": "2011-07-11T19:52:59Z",
"creator": {
"email": "[email protected]",
"fullName": "Yvette Keller",
"guid": "VDXGZCXOBEVEXGZIWZJK"
},
"deferDeadlineDateTime": null,
"deferralCode": null,
"evaluatorGroup": {
"guid": "3L5O7K5WJM3K3M5O5JDC",
"name": "Product Enhancement"
},
"guid": "N5P8R4PG36PO7QXI618R",
"lifecycleDateTime": "2011-07-11T19:52:59Z",
"lifecycleStatus": {
"type": "UNSUBMITTED"
},
"number": "MCR-000001",
"problem": "In manufacturing we are finding that the phillips pan head
screws on the EveryRoad GPS Model 300 are not holding the screw driver bits very
well. We are using pneumatic screw drivers and they are disengaging as we assemble
the product. The sudden jumps and slips are sometimes leaving track marks on the
plastic shells.",
"requestCode": "Manufacturability",
"requestedAction": "Please change the screws in the EveryRoad GPS from
a phillips head drive style to a torx head drive style. Torx provides better engagement
and will make it easier to assembled the product.",

©2022 Arena, A PTC Business www.arenasolutions.com 330

 Arena REST API Developer Guide Endpoints

"resolutionCode": null,
"submissionDateTime": null,
"submitter": null,
"title": "Change drive style for EveryRoad screws from Phillips to Torx"

},
{
"category": {
"guid": "HZJ2LYJAX0JTCVAHHI66",
"name": "Engineering Change Request"
},
"creationDateTime": "2011-07-11T23:28:57Z",
"creator": {
"email": "[email protected]",
"fullName": "Yvette Keller",
"guid": "VDXGZCXOBEVEXGZIWZJK"
},
"deferDeadlineDateTime": null,
"deferralCode": null,
"evaluatorGroup": {
"guid": "4M6P8L6XKN4L4N6P7X7E",
"name": "Engineering plus Board Supplier"
},
"guid": "O6Q9S5QH47QP8RYJ729F",
"lifecycleDateTime": "2011-08-09T22:32:56Z",
"lifecycleStatus": {
"type": "PROMOTED"
},
"number": "ECR-000002",
"problem": "We've had some reports of EveryRoad 300's rear panel melting
and in one case, a probable fire. All melting situations have occurred on vehicle
dashboards. Because of the risk of lawsuits associated with this problem, we are
ranking it as high-urgency.",
"requestCode": "Performance",
"requestedAction": "Engineering should begin thermal testing / analysis
immediately to determine what might be causing this problem.",
"resolutionCode": "Approved [Immediate]",
"submissionDateTime": "2011-08-04T20:25:47Z",
"submitter": {
"email": "[email protected]",
"fullName": "John Parker",
"guid": "XFZI1EZQDGXGZI1KTJQ2"
},
"title": "EveryRoad Model 300 Case Melting"
},
{
"category": {
"guid": "I0K3MZKBY1KUDWBIIJ7C",
"name": "Manufacturing Change Request"
},
"creationDateTime": "2011-07-11T20:01:22Z",
"creator": {
"email": "[email protected]",
"fullName": "Yvette Keller",
"guid": "VDXGZCXOBEVEXGZIWZJK"

©2022 Arena, A PTC Business www.arenasolutions.com 331

 Arena REST API Developer Guide Endpoints

},
"deferDeadlineDateTime": null,
"deferralCode": null,
"evaluatorGroup": null,
"guid": "P7RAT6RI58RQ9SZK83AX",
"lifecycleDateTime": "2011-07-11T20:01:22Z",
"lifecycleStatus": {
"type": "UNSUBMITTED"
},
"number": "MCR-000002",
"problem": "The model 300 seems to show fingerprints on the enclosure.
The problem, while not affecting performance, is visually ugly. Can anything be
done?",
"requestCode": "Performance",
"requestedAction": "Please investigate new materials or textures for the
EveryRoad housing.",
"resolutionCode": null,
"submissionDateTime": null,
"submitter": null,
"title": "Fingerprints show readily on the EveryRoad housing"
},
...
]
}

Get promoted changes in category Engineering Change Request.

GET
<url>/requests?lifecycleStatus.type=PROMOTED&category.guid=HZJ2LYJAX0JTCVAHHI66

{
"count": 2,
"results": [
{
"category": {
"guid": "HZJ2LYJAX0JTCVAHHI66",
"name": "Engineering Change Request"
},
"creationDateTime": "2011-07-11T23:28:57Z",
"creator": {
"email": "[email protected]",
"fullName": "Yvette Keller",
"guid": "VDXGZCXOBEVEXGZIWZJK"
},
"deferDeadlineDateTime": null,
"deferralCode": null,
"evaluatorGroup": {
"guid": "4M6P8L6XKN4L4N6P7X7E",
"name": "Engineering plus Board Supplier"
},
"guid": "O6Q9S5QH47QP8RYJ729F",
"lifecycleDateTime": "2011-08-09T22:32:56Z",
"lifecycleStatus": {
"type": "PROMOTED"
},

©2022 Arena, A PTC Business www.arenasolutions.com 332

 Arena REST API Developer Guide Endpoints

"number": "ECR-000002",
"problem": "We've had some reports of EveryRoad 300's rear panel melting
and in one case, a probable fire. All melting situations have occurred on vehicle
dashboards. Because of the risk of lawsuits associated with this problem, we are
ranking it as high-urgency.",
"requestCode": "Performance",
"requestedAction": "Engineering should begin thermal testing / analysis
immediately to determine what might be causing this problem.",
"resolutionCode": "Approved [Immediate]",
"submissionDateTime": "2011-08-04T20:25:47Z",
"submitter": {
"email": "[email protected]",
"fullName": "John Parker",
"guid": "XFZI1EZQDGXGZI1KTJQ2"
},
"title": "EveryRoad Model 300 Case Melting"
},
{
"category": {
"guid": "HZJ2LYJAX0JTCVAHHI66",
"name": "Engineering Change Request"
},
"creationDateTime": "2011-07-11T22:55:16Z",
"creator": {
"email": "[email protected]",
"fullName": "Yvette Keller",
"guid": "VDXGZCXOBEVEXGZIWZJK"
},
"deferDeadlineDateTime": null,
"deferralCode": null,
"evaluatorGroup": {
"guid": "3L5O7K5WJM3K3M5O5JDC",
"name": "Product Enhancement"
},
"guid": "Q8SBU7SJ69SRAT0L94BE",
"lifecycleDateTime": "2014-10-28T21:20:07Z",
"lifecycleStatus": {
"type": "PROMOTED"
},
"number": "ECR-000001",
"problem": "EveryRoad Model 300 is currently mounted directly to a car
dashboard through a loop and hook (Velcro) system. Product management has received
significant complaints that this mounting system does not work well on certain cars
or the owners do not want to have adhesive on their dashboard.",
"requestCode": "Performance",
"requestedAction": "Find a method of mounting the EveryRoad GPS Model
300 which:\n1) Is flexible to fit on many different cars\n2) Does not require adhesive
to be in direct contact with a car",
"resolutionCode": "Approved [Immediate]",
"submissionDateTime": "2011-07-20T22:16:33Z",
"submitter": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},

©2022 Arena, A PTC Business www.arenasolutions.com 333

 Arena REST API Developer Guide Endpoints

"title": "Alternate Mounting Solution for EveryRoad GPS"

}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 334

 Arena REST API Developer Guide Endpoints

GET Request
/requests/<GUID>

Returns a Request object with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a request with a unique GUID

GET /requests/<GUID>

{
"category": {
"guid": "HZJ2LYJAX0JTCVAHHI66",
"name": "Engineering Change Request"
},
"creationDateTime": "2011-07-11T22:55:16Z",
"creator": {
"email": "[email protected]",
"fullName": "Yvette Keller",
"guid": "VDXGZCXOBEVEXGZIWZJK"
},
"deferDeadlineDateTime": null,

©2022 Arena, A PTC Business www.arenasolutions.com 335

 Arena REST API Developer Guide Endpoints

"deferralCode": null,
"dispositionType": null,
"evaluatorGroup": {
"guid": "3L5O7K5WJM3K3M5O5JDC",
"name": "Product Enhancement"
},
"guid": "Q8SBU7SJ69SRAT0L94BE",
"lifecycleDateTime": "2014-10-28T21:20:07Z",
"lifecycleStatus": {
"type": "PROMOTED"
},
"number": "ECR-000001",
"problem": "EveryRoad Model 300 is currently mounted directly to a car dashboard
through a loop and hook (Velcro) system. Product management has received significant
complaints that this mounting system does not work well on certain cars or the owners
do not want to have adhesive on their dashboard.",
"requestCode": "Performance",
"requestedAction": "Find a method of mounting the EveryRoad GPS Model 300
which:\n1) Is flexible to fit on many different cars\n2) Does not require adhesive
to be in direct contact with a car",
"resolutionCode": "Approved [Immediate]",
"submissionDateTime": "2011-07-20T22:16:33Z",
"submitter": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"title": "Alternate Mounting Solution for EveryRoad GPS"
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"ASCVERC3QTCFYGPWW1WCS\" is not valid"
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 336

 Arena REST API Developer Guide Endpoints

POST Request Create

/requests

In all cases, numberSequencePrefix is required. If a default numberSequencePrefix is associated with the

specified request category, not specifying a numberSequencePrefix will result in automatically selecting the
default.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Create Request.

POST /requests

Request

{
"category": {
"guid": "HZJ2LYJAX0JTCVAHHI66"
},
"creatorParticipation": false,
"evaluatorGroup": {

©2022 Arena, A PTC Business www.arenasolutions.com 337

 Arena REST API Developer Guide Endpoints

"guid": "SAUDW9UL8BS9SBUDUHW0"
},
"numberSequencePrefix": {
"value": "ECR-"
},
"title": "Melted Bezels on Model 360",
"problem": "Unit is overheating",
"requestCode": "Cost",
"requestedAction": "Add Additional Fans and Heat Sinks"
}

Response

{
"category": {
"guid": "HZJ2LYJAX0JTCVAHHI66",
"name": "Engineering Change Request"
},
"creationDateTime": "2021-09-06T05:36:54Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"deferDeadlineDateTime": null,
"deferralCode": null,
"dispositionType": null,
"evaluatorGroup": {
"guid": "SAUDW9UL8BS9SBUDUHW0",
"name": "ECR Review Board"
},
"guid": "SAUDW9UL8BUTCVRBA53C",
"lifecycleDateTime": "2021-09-06T05:36:54Z",
"lifecycleStatus": {
"type": "UNSUBMITTED"
},
"number": "ECR-000009",
"problem": "Unit is overheating",
"requestCode": "Cost",
"requestedAction": "Add Additional Fans and Heat Sinks",
"resolutionCode": null,
"submissionDateTime": null,
"submitter": null,
"title": "Melted Bezels on Model 360"
}

©2022 Arena, A PTC Business www.arenasolutions.com 338

 Arena REST API Developer Guide Endpoints

PUT Request Edit

/requests/<GUID>

Updates attribute information for a Request with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Edit a Request.

/requests/<GUID>

Request

{
"category": {
"guid": "GYI1KXI9WZISBU9GGH53"
},
"title": "Melted Bezels on Model 400",
"problem": "Unit PCB is overheating",
"requestCode": "Performance"
}

©2022 Arena, A PTC Business www.arenasolutions.com 339

 Arena REST API Developer Guide Endpoints

Response

{
"category": {
"guid": "GYI1KXI9WZISBU9GGH53",
"name": "Document Change Request"
},
"creationDateTime": "2021-09-06T05:36:54Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"deferDeadlineDateTime": null,
"deferralCode": null,
"dispositionType": null,
"evaluatorGroup": {
"guid": "SAUDW9UL8BS9SBUDUHW0",
"name": "ECR Review Board"
},
"guid": "SAUDW9UL8BUTCVRBA53C",
"lifecycleDateTime": "2021-09-06T05:36:54Z",
"lifecycleStatus": {
"type": "UNSUBMITTED"
},
"number": "ECR-000009",
"problem": "Unit PCB is overheating",
"requestCode": "Performance",
"requestedAction": "Add Additional Fans and Heat Sinks",
"resolutionCode": null,
"submissionDateTime": null,
"submitter": null,
"title": "Melted Bezels on Model 400"
}

Request with invalid GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"ASCVERC3QTCFYGPWW1WCS\" is not valid"
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 340

 Arena REST API Developer Guide Endpoints

DELETE Request
/requests/<GUID>

Deletes a Request with a given GUID. Requests can only be deleted in the Open and Unsubmitted, Deferred,
and Closed lifecycle statuses.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response.

Request with invalid GUID

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 341

 Arena REST API Developer Guide Endpoints

GET Request Items

/requests/<GUID>/items

Returns all Request Items included in a request with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all items included in a request

GET /requests/<GUID>/items

{
"count": 3,
"results": [
{
"guid": "TBVEXAVM9CPO7QZFFDRY",
"item": {
"guid": "3L5O7K5WJM5DWEO7JBIR",
"name": "Screw, M3 x 6, ST, Torx",
"number": "472-00001",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {

©2022 Arena, A PTC Business www.arenasolutions.com 342

 Arena REST API Developer Guide Endpoints

"api":
"https://api.arenasolutions.com/v1/items/3L5O7K5WJM5DWEO7JBIR",
"app": "https://app.bom.com/3L5O7K5WJM5DWEO7JBIR"
}
},
"notes": "Similar to 472-00002 but with Torx drive style"
},
{
"guid": "UCWFYBWNADQP8R0GGESV",
"item": {
"guid": "7P9SBO90NQ9H0IRHBGKB",
"name": "Screw, M3 x 6, ST, PH",
"number": "472-00002",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {
"api":
"https://api.arenasolutions.com/v1/items/UCWFYBWNADQP8R0GGESV",
"app": "https://app.bom.com/UCWFYBWNADQP8R0GGESV"
}
},
"notes": "Self-tapping Pan head screw with Phillips drive style"
},
{
"guid": "VDXGZCXOBERQ9S1HHFT8",
"item": {
"guid": "HZJ2LYJAX0JRAS1RLQU7",
"name": "Screw, M2 x 5, ST, PH",
"number": "472-00003",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {
"api":
"https://api.arenasolutions.com/v1/items/HZJ2LYJAX0JRAS1RLQU7",
"app": "https://app.bom.com/HZJ2LYJAX0JRAS1RLQU7"
}
},
"notes": "Self-tapping Pan head screw with Phillips drive style"
},
]
}

Request with invalid GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 343

 Arena REST API Developer Guide Endpoints

GET Request Affected Item

/requests/<GUID>/items/<GUID>

Returns a Request Item with a given GUID included in a request with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a specific item included in a request

GET /requests/<GUID>/items/<GUID>

{
"guid": "TBVEXAVM9CPO7QZFFDRY",
"item": {
"guid": "3L5O7K5WJM5DWEO7JBIR",
"name": "Screw, M3 x 6, ST, Torx",
"number": "472-00001",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "https://api.arenasolutions.com/v1/items/3L5O7K5WJM5DWEO7JBIR",
"app": "https://app.bom.com/3L5O7K5WJM5DWEO7JBIR"
}

©2022 Arena, A PTC Business www.arenasolutions.com 344

 Arena REST API Developer Guide Endpoints

},
"notes": "Similar to 472-00002 but with Torx drive style"
}

Request with invalid GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 345

 Arena REST API Developer Guide Endpoints

POST Request Item Add

/requests/<GUID>/items

Adds an item to a request with a specific GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

Add an item to a request, specifying notes.

/requests/<GUID>/items

{
"item": {
"guid": "1J3M5I3UHK3BUCLB5AED"
},
"notes": "This is overheating the forward unit."
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 346

 Arena REST API Developer Guide Endpoints

Sample Response Body

{
"guid": "DVFYHUF6TW98RAB185YV",
"item": {
"guid": "1J3M5I3UHK3BUCLB5AED",
"name": "Manual, Everyroad Model 300/500",
"number": "770-00001",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "https://api.arenasolutions.com/v1/items/3L5O7K5WJM5DWEO7JBIR",
"app": "https://app.bom.com/3L5O7K5WJM5DWEO7JBIR"
}
},
"notes": "This is overheating the forward unit."
}

Request with invalid GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 347

 Arena REST API Developer Guide Endpoints

PUT Request Item Edit

/requests/<GUID>/items/<GUID>

Updates the notes for an item on a request with a given request-item association GUID, included in a request
with a given GUID..

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"notes": "Edit: This will be affected by the solution."
}

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Update the notes information for an item on a request

/requests/<GUID>/items/<GUID>

{
"guid": "CUEXGTE5SV87Q9A3DB9W",
"item": {

©2022 Arena, A PTC Business www.arenasolutions.com 348

 Arena REST API Developer Guide Endpoints

"guid": "R9TCV8TK7AT1KZNA8V5I",
"name": "Gasket, 3.75 in",
"number": "437-00002",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "https://api.arenasolutions.com/v1/items/R9TCV8TK7AT1KZNA8V5I",
"app": "https://app.bom.com/R9TCV8TK7AT1KZNA8V5I"
}
},
"notes": "Edit: This will be affected by the solution."
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 349

 Arena REST API Developer Guide Endpoints

DELETE Request Item

requests/<GUID>/items/<GUID>

Removes an item with a given GUID from a request with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
• No JSON response.

• Request with invalid GUID (item not included in change)

{
"status":400,
"errors":[
{
"code":3012,
"message":"The requested object with guid \"UCWFYFYEAN5YH0JSFPEP\" is not
found."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 350

 Arena REST API Developer Guide Endpoints

GET Request File View Associations

/requests/<GUID>/files

Returns a list of files for a Request with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Request Files View Associations

GET <url>/requests/<GUID>/files

{
"count": 5,
"results": [
{
"file": {
"author": {
"fullName": "Kathy Davies"
},
"category": {
"guid": "CUEXGTE5SVEO7Q5CCD07",

©2022 Arena, A PTC Business www.arenasolutions.com 351

 Arena REST API Developer Guide Endpoints

"name": "Image"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2011-06-16T21:36:24Z",
"description": "Rendered and color from 20-0002 base drawing",
"edition": "2",
"format": "png",
"guid": "CUEXGTE5SVEUDWZQCIWW",
"hasMarkup": false,
"lastModifiedDateTime": "2011-06-16T21:36:24Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "image/x-png",
"name": "EveryRoad Render4.png",
"number": "FILE-000875",
"private": false,
"size": 74607,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "EveryRoad GPS Car Navigation Unit - Model 300, Rendering"
},
"guid": "3L5O7K5WJM39SBAEY0X0"
},
{
"file": {
"author": {
"fullName": "Heidi Walker"
},
"category": {
"guid": "2K4N6J4VIL4EXGV223PR",
"name": "-uncategorized-"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2011-08-31T18:12:53Z",
"description": "PDF output of CAD rendering for ERGPS 300 board.",
"edition": "1",
"format": "pdf",
"guid": "Q8SBU7SJ69S8RAB9QGAJ",
"hasMarkup": false,
"lastModifiedDateTime": "2011-08-31T18:12:53Z",
"latest": true,
"location": null,
"locked": false,
"mimeType": "application/pdf",
"name": "EveryRoad GPS Car Navigation Unit - Model 300, Rendering.pdf",

"number": "FILE-000948",
"private": false,
"size": 8690,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "EveryRoad GPS Car Navigation Unit - Model 300, Rendering"

©2022 Arena, A PTC Business www.arenasolutions.com 352

 Arena REST API Developer Guide Endpoints

},
"guid": "4M6P8L6XKN4ATCBFZ1YG"
},
{
"file": {
"author": {
"fullName": "Heidi Walker"
},
"category": {
"guid": "2K4N6J4VIL4EXGV223PR",
"name": "-uncategorized-"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2011-08-31T18:11:23Z",
"description": "ERGPS MPI for assembling 300 PCBA.",
"edition": "1",
"format": "pdf",
"guid": "ASCVERC3QTCSBUVTA0U1",
"hasMarkup": false,
"lastModifiedDateTime": "2011-08-31T18:11:23Z",
"latest": true,
"location": null,
"locked": false,
"mimeType": "application/pdf",
"name": "MPI, ERGPS 300 Board.pdf",
"number": "FILE-000947",
"private": false,
"size": 8690,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "MPI, ERGPS 300 Board"
},
"guid": "5N7Q9M7YLO5BUDCG02ZY"
},
...
]
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 353

 Arena REST API Developer Guide Endpoints

GET Request Files View Association

/requests/<GUID>/files/<GUID>

Returns a specific Request-File association with a given GUID from the Files view of a specific Request with a
given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Request Files View Association

GET <url>/requests/<GUID>/files/<GUID>

{
"file": {
"author": {
"fullName": "Heidi Walker"
},
"category": {
"guid": "2K4N6J4VIL4EXGV223PR",
"name": "-uncategorized-"
},

©2022 Arena, A PTC Business www.arenasolutions.com 354

 Arena REST API Developer Guide Endpoints

"checkedOut": false,
"corrected": false,
"creationDateTime": "2011-08-31T18:11:23Z",
"description": "ERGPS MPI for assembling 300 PCBA.",
"edition": "1",
"format": "pdf",
"guid": "ASCVERC3QTCSBUVTA0U1",
"hasMarkup": false,
"lastModifiedDateTime": "2011-08-31T18:11:23Z",
"latest": true,
"location": null,
"locked": false,
"mimeType": "application/pdf",
"name": "MPI, ERGPS 300 Board.pdf",
"number": "FILE-000947",
"private": false,
"size": 8690,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "MPI, ERGPS 300 Board"
},
"guid": "5N7Q9M7YLO5BUDCG02ZY"
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 355

 Arena REST API Developer Guide Endpoints

POST Request Files View Add Existing File

/requests/<GUID>/files

Associates an existing File Association object with the Files view of a Request with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Sample Request Body

{
"file": {
"guid": "XFZI1EZQDGZFYHKBX3JI"
}
}

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Associate an existing file with a Request

/requests/<GUID>/files

{
"file": {

©2022 Arena, A PTC Business www.arenasolutions.com 356

 Arena REST API Developer Guide Endpoints

"author": {
"fullName": "George C Lewis"
},
"category": {
"guid": "CUEXGTE5SVEO7Q5CCD07",
"name": "Image"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2011-06-02T19:30:28Z",
"description": null,
"edition": "1",
"format": "jpg",
"guid": "XFZI1EZQDGZFYHKBX3JI",
"hasMarkup": false,
"lastModifiedDateTime": "2011-06-02T19:30:28Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "image/jpeg",
"name": "ZIP-PWR-AC.jpg",
"number": "FILE-000926",
"private": false,
"size": 4494,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "Zip-LinQ US Adapter Image"
},
"guid": "HZJ2LYJAX0HN6PORLJZA"
}

An error is returned if the GUID is not valid.

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 357

 Arena REST API Developer Guide Endpoints

DELETE Request File View Association

/requests/<GUID>/files/<GUID>

Removes a File association from the Files view of a Request with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response.

Produces an error if the requested file association does not exist.

{
"status": 400,
"errors": [
{
"code": 3029,
"message": "The file association does not exist between object
\"Q8SBG6CHGDWDWB7W8EJG\" and object \"EWGZ4U0541K0J2TJSQGG\"."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 358

 Arena REST API Developer Guide Endpoints

GET Request File Markups

/requests/<GUID>/markupfiles

Returns a collection of Markup Files associated with a specific Request.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get File Markups of a Request File with a given GUID

GET <url>/requests/<GUID>/markupfiles

{
"count": 2,
"results": [
{
"guid": "3L5O7K5WJM0N6PL54KRE",
"markup": {
"author": {
"fullName": "Jamie Smith"
},
"category": {

©2022 Arena, A PTC Business www.arenasolutions.com 359

 Arena REST API Developer Guide Endpoints

"guid": "0I2L4H2TGJ2CVET001OY"
},
"creationDateTime": "2021-01-22T19:51:01Z",
"format": "333",
"guid": "Q8SBU7SJ69S8RA07P9F9",
"lastModifiedDateTime": "2021-01-22T19:59:08Z",
"locked": false,
"mimeType": "application/pdf",
"name": "ergps-300-schematic.pdf",
"size": 260178,
"storageMethodName": "FILE",
"title": "1004"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"reserved": true,
"reservedUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
},
{
"guid": "4M6P8L6XKN1O7QM65LS5",
"markup": {
"author": {
"fullName": "Jamie Smith"
},
"category": {
"guid": "2K4N6J4VIL4EXGV223PR"
},
"creationDateTime": "2021-01-22T03:31:04Z",
"format": "Web",
"guid": "FXH0JWH8VYHXGZPWEY43",
"lastModifiedDateTime": "2021-01-22T03:31:04Z",
"location": "www.everyroadgps.com/Spring2021",
"locked": false,
"size": 0,
"storageMethodName": "WEB",
"title": "ftp001"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"reserved": false
}
]
}

Returns an error if a parameter is not a valid search attribute.

©2022 Arena, A PTC Business www.arenasolutions.com 360

 Arena REST API Developer Guide Endpoints

{
"status":400,
"errors":[
{
"code":3019,
"message":"The attribute \"edition\" is not searchable."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 361

 Arena REST API Developer Guide Endpoints

GET Request File Markup

/requests/<GUID>/markupfiles/<GUID>

Returns a Request File Markup object with a given GUID. This is the latest edition of the File.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get a Requests file with a given GUID

GET <url>/requests/<GUID>/markupfiles/<GUID>

{
"guid": "4M6P8L6XKN1O7QM65LS5",
"markup": {
"author": {
"fullName": "ftp001"
},
"category": {
"guid": "2K4N6J4VIL4EXGV223PR"
},
"creationDateTime": "2021-01-22T03:31:04Z",

©2022 Arena, A PTC Business www.arenasolutions.com 362

 Arena REST API Developer Guide Endpoints

"format": "Web",
"guid": "FXH0JWH8VYHXGZPWEY43",
"lastModifiedDateTime": "2021-01-22T03:31:04Z",
"location": "www.everyroadgps.com/Spring2021",
"locked": false,
"size": 0,
"storageMethodName": "WEB",
"title": "ftp001"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"reserved": false
}

Returns an error if a parameter is not a valid search attribute.

{
"status":400,
"errors":[
{
"code":3019,
"message":"The attribute \"edition\" is not searchable."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 363

 Arena REST API Developer Guide Endpoints

POST Request File Markup Create

/requests/<GUID>/markupfiles

Creates a Request File Markup File object.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type multipart/form-data

Sample Request Body

{
"file":{
"guid":"Z43M5I3UHK3J2LN69BYY"
}
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-FileGuid GUID string GUID for new file - only when including
content
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
• When associating a File Markup to a Request:

©2022 Arena, A PTC Business www.arenasolutions.com 364

 Arena REST API Developer Guide Endpoints

{
"guid": "7B4E2M7YLO2P8RN76MT6",
"markup": {
"author": {
"fullName": "Tony Shaftoe"
},
"category": {
"guid": "0I2L4H2TGJ2CVET001OY"
},
"creationDateTime": "2011-07-25T22:38:18Z",
"format": "doc",
"guid": "Z43M5I3UHK3J2LN69BYY",
"lastModifiedDateTime": "2011-07-25T22:38:18Z",
"locked": true,
"mimeType": "application/msword",
"name": "mount-instructions-07-25-2011.doc",
"size": 27136,
"storageMethodName": "FILE",
"title": "mount-instructions-07-25-2011"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"reserved": false
}

Returns an error if a required metadata attribute is missing.

{
"status":400,
"errors":[
{
"code":3001,
"message":"The attribute \"edition\" is required."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 365

 Arena REST API Developer Guide Endpoints

DELETE Request File Markup

/requests/<GUID>/markupfiles/<GUID>

Deletes a Request File Markup with a given GUID. When a File has more than one Markup, only the latest,
unlocked edition can be deleted--to delete an entire file, repeat the DELETE request for all editions.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response.

Request with bad GUID

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}

©2022 Arena, A PTC Business www.arenasolutions.com 366

 Arena REST API Developer Guide Endpoints

]
}

©2022 Arena, A PTC Business www.arenasolutions.com 367

 Arena REST API Developer Guide Endpoints

GET Request Quality Processes

GET /requests/<GUID>/quality

GET /requests/<GUID>/quality/<GUID>

Returns a collection of Quality Process objects for a Request with a given GUID (all Quality Processes in which
the Request is an affected object). If the endpoint is apprended with a valid GUID, it returns a specific Quality
Process and the step information where a specific Request has been added as an affected object.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get all quality processes that include a given request

GET /requests/0I2LQGHHQXGXGVRR5XND/quality

{
"count": 2,
"results": [
{
"guid": "6O8RAN8ZMP7I1K3LZHS1",
"notes": null,

©2022 Arena, A PTC Business www.arenasolutions.com 368

 Arena REST API Developer Guide Endpoints

"qualityProcess": {
"guid": "M4O7Q3OF25OK3M5OHUQ2",
"name": "Manufacturing flaws on 175-00001 boards",
"number": "CAR-000007",
"step": {
"guid": "N5P8R4PG36PL4N6PIVRR",
"name": "Problem Description"
},
"type": null
}
},
{
"guid": "5N7Q9M7YLO6H0J2KYGR1",
"notes": null,
"qualityProcess": {
"guid": "TBVEXAVM9CVRATCVO1X4",
"name": "Everyroad bezels melted/burned",
"number": "CAR-000008",
"step": {
"guid": "UCWFYBWNADWSBUDWP2Y8",
"name": "Problem Description"
},
"type": null
}
}
]
}

Return a specific Quality Process and specific step where a specific Request has been added as an affected
object.

GET /requests/<GUID>/quality/<GUID>

{
"guid": "6O8RAN8ZMP7I1K3LZHS1",
"notes": null,
"qualityProcess": {
"guid": "M4O7Q3OF25OK3M5OHUQ2",
"name": "Manufacturing flaws on 175-00001 boards",
"number": "CAR-000007",
"step": {
"guid": "N5P8R4PG36PL4N6PIVRR",
"name": "Problem Description"
},
"type": null
}
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,

©2022 Arena, A PTC Business www.arenasolutions.com 369

 Arena REST API Developer Guide Endpoints

"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."

}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 370

 Arena REST API Developer Guide Endpoints

GET Changes
/changes

Returns a collection of Change objects matching the given search criteria. Note that the Changes returned
here are a compact version. For a full Change object, use the GET Change endpoint GET/changes/guid.

Changes include different attributes depending on the effectivityType (PERMANENT_ON_APPROVAL,

PERMANENT_ON_DATE, or TEMPORARY) and lifecyclePhase (OPEN_AND_UNLOCKED, OPEN_AND_LOCKED,
SUBMITTED_FOR_ROUTING, SUBMITTED_FOR_APPROVAL, REJECTED, CANCELED, APPROVED, EFFECTIVE,
COMPLETED, or EXPIRED)

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all
changes where results should begin. All
changes before the offset in the search
results are ignored. The default value is 0.
limit integer Specifies the number of results that should
be returned. By default the maximum
number of items is 20. Can return up 400
changes.

Searchable Attributes

Name Value Description

[additional attribute guid value] string This special search permits searching for
strings in additional attribute values. For
example GET
/items?VDXGZ7E0GO5N6P8PR55G=*100pF
where VDXGZ7E0GO5N6P8PR55G is the
GUID of a custom attribute and we are
searching for all items whose value for this
attribute include the string "100pF". The
ability to search for more than one value is
available for the following attribute field
types: DROP_DOWN & FIXED_DROPDOWN
(where multi-select is true). See note below
this table for additional details.

©2022 Arena, A PTC Business www.arenasolutions.com 371

 Arena REST API Developer Guide Endpoints

Name Value Description

Additional attributes, also known as custom
attributes, support the date field type. Users
can perform searches by additional
attributes with a date field type by using
the format yyyy-mm-dd. In the following
example, the user is using the following to
search for a date field type custom attribute
with a value of April 1, 2019:

GET
/changes?9QU24KGNKOUGD1Z0RM3X=2019-04-01
category.guid string category unique ID
creator.guid string creator user unique ID
effectiveDateTimeFrom Date-Formatted String the date and time (in Zulu format) a change
was made effective. Returns all Changes
made effective after this date.
effectiveDateTimeTo Date-Formatted String the date and time (in Zulu format) a change
was made effective. Returns all Changes
made effective before this date.
implementationStatus string implementation status of the change.
Values can be NOT_STARTED, IN_PROGRESS,
NEEDS_ATTENTION, or DONE.
expirationDateTimeFrom Date-Formatted String the date and time (in Zulu format) a change
is set to expire. Returns all Changes that
expire after this date.
expirationDateTimeTo Date-Formatted String the date and time (in Zulu format) a change
is set to expire. Returns all Changes that
expire before this date.
lifecycleStatus.type string lifecycle status of the change. Values can
be OPEN_AND_UNLOCKED,
OPEN_AND_LOCKED,
SUBMITTED_FOR_ROUTING,
SUBMITTED_FOR_APPROVAL, REJECTED,
CANCELED, APPROVED, EFFECTIVE,
COMPLETED, or EXPIRED.
number string number of the change
title string title of the change

Note: Search behavior in the Arena REST API differs from search behavior in the Arena application. In the API, a
trailing asterisk (wildcard) is required to return results that start with a string; in the Arena application, a trailing
asterisk is always implied.

©2022 Arena, A PTC Business www.arenasolutions.com 372

 Arena REST API Developer Guide Endpoints

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all changes

GET /changes

{
"count":25,
"results":[
{
"category":{
"guid":"ASCVERC3QTCM5O3AABZF"
},
"creationDateTime":"2013-12-11T19:33:12Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"effectiveDateTime":"2013-12-11T19:41:13Z",
"guid":"7P9SBO90NQ9CVDTX9JUN",
"implementationStatus":"NOT_STARTED",
"lifecycleDateTime":"2013-12-11T19:41:13Z",
"lifecycleStatus":{
"type":"EFFECTIVE"
},
"number":"DCO-000003",
"submissionDateTime":"2013-12-11T19:38:10Z",
"title":"Release new rev of discretes to include CoCs"
},
{
"category":{
"guid":"4M6P8L6XKN6GZIX445T6"

©2022 Arena, A PTC Business www.arenasolutions.com 373

 Arena REST API Developer Guide Endpoints

},
"creationDateTime":"2018-03-07T00:53:59Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"effectiveDateTime":null,
"expirationDateTime":"2018-03-30T07:00:00Z",
"guid":"3L5O7K5WJM58R9PPUQJC",
"implementationStatus":"NOT_STARTED",
"lifecycleDateTime":"2018-03-07T00:53:59Z",
"lifecycleStatus":{
"type":"OPEN_AND_UNLOCKED"
},
"number":"DEV-000002",
"submissionDateTime":null,
"title":"Use Alternate Chipset with New Logic in 500 Boards"
},
{
"category":{
"guid":"7P9SBO90NQ9J2L0778WO"
},
"creationDateTime":"2015-02-18T21:56:44Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"effectiveDateTime":null,
"guid":"6O8RAN8ZMP8BUCSWLSDB",
"implementationStatus":"NOT_STARTED",
"lifecycleDateTime":"2016-07-18T21:19:06Z",
"lifecycleStatus":{
"type":"SUBMITTED_FOR_APPROVAL"
},
"number":"ECO-000017",
"submissionDateTime":"2016-07-18T21:18:39Z",
"title":"Switch resistor combination in 830-00001"
},
{
"category":{
"guid":"ASCVERC3QTCM5O3AABZF"
},
"creationDateTime":"2012-01-11T19:14:23Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"effectiveDateTime":"2012-01-11T19:16:35Z",
"guid":"L3N6P2NE14NQ9SEDI1DJ",
"implementationStatus":"NOT_STARTED",
"lifecycleDateTime":"2012-01-11T19:16:35Z",
"lifecycleStatus":{

©2022 Arena, A PTC Business www.arenasolutions.com 374

 Arena REST API Developer Guide Endpoints

"type":"EFFECTIVE"
},
"number":"DCO-000002",
"submissionDateTime":"2012-01-11T19:14:46Z",
"title":"BOM correction - Docs only"
},
{
"category":{
"guid":"BTDWFSD4RUDN6P4BBC0T"
},
"creationDateTime":"2012-04-27T22:34:15Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"effectiveDateTime":"2012-04-27T23:16:20Z",
"guid":"HZJ2LYJAX0JM5N384TAO",
"implementationStatus":"NOT_STARTED",
"lifecycleDateTime":"2012-04-27T23:16:20Z",
"lifecycleStatus":{
"type":"EFFECTIVE"
},
"number":"MCO-000003",
"submissionDateTime":"2012-04-27T22:34:47Z",
"title":"Add Trilby Technology as Source for 830-00001"
},
{
"category":{
"guid":"7P9SBO90NQ9J2L0778WO"
},
"creationDateTime":"2018-03-07T01:17:44Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"effectiveDateTime":null,
"guid":"5N7Q9M7YLO7ATBRRWSLF",
"implementationStatus":"NOT_STARTED",
"lifecycleDateTime":"2018-03-07T01:21:34Z",
"lifecycleStatus":{
"type":"SUBMITTED_FOR_APPROVAL"
},
"number":"ECO-000022",
"submissionDateTime":"2018-03-07T01:21:20Z",
"title":"New Fabrication for Everyroad Rear Panel"
},
{
"category":{
"guid":"BTDWFSD4RUDN6P4BBC0T"
},
"creationDateTime":"2012-01-11T00:49:46Z",
"creator":{
"email":"[email protected]",

©2022 Arena, A PTC Business www.arenasolutions.com 375

 Arena REST API Developer Guide Endpoints

"fullName":"Heidi Walker",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"effectiveDateTime":"2012-01-12T23:55:53Z",
"guid":"M4O7Q3OF25ORATFGURLY",
"implementationStatus":"NOT_STARTED",
"lifecycleDateTime":"2012-01-12T23:55:53Z",
"lifecycleStatus":{
"type":"EFFECTIVE"
},
"number":"MCO-000002",
"submissionDateTime":"2012-01-11T00:50:00Z",
"title":"Add Plasmus Plastics as Source for Everyroad Front Bezel 432-00001"

},
...
]
}

Get effective changes in category ECO

GET
<url>/changes?lifecycleStatus.type=effective&category.guid=L3N6PX663K3DWFYF3F6C

{
"count":5,
"results":[
{
"category":{
"guid":"L3N6PX663K3DWFYF3F6C"
},
"creationDateTime":"2011-02-14T23:38:11Z",
"creator":{
"email":"[email protected]",
"fullName":"Rachael Borger",
"guid":"9RBUDLUUR8P8RATCVROR"
},
"effectiveDateTime":"2011-02-15T00:11:43Z",
"guid":"K2M5OW552J25O6PARG53",
"implementationStatus":"IN_PROGRESS",
"lifecycleDateTime":"2011-02-15T00:11:43Z",
"lifecycleStatus":{
"type":"EFFECTIVE"
},
"number":"ECO-000002",
"submissionDateTime":"2011-02-15T00:05:03Z",
"title":"Production Release of EveryRoad GPS PCBA and components"
},
{
"category":{
"guid":"L3N6PX663K3DWFYF3F6C"
},
"creationDateTime":"2011-02-15T01:33:35Z",
"creator":{
"email":"[email protected]",

©2022 Arena, A PTC Business www.arenasolutions.com 376

 Arena REST API Developer Guide Endpoints

"fullName":"Toshiro Makamuri",
"guid":"CUEXGOXXUBSBUDWFYURL"
},
"effectiveDateTime":"2011-02-15T21:22:57Z",
"guid":"L3N6PX663K36P7QBSH62",
"implementationStatus":"IN_PROGRESS",
"lifecycleDateTime":"2011-02-15T21:22:57Z",
"lifecycleStatus":{
"type":"EFFECTIVE"
},
"number":"ECO-000005",
"submissionDateTime":"2011-02-15T19:30:12Z",
"title":"Production Release of Everyroad GPS Custom Mechanical Parts"
},
...
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 377

 Arena REST API Developer Guide Endpoints

GET Change
/changes/<GUID>

Returns a Change object with a given GUID. The attributes returned in the response differ according to the
effectivityType. For example, a Change with a future effectivity (effectivityType=PERMANENT_ON_DATE)
includes the attribute effectivityPlannedDateTime.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a change with permanent-on-approval effectivity

GET /changes/<GUID>

{
"additionalAttributes":[
{
"apiName":"custom2269737",
"fieldType":"FIXED_DROP_DOWN",
"guid":"FXH0JR00XEVDWFYGNJQZ",
"multiSelect":false,
"name":"Urgency",
"value":"High"
},

©2022 Arena, A PTC Business www.arenasolutions.com 378

 Arena REST API Developer Guide Endpoints

{
"apiName":"custom2361807",
"fieldType":"FIXED_DROP_DOWN",
"guid":"ZH1K3BKKHYFXGZI0528P",
"multiSelect":false,
"name":"Cost over $500?",
"value":"Yes"
},
{
"apiName":"custom8397153",
"fieldType":"NUMBER",
"guid":"9QU24KGNKOUGD1Z0RM3X",
"name":"Priority (1-5)",
"value":2
}
],
"approvalDeadlineDateTime":"2018-06-01T06:59:59Z",
"category":{
"guid":"L3N6PX663K3DWFYF3F6C",
"name":"Engineering Change Order",
"path":"Change\\Change Order\\Engineering Change Order"
},
"creationDateTime":"2014-07-16T23:43:07Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"description":"3 components in the Everyroad board are going to go end of life in
the next 6 months. I have sourced replacements from SiliconExpert.",
"effectiveDateTime":null,
"effectivityType":"PERMANENT_ON_APPROVAL",
"enforceApprovalDeadline":false,
"guid":"K2M5OW552J25O6PAIDQZ",
"implementationStatus":"NOT_STARTED",
"lifecycleDateTime":"2018-05-23T22:35:41Z",
"lifecycleStatus":{
"type":"OPEN_AND_UNLOCKED"
},
"number":"ECO-000011",
"routingAdmins": [
{
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
],
"routings":[
{
"guid":"J1L4NV441IZ2L4N6P3EZ",
"name":"Approval Routing"
}
],
"submissionDateTime":"2014-07-16T23:43:54Z",
"submitter":{

©2022 Arena, A PTC Business www.arenasolutions.com 379

 Arena REST API Developer Guide Endpoints

"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"title":"Replace at-risk components in EveryRoad PCBA",
"withdrawnDateTime":"2018-05-23T22:35:41Z"
}

Get a change with permanent-on-date effectvity

GET /changes/<GUID>

{
"additionalAttributes":[
{
"apiName":"custom2269737",
"fieldType":"FIXED_DROP_DOWN",
"guid":"FXH0JR00XEVDWFYGNJQZ",
"multiSelect":false,
"name":"Urgency",
"value":"High"
},
{
"apiName":"custom2361807",
"fieldType":"FIXED_DROP_DOWN",
"guid":"ZH1K3BKKHYFXGZI0528P",
"multiSelect":false,
"name":"Cost over $500?",
"value":"No"
},
{
"apiName":"custom8397153",
"fieldType":"NUMBER",
"guid":"9QU24KGNKOUGD1Z0RM3X",
"name":"Priority (1-5)",
"value":1
}
],
"approvalDeadlineDateTime":"2018-06-01T06:59:59Z",
"category":{
"guid":"L3N6PX663K3DWFYF3F6C",
"name":"Engineering Change Order",
"path":"Change\\Change Order\\Engineering Change Order"
},
"creationDateTime":"2018-05-01T11:40:11Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"description":"This change phases in the new fab for the rear panel on the 300
and 500 models. The effectivity date for this change will be July 1st, 2018 regardless
of approval date.",
"effectiveDateTime":null,
"effectivityPlannedDateTime":"2018-07-01T07:00:00Z",

©2022 Arena, A PTC Business www.arenasolutions.com 380

 Arena REST API Developer Guide Endpoints

"effectivityType":"PERMANENT_ON_DATE",
"enforceApprovalDeadline":false,
"guid":"5N7Q9M7YLO7ATBRRWSLF",
"implementationStatus":"NOT_STARTED",
"lifecycleDateTime":"2018-05-23T22:35:41Z",
"lifecycleStatus":{
"type":"SUBMITTED_FOR_APPROVAL"
},
"number":"ECO-000022",
"routingAdmins": [
{
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
],
"routings":[
{
"guid":"I0K3MZKBY1IL4N6P5RSG",
"name":"Component Librarian"
},
{
"guid":"2K4N6J4VIL25O7Q9PBCD",
"name":"CTO Review"
}
],
"submissionDateTime":"2014-07-16T23:43:54Z",
"submitter":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"title":"New Fabrication for Everyroad Rear Panel,
}

Get a change with temporary effectivity

GET /changes/<GUID>

{
"additionalAttributes":[
{
"apiName":"custom2361807",
"fieldType":"FIXED_DROP_DOWN",
"guid":"ZH1K3BKKHYFXGZI0528P",
"multiSelect":false,
"name":"Cost over $500?",
"value":"No"
},
{
"apiName":"custom8397153",
"fieldType":"NUMBER",
"guid":"9QU24KGNKOUGD1Z0RM3X",
"name":"Priority (1-5)",
"value":1

©2022 Arena, A PTC Business www.arenasolutions.com 381

 Arena REST API Developer Guide Endpoints

}
],
"approvalDeadlineDateTime":"2018-06-01T06:59:59Z",
"category":{
"guid":"O6Q9S0996N6GZI1I6I94",
"name":"Deviation",
"path":"Change\\Deviation"
},
"creationDateTime":"2018-05-23T23:08:20Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"description":"The Bezel used for the 300 model is compatible with the 500 model.
Acceptable deviation until August 2018.",
"effectiveDateTime":null,
"effectivityType":"TEMPORARY",
"enforceApprovalDeadline":false,
"expirationDateTime":"2018-08-01T07:00:00Z",
"guid":"SAUDW4DDARADWEXINFET",
"implementationStatus":"NOT_STARTED",
"lifecycleDateTime":"2018-05-23T23:09:44Z",
"lifecycleStatus":{
"type":"SUBMITTED_FOR_APPROVAL"
},
"number":"DEV-000001",
"routingAdmins": [
{
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
],
"routings":[
{
"guid":"J1L4NV441IZ2L4N6P3EZ",
"name":"Approval Routing"
}
],
"submissionDateTime":"2018-05-23T23:09:44Z",
"submitter":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"title":"Use Existing Stock for EveryRoad Bezel"
}

Request with bad GUID

{
"status":400,
"errors":[
{

©2022 Arena, A PTC Business www.arenasolutions.com 382

 Arena REST API Developer Guide Endpoints

"code":3011,
"message":"The guid \"ASCVERC3QTCFYGPWW1WCS\" is not valid"
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 383

 Arena REST API Developer Guide Endpoints

GET Change Affected Items

/changes/<GUID>/items

Returns all Change Affected Items included in a change with a given GUID. The response includes inventory
dispostion and information about each view of each item, including whether it is included in the change and
whether it contains modifications to the working revision.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all items included in a change

GET /changes/<GUID>/items

{
"count":4,
"results":[
{
"affectedItemRevision":{
"effectiveDateTime": "2011-07-26T06:54:20Z",
"guid":"Q8SBU2BB8P8P8MTGTWBE",
"name": "Yellow, Side Fastener",
"number":"072-0003",
"revisionNumber":"A",

©2022 Arena, A PTC Business www.arenasolutions.com 384

 Arena REST API Developer Guide Endpoints

"revisionStatus": "SUPERSEDED",
"url": {
"api": "https://api.arenasolutions.com/v1/items/Q8SBU2BB8P8P8MTGTWBE",

"app": "https://app.bom.com/Q8SBU2BB8P8P8MTGTWBE"
}
},
"bomView":{
"includedInThisChange":false,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":false,
"notes":null
},
"dispositionAttributes":[
{
"guid":"GYI1KS11YFWEXGZGIP4U",
"name":"On Order",
"notes":null,
"value":null
},
{
"guid":"HZJ2LT22ZGXFYH0HJQ5B",
"name":"WIP",
"notes":null,
"value":null
},
{
"guid":"I0K3MU330HYGZI1IKR6T",
"name":"Finished Goods",
"notes":null,
"value":null
},
{
"guid":"J1L4NV441IZH0J2JLS78",
"name":"In the Field",
"notes":null,
"value":null
},
{
"guid":"K2M5OW552J0I1K3KMT84",
"name":"In Stock",
"notes":null,
"value":null
}
],
"filesView":{
"includedInThisChange":false,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":false,
"notes":null
},
"guid":"J1L4NV441I0TCVENB6LQ",
"materialEffectivityDateTime":null,
"newItemRevision":{
"effectiveDateTime": "2011-11-18T22:04:06Z",

©2022 Arena, A PTC Business www.arenasolutions.com 385

 Arena REST API Developer Guide Endpoints

"guid":"L3N6PX663K3K3HOBOO3A",
"name": "Yellow, Side Fastener",
"number":"072-0003",
"revisionNumber":"B",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "https://api.arenasolutions.com/v1/items/L3N6PX663K3K3HOBOO3A",

"app": "https://app.bom.com/L3N6PX663K3K3HOBOO3A"
}
},
"newLifecyclePhase":{
"guid":"ASCVEMVVS9RUDWFYHWC3",
"name":"In Production"
},
"newRevisionNumber": "B",
"sourcingView":{
"includedInThisChange":true,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":false,
"notes":null
},
"specsView":{
"includedInThisChange":true,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":false,
"notes":null
}
},
{
"affectedItemRevision":{
"effectiveDateTime": "2011-10-26T07:54:20Z",
"guid":"6O8RAIRRO5O5O29W9CHJ",
"name": "Blue, Side Fastener",
"number":"072-0005",
"revisionNumber":"A",
"revisionStatus": "SUPERSEDED",
"url": {
"api": "https://api.arenasolutions.com/v1/items/6O8RAIRRO5O5O29W9CHJ",

"app": "https://app.bom.com/6O8RAIRRO5O5O29W9CHJ"
}
},
"bomView":{
"includedInThisChange":false,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":false,
"notes":null
},
"dispositionAttributes":[
{
"guid":"GYI1KS11YFWEXGZGIP4U",
"name":"On Order",
"notes":null,
"value":"Cancel"

©2022 Arena, A PTC Business www.arenasolutions.com 386

 Arena REST API Developer Guide Endpoints

},
{
"guid":"HZJ2LT22ZGXFYH0HJQ5B",
"name":"WIP",
"notes":null,
"value":"Build-out"
},
{
"guid":"I0K3MU330HYGZI1IKR6T",
"name":"Finished Goods",
"notes":null,
"value":"Ship-as-is"
},
{
"guid":"J1L4NV441IZH0J2JLS78",
"name":"In the Field",
"notes":null,
"value":"Do Nothing"
},
{
"guid":"K2M5OW552J0I1K3KMT84",
"name":"In Stock",
"notes":"use to exhaust",
"value":"Build-out"
}
],
"filesView":{
"includedInThisChange":true,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":true,
"notes":null
},
"guid":"L3N6PX663K2VEXGPD8NB",
"materialEffectivityDateTime":null,
"newItemRevision":{
"effectiveDateTime": "2011-12-25T22:04:06Z",
"guid":"5N7Q9HQQN4N4N18V889C",
"name": "Blue, Side Fastener",
"number":"072-0005",
"revisionNumber":"B",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "https://api.arenasolutions.com/v1/items/5N7Q9HQQN4N4N18V889C",

"app": "https://app.bom.com/5N7Q9HQQN4N4N18V889C"
}
},
"newLifecyclePhase":{
"guid":"9RBUDLUUR8QTCVEXGVB9",
"name":"Abandoned"
},
"newRevisionNumber": "2",
"sourcingView":{
"includedInThisChange":false,
"lockedByAnotherChange":false,

©2022 Arena, A PTC Business www.arenasolutions.com 387

 Arena REST API Developer Guide Endpoints

"modifiedOnWorkingRev":false,
"notes":null
},
"specsView":{
"includedInThisChange":true,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":true,
"notes":null
}
},
...
]
}

Request with invalid GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 388

 Arena REST API Developer Guide Endpoints

GET Change Affected Item

/changes/<GUID>/items/<GUID>

Returns a Change Affected Item with a given GUID included in a change with a given GUID. The response
includes inventory disposition and information about each view of the item, including whether or not the view
is included in the change and whether or not it contains modifications to the working revision.

Note:

1. For permanent Changes, when the Item added to the Change is unreleased:

a. There is no affectedItemRevision attribute.

b. Before the Change is effective, newItemRevision GUID will reference the working revision of the Item.

c. After the Change is effective the new newItemRevision GUID willl reference the Item revision that was made
effective as a consequence of this Change.

d. newLifecyclePhase is the new lifecycle phase of the Item that was introduced when the Change became
effective.

e. newRevisionNumber is the new revision number of the Item specified in the Change that became effective
due to the Change being released.

2. For permanent Changes, when the Item added to the Change is released:

a. Before the Change is effective:

i. The newItemRevision GUID references the working revision of the Item. Note this GUID can change if this
Item is released by another Change or through a revisioning event.

ii. The affectedItemRevision GUID references the effective revision of the Item.

b. After the Change is effective:

i. The newItemRevision GUID references the Item revision that was made effective as a consequence of this
Change.

ii. The affectedItemRevision GUID references the effective Item revision.

c. The newLifecyclePhase is the new lifecycle phase of the Item tas a result of the Change becoming effective.

d. The newRevisionNumber is the planned revision number, which becomes the revision number of the Item
when the Change becomes effective.

3. For temporary Changes:

a. Unreleased Items can not be added to a temporary Change. The newLifecyclePhase and newRevisionNumber
fields are not used.

b. Before the temporary Change is effective, the affectedItemRevision GUID is the effective Item revision.

c. After the Deviation becomes effective, the affectedItemRevision GUID is the superseded Item revision. The
newItemRevision GUID is the new revision inserted between the former effective and the working revisions.

©2022 Arena, A PTC Business www.arenasolutions.com 389

 Arena REST API Developer Guide Endpoints

d. After the Deviation, the temporary Change expires, the affectedItemRevision GUID and the newItemRevision
GUID do not change.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a specific item included in a change

GET /changes/<GUID>/items/<GUID>

{
"affectedItemRevision":{
"effectiveDateTime": "2011-07-26T06:54:20Z",
"guid":"6O8RAIRRO5O5O29W9CHJ",
"name": "Front Glass Panel",
"number":"034-0003",
"revisionNumber":"A",
"revisionStatus": "SUPERSEDED",
"url": {
"api": "https://api.arenasolutions.com/v1/items/6O8RAIRRO5O5O29W9CHJ",
"app": "https://app.bom.com/6O8RAIRRO5O5O29W9CHJ"
}
},
"bomView":{
"includedInThisChange":false,

©2022 Arena, A PTC Business www.arenasolutions.com 390

 Arena REST API Developer Guide Endpoints

"lockedByAnotherChange":false,
"modifiedOnWorkingRev":false,
"notes":null
},
"dispositionAttributes":[
{
"guid":"GYI1KS11YFWEXGZGIP4U",
"name":"On Order",
"notes":null,
"value":"Cancel"
},
{
"guid":"HZJ2LT22ZGXFYH0HJQ5B",
"name":"WIP",
"notes":null,
"value":"Build-out"
},
{
"guid":"I0K3MU330HYGZI1IKR6T",
"name":"Finished Goods",
"notes":null,
"value":"Ship-as-is"
},
{
"guid":"J1L4NV441IZH0J2JLS78",
"name":"In the Field",
"notes":null,
"value":"Do Nothing"
},
{
"guid":"K2M5OW552J0I1K3KMT84",
"name":"In Stock",
"notes":"use to exhaust",
"value":"Build-out"
}
],
"filesView":{
"includedInThisChange":true,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":true,
"notes":null
},
"guid":"L3N6PX663K2VEXGPD8NB",
"materialEffectivityDateTime":null,
"newItemRevision":{
"effectiveDateTime": "2011-11-18T22:04:06Z",
"guid":"5N7Q9HQQN4N4N18V889C",
"name": "Front Glass Panel",
"number":"034-0003",
"revisionNumber":"B",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "https://api.arenasolutions.com/v1/items/5N7Q9HQQN4N4N18V889C",
"app": "https://app.bom.com/5N7Q9HQQN4N4N18V889C"
}

©2022 Arena, A PTC Business www.arenasolutions.com 391

 Arena REST API Developer Guide Endpoints

},
"newLifecyclePhase":{
"guid":"9RBUDLUUR8QTCVEXGVB9",
"name":"Abandoned"
},
"newRevisionNumber": "A",
"sourcingView":{
"includedInThisChange":false,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":false,
"notes":null
},
"specsView":{
"includedInThisChange":true,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":true,
"notes":null
}
}

Request with invalid GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 392

 Arena REST API Developer Guide Endpoints

GET Change Quality Processes

GET /changes/<GUID>/quality

GET /changes/<GUID>/quality/<GUID>

Returns a collection of Quality Process objects for a Change with a given GUID (all Quality Processes in which
the Change is an affected object). If the endpoint is apprended with a valid GUID, it returns a specific Quality
Process and the step information where a specific Change has been added as an affected object.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get all quality processes that include a given change

GET /changes/0I2LQGHHQXGXGVRR5XND/quality

{
"count": 2,
"results": [
{
"guid": "1J3M5I3UHK2DWFYGUCNU",
"notes": null,

©2022 Arena, A PTC Business www.arenasolutions.com 393

 Arena REST API Developer Guide Endpoints

"qualityProcess": {
"guid": "M4O7Q3OF25OK3M5OHUQ2",
"name": "Manufacturing flaws on 175-00001 boards",
"number": "CAR-000007",
"step": {
"guid": "N5P8R4PG36PL4N6PIVRR",
"name": "Problem Description"
},
"type": null
}
},
{
"guid": "0I2L4H2TGJ1CVEXFTBMY",
"notes": null,
"qualityProcess": {
"guid": "TBVEXAVM9CVRATCVO1X4",
"name": "Everyroad bezels melted/burned",
"number": "CAR-000008",
"step": {
"guid": "UCWFYBWNADWSBUDWP2Y8",
"name": "Problem Description"
},
"type": null
}
}
]
}

Return a specific Quality Process and specific step where a specific Change has been added as an affected
object.

GET /changes/<GUID>/quality/<GUID>

{
"guid": "1J3M5I3UHK2DWFYGUCNU",
"notes": null,
"qualityProcess": {
"guid": "M4O7Q3OF25OK3M5OHUQ2",
"name": "Manufacturing flaws on 175-00001 boards",
"number": "CAR-000007",
"step": {
"guid": "N5P8R4PG36PL4N6PIVRR",
"name": "Problem Description"
},
"type": null
}
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,

©2022 Arena, A PTC Business www.arenasolutions.com 394

 Arena REST API Developer Guide Endpoints

"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."

}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 395

 Arena REST API Developer Guide Endpoints

POST Change Create

/changes

Creates a new Change object. You can create changes with three different types of effectivity:

1. Permanent on Approval: The Change becomes effective immediately upon the last necessary vote being
entered.

2. Permanent on Date: The Change enters the Approved state upon the last necessary vote being entered,
but does not become effective until the specified date. Requires the attribute plannedEffectivityDateTime.

3. Temporary: Changes with temporary effectivity (often called Deviations) become effective immediately
upon the last necessary vote being entered, and expire on a specified date. Requires the attribute
expirationDate.

In all cases, numberSequencePrefix is required. If a default numberSequencePrefix is associated with the

specified change category, not specifying a numberSequencePrefix will result in automatically selecting the
default.

Below are examples of each type of Change, including all fields that can be created for each effectivity type.

See the Note on Date/Time Handling

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 396

 Arena REST API Developer Guide Endpoints

Sample Requests and Responses

Create change with permanent-on-approval effectivity

POST /changes

Request

{
"category":{
"guid":"7P9SBO90NQ9J2L0778WO"
},
"numberSequencePrefix":{
"value":"ECO-"
},
"title":"EveryRoad Model 300 Case Melting",
"description":"The Model 300 overheats when the unit is left on in an excessively
hot environment. The typical environment would be a vehicle with closed doors on a
hot day. In these cases, the unit fails due to chip failure and in rare cases, can
cause fire. The resolution to this issue includes increasing the diameter of the
cooling holes on the back of the unit, and the addition of a thermal overload circuit
to shutdown the EveryRoad before ignition can occur.",
"routings":[
{
"guid":"HZJ2LYJAX0HK3M5O4QR4"
}
],
"approvalDeadlineDateTime":"2018-09-15T00:00:00Z",
"enforceApprovalDeadline":true,
"effectivityType":"PERMANENT_ON_APPROVAL",
"additionalAttributes":[
{
"guid":"6O8RAN8ZMP7UDWDIQH5T",
"value":"Medium-High"
},
{
"guid":"9QU24KGNKOUGD1Z0RM3X",
"value":2
}
]
}

Response

{
"additionalAttributes":[
{
"apiName":"custom2361807",
"fieldType":"FIXED_DROP_DOWN",
"guid":"6O8RAN8ZMP7UDWDIQH5T",
"name":"Urgency",
"value":"Medium-High"
},
{
"apiName":"custom8397153",

©2022 Arena, A PTC Business www.arenasolutions.com 397

 Arena REST API Developer Guide Endpoints

"fieldType":"NUMBER",
"guid":"9QU24KGNKOUGD1Z0RM3X",
"name":"Priority (1-5)",
"value":2
}
],
"approvalDeadlineDateTime":"2018-09-15T07:59:59Z",
"category":{
"guid":"7P9SBO90NQ9J2L0778WO",
"name":"Engineering Change Order",
"path":"Change\\Change Order\\Engineering Change Order"
},
"creationDateTime":"2018-02-21T21:38:26Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"description":"The Model 300 overheats when the unit is left on in an excessively
hot environment. The typical environment would be a vehicle with closed doors on a
hot day. In these cases, the unit fails due to chip failure and in rare cases, can
cause fire. The resolution to this issue includes increasing the diameter of the
cooling holes on the back of the unit, and the addition of a thermal overload circuit
to shutdown the EveryRoad before ignition can occur.",
"effectiveDateTime":null,
"effectivityType":"PERMANENT_ON_APPROVAL",
"enforceApprovalDeadline":true,
"guid":"L3N6P2NE14NQ9R77C5PD",
"implementationStatus":"NOT_STARTED",
"lifecycleDateTime":"2018-02-21T21:38:26Z",
"lifecycleStatus":{
"type":"OPEN_AND_UNLOCKED"
},
"number":"ECO-000026",
"routings":[
{
"guid":"HZJ2LYJAX0HK3M5O4QR4",
"name":"Production Phase Changes"
}
],
"submissionDateTime":null,
"title":"EveryRoad Model 300 Case Melting"
}

Change with permanent-on-date effectivity

POST /changes

Request

{
"category":{
"guid":"7P9SBO90NQ9J2L0778WO"
},
"numberSequencePrefix":{

©2022 Arena, A PTC Business www.arenasolutions.com 398

 Arena REST API Developer Guide Endpoints

"value":"ECO-"
},
"title":"New Fabrication for Everyroad Rear Panel",
"description":"This change phases in the new fab for the rear panel on the 300
and 500 models. The effectivity date for this change will be April 1st, 2018 regardless
of approval date.",
"routings":[
{
"guid":"I0K3MZKBY1IL4N6P5RSG"
},
{
"guid":"2K4N6J4VIL25O7Q9PBCD"
}
],
"approvalDeadlineDateTime":"2018-03-24T06:59:59Z",
"enforceApprovalDeadline":true,
"effectivityType":"PERMANENT_ON_DATE",
"effectivityPlannedDateTime":"2018-04-01T07:00:00Z",
"additionalAttributes":[
{
"guid":"6O8RAN8ZMP7UDWDIQH5T",
"value":"Medium-High"
},
{
"guid":"9QU24KGNKOUGD1Z0RM3X",
"value":"2"
}
]
}

Response

{
"additionalAttributes":[
{
"apiName":"custom2361807",
"fieldType":"FIXED_DROP_DOWN",
"guid":"6O8RAN8ZMP7UDWDIQH5T",
"name":"Urgency",
"value":"Medium-High"
},
{
"apiName":"custom8397153",
"fieldType":"NUMBER",
"guid":"9QU24KGNKOUGD1Z0RM3X",
"name":"Priority (1-5)",
"value":2
}
],
"approvalDeadlineDateTime":"2018-03-24T06:59:59Z",
"category":{
"guid":"7P9SBO90NQ9J2L0778WO",
"name":"Engineering Change Order",
"path":"Change\\Change Order\\Engineering Change Order"
},

©2022 Arena, A PTC Business www.arenasolutions.com 399

 Arena REST API Developer Guide Endpoints

"creationDateTime":"2018-02-21T21:43:30Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"description":"This change phases in the new fab for the rear panel on the 300
and 500 models. The effectivity date for this change will be April 1st, 2018 regardless
of approval date.",
"effectiveDateTime":null,
"effectivityPlannedDateTime":"2018-09-30T07:59:59Z",
"effectivityType":"PERMANENT_ON_DATE",
"enforceApprovalDeadline":true,
"guid":"M4O7Q3OF25ORAS88D6Q9",
"implementationStatus":"NOT_STARTED",
"lifecycleDateTime":"2018-02-21T21:43:30Z",
"lifecycleStatus":{
"type":"OPEN_AND_UNLOCKED"
},
"number":"ECO-000027",
"routings":[
{
"guid": "I0K3MZKBY1IL4N6P5RSG",
"name": "Component Librarian"
},
{
"guid": "2K4N6J4VIL25O7Q9PBCD",
"name": "CTO Review"
}
],
"submissionDateTime":null,
"title":"New Fabrication for Everyroad Rear Panel"
}

Change with temporary effectivity

POST /changes

Request

{
"category":{
"guid":"4M6P8L6XKN6GZIX445T6"
},
"numberSequencePrefix":{
"value":"DEV-"
},
"title":"Temporarily use gray enclosure while black enclosure is unavailable.",
"description":"Supplier unable to deliver gray enclosure for 3 weeks. Substitute
with black until delivery resumes.",
"routings":[
{
"guid":"I0K3MZKBY1IL4N6P5RSG"
}
],

©2022 Arena, A PTC Business www.arenasolutions.com 400

 Arena REST API Developer Guide Endpoints

"effectivityType":"TEMPORARY",
"expirationDateTime":"2018-10-15T07:59:59Z",
"additionalAttributes":[
{
"guid":"TBVEXAVM9CUH0J05D4RE",
"value":"< $5000"
},
{
"guid":"6O8RAN8ZMP7UDWDIQH5T",
"value":"High-Medium"
},
{
"guid":"9QU24KGNKOUGD1Z0RM3X",
"value":"2"
}
]
}

Response

{
"additionalAttributes":[
{
"apiName":"custom2361807",
"fieldType":"FIXED_DROP_DOWN",
"guid":"6O8RAN8ZMP7UDWDIQH5T",
"name":"Urgency",
"value":"Medium-High"
},
{
"apiName":"custom8397153",
"fieldType":"NUMBER",
"guid":"9QU24KGNKOUGD1Z0RM3X",
"name":"Priority (1-5)",
"value":2
},
{
"apiName":"custom8397153",
"fieldType":"PREDEFINED_DROP_DOWN",
"guid":"9QU24KGNKOUGD1Z0RM3X",
"name":"Cost Impact",
"value":"< $5000"
}
],
"category":{
"guid":"4M6P8L6XKN6GZIX445T6",
"name":"Deviation",
"path":"Change\\Deviation"
},
"creationDateTime":"2018-02-22T00:33:03Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},

©2022 Arena, A PTC Business www.arenasolutions.com 401

 Arena REST API Developer Guide Endpoints

"description":"Supplier unable to deliver gray enclosure for 3 weeks. Substitute

with black until delivery resumes.",
"effectiveDateTime":null,
"effectivityType":"TEMPORARY",
"enforceApprovalDeadline":false,
"expirationDateTime":"2018-10-15T07:59:59Z",
"guid":"UCWFYBWNADWZI0GGLEYM",
"implementationStatus":"NOT_STARTED",
"lifecycleDateTime":"2018-02-22T00:33:03Z",
"lifecycleStatus":{
"type":"OPEN_AND_UNLOCKED"
},
"number":"DEV-000002",
"routings":[
{
"guid":"I0K3MZKBY1IL4N6P5RSG",
"name":"Component Librarian"
}
],
"submissionDateTime":null,
"title":"Temporarily use gray enclosure while black enclosure is unavailable."
}

value supplied for effectivityType does not match default value enforced for the selected category

{
"status":400,
"errors":[
{
"code":4014,
"message":"The default value for effectivityType is enforced for Changes
assigned to this category, so the supplied value must match the default."
}
]
}

value supplied for numberingSequence does not match default value enforced for the selected category

{
"status":400,
"errors":[
{
"code":4015,
"message":"The default value for numberingSequence is enforced for Changes
assigned to this category, so the supplied value must match the default."
}
]
}

Request with invalid GUID

{
"status":400,
"errors":[
{
"code":3045,

©2022 Arena, A PTC Business www.arenasolutions.com 402

 Arena REST API Developer Guide Endpoints

"message":"The GUID 07SFVKE79SLLW285LF8S is invalid."

}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 403

 Arena REST API Developer Guide Endpoints

PUT Change Edit

/changes/<GUID>

Updates attribute information for a change with a given GUID.

Changes cannot be edited after they are submitted, with the following exceptions:

1. Approval Deadline and Expiration Date can be edited on Submitted and Effective Changes by Change
Administrator users.

2. Implementation Status can be edited in any lifecycle phase.

The fields you can update are dependent on the Change's effectivity type.

Permanent on Approval Permanent on Date Temporary

category; title; description; category; title; description; category; title; description;
approvalDeadline; effectivityType*; approvalDeadline; effectivityType*; approvalDeadline;
enforceApprovalDeadline; enforceApprovalDeadline; enforceApprovalDeadline;
implementationStatus; Additional implementationStatus; Additional expirationDateTime; implementationStatus;
Attribute values Attribute values Additional Attribute values

*For Changes with Permanent Effectivity, effectivityType can be edited to the other Permanent value, but
cannot be changed to Temporary. For Changes with Temporary Effectivity, effectivityType cannot be edited.

See the Note on Date/Time Handling

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions

©2022 Arena, A PTC Business www.arenasolutions.com 404

 Arena REST API Developer Guide Endpoints

Name Value Description

X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Edit a Change with permanent-on-approval effectivity

/changes/<GUID>

Request

{
"category":{
"guid":"7P9SBO90NQ9J2L0778WO"
},
"title":"New Injection Molding for Everyroad Rear Panel",
"description":"Updated design for Rear Panel 432-00003. This panel is used in the
500 model Everyroad GPS.\n\nModifications on Sourcing, and Files views. EDIT--see
new dimensions for clearance.",
"approvalDeadlineDateTime":"2018-09-15T00:00:00Z",
"effectivityType":"PERMANENT_ON_APPROVAL",
"enforceApprovalDeadline":true,
"implementationStatus":"NOT_STARTED",
"additionalAttributes":[
{
"guid":"6O8RAN8ZMP7UDWDIQH5T",
"value":"High-Medium"
}
]
}

Response

{
"additionalAttributes":[
{
"apiName":"custom2361807",
"fieldType":"FIXED_DROP_DOWN",
"guid":"6O8RAN8ZMP7UDWDIQH5T",
"name":"Urgency",
"value":"High-Medium"
}
],
"approvalDeadlineDateTime":"2018-09-15T00:00:00Z",
"category":{
"guid":"7P9SBO90NQ9J2L0778WO",
"name":"Engineering Change Order",
"path":"Change\\Change Order\\Engineering Change Order"
},
"creationDateTime":"2016-11-18T19:31:15Z",
"creator":{

©2022 Arena, A PTC Business www.arenasolutions.com 405

 Arena REST API Developer Guide Endpoints

"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"description":"Updated design for Rear Panel 432-00003. This panel is used in the
500 model Everyroad GPS.\n\nModifications on Sourcing, and Files views. EDIT--see
new dimensions for clearance.",
"effectiveDateTime":null,
"effectivityType":"PERMANENT_ON_APPROVAL",
"enforceApprovalDeadline":true,
"guid":"Q8SBU7SJ69SVEWCEKLBO",
"implementationStatus":"NOT_STARTED",
"lifecycleDateTime":"2016-11-18T19:31:15Z",
"lifecycleStatus":{
"type":"OPEN_AND_UNLOCKED"
},
"number":"ECO-000020",
"routings":[
{
"guid":"HZJ2LYJAX0HK3M5O4QR4",
"name":"Production Phase Changes"
}
],
"submissionDateTime":null,
"title":"New injection molding for Everyroad Rear Panel"
}

Edit a Change with permanent-on-date effectivity

/changes/<GUID>

Request

{
"category":{
"guid":"7P9SBO90NQ9J2L0778WO"
},
"title":"New Fabrication for Everyroad Rear Panel",
"description":"This change phases in the new fab for the rear panel on the 300
and 500 models. The effectivity date for this change will be April 1st, 2018 regardless
of approval date.",
"approvalDeadlineDateTime":"2018-09-15T00:00:00Z",
"effectivityPlannedDateTime":"2018-04-01T07:00:00Z",
"effectivityType":"PERMANENT_ON_DATE",
"enforceApprovalDeadline":true,
"implementationStatus":"NOT_STARTED",
"additionalAttributes":[
{
"guid":"6O8RAN8ZMP7UDWDIQH5T",
"value":"High-Medium"
}
]
}

Response

©2022 Arena, A PTC Business www.arenasolutions.com 406

 Arena REST API Developer Guide Endpoints

{
"additionalAttributes":[
{
"apiName":"custom2361807",
"fieldType":"FIXED_DROP_DOWN",
"guid":"6O8RAN8ZMP7UDWDIQH5T",
"name":"Urgency",
"value":"High-Medium"
}
],
"approvalDeadlineDateTime": "2018-03-24T06:59:59Z",
"category": {
"guid": "7P9SBO90NQ9J2L0778WO",
"name": "Engineering Change Order",
"path": "Change\\Change Order\\Engineering Change Order"
},
"creationDateTime": "2018-03-07T01:17:44Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "This change phases in the new fab for the rear panel on the 300
and 500 models. The effectivity date for this change will be April 1st, 2018 regardless
of approval date.",
"effectiveDateTime": null,
"effectivityPlannedDateTime": "2018-04-01T07:00:00Z",
"effectivityType": "PERMANENT_ON_DATE",
"enforceApprovalDeadline":true,
"guid": "5N7Q9M7YLO7ATBRRWSLF",
"implementationStatus": "NOT_STARTED",
"lifecycleDateTime": "2018-03-07T18:52:06Z",
"lifecycleStatus": {
"type": "OPEN_AND_UNLOCKED"
},
"number": "ECO-000022",
"routings": [
{
"guid": "I0K3MZKBY1IL4N6P5RSG",
"name": "Component Librarian"
},
{
"guid": "2K4N6J4VIL25O7Q9PBCD",
"name": "CTO Review"
}
],
"submissionDateTime": "2018-03-07T01:21:20Z",
"submitter": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"title": "New Fabrication for Everyroad Rear Panel",
"withdrawnDateTime": "2018-03-07T18:52:06Z"
}

©2022 Arena, A PTC Business www.arenasolutions.com 407

 Arena REST API Developer Guide Endpoints

Edit a Change with temporary effectivity

/changes/<GUID>

Request

{
"category":{
"guid":"4M6P8L6XKN6GZIX445T6"
},
"title":"Use Alternate Chipset with New Logic in 500 Boards",
"description":"The chipset at U1, U3, U17 can be programmed with the new logic
X89c12. Allow use of the alternate chips at these locations until supply is exhausted.
EDIT-Add U14.",
"approvalDeadlineDateTime":"2018-03-10T07:59:59Z",
"enforceApprovalDeadline":false,
"expirationDateTime": "2018-03-28T07:00:00Z"
"implementationStatus":"NOT_STARTED",
"additionalAttributes":[
{
"guid":"6O8RAN8ZMP7UDWDIQH5T",
"value":"High-Medium"
}
]
}

Response

{
"additionalAttributes":[
{
"apiName":"custom2361807",
"fieldType":"FIXED_DROP_DOWN",
"guid":"6O8RAN8ZMP7UDWDIQH5T",
"name":"Urgency",
"value":"High-Medium"
}
],
"approvalDeadlineDateTime":"2018-03-10T07:59:59Z",
"category":{
"guid":"4M6P8L6XKN6GZIX445T6",
"name":"Deviation",
"path":"Change\\Deviation"
},
"creationDateTime":"2018-03-07T00:53:59Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"description":"The chipset at U1, U3, U17 can be programmed with the new logic
X89c12. Allow use of the alternate chips at these locations until supply is exhausted.
EDIT-Add U14.",
"effectiveDateTime":null,
"effectivityType":"TEMPORARY",

©2022 Arena, A PTC Business www.arenasolutions.com 408

 Arena REST API Developer Guide Endpoints

"enforceApprovalDeadline":false,
"expirationDateTime":"2018-03-28T07:00:00Z",
"guid":"3L5O7K5WJM58R9PPUQJC",
"implementationStatus":"NOT_STARTED",
"lifecycleDateTime":"2018-03-07T00:53:59Z",
"lifecycleStatus":{
"type":"OPEN_AND_UNLOCKED"
},
"number":"DEV-000002",
"routings":[
{
"guid":"I0K3MZKBY1IL4N6P5RSG",
"name":"Component Librarian"
},
{
"guid":"2K4N6J4VIL25O7Q9PBCD",
"name":"CTO Review"
}
],
"submissionDateTime":null,
"title":"Use Alternate Chipset with New Logic in 500 Boards"
}

Attempt to move a Change beteween permanent and temporary effectivity

{
"status":400,
"errors":[
{
"code":4019,
"message":"Effectivity cannot be modified because once created, a Change
cannot move between permanent and temporary effectivity."
}
]
}

effectivityType has an enforced default value and cannot be edited

{
"status":400,
"errors":[
{
"code":4014,
"message":"The default value for effectivityType is enforced for Changes
assigned to this category, so the supplied value must match the default."
}
]
}

numberingSequence has an enforced default value and cannot be edited

{
"status":400,
"errors":[
{
"code":4015,

©2022 Arena, A PTC Business www.arenasolutions.com 409

 Arena REST API Developer Guide Endpoints

"message":"The default value for numberingSequence is enforced for Changes

assigned to this category, so the supplied value must match the default."
}
]
}

Category cannot be selected because it has an enforced default value for effectivityType which does not match
the current value

{
"status":400,
"errors":[
{
"code":4017,
"message":"This Change cannot be assigned to the specified category
because that category’s enforced default effectivity is not allowed."
}
]
}

Category cannot be selected because it has an enforced default value for numberingSequence which does
not match the current value

{
"status":400,
"errors":[
{
"code":4018,
"message":"This Change cannot be assigned to the specified category
because once created, a Change cannot move to a different number sequence."
}
]
}

Change cannot be updated in the current lifecycle stage

{
"status":400,
"errors":[
{
"code":4020,
"message":"The change cannot be updated at this lifecycle stage."
}
]
}

Request with invalid GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"ASCVERC3QTCFYGPWW1WCS\" is not valid"
}

©2022 Arena, A PTC Business www.arenasolutions.com 410

 Arena REST API Developer Guide Endpoints

]
}

©2022 Arena, A PTC Business www.arenasolutions.com 411

 Arena REST API Developer Guide Endpoints

DELETE Change
/changes/<GUID>

Deletes a change with a given GUID. Changes can only be deleted in the Open and Unlocked, Canceled, and
Rejected lifecycle phases.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response.

Request with invalid GUID

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 412

 Arena REST API Developer Guide Endpoints

POST Change Affected Item Add

/changes/<GUID>/items

Adds an item to a change with a specific GUID.

NOTES:

1. newItemRevision is the GUID of the working revision of the Item being added to the change. In workspaces
that include Revision Sequences (wherein the next revision is automatically assigned to an Item as long as
no revision has been specified on the working revision), newRevisionNumber can be omitted, as long as
there is a next revision available in the sequence.

2. affectedItemRevision is the GUID of the effective revision of the Item being added to the Change.

3. The GUID in the response to this call is the Change-Item association GUID and is used in the PUT Change
Affected Item endpoint.

4. If includedInThisChange=false for any view, the notes field is not allowed.

5. When adding items to a Change with temporary effectivity, no views can be specified.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

Add an item to a change, specifying included views and inventory disposition

/changes/<GUID>/items

{
"filesView":{
"includedInThisChange":true,
"notes":"Files notes."
},
"sourcingView":{
"includedInThisChange":true,
"notes":"Sourcing notes."
},
"specsView":{
"includedInThisChange":true,
"notes":"Specs notes."
},
"bomView":{
"includedInThisChange":true,
"notes":"BOM notes."
},
"newItemRevision":{

©2022 Arena, A PTC Business www.arenasolutions.com 413

 Arena REST API Developer Guide Endpoints

"guid":"TBVEXAVM9CVCVDN6IAA5"
},
"newRevisionNumber":"B",
"newLifecyclePhase":{
"guid":"DVFYHUF6TWEH0J2L4EYV"
},
"materialEffectivityDateTime":"2018-06-02T00:00:00Z",
"dispositionAttributes":[
{
"guid":"XFZI1EZQDGYL4N5DOHO4",
"value":"Accept to stock",
"notes":"Still usable with mod"
}
]
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

{
"affectedItemRevision":{
"effectiveDateTime": "2020-07-26T06:54:20Z",
"guid":"8QATCPA1ORARAS2LXQC0",
"name": "Dura-Glass Panel",
"number":"130-00001",
"revisionNumber":"A",
"revisionStatus": "SUPERSEDED",
"url": {
"api": "https://api.arenasolutions.com/v1/items/8QATCPA1ORARAS2LXQC0",
"app": "https://app.bom.com/8QATCPA1ORARAS2LXQC0"
}
},

©2022 Arena, A PTC Business www.arenasolutions.com 414

 Arena REST API Developer Guide Endpoints

"bomView":{
"includedInThisChange":true,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":false,
"notes":"BOM notes."
},
"dispositionAttributes":[
{
"guid":"1J3M5I3UHK1J2L3BMFMM",
"name":"In the Field",
"notes":null,
"value":null
},
{
"guid":"2K4N6J4VIL2K3M4CNGNG",
"name":"WIP",
"notes":null,
"value":null
},
{
"guid":"3L5O7K5WJM3L4N5DOHOB",
"name":"On Order",
"notes":"Still usable with mod",
"value":"Accept to stock"
},
{
"guid":"4M6P8L6XKN4M5O6EPIPJ",
"name":"Finished Goods",
"notes":null,
"value":null
},
{
"guid":"5N7Q9M7YLO5N6P7FQJQH",
"name":"In Stock",
"notes":null,
"value":null
}
],
"filesView":{
"includedInThisChange":true,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":false,
"notes":"Files notes."
},
"guid":"HZJ2LYJAX0IBUD0C2CRS",
"materialEffectivityDateTime":null,
"newItemRevision":{
"effectiveDateTime": "2020-11-18T22:04:06Z",
"guid":"TBVEXAVM9CVCVDN6IAA5",
"name": "Dura-Glass Panel",
"number":"130-00001",
"revisionNumber":"B",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "https://api.arenasolutions.com/v1/items/TBVEXAVM9CVCVDN6IAA5",

©2022 Arena, A PTC Business www.arenasolutions.com 415

 Arena REST API Developer Guide Endpoints

"app": "https://app.bom.com/TBVEXAVM9CVCVDN6IAA5"
}
},
"newLifecyclePhase":{
"guid":"DVFYHUF6TWEH0J2L4EYV",
"name":"In Production"
},
"newRevisionNumber":"B",
"sourcingView":{
"includedInThisChange":true,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":true,
"notes":"Sourcing notes."
},
"specsView":{
"includedInThisChange":true,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":false,
"notes":"Specs notes."
}
}

Request with invalid GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 416

 Arena REST API Developer Guide Endpoints

PUT Change Affected Item Edit

/changes/<GUID>/items/<GUID>

Updates modification information for an item on a change with a given change-item association GUID, included
in a change with a given GUID, including item views/notes, new revision number, new lifecycle phase, and
inventory disposition information.

Item modifications can only be edited while a change is in the Open and Unlocked lifecycle phase. As soon as
a change is submitted, all included Items are locked to modification.

Note: When making edits to an Item's modification information, you must provide newRevisionNumber, even if you
do not wish to change it from the current value.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"filesView":{
"includedInThisChange":false
},
"sourcingView":{
"includedInThisChange":false
},
"specsView":{
"includedInThisChange":true,
"notes":"note new owner"
},
"bomView":{
"includedInThisChange":true,
"notes":"modifications at lines 17 and 34"
},
"newRevisionNumber":"C",
"newLifecyclePhase":{
"guid":"O6Q9S07T9HZ2L4N6P38C"
},
"materialEffectivityDateTime":"2017-06-03T19:23:58Z",
"dispositionAttributes":[
{
"guid":"6O8RAIPBRZGYH0J0206J",
"value":"Use to exhaust",
"notes":"The remaining batches can be shipped with the service bulletin"
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 417

 Arena REST API Developer Guide Endpoints

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Update the modification information for an item on a change

/changes/<GUID>/items/<GUID>

{
"affectedItemRevision":{
"effectiveDateTime": "2020-10-01T06:54:20Z",
"guid":"YG0J2J2IERARATB537OW",
"name": "Power Supply",
"number":"110-0003",
"revisionNumber":"A",
"revisionStatus": "SUPERSEDED",
"url": {
"api": "https://api.arenasolutions.com/v1/items/YG0J2J2IERARATB537OW",
"app": "https://app.bom.com/YG0J2J2IERARATB537OW"
}
},
"bomView":{
"includedInThisChange":true,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":true,
"notes":"modifications at lines 17 and 34"
},
"dispositionAttributes":[
{
"guid":"Q8SBUBUA6J0I1K3MH6FR",
"name":"On Order",
"notes":null,
"value":null
},

©2022 Arena, A PTC Business www.arenasolutions.com 418

 Arena REST API Developer Guide Endpoints

{
"guid":"R9TCVCVB7K1J2L4NI7GB",
"name":"WIP",
"notes":null,
"value":null
},
{
"guid":"TBVEXEXD9M3L4N6PK9HS",
"name":"Finished Goods",
"notes":null,
"value":null
},
{
"guid":"UCWFYFYEAN4M5O7QLAI3",
"name":"In the Field",
"notes":null,
"value":null
},
{
"guid":"6O8RAIPBRZGYH0J0206J",
"name":"In Stock",
"notes":"The remaining batches can be shipped with the service bulletin",
"value":"Use to exhaust"
}
],
"filesView":{
"includedInThisChange":false
},
"guid":"UCWFYFYEAN5YH0JSFPEP",
"materialEffectivityDateTime":2017-06-03T19:23:58Z,
"newItemRevision":{
"effectiveDateTime": "2020-11-18T22:04:06Z",
"guid":"3L5O7O7NJWFWFYGA8CTT",
"name": "Power Supply",
"number":"110-0003",
"revisionNumber":"B",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "https://api.arenasolutions.com/v1/items/3L5O7O7NJWFWFYGA8CTT",
"app": "https://app.bom.com/3L5O7O7NJWFWFYGA8CTT"
}
},
"newLifecyclePhase":{
"guid":"O6Q9S07T9HZ2L4N6P38C",
"name":"In Production"
},
"newRevisionNumber":"C",
"sourcingView":{
"includedInThisChange":false
},
"specsView":{
"includedInThisChange":true,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":false,
"notes":"note new owner"

©2022 Arena, A PTC Business www.arenasolutions.com 419

 Arena REST API Developer Guide Endpoints

}
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 420

 Arena REST API Developer Guide Endpoints

DELETE Change Affected Item

changes/<GUID>/items/<GUID>

Removes an item with a given GUID from a change with a given GUID. Items can only be removed from changes
in the Open and Unlocked lifecycle phase.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response.

Change is not in an editable lifecycle

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 421

 Arena REST API Developer Guide Endpoints

Request with invalid GUID (item not included in change)

{
"status":400,
"errors":[
{
"code":3012,
"message":"The requested object with guid \"UCWFYFYEAN5YH0JSFPEP\" is not
found."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 422

 Arena REST API Developer Guide Endpoints

POST Change Status (Lock/Unlock)

/changes/statuschanges

This endpoint can be used to change the status of a Change object. This article demonstates how to lock a
change to prevent users from editing any of its views. This article also demonstrates how to unlock a change.

To lock a change with a specific GUID, include the new attribute status and input a value of OPEN_AND_LOCKED
within the request body.

To unlock a change, input a value of OPEN_AND_UNLOCKED for the attribute status within the request body.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Locks a Change. The Change must have an initial status of OPEN_AND_UNLOCKED.

POST /changes/statuschanges

Request

{
"change": {

©2022 Arena, A PTC Business www.arenasolutions.com 423

 Arena REST API Developer Guide Endpoints

"guid": "Q8SBU7SJ69SVEWCEKLBO"
},
"comment": "Locking change.",
"status": "OPEN_AND_LOCKED"
}

Response

{
"change": {
"guid": "Q8SBU7SJ69SVEWCEKLBO",
"number": "ECO-000020"
},
"comment": "Locking change.",
"status": "OPEN_AND_LOCKED"
}

Unlocks a Change. Change must initially have a status of OPEN_AND_LOCKED.

POST /changes/statuschanges

Request

{
"change": {
"guid": "Q8SBU7SJ69SVEWCEKLBO"
},
"comment": "Unlocking Change to edit routing and description.",
"status": "OPEN_AND_UNLOCKED"
}

Response

{
"change": {
"guid": "Q8SBU7SJ69SVEWCEKLBO",
"number": "ECO-000020"
},
"comment": "Unlocking Change to edit routing and description.",
"status": "OPEN_AND_UNLOCKED"
}

©2022 Arena, A PTC Business www.arenasolutions.com 424

 Arena REST API Developer Guide Endpoints

POST Change Status (Submitting and Admin-Defined)

/changes/statuschanges

This endpoint can be used to change the status of a Change object. This article demonstates how to submit a
change that has a routing method of admin-defined. Admin-Defined routing methods can be configured
within the Configuration, Changes view in Workspace settings or in the Routing section of the specific change
category in the Changes, Category view in workspace settings.

The Admin-Defined routing method is unique because it is a two-setp submission process. A user must first
submit the change to a change administrator. This process is called submitted for routing. The change
administrator then assigns a routing to the change and submits the change. This process is called submitted
for approval.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Submits a change for routing when routing method is set to admin-defined. In this endpoint, the user submits
the change for routing. In the example below, the user doesn't have to define the change administrator since
it is defined by the change category.

POST /changes/statuschanges

©2022 Arena, A PTC Business www.arenasolutions.com 425

 Arena REST API Developer Guide Endpoints

Request

{
"change": {
"guid": "P7RAT6RI58RUDVBBE2ZP"
},
"administrators": {
{
"guid": "J1L4N0LCZ2J2L4N6F6ZL"
}
},
"comment": "Change was built with a category that contains an admin defined
routing method. Modifying to a different Change Admin",
"status": "SUBMITTED"
}

Response

{
"administrators": [
{
"email": "[email protected]"
"number": "Heidi Walker"
"guid": "WEYH0DYPCFWFYH0JSIPD",
},
],
"change": {
"guid": "P7RAT6RI58RUDVBBE2ZP",
"number": "ECO-000027"
},
"comment": "Change was built with a category that contains an admin defined
routing method.",
"status": "SUBMITTED_FOR_ROUTING"
}

POST /changes/statuschanges

Submits a change for routing when routing method is set to admin-defined. In this endpoint, the user submits
the change for routing. In the example below, the user includes a change administrator to modify the assigned
change administrator for the change.

Request

{
"administrators": [
{
"email": "[email protected]"
"number": "Toshiro Makamuri"
"guid": "J1L4N0LCZ2J2L4N6F6ZL",
},
],
"change": {
"guid": "P7RAT6RI58RUDVBBE2ZP",
"number": "ECO-000027"
},

©2022 Arena, A PTC Business www.arenasolutions.com 426

 Arena REST API Developer Guide Endpoints

"comment": "Change was built with a category that contains an admin defined
routing method. Modifying to a different Change Admin",
"status": "SUBMITTED_FOR_ROUTING"
}

Response

{
"administrators": [
{
"email": "[email protected]"
"number": "Toshiro Makamuri"
"guid": "J1L4N0LCZ2J2L4N6F6ZL",
},
],
"change": {
"guid": "P7RAT6RI58RUDVBBE2ZP",
"number": "ECO-000027"
},
"comment": "Change was built with a category that contains an admin defined
routing method. Modifying to a different Change Admin",
"status": "SUBMITTED_FOR_ROUTING"
}

POST /changes/statuschanges

In this example, a change administrator submits a change that has been submitted for routing. It is implied
that the change administrator has assigned a routing through the use of another endpoint. Once the routing
is configured and the change administrator submits the change, the change moves to the following status:
SUBMITTED_FOR_APPROVAL.

Request

{
"change": {
"guid": "P7RAT6RI58RUDVBBE2ZP"
},
"comment": "Submitting Change for Approval. The user performing this call is the
Change Administrator",
"status": "SUBMITTED"
}

Response

{
"administrators": [
{
"email": "[email protected]"
"number": "Toshiro Makamuri"
"guid": "J1L4N0LCZ2J2L4N6F6ZL",
},
],
"change": {
"guid": "P7RAT6RI58RUDVBBE2ZP",
"number": "ECO-000027"

©2022 Arena, A PTC Business www.arenasolutions.com 427

 Arena REST API Developer Guide Endpoints

},
"comment": "Submitting Change for Approval. The user performing this call is the
Change Administrator",
"status": "SUBMITTED_FOR_APPROVAL"
}

Request

An error is returned if a user attempts to include a change administrator in the request body for a change with
a status of SUBMITTED_FOR_ROUTING. Note that in the earlier example where the user edited the change
administrator with this endpoint the change was moving from a status of OPEN_AND_UNLOCKED to
SUBMITTED_FOR_ROUTING. In the example below, the change already contains a status of
SUBMITTED_FOR_ROUTING.

{
"change": {
"guid": "P7RAT6RI58RUDVBBE2ZP"
},
"administrators": {
{
"guid": "J1L4N0LCZ2J2L4N6F6ZL"
}
},
"comment": "Change was built with a category that contains an admin defined
routing method. Change was already submitted for routing.",
"status": "SUBMITTED"
}

Response

{
"status": 400,
"errors": [
{
"code": 3145,
"message": "This specific change lifecycle transition does not support
the inclusion of a change administrator."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 428

 Arena REST API Developer Guide Endpoints

POST Change Status (Submitting and Auto-Routing)

/changes/statuschanges

This endpoint can be used to change the status of a Change object. This article demonstates how to submit a
change that has a routing method of auto-routing. Auto-Routing routing methods can be configured within
the Configuration, Changes view in Workspace settings or in the Routing section of the specific change category
in the Changes, Category view in workspace settings.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Submits a Change when the routing method is set to auto-routing. In this scenario, no routing is applied and
the routing method is set to auto-routing so the change is effective immediately after submitting.

POST /changes/statuschanges

Request

{
"change": {
"guid": "L3N6P2NE14NQ9R77AYVQ"
},

©2022 Arena, A PTC Business www.arenasolutions.com 429

 Arena REST API Developer Guide Endpoints

"comment": "Submitting for approval without a routing in an auto-routing

configuraiton workspace",
"status": "SUBMITTED"
}

Response

{
"change": {
"guid": "L3N6P2NE14NQ9R77AYVQ",
"number": "ECO-000023"
},
"comment": "Unlocking Change to edit routing and description.",
"status": "EFFECTIVE"
}

Submits a Change when the routing method is set to auto-routing. In this scenario, a routing is specified within
the workspace configuration settings or within the Routing tab for the change category.

POST /changes/statuschanges

Request

{
"change": {
"guid": "L3N6P2NE14NQ9R77AYVQ"
},
"comment": "Submitting for approval. Routing is specified by the modifications
of the Item within the change.",
"status": "SUBMITTED"
}

Response

{
"change": {
"guid": "L3N6P2NE14NQ9R77AYVQ",
"number": "ECO-000023"
},
"comment": "Submitting for approval. Routing is specified by the modifications
of the Item within the change.",
"status": "SUBMITTED_FOR_APPROVAL"
}

Returns an error if a user includes a change administrator when the change has a routing method of auto-routing.

POST /changes/statuschanges

Request

{
"change": {
"guid": "L3N6P2NE14NQ9R77AYVQ"
},
"administrators": {
{

©2022 Arena, A PTC Business www.arenasolutions.com 430

 Arena REST API Developer Guide Endpoints

"guid": "WEYH0DYPCFWFYH0JSIPD"
}
},
"comment": "Submitting for approval using a Change with a category specific
routing set to auto-routing",
"status": "SUBMITTED"
}

Response

{
"status": 400,
"errors": [
{
"code": 3145,
"message": "This specific change lifecycle transition does not support
the inclusion of a change administrator."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 431

 Arena REST API Developer Guide Endpoints

POST Change Status (Submitting and User-Defined)

/changes/statuschanges

This endpoint can be used to change the status of a Change object. This article demonstates how to submit a
change that has a routing method of user-defined. User-Defined routing methods can be configured within
the Configuration, Changes view in Workspace settings or in the Routing section of the specific change category
in the Changes, Category view in workspace settings.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Submits a Change when the routing method is set to user-defined. In this scenario, the routing is configured
by the user in the user interface.

POST /changes/statuschanges

Request

{
"change": {
"guid": "R9TCV8TK7ATWFXDDG41X"
},

©2022 Arena, A PTC Business www.arenasolutions.com 432

 Arena REST API Developer Guide Endpoints

"comment": "Submitting Change for Approval. User defined routing method. Routing
specified.",
"status": "SUBMITTED"
}

Response

{
"change": {
"guid": "R9TCV8TK7ATWFXDDG41X",
"number": "ECO-000028"
},
"comment": "Submitting Change for Approval. User defined routing method. Routing
specified.",
"status": "SUBMITTED_FOR_APPROVAL"
}

Returns an error if the user submits the change and no routing is specified.

POST /changes/statuschanges

Request

{
"change": {
"guid": "R9TCV8TK7ATWFXDDG41X"
},
"comment": "Submitting Change for Approval. User defined routing method. No
routing specified.",
"status": "SUBMITTED"
}

Response

{
"status": 400,
"errors": [
{
"code": 5006,
"message": "No routing has been specified for this Change. The Change
configuration for this workspace requires that at least one routing be
assigned before a Change may be submitted."
},
{
"code": 5106,
"message": "Item Number #347-98765: The modified Item has required
inventory disposition actions that must be selected. Before this Change can
be submitted you must fo to the Inventory Disposition subview of
the Items view and select a Disposition Action for each required Disposition
Status."
},
{
"code": 5183,
"message": "Item Number #450-98900: The modified Item is being released
to Design and may not contain this unreleased Item in its BOM. You must
remove the Unreleased Item from the BOM of the modified Item, release

©2022 Arena, A PTC Business www.arenasolutions.com 433

 Arena REST API Developer Guide Endpoints

it to Design (by including it in this Change), or remove the modified

Item from this Change. If you choose to include this Item in this
Change, it will be released to the Design stage at the same phase as the
modified Item."
},
{
"code": 5202,
"message": "Notice: No approval deadline has been specified for this
Change."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 434

 Arena REST API Developer Guide Endpoints

GET Change Alerts

changes/<guid>/alerts

Submitting changes can fail due to change submission errors. Change submission errors can occur due to Item
lifecycle disagreements, failure to complete required invetory dispositions, and other issues.

When a Change fails to submit, the first 20 errors are displayed within the response. If there are more than 20
errors, users can use this GET Change Alerts endpoint to see all the errors.

The Change Alerts endpoints displays warning notices as well as errors. Errors are issues that have to be
corrected in order for the Change to be submitted. Notices are warning notifications that do not have to be
corrected in order for the Change to be submitted.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get the Change Alerts of a Change.

GET /changes/<GUID>/alerts

{
"count": 54,

©2022 Arena, A PTC Business www.arenasolutions.com 435

 Arena REST API Developer Guide Endpoints

"results": [
{
"code": 5006,
"message": "No routing has been specified for this Change. The Change
configuration for this workspace requires that at least one routing be
assigned before a Change may be submitted."
},
{
"code": 5106,
"message": "Item Number #347-98765: The modified Item has required
inventory disposition actions that must be selected. Before this Change can
be submitted you must fo to the Inventory Disposition subview of
the Items view and select a Disposition Action for each required Disposition
Status."
},
{
"code": 5183,
"message": "Item Number #450-98900: The modified Item is being released
to Design and may not contain this unreleased Item in its BOM. You must
remove the Unreleased Item from the BOM of the modified Item, release
it to Design (by including it in this Change), or remove the modified
Item from this Change. If you choose to include this Item in this
Change, it will be released to the Design stage at the same phase as the
modified Item."
},
{
"code": 5202,
"message": "Notice: No approval deadline has been specified for this
Change."
},
...
]
}

In the example above, alert error code 5202 is a notice. All the other alerts that do not contain the string "Notice:"
are errors that must be resolved in order for the change to be submitted.

©2022 Arena, A PTC Business www.arenasolutions.com 436

 Arena REST API Developer Guide Endpoints

GET Change Files View Associations

/changes/<GUID>/files

Returns a list of Files for a Change with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Change File Associations

GET <url>/changes/<GUID>/files

{
"count": 3,
"results": [
{
"file": {
"author": {
"fullName": "George C Lewis"
},
"category": {
"guid": "CUEXGTE5SVEO7Q5CCD07"

©2022 Arena, A PTC Business www.arenasolutions.com 437

 Arena REST API Developer Guide Endpoints

},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2011-06-02T19:30:28Z",
"description": null,
"edition": "1",
"format": "jpg",
"guid": "5N7Q9M7YLO7N6PSJ5BSL",
"hasMarkup": false,
"lastModifiedDateTime": "2011-06-02T21:48:39Z",
"latest": true,
"location": null,
"locked": false,
"mimeType": "image/jpeg",
"name": "27005.jpg",
"number": "FILE-000899",
"private": false,
"size": 9627,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "USB Mini Cable image"
},
"guid": "J1L4N0LCZ2JQ9SO87OGE"
},
{
"file": {
"author": {
"fullName": "George C Lewis"
},
"category": {
"guid": "CUEXGTE5SVEO7Q5CCD07"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2011-06-02T19:30:28Z",
"description": "rework from ZIP-PWR-DC",
"edition": "1",
"format": "jpg",
"guid": "ZH1K3G1SFI1H0JMDZ5MJ",
"hasMarkup": false,
"lastModifiedDateTime": "2011-06-02T21:53:42Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "image/jpeg",
"name": "ZIP-PWR-DC.jpg",
"number": "FILE-000864",
"private": false,
"size": 4480,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "USB to Car Power Adapter image"
},
"guid": "HZJ2LYJAX0HO7QM65MEH"
},

©2022 Arena, A PTC Business www.arenasolutions.com 438

 Arena REST API Developer Guide Endpoints

{
"file": {
"author": {
"fullName": "George C Lewis"
},
"category": {
"guid": "3L5O7K5WJM5FYHW334R7"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2011-06-02T19:30:28Z",
"description": null,
"edition": "1",
"format": "pdf",
"guid": "K2M5O1MD03M2L47YKQ7D",
"hasMarkup": false,
"lastModifiedDateTime": "2011-06-02T19:30:28Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/pdf",
"name": "USB to Car Power Adapter.pdf",
"number": "FILE-000914",
"private": false,
"size": 41235,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "USB to Car Power Adapter"
},
"guid": "I0K3MZKBY1IP8RN76NF7"
}
]
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 439

 Arena REST API Developer Guide Endpoints

GET Change Files View Association

/changes/<GUID>/files/<GUID>

Returns a specific File from the Files view of a specific Change with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Change Files View Association

GET <url>/changes/<GUID>/files/<GUID>

{
"file": {
"author": {
"fullName": "George C Lewis"
},
"category": {
"guid": "3L5O7K5WJM5FYHW334R7"
},
"checkedOut": false,
"corrected": false,

©2022 Arena, A PTC Business www.arenasolutions.com 440

 Arena REST API Developer Guide Endpoints

"creationDateTime": "2011-06-02T19:30:28Z",
"description": null,
"edition": "1",
"format": "pdf",
"guid": "K2M5O1MD03M2L47YKQ7D",
"hasMarkup": false,
"lastModifiedDateTime": "2011-06-02T19:30:28Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/pdf",
"name": "USB to Car Power Adapter.pdf",
"number": "FILE-000914",
"private": false,
"size": 41235,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "USB to Car Power Adapter"
},
"guid": "I0K3MZKBY1IP8RN76NF7"
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 441

 Arena REST API Developer Guide Endpoints

POST Change Files View Add Existing File

/changes/<GUID>/files

Associates an existing File Association object with the Files view of a Change with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Sample Request Body

{
"file":{
"guid":"VDXGZCXOBEXDWFI9V1ID"
}
}

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Associate an existing file with a Change

/changes/<GUID>/files

{
"file": {

©2022 Arena, A PTC Business www.arenasolutions.com 442

 Arena REST API Developer Guide Endpoints

"author": {
"fullName": "Bret D Lobree"
},
"category": {
"guid": "3L5O7K5WJM5FYHW334R7"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2011-06-02T19:30:28Z",
"description": "COMPACT PLCC SOCKETS Surface Mount",
"edition": "1",
"format": "pdf",
"guid": "VDXGZCXOBEXDWFI9V1ID",
"hasMarkup": false,
"lastModifiedDateTime": "2011-06-02T19:30:28Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/pdf",
"name": "095.pdf",
"number": "FILE-000860",
"private": false,
"size": 154507,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "Mill-Max Series 540"
},
"guid": "L3N6P2NE14LSBUQA9QHP"
}

An error is returned if the GUID is not valid.

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 443

 Arena REST API Developer Guide Endpoints

DELETE Change File View Association

/changes/<GUID>/files/<GUID>

Removes a File association from the Files view of a Change with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response.

Produces an error if the requested file association does not exist.

{
"status": 400,
"errors": [
{
"code": 3029,
"message": "The file association does not exist between object
\"Q8SBG6CHGDWDWB7W8EJG\" and object \"EWGZ4U0541K0J2TJSQGG\"."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 444

 Arena REST API Developer Guide Endpoints

GET Change Implementation Files View Associations

/changes/<GUID>/implementationfiles

Returns a list of file objects associated with the Implementation view of a Change with a specific GUID.

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Change Implementation View Associations

GET <url>/changes/<GUID>/implementationfiles

{
"count": 4,
"results": [
{
"file": {
"author": {
"fullName": "Bret D Lobree"
},
"category": {
"guid": "TBVEXAVM9CV5O7MTTUH9"
},
"checkedOut": false,
"corrected": false,

©2022 Arena, A PTC Business www.arenasolutions.com 445

 Arena REST API Developer Guide Endpoints

"creationDateTime": "2011-06-02T19:30:28Z",
"description": null,
"edition": "1",
"format": "pdf",
"guid": "9RBUDQB2PSBRATWN9FV3",
"hasMarkup": false,
"lastModifiedDateTime": "2011-06-02T19:30:28Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/pdf",
"name": "NDT456P.pdf",
"number": "FILE-000815",
"private": false,
"size": 101958,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "NDT456P"
},
"guid": "FXH0JWH8VYC0J2EYESP7"
},
{
"file": {
"author": {
"fullName": "Helen Shaughnessy"
},
"category": {
"guid": "TBVEXAVM9CV5O7MTTUH9"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2011-06-02T19:30:28Z",
"description": "NEC Product Spec for touch screen model -
nl4864hl11-01b",
"edition": "1",
"format": "pdf",
"guid": "HZJ2LYJAX0JZI14VHN4J",
"hasMarkup": false,
"lastModifiedDateTime": "2011-06-02T19:30:28Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/pdf",
"name": "NEC - TouchLCD-NL4864HL11-01B.pdf",
"number": "FILE-000911",
"private": false,
"size": 251396,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "NEC - TouchLCD-NL4864HL11-01B"
},
"guid": "EWGZIVG7UXBZI1DXDRO2"
},
{
"file": {

©2022 Arena, A PTC Business www.arenasolutions.com 446

 Arena REST API Developer Guide Endpoints

"author": {
"fullName": "Helen Shaughnessy"
},
"category": {
"guid": "TBVEXAVM9CV5O7MTTUH9"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2011-06-02T19:30:28Z",
"description": "NEC Datasheet for NL4864HL11-01B 3.5 inch LCD touch
screen",
"edition": "1",
"format": null,
"guid": "6O8RAN8ZMP8O7QTK6CSN",
"hasMarkup": false,
"lastModifiedDateTime": "2011-06-02T19:30:28Z",
"latest": true,
"location": "http://www.nec-lcd.com/en/products/nl4864hl11-01b.html",

"locked": true,
"mimeType": null,
"name": null,
"number": "FILE-000935",
"private": false,
"size": 0,
"storageMethod": 3,
"storageMethodName": "WEB",
"title": "NEC Datasheet for NL4864HL11-01B"
},
"guid": "DVFYHUF6TWAYH0CWCQNV"
},
{
"file": {
"author": {
"fullName": "Nathan Martin"
},
"category": {
"guid": "7P9SBO90NQ9J2L0778VN"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2011-06-02T19:30:28Z",
"description": "See Item_Number schema for compliance status",
"edition": "1",
"format": "pdf",
"guid": "Q8SBU7SJ69S8RAD4QWBR",
"hasMarkup": false,
"lastModifiedDateTime": "2011-06-02T19:30:28Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/pdf",
"name": "NRC06J474TR_NICCS01262-1.pdf",
"number": "FILE-000873",
"private": false,

©2022 Arena, A PTC Business www.arenasolutions.com 447

 Arena REST API Developer Guide Endpoints

"size": 136411,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "NRC06J474TR_NICCS01262-1"
},
"guid": "CUEXGTE5SV9XGZBVBPM7"
}
]
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 448

 Arena REST API Developer Guide Endpoints

GET Change Implementation Files View Association

/changes/<GUID>/implementationfiles/<GUID>

Returns a File object located within the Implementation Files view of a Change with a specific GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Change Implementation Views Association

GET <url>/files/<GUID>/implementationfiles/<GUID>

{
"file": {
"author": {
"fullName": "Helen Shaughnessy"
},
"category": {
"guid": "TBVEXAVM9CV5O7MTTUH9"
},
"checkedOut": false,
"corrected": false,

©2022 Arena, A PTC Business www.arenasolutions.com 449

 Arena REST API Developer Guide Endpoints

"creationDateTime": "2011-06-02T19:30:28Z",
"description": "NEC Product Spec for touch screen model - nl4864hl11-01b",
"edition": "1",
"format": "pdf",
"guid": "HZJ2LYJAX0JZI14VHN4J",
"hasMarkup": false,
"lastModifiedDateTime": "2011-06-02T19:30:28Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/pdf",
"name": "NEC - TouchLCD-NL4864HL11-01B.pdf",
"number": "FILE-000911",
"private": false,
"size": 251396,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "NEC - TouchLCD-NL4864HL11-01B"
},
"guid": "EWGZIVG7UXBZI1DXDRO2"
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 450

 Arena REST API Developer Guide Endpoints

POST Change Implementation Files View Add Existing File

/changes/<GUID>/implementationfiles

Associates an existing File Association object with the Implementation Files view of a Change with a given
GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Sample Request Body

{
"file":{
"guid":"WEYH0DYPCFYEXGJAW2JP"
}
}

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Associate an existing file with the Implementation Files view of a specific Change.

/changes/<GUID>/implementationfiles

©2022 Arena, A PTC Business www.arenasolutions.com 451

 Arena REST API Developer Guide Endpoints

{
"file": {
"author": {
"fullName": "George C Lewis"
},
"category": {
"guid": "TBVEXAVM9CV5O7MTTUH9"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2011-06-02T19:30:28Z",
"description": null,
"edition": "1",
"format": "pdf",
"guid": "WEYH0DYPCFYEXGJAW2JP",
"hasMarkup": false,
"lastModifiedDateTime": "2011-06-02T19:30:28Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/pdf",
"name": "ZIP-PWR-AC.pdf",
"number": "FILE-000861",
"private": false,
"size": 120052,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "ZIP-PWR-AC"
},
"guid": "I0K3MZKBY1F3M5H1HVS5"
}

An error is returned if the GUID is not valid.

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 452

 Arena REST API Developer Guide Endpoints

DELETE Change Implementation File View Association

/changes/<GUID>/implementationfiles/<GUID>

Removes a File association from the Implementation Files view of a Change with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response.

Produces an error if the requested file association does not exist.

{
"status": 400,
"errors": [
{
"code": 3029,
"message": "The file association does not exist between object
\"Q8SBG6CHGDWDWB7W8EJG\" and object \"EWGZ4U0541K0J2TJSQGG\"."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 453

 Arena REST API Developer Guide Endpoints

GET Change File Markups

/changes/<GUID>/markupfiles

Returns a collection of Markup Files associated with a specific Change.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get File Markups of a File with a given GUID

GET <url>/changes/<GUID>/markupfiles

{
"count": 2,
"results": [
{
"guid": "3L5O7K5WJM0N6PL54KRE",
"markup": {
"author": {
"fullName": "Jamie Smith"
},
"category": {

©2022 Arena, A PTC Business www.arenasolutions.com 454

 Arena REST API Developer Guide Endpoints

"guid": "0I2L4H2TGJ2CVET001OY"
},
"creationDateTime": "2021-01-22T19:51:01Z",
"format": "333",
"guid": "Q8SBU7SJ69S8RA07P9F9",
"lastModifiedDateTime": "2021-01-22T19:59:08Z",
"locked": false,
"mimeType": "application/pdf",
"name": "ergps-300-schematic.pdf",
"size": 260178,
"storageMethodName": "FILE",
"title": "1004"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"reserved": true,
"reservedUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
},
{
"guid": "4M6P8L6XKN1O7QM65LS5",
"markup": {
"author": {
"fullName": "Jamie Smith"
},
"category": {
"guid": "2K4N6J4VIL4EXGV223PR"
},
"creationDateTime": "2021-01-22T03:31:04Z",
"format": "Web",
"guid": "FXH0JWH8VYHXGZPWEY43",
"lastModifiedDateTime": "2021-01-22T03:31:04Z",
"location": "www.everyroadgps.com/Spring2021",
"locked": false,
"size": 0,
"storageMethodName": "WEB",
"title": "ftp001"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"reserved": false
}
]
}

Returns an error if a parameter is not a valid search attribute.

©2022 Arena, A PTC Business www.arenasolutions.com 455

 Arena REST API Developer Guide Endpoints

{
"status":400,
"errors":[
{
"code":3019,
"message":"The attribute \"edition\" is not searchable."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 456

 Arena REST API Developer Guide Endpoints

GET Change File Markup

/changes/<GUID>/markupfiles/<GUID>

Returns a Change File Markup object with a given GUID. This is the latest edition of the File.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get a Change-File association with a given GUID

GET <url>/changes/<GUID>/markupfiles/<GUID>

{
"guid": "4M6P8L6XKN1O7QM65LS5",
"markup": {
"author": {
"fullName": "ftp001"
},
"category": {
"guid": "2K4N6J4VIL4EXGV223PR"
},
"creationDateTime": "2021-01-22T03:31:04Z",

©2022 Arena, A PTC Business www.arenasolutions.com 457

 Arena REST API Developer Guide Endpoints

"format": "Web",
"guid": "FXH0JWH8VYHXGZPWEY43",
"lastModifiedDateTime": "2021-01-22T03:31:04Z",
"location": "www.everyroadgps.com/Spring2021",
"locked": false,
"size": 0,
"storageMethodName": "WEB",
"title": "ftp001"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"reserved": false
}

Returns an error if a parameter is not a valid search attribute.

{
"status":400,
"errors":[
{
"code":3019,
"message":"The attribute \"edition\" is not searchable."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 458

 Arena REST API Developer Guide Endpoints

POST Change File Markup Create

/changes/<GUID>/markupfiles

Creates a Change File Markup File object.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type multipart/form-data

Sample Request Body

{
"file":{
"guid":"1J3M5I3UHK3J2LN69BYY"
}
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-FileGuid GUID string GUID for new file - only when including
content
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
• When associating a File Markup to a Change:

©2022 Arena, A PTC Business www.arenasolutions.com 459

 Arena REST API Developer Guide Endpoints

{
"guid": "5N7Q9M7YLO2P8RN76MT6",
"markup": {
"author": {
"fullName": "Tony Shaftoe"
},
"category": {
"guid": "0I2L4H2TGJ2CVET001OY"
},
"creationDateTime": "2011-07-25T22:38:18Z",
"format": "doc",
"guid": "1J3M5I3UHK3J2LN69BYY",
"lastModifiedDateTime": "2011-07-25T22:38:18Z",
"locked": true,
"mimeType": "application/msword",
"name": "mount-instructions-07-25-2011.doc",
"size": 27136,
"storageMethodName": "FILE",
"title": "mount-instructions-07-25-2011"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"reserved": false
}

Returns an error if a required metadata attribute is missing.

{
"status":400,
"errors":[
{
"code":3001,
"message":"The attribute \"edition\" is required."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 460

 Arena REST API Developer Guide Endpoints

DELETE Change File Markup

/changes/<GUID>/markupfiles/<GUID>

Deletes a Change File Markup with a given GUID. When a File has more than one Markup, only the latest,
unlocked edition can be deleted--to delete an entire file, repeat the DELETE request for all editions.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response.

Request with bad GUID

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}

©2022 Arena, A PTC Business www.arenasolutions.com 461

 Arena REST API Developer Guide Endpoints

]
}

©2022 Arena, A PTC Business www.arenasolutions.com 462

 Arena REST API Developer Guide Endpoints

GET Changes Ticket References

/changes/<GUID>/tickets

/changes/<GUID>/tickets/<GUID>

Returns the Ticket References of a Change object. If the endpoint is appended with a valid GUID, it returns a
single specific Change Ticket Reference.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all the Ticket References associated with an Change of a given GUID.

GET /changes/<GUID>/tickets

{
"count": 2,
"results": [
{
"guid": "CUEXGTE5SVC6P8R9O93E",
"ticket": {
"guid": "GYI1KXI9WZGVEXGZI0K9",

©2022 Arena, A PTC Business www.arenasolutions.com 463

 Arena REST API Developer Guide Endpoints

"number": "DEF-000002"
}
},
{
"guid": "HZJ2LYJAX0HBUDWETE84",
"ticket": {
"guid": "5N7Q9M7YLO5K3M5O7PAS",
"number": "REQ-000004"
}
}
]
}

Get a single Ticket Reference with a specific GUID associated with a Change with a specific GUID.

GET /changes/<GUID>/tickets/<GUID>

{
"guid": "CUEXGTE5SVC6P8R9O93E",
"ticket": {
"guid": "GYI1KXI9WZGVEXGZI0K9",
"number": "DEF-000002"
}
}

request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 464

 Arena REST API Developer Guide Endpoints

GET Quality Processes Search

/qualityprocesses

Returns a collection of Quality Process objects matching the given search criteria.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all quality
processes where results should begin. All
processes before the offset in the search
results are ignored. The default value is 0.
limit integer Specifies the number of results that should
be returned. By default the maximum
number of quality processes is 20. Can
return up 400 suppliers.

Searchable Attributes

Name Value Description

[additional attribute guid value] string This special search permits searching for
strings in additional attribute values. For
example GET
/items?VDXGZ7E0GO5N6P8PR55G=*100pF
where VDXGZ7E0GO5N6P8PR55G is the
GUID of a custom attribute and we are
searching for all items whose value for this
attribute include the string "100pF". The
ability to search for more than one value is
available for the following attribute field
types: DROP_DOWN & FIXED_DROPDOWN
(where multi-select is true). See note below
this table for additional details.

Additional attributes, also known as custom

attributes, support the date field type. Users
can perform searches by additional
attributes with a date field type by using
the format yyyy-mm-dd. In the following

©2022 Arena, A PTC Business www.arenasolutions.com 465

 Arena REST API Developer Guide Endpoints

Name Value Description

example, the user is using the following to
search for a date field type custom attribute
with a value of April 1, 2019:

GET
/qualityprocesses?GYI16WXX6DUDWFYHPRY3=2019-04-01
description string Quality process description
number string quality process number
name string quality process name
template.guid string template unique identifier
type string quality process type
owner.fullName string owner full name (first and last)
owner.guid string owner unique ID
status string status of the quality process (OPEN,
IN_PROGRESS, COMPLETED). Uncompleted
Quality Processes can be queried by
inputting a NOT operator, represented by
an exclamation point, with status. Example:
url/qualityprocesses?status=!COMPLETED
creator.fullName string creator full name (first and last)
creator.guid string creator unique ID

Note: Search behavior in the Arena REST API differs from search behavior in the Arena application. In the API, a
trailing asterisk (wildcard) is required to return results that start with a string; in the Arena application, a trailing
asterisk is always implied.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count

©2022 Arena, A PTC Business www.arenasolutions.com 466

 Arena REST API Developer Guide Endpoints

Name Value Description

X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all quality processes

/qualityprocesses

{
"count":9,
"results":[
{
"completedDateTime":null,
"creationDateTime":"2016-04-19T19:41:32Z",
"creator":{
"fullName":"Roy S",
"guid":"7P9SXNOOX4L4N6P8BG6R"
},
"currentStep":{
"approvals":null,
"attributes":null,
"guid":"YG0JOEFFOVEATCVEUGI5"
},
"description":"New Quality Process",
"guid":"XFZINDEENUD9SBUDTFH4",
"name":"New Process Introduction",
"number":"8D-000003",
"owner":{
"fullName":"Roy Stafford",
"guid":"GYI16WXX6DUDWFYHPRY3"
},
"status":"OPEN",
"statusMode":"AUTOMATIC",
"targetCompletionDateTime":null,
"template":{
"active":null,
"guid":"6O8RWMNNW3MI1K3M2TOK"
},
"type":"Design"
},
...
]
}

Returns an error if a parameter is not a valid search attribute.

{
"status": 400,
"errors": [
{
"code": 3019,
"message": "The attribute \"a\" is not searchable."
}

©2022 Arena, A PTC Business www.arenasolutions.com 467

 Arena REST API Developer Guide Endpoints

]
}

©2022 Arena, A PTC Business www.arenasolutions.com 468

 Arena REST API Developer Guide Endpoints

GET Quality Process Summary

/qualityprocesses/<GUID>

Returns a Quality Process object with a specific GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

includePossibleValues true or false If this is set to true, it returns all the possible
values for Drop Down List attributes. The
default value is false.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a single quality process

/settings/qualityprocesses/<GUID>

©2022 Arena, A PTC Business www.arenasolutions.com 469

 Arena REST API Developer Guide Endpoints

{
"completedDateTime":null,
"creationDateTime":"2016-04-19T19:23:22Z",
"creator":{
"fullName":"Roy Stafford",
"guid":"GYI16WXX6DUDWFYHPRY3"
},
"currentStep":{
"approvals":null,
"attributes":null,
"guid":"HZJ27XYY7EXTCVEXDZ27"
},
"description":"New Process Introduction Quality Assurance",
"guid":"EWGZ4UVV4BUQ9SBUAWZK",
"name":"New Process Introduction",
"number":"8D-000001",
"owner":{
"fullName":"Roy Stafford",
"guid":"GYI16WXX6DUDWFYHPRY3"
},
"status":"OPEN",
"statusMode":"AUTOMATIC",
"targetCompletionDateTime":"2016-04-30T06:59:59Z",
"template":{
"active":null,
"guid":"6O8RWMNNW3MI1K3M2TOK"
},
"type":null
}

Produces an error if the process GUID is not valid.

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"CUB5FVEN6P8RAQI\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 470

 Arena REST API Developer Guide Endpoints

POST Quality Process Create

/qualityprocesses

Creates a new Quality Process object.

NOTES:

1. If no default owner is specified for the template, you must include the GUID of an eligible owner. Otherwise,
the Create Quality Process endpoint will return an error. Find eligible owners using the Get Quality Process
Owners endpoint.

2. To create a new number for the Quality Process, the API requires that you pass the GUID for the number
format prefix only. The rest of the number is autogenerated.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"description":"New Quality Process",
"name":"New Process Introduction",
"owner":{
"guid":"GYI16WXX6DUDWFYHPRY3"
},
"template":{
"guid":"6O8RWMNNW3MI1K3M2TOK",
"numberFormat":{
"prefix":{
"guid":"P7RAF566FM5EXGZI199V"
}
}
},
"type":"Design"
}

Response Codes

Code Description
201 Success
400 Failure

©2022 Arena, A PTC Business www.arenasolutions.com 471

 Arena REST API Developer Guide Endpoints

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Create a quality process

/qualityprocesses

{
"completedDateTime":null,
"creationDateTime":"2016-04-26T17:15:23Z",
"creator":{
"fullName":"Roy S",
"guid":"7P9SXNOOX4L4N6P8BG6R"
},
"currentStep":{
"approvals":null,
"attributes":null,
"guid":"HZJ27XYY7EXTCVEXDZX2"
},
"description":"New Quality Process",
"guid":"GYI16WXX6DWSBUDWCYWC",
"name":"New Process Introduction",
"number":"8D-000013",
"owner":{
"fullName":"Roy Stafford",
"guid":"GYI16WXX6DUDWFYHPRY3"
},
"status":"OPEN",
"statusMode":"AUTOMATIC",
"targetCompletionDateTime":null,
"template":{
"active":null,
"guid":"6O8RWMNNW3MI1K3M2TOK"
},
"type":"Design"
}

Returns an error if no owner is specified and there is no default owner for the template:

{
"status": 400,

©2022 Arena, A PTC Business www.arenasolutions.com 472

 Arena REST API Developer Guide Endpoints

"errors": [
{
"code": 400,
"message": "Quality Processes cannot be created without an owner. No default
owner is specified for this template and no owner was specified in the request body."

}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 473

 Arena REST API Developer Guide Endpoints

PUT Quality Process Update

/qualityprocesses/<GUID>

Updates the metadata of a Quality Process object with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"description":"Quality Process with updated name",
"name":"New Process Introduction",
"type":"Manufacturing"
}

Response Codes

Code Description
201 Success
400 Failure

Response Headers

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Update the details of a quality process

/qualityprocesses/<GUID>

{
"completedDateTime":null,

©2022 Arena, A PTC Business www.arenasolutions.com 474

 Arena REST API Developer Guide Endpoints

"creationDateTime":"2016-04-26T16:48:47Z",
"creator":{
"fullName":"Roy S",
"guid":"7P9SXNOOX4L4N6P8BG6R"
},
"currentStep":{
"approvals":null,
"attributes":null,
"guid":"R9TCH788HO73M5O7N980"
},
"description":"Quality Process with updated name",
"guid":"Q8SBG677GN62L4N6M876",
"name":"New Process Introduction",
"number":"8D-000010",
"owner":{
"fullName":"Heidi Walker",
"guid":"I0K38YZZ8FWFYH0JSIPF"
},
"status":"OPEN",
"statusMode":"AUTOMATIC",
"targetCompletionDateTime":null,
"template":{
"active":null,
"guid":"6O8RWMNNW3MI1K3M2TOK"
},
"type":"Manufacturing"
}

Returns an error if the GUID is not valid

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 475

 Arena REST API Developer Guide Endpoints

DELETE Quality Process

/qualityprocesses/<GUID>

Deletes a Quality Process with a given GUID.

Note: Any full user can delete a Quality Process via the API. This differs from the Arena application, in which users
must be the owner of the process or an Account Administrator to delete a Quality Process.

Request Headers

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response

Returns an error if the GUID is not valid

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 476

 Arena REST API Developer Guide Endpoints

POST Quality Process Complete

/qualityprocesses/statuschanges

Completes a Quality Process object.

NOTES:

1. To execute this endpoint, the user must be the Quality Process owner or an Account Administrator.

2. The user must be able to read and edit the Quality Process.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"qualityProcess":{
"guid":"K2M5O1MD03MI1K3MVZIC"
},
"complete":true,
"comment":"CAR-000003 has been resolved."
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 477

 Arena REST API Developer Guide Endpoints

Sample Response Body

Complete a quality process

/qualityprocesses/statuschanges

{
"completedDateTime":"2019-07-05T21:57:22Z",
"creationDateTime":"2017-01-20T19:35:37Z",
"creator":{
"fullName":"Heidi W",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"currentStep":{
"approvals":null,
"attributes":null,
"guid":"Q6Q9S5QH47QMFO7QZ3MG"
},
"description":"Products have been melting at high temps.",
"guid":"K2M5O1MD03ML1K3MVZIC",
"name":"Everyroad bezels melted/burned.",
"number":"CAR-000003",
"owner":{
"fullName":"Heidi W",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"status":"COMPLETED",
"statusMode":"AUTOMATIC",
"targetCompletionDateTime":"2017-02-04T07:59:59Z",
"template":{
"active":null,
"guid":"2KN4N6J4VIL40J2L4N0B3"
},
"type":NULL
}

Returns an error if the Quality Process is already completed.

{
"status": 400,
"errors": [
{
"code": 3089,
"message": "The quality process is already completed."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 478

 Arena REST API Developer Guide Endpoints

POST Quality Process Reopen

/qualityprocesses/statuschanges

Completes a Quality Process object.

NOTES:

1. To execute this endpoint, the user must be the Quality Process owner or an Account Administrator.

2. The user must be able to read and edit the Quality Process.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"qualityProcess":{
"guid":"K2M5O1MD03MI1K3MVZIC"
},
"complete":false,
"comment":"CAR-000003 must be repopened."
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 479

 Arena REST API Developer Guide Endpoints

Sample Response Body

Reopen a quality process

/qualityprocesses/statuschanges

{
"completedDateTime":null,
"creationDateTime":"2017-01-20T19:35:37Z",
"creator":{
"fullName":"Heidi W",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"currentStep":{
"approvals":null,
"attributes":null,
"guid":"Q6Q9S5QH47QMFO7QZ3MG"
},
"description":"Products have been melting at high temps.",
"guid":"K2M5O1MD03ML1K3MVZIC",
"name":"Everyroad bezels melted/burned.",
"number":"CAR-000003",
"owner":{
"fullName":"Heidi W",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"status":"OPEN",
"statusMode":"AUTOMATIC",
"targetCompletionDateTime":"2017-02-04T07:59:59Z",
"template":{
"active":null,
"guid":"2KN4N6J4VIL40J2L4N0B3"
},
"type":NULL
}

Returns an error if the Quality Process is already open.

{
"status": 400,
"errors": [
{
"code": 3089,
"message": "The quality process is already open."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 480

 Arena REST API Developer Guide Endpoints

GET Quality Process Step Affected Objects

/qualityprocesses/<GUID>/steps/<GUID>/affected

Returns a collection of Affected Objects for a step with a given GUID in a Quality Process with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get affected objects for a quality process step

/qualityprocesses/<GUID>/steps/<GUID>/affected

{
"count":4,
"results":[
{
"affected":{
"description":"supplier info",
"display":"Flextronics",
"link":"www.flextronics.com",
"type":"URL"
},

©2022 Arena, A PTC Business www.arenasolutions.com 481

 Arena REST API Developer Guide Endpoints

"guid":"5N7Q9HOAQYHDWFYH0YMJ",
"notes":"Flextronics home page"
},
{
"affected":{
"guid":"K2M5OW3P5DWSBUDWFCNT",
"step":{
"guid":"L3N6PX4Q6EXTCVEXGDOY"
},
"type":"QUALITY"
},
"guid":"P7RAT18UAI1XGZI1KI7E",
"notes":null
},
{
"affected":{
"guid":"XFZI19G2IQ9Q9SBHKVAP",
"type":"ITEM"
},
"guid":"N5P8RZ6S8GZVEXGZIG5A",
"notes":null
},
{
"affected":{
"guid":"GYI1KSZL19SRAQT1RNH7",
"type":"REQUEST"
},
"guid":"VDXGZ7E0GO73M5O7QODM",
"notes":null
},
{
"affected":{
"guid":"FXH0JWH8VYHK3ML98YSK",
"type":"CHANGE"
},
"guid":"7P9SBO90NQ9J2L0778WO",
"notes":null
}
]
}

Returns an error if the GUID is not valid

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 482

 Arena REST API Developer Guide Endpoints

GET Quality Process Step Affected Object

/qualityprocesses/<GUID>/steps/<GUID>/affected/<GUID>

Returns an Affected Object with a given GUID that appears in a step with a given GUID in a Quality Process
with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a single affected object from a quality process step

/qualityprocesses/<GUID>/steps/<GUID>/affected/<GUID>

{
"affected":{
"description":"Supplier info",
"display":"Flextronics home page",
"link":"www.flextronics.com",
"type":"URL"
},
"guid":"5N7Q9HOAQYHDWFYH0YMJ",

©2022 Arena, A PTC Business www.arenasolutions.com 483

 Arena REST API Developer Guide Endpoints

"notes":"Flex page"
}

Returns an error if the GUID is not valid

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 484

 Arena REST API Developer Guide Endpoints

POST Quality Process Step Affected Object Add

/qualityprocesses/<GUID>/steps/<GUID>/affected

Adds an Affected Object in a step with a given GUID in a Quality Process with a given GUID. The type can be
ITEM, REQUEST, CHANGE, SUPPLIER, SUPPLIER ITEM, FILE, QUALITY, or URL.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

Add an object of type ITEM

{
"notes":"Improved venting panel for upcoming release",
"affected":{
"guid":"8S0CH2NXC02JD0CJSFJN"
}
}

Add an object of type REQUEST

{
"notes": "A Request?",
"affected": {
"guid": "CUEXGTE5SVEDWFBVUQUK"
}
}

Add an object of type CHANGE

{
"notes":"A Change",
"affected":{
"guid": "ASCV0QST650RAS81FACQ":
}
}

Add an object of type SUPPLIER

{
"notes":"Allied Electronics Inc.",
"affected":{
"guid": "VDXGLBDERQ9FYHMC0ZH6":
}
}

Add an object of type SUPPLIER ITEM

©2022 Arena, A PTC Business www.arenasolutions.com 485

 Arena REST API Developer Guide Endpoints

{
"notes":"A Supplier Item",
"affected":{
"guid": "2K4NSIKLYXGL4NLZFKS9":
}
}

Add an object of type File

{
"notes":"A File",
"affected":{
"guid":"ZH1KPFHIVUDTCVL9QG9B"
}
}

Add an object of type QUALITY

{
"notes":"Existing CAPA",
"affected":{
"step":{
"guid":"7P9SXNOOX4NJ2L4N1EUS"
}
}
}

Add an object of type URL

{
"notes":"look at this!",
"affected":{
"link":"www.flextronics.com",
"display":"Flextronics home page",
"description":"Supplier info"
}
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time

©2022 Arena, A PTC Business www.arenasolutions.com 486

 Arena REST API Developer Guide Endpoints

Name Value Description

Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

add an affected object of type ITEM to a step

/qualityprocesses/<GUID>/steps/<GUID>/affected

{
"affected":{
"guid":"8S0CH2NXC02JD0CJSFJN",
"type":"ITEM"
},
"guid":"A89MHQ7ANF001HNAMWIS",
"notes":"Improved venting panel for upcoming release"
}

add an affected object of type REQUEST to a step

/qualityprocesses/<GUID>/steps/<GUID>/affected

{
"affected": {
"guid": "CUEXGTE5SVEDWFBVUQUK",
"type": "REQUEST"
},
"guid": "TBVEXAVM9CU5O7Q8M4FB",
"notes": "A Request"
}

add an affected object of type CHANGE to a step

/qualityprocesses/<GUID>/steps/<GUID>/affected

{
"affected": {
"guid": "ASCV0QST650RAS81FACQ".
"type": "CHANGE"
},
"guid": "EWGZ4UWXA9S07Q9PU9NA",
"notes": "A Change"
}

add an affected object of type SUPPLIER to a step

/qualityprocesses/<GUID>/steps/<GUID>/affected

{
"affected": {

©2022 Arena, A PTC Business www.arenasolutions.com 487

 Arena REST API Developer Guide Endpoints

"guid": "VDXGLBDERQ9FYHMC0ZH6".
"type": "SUPPLIER"
},
"guid": "N5P8D356JI1XGZIY3ISG",
"notes": "Allied Electronics Inc."
}

add an affected object of type SUPPLIER ITEM to a step

/qualityprocesses/<GUID>/steps/<GUID>/affected

{
"affected": {
"guid": "2K4NSIKLYXGL4NLZFKS9".
"type": "SUPPLIER ITEM"
},
"guid": "TBVEJ98CP073M50490VI",
"notes": "A Supplier Item"
}

add an affected object of type FILE to a step

/qualityprocesses/<GUID>/steps/<GUID>/affected

{
"affected": {
"guid": "ZH1KPFHIVUDTCVL9QG9B".
"type": "FILE"
},
"guid": "SAUDI8AB0N62L4N38NWU",
"notes": "A File"
}

add an affected object of type QUALITY to a step

/qualityprocesses/<GUID>/steps/<GUID>/affected

{
"affected":{
"guid":"LS937AN72907WHU1MLWA",
"step":{
"guid":"7P9SXNOOX4NJ2L4N1EUS"
},
"type":"QUALITY",
"guid":"7P9SBJQCS0JFYH0J20O3",
"notes":"Existing CAPA"
}

add an affected object of type URL to a step

/qualityprocesses/<GUID>/steps/<GUID>/affected

{
"affected":{
"description":"Supplier info",
"display":"Flextronics home page",

©2022 Arena, A PTC Business www.arenasolutions.com 488

 Arena REST API Developer Guide Endpoints

"link":"www.flextronics.com",
"type":"URL"
},
"guid":"7P9SBJQCS0JFYH0J20O3",
"notes":"look at this!"
}

Returns an error if a GUID is not valid

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 489

 Arena REST API Developer Guide Endpoints

PUT Quality Process Step Affected Object Update

/qualityprocesses/<GUID>/steps/<GUID>/affected/<GUID>

Updates an existing Affected Object with a given GUID in a step with a given GUID in a Quality Process with a
given GUID. Current supported Affected Objects are ITEMS, CHANGES, SUPPLIERS, SUPPLIER ITEMS, FILES,
QUALITY, and URLs.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"notes":"look at this!"
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Update an affected object in a quality process step

/qualityprocesses/<GUID>/steps/<step_GUID>/affected/<GUID>

©2022 Arena, A PTC Business www.arenasolutions.com 490

 Arena REST API Developer Guide Endpoints

{
"affected":{
"description":"Supplier info",
"display":"Flextronics home page",
"link":"www.flextronics.com",
"type":"URL"
},
"guid":"7P9SBJQCS0JFYH0J20O3",
"notes":"look at this!"
}

Returns an error if a GUID is not valid

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 491

 Arena REST API Developer Guide Endpoints

DELETE Quality Process Step Affected Object

/qualityprocesses/<GUID>/steps/<GUID>/affected/<GUID>

Deletes an Affected Object with a given GUID from Quality Process step with a given GUID in a Quality Process
with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Returns an error if the GUID is not valid

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 492

 Arena REST API Developer Guide Endpoints

GET Quality Process Steps

/qualityprocesses/<GUID>/steps

Returns a collection of Quality Process Step objects for a Quality Process with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get steps for a given quality process

/qualityprocesses/<GUID>/steps

{
"count":6,
"results":[
{
"approvals":null,
"assignee":{
"deprecated": true,
"fullName":"John Parker",
"guid":"7P9SBJSSP6N6P8RATPM6",
"note": "The assignee response object is deprecated. Please use assignees."

©2022 Arena, A PTC Business www.arenasolutions.com 493

 Arena REST API Developer Guide Endpoints

},
"assignees": {
"users": [
{
"fullName": "John Parker",
"guid": "7P9SBJSSP6N6P8RATPM6"
}
],
"attributes":[
{
"apiName":"custom890",
"fieldType":"MULTI_LINE_TEXT",
"guid":"8QATCKTTQ7O6P8RATC7Q",
"name":"Problem Description",
"value":"Bad sensor in X27 was noted at 80% failure and went full
failure, causing a short that fried the board."
}
],
"completeDateTime":"2018-09-04T01:32:03Z",
"completeUser":{
"fullName":"John Parker"
},
"dueDateTime":"2018-09-04T06:59:59Z",
"guid":"BTDWFNWWTATP8RATBC4E",
"name":"Problem Description",
"order":1,
"status":"COMPLETE",
"type":"REGULAR"
},
{
"approvals":null,
"assignee":null,
"assignee": {
"userGroups": [
{
"guid": "BTDWFSD4RU0N6P8RA955",
"name": "Quality Assurance",
"users": [
{
"fullName":"James Deckard",
"guid":"6O8RAIRRO5M5O7Q9SOLD"
},
{
"fullName":"Caroline Goff ",
"guid":"5N7Q9M7YL0507Q9SY0E7"
},
{
"fullName":"Peter Yeh",
"guid":"0I2L4H2TGJ0J2L4NWMTA"
}
]

}
],

©2022 Arena, A PTC Business www.arenasolutions.com 494

 Arena REST API Developer Guide Endpoints

"attributes":[
{
"apiName":"custom891",
"fieldType":"SINGLE_LINE_TEXT",
"guid":"9RBUDLUUR8P7Q9SBUD83",
"name":"Serial Number(s) of Nonconforming Parts",
"value":"04444444781"
},
{
"apiName":"custom892",
"fieldType":"FIXED_DROP_DOWN",
"guid":"ASCVEMVVS9Q8RATCVE9P",
"name":"Inventory Impact?",
"value":"Yes"
},
{
"apiName":"custom893",
"fieldType":"MULTI_LINE_TEXT",
"guid":"BTDWFNWWTAR9SBUDWFAK",
"name":"Inventory Impact description",
"value":"Review all X27 boards"
},
{
"apiName":"custom894",
"fieldType":"MULTI_LINE_TEXT",
"guid":"CUEXGOXXUBSATCVEXGBH",
"name":"Supplier Containment actions required",
"value":"Stop-ship from Plasmus."
},
{
"apiName":"custom895",
"fieldType":"MULTI_LINE_TEXT",
"guid":"DVFYHPYYVCTBUDWFYHCF",
"name":"Internal Containment actions required",
"value":"Hold on production"
},
{
"apiName":"custom896",
"fieldType":"MULTI_LINE_TEXT",
"guid":"EWGZIQZZWDUCVEXGZIDO",
"name":"Customer Containment actions required",
"value":"Notify all X27 100 batch buyers to discontinue usage."
}
],
"completeDateTime":"2018-09-04T01:34:38Z",
"completeUser":{
"fullName":"James Deckard"
},
"dueDateTime":"2018-09-04T06:59:59Z",
"guid":"CUEXGOXXUBUQ9SBUCD5K",
"name":"Immediate Containment",
"order":2,
"status":"COMPLETE",
"type":"REGULAR"
},

©2022 Arena, A PTC Business www.arenasolutions.com 495

 Arena REST API Developer Guide Endpoints

{
"approvals":null,
"assignee":{
"deprecated": true,
"fullName":"Rachael Borger",
"guid":"9RBUDLUUR8P8RATCVROR",
"note": "The assignee response object is deprecated. Please use assignees."

},
"assignees": {
"users": [
{
"fullName": "Rachael Borger",
"guid": "9RBUDLUUR8P8RATCVROR"
}
],
}
"attributes":[
{
"apiName":"custom897",
"fieldType":"MULTI_LINE_TEXT",
"guid":"FXH0JR00XEVDWFYH0JE4",
"name":"Possible Causes",
"value":"There is not enough clearance for adequate venting on the
board."
},
{
"apiName":"custom898",
"fieldType":"MULTI_LINE_TEXT",
"guid":"GYI1KS11YFWEXGZI1KF5",
"name":"5 Whys",
"value":"Why 1: How can we fix the clearance problem?\nResponse: New
molding for front cover\nWhy 2: Why did testing not catch this?\nResponse: Our tests
were performed with the same cover, but it is possible a burring flaw limited the
clearance\nWhy 3: Why did we not catch burring flaws on this shipment?\nResponse:
Unknown\nWhy 4: Why did our tooling process allow burring?\nResponse: We were nearing
the next calibration. Possibly a tooling machine failed.\nWhy 5: Why are we not
calibrating more often?\nResponse: Good question. We should review this interval."
}
],
"completeDateTime":null,
"completeUser":null,
"dueDateTime":"2018-09-06T06:59:59Z",
"guid":"DVFYHPYYVCVRATCVDE6Z",
"name":"Root Cause Analysis",
"order":3,
"status":"OPEN",
"type":"REGULAR"
},
{
"allowOwnerToAddApprovers":true,
"approvals":null,
"assignee":null,
"completeDateTime":null,
"completeUser":null,

©2022 Arena, A PTC Business www.arenasolutions.com 496

 Arena REST API Developer Guide Endpoints

"dueDateTime":null,
"guid":"EWGZIQZZWDWSBUDWEF7A",
"name":"Root Cause Confirmation",
"order":4,
"status":"OPEN",
"type":"SIGNOFF"
},
...
]
}

Returns an error if the GUID is not valid

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 497

 Arena REST API Developer Guide Endpoints

GET Quality Process Step

/qualityprocesses/<GUID>/steps/<GUID>

Returns a Quality Process Step object with a given GUID for a Quality Process with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a single step for a given quality process

/qualityprocesses/<GUID>/steps/<GUID>

{
"approvals":null,
"assignee":{
"deprecated": true,
"fullName":"John Parker",
"guid":"7P9SBJSSP6N6P8RATPM6",
"note": "The assignee response object is deprecated. Please use assignees."
},
"assignees": {
"users": [

©2022 Arena, A PTC Business www.arenasolutions.com 498

 Arena REST API Developer Guide Endpoints

{
"fullName": "John Parker",
"guid": "7P9SBJSSP6N6P8RATPM6"
}
]
},
"attributes":[
{
"apiName":"custom891",
"fieldType":"SINGLE_LINE_TEXT",
"guid":"9RBUDLUUR8P7Q9SBUD83",
"name":"Serial Number(s) of Nonconforming Parts",
"value":"04444444781"
},
{
"apiName":"custom892",
"fieldType":"FIXED_DROP_DOWN",
"guid":"ASCVEMVVS9Q8RATCVE9P",
"name":"Inventory Impact?",
"value":"Yes"
},
{
"apiName":"custom893",
"fieldType":"MULTI_LINE_TEXT",
"guid":"BTDWFNWWTAR9SBUDWFAK",
"name":"Inventory Impact description",
"value":"Review all X27 boards"
},
{
"apiName":"custom894",
"fieldType":"MULTI_LINE_TEXT",
"guid":"CUEXGOXXUBSATCVEXGBH",
"name":"Supplier Containment actions required",
"value":"Stop-ship from Plasmus."
},
{
"apiName":"custom895",
"fieldType":"MULTI_LINE_TEXT",
"guid":"DVFYHPYYVCTBUDWFYHCF",
"name":"Internal Containment actions required",
"value":"Hold on production"
},
{
"apiName":"custom896",
"fieldType":"MULTI_LINE_TEXT",
"guid":"EWGZIQZZWDUCVEXGZIDO",
"name":"Customer Containment actions required",
"value":"Notify all X27 100 batch buyers to discontinue usage."
}
],
"completeDateTime":"2018-09-04T01:34:38Z",
"completeUser":{
"fullName":"James Deckard"
},
"dueDateTime":"2018-09-04T06:59:59Z",

©2022 Arena, A PTC Business www.arenasolutions.com 499

 Arena REST API Developer Guide Endpoints

"guid":"CUEXGOXXUBUQ9SBUCD5K",
"name":"Immediate Containment",
"order":2,
"status":"COMPLETE",
"type":"REGULAR"
}

Produces an error if the step GUID is not valid.

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"CUB5FVEN6P8RAQI\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 500

 Arena REST API Developer Guide Endpoints

GET Quality Process Step Decisions

/qualityprocesses/<GUID>/steps/<GUID>/decisions

/qualityprocesses/<GUID>/steps/<GUID>/decisions/<GUID>

Returns the decisions of users in a Quality Process sign-off step when given the GUID of the Quality Process
and the GUID of the Quality sign-off step.

If appended with a valid decision GUID from the above, the endpoint returns a specific decision from a specific
user of a specific step within a specific Quality Process.

The new property decision only appears in Quality sign-off steps.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get decisions for a given quality process sign-off step where all users are required to sign off.

/qualityprocesses/<GUID>/steps/<GUID>/decisions

{
"count": 4,

©2022 Arena, A PTC Business www.arenasolutions.com 501

 Arena REST API Developer Guide Endpoints

"results": [
{
"comments": "Thanks for spearheading this case Heidi.",
"decision": "APPROVED",
"decisionDateTime": "2021-11-28T10:09:57Z",
"decisionType": "ALL_REQUIRED",
"group": {
"guid": "DVFYHUF6TW2P8RATCFGK",
"name": "Quality Process Approval Group"
},
"guid": "VDXGZCXOBEK5O7Q9AQQ2",
"user": {
"email": "[email protected]",
"fullName": "Richard Hatcher",
"guid": "M4O7Q3OF25M5O7Q9AQQR"
}
},
{
"comments": null,
"decision": "APPROVED",
"decisionDateTime": "2021-11-28T10:11:32Z",
"decisionType": "ALL_REQUIRED",
"group": {
"guid": "DVFYHUF6TW2P8RATCFGK",
"name": "Quality Process Approval Group"
},
"guid": "4M6P8L6XKNTEXGZIRHOU",
"user": {
"email": "[email protected]",
"fullName": "Rachael Borger",
"guid": "VDXGZCXOBEVEXGZIRHOJ"
}
},
{
"comments": "Please submit an ECR to ensure all preventative measures
have been taken. Thanks.",
"decision": "APPROVED",
"decisionDateTime": "2021-11-28T10:08:04Z",
"decisionType": "ALL_REQUIRED",
"group": {
"guid": "DVFYHUF6TW2P8RATCFGK",
"name": "Quality Process Approval Group"
},
"guid": "ASCVERC3QTZK3M5OXNUW",
"user": {
"email": "[email protected]",
"fullName": "Eleanor Canard",
"guid": "1J3M5I3UHK1K3M5OXNUV"
}
},
{
"comments": null,
"decision": "APPROVED",
"decisionDateTime": "2021-11-28T10:07:13Z",
"decisionType": "ALL_REQUIRED",

©2022 Arena, A PTC Business www.arenasolutions.com 502

 Arena REST API Developer Guide Endpoints

"group": {
"guid": "DVFYHUF6TW2P8RATCFGK",
"name": "Quality Process Approval Group"
},
"guid": "5N7Q9M7YLOUFYH0JSIP0",
"user": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
}
]
}

Get decisions for a given quality process sign-off step where only one user is required to sign off.

/qualityprocesses/<GUID>/steps/<GUID>/decisions

{
"count": 2,
"results": [
{
"comments": null,
"decision": null,
"decisionDateTime": null,
"decisionType": "ONE_REQUIRED",
"guid": "ASCVERC3QTZK3M5OXNUW",
"user": {
"email": "[email protected]",
"fullName": "Eleanor Canard",
"guid": "1J3M5I3UHK1K3M5OXNUV"
}
},
{
"comments": null,
"decision": "APPROVED",
"decisionDateTime": "2021-11-28T09:49:01Z",
"decisionType": "ONE_REQUIRED",
"guid": "5N7Q9M7YLOUFYH0JSIP0",
"user": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
}
]
}

Get a specific decision from the existing decisions of a sign-off step.

/qualityprocesses/<GUID>/steps/<GUID>/decisions/<GUID>

{
"comments": "While I understand the issue is a high priority for our Canada team,
I am not willing to budge on this issue until the core issue is resolved. Otherwise

©2022 Arena, A PTC Business www.arenasolutions.com 503

 Arena REST API Developer Guide Endpoints

this issue will come up again.",

"decision": "REJECTED",
"decisionDateTime": "2021-11-28T10:14:20Z",
"decisionType": "ALL_REQUIRED",
"guid": "5N7Q9M7YLOUFYH0JSIP0",
"user": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
}

Returns an error if any GUID is not valid

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 504

 Arena REST API Developer Guide Endpoints

PUT Quality Process Step Update (User Assignee)

/qualityprocesses/<GUID>/steps/<GUID>

Updates an existing Step object with a given GUID in a Quality Process with a given GUID.

Editable attributes: Assignee, attribute values, dueDateTime.

Note: When you specify dueDateTime for a step, only the date portion of the dueDateTime string is honored. Time
always appears as 23:59:59 local time.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"assignees": {
"users": [
{
"guid": "2K4N6EL7NVCVEXGZI8QJ"
}
]
},
"attributes": [
{
"guid": "6O8RAIPBRZIEXGZI1HZ1",
"value": "Send notification email"
}
],
"dueDateTime": "2021-08-08T15:00:00Z"
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response

©2022 Arena, A PTC Business www.arenasolutions.com 505

 Arena REST API Developer Guide Endpoints

Name Value Description

Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Update a quality process step

/qualityprocesses/<GUID>/steps/<GUID>

{
"approvals":null,
"assignee":{
"deprecated": true,
"fullName":"REST API Admin",
"guid":"2K4N6EL7NVCVEXGZI8QJ",
"note": "The assignee response object is deprecated. Please use assignees."
},
"assignees":{
"users":[
{
"fullName":"REST API Admin",
"guid":"2K4N6EL7NVCVEXGZI8QJ"
}
]
},
"attributes":[
{
"guid":"1J3M5DK6MUD9SBUDWCUV",
"name":"Serial Number(s) of Nonconforming Parts"
},
{
"guid":"2K4N6EL7NVEATCVEXDVS",
"name":"Inventory Impact?",
"value":"N/A"
},
{
"guid":"3L5O7FM8OWFBUDWFYEWF",
"name":"Inventory Impact description"
},
{
"guid":"4M6P8GN9PXGCVEXGZFXC",
"name":"Supplier Containment actions required"
},
{
"guid":"5N7Q9HOAQYHDWFYH0GYB",
"name":"Internal Containment actions required"
},
{

©2022 Arena, A PTC Business www.arenasolutions.com 506

 Arena REST API Developer Guide Endpoints

"guid":"6O8RAIPBRZIEXGZI1HZ1",
"name":"Customer Containment actions required",
"value":"Send notification email"
}
],
"completeDateTime":null,
"completeUser":null,
"dueDateTime":"2021-08-08T15:00:00Z",
"guid":"DVFYHPWIY6PL4N6P82C8",
"name":"Immediate Containment",
"order":3,
"status":"OPEN",
"type":"REGULAR"
}

Returns an error if the GUID is not valid:

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"CUB5FVEN6P8RAQI\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 507

 Arena REST API Developer Guide Endpoints

PUT Quality Process Step Update (User Group Assignee)

/qualityprocesses/<GUID>/steps/<GUID>

Updates an existing Step object with a given GUID in a Quality Process with a given GUID.

Editable attributes: Assignee, attribute values, dueDateTime.

Note: When you specify dueDateTime for a step, only the date portion of the dueDateTime string is honored. Time
always appears as 23:59:59 local time.

This endpoint can only be used in workspaces that have Access Policies enabled.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"assignees": {
"userGroups": [
{
"guid": "GYI1KSSHLGWDWFYH0D3Z"
}
]
},
"attributes": [
{
"guid": "6O8RAIPBRZIEXGZI1HZ1",
"value": "Send notification email"
}
],
"dueDateTime": "2026-08-08T15:00:00Z"
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response

©2022 Arena, A PTC Business www.arenasolutions.com 508

 Arena REST API Developer Guide Endpoints

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Update a quality process step

/qualityprocesses/<GUID>/steps/<GUID>

{
"approvals":null,
"assignee": null,
"assignees":[
"userGroups":[
{
"name":"Quality Assurance",
"guid":"GYI1KSSHLGWDWFYH0D3Z"
"users":[
{
"fullName":"Dasha Hendricks",
"guid":"ASCV96ACN4L4N6P8BG6H"
},
{
"fullName":"Roy Peralez",
"guid":"ZHYRWM5DWFS6CLQ1"
},
...
]
}
],
"attributes":[
{
"guid":"1J3M5DK6MUD9SBUDWCUV",
"name":"Serial Number(s) of Nonconforming Parts"
},
{
"guid":"2K4N6EL7NVEATCVEXDVS",
"name":"Inventory Impact?",
"value":"N/A"
},
{
"guid":"3L5O7FM8OWFBUDWFYEWF",
"name":"Inventory Impact description"
},
{
"guid":"4M6P8GN9PXGCVEXGZFXC",

©2022 Arena, A PTC Business www.arenasolutions.com 509

 Arena REST API Developer Guide Endpoints

"name":"Supplier Containment actions required"

},
{
"guid":"5N7Q9HOAQYHDWFYH0GYB",
"name":"Internal Containment actions required"
},
{
"guid":"6O8RAIPBRZIEXGZI1HZ1",
"name":"Customer Containment actions required",
"value":"Send notification email"
}
],
"completeDateTime":null,
"completeUser":null,
"dueDateTime":"2026-08-08T15:00:00Z",
"guid":"DVFYHPWIY6PL4N6P82C8",
"name":"Immediate Containment",
"order":3,
"status":"OPEN",
"type":"REGULAR"
}

Returns an error if the GUID is not valid:

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"CUB5FVEN6P8RAQI\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 510

 Arena REST API Developer Guide Endpoints

PUT Quality Process Step Update (Deprecated)

/qualityprocesses/<GUID>/steps/<GUID>

Updates an existing Step object with a given GUID in a Quality Process with a given GUID.

Editable attributes: Assignee, attribute values, dueDateTime.

Note: When you specify dueDateTime for a step, only the date portion of the dueDateTime string is honored. Time
always appears as 23:59:59 local time.

Please note that the Assignee response object is deprecated. Please use Assignees when assigning a user or
User Group to a Quality Proecss step. See note attached to Assignee object body within response body.

Request Header

Sample Request Body

{
"dueDateTime":"2016-11-20T00:00:00Z",
"assignee":{
"guid":"2K4N6EL7NVCVEXGZI8QJ"
},
"attributes":[
{
"guid":"6O8RAIPBRZIEXGZI1HZ1",
"value":"Send notification email"
}
]
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 511

 Arena REST API Developer Guide Endpoints

Sample Response Body

Update a quality process step

/qualityprocesses/<GUID>/steps/<GUID>

{
"approvals":null,
"assignee":{
"deprecated": true,
"fullName":"John Parker",
"guid":"7P9SBJSSP6N6P8RATPM6",
"note": "The assignee response object is deprecated. Please use assignees."
},
"assignees": {
"users": [
{
"fullName": "John Parker",
"guid": "7P9SBJSSP6N6P8RATPM6"
}
]
},
"attributes":[
{
"guid":"1J3M5DK6MUD9SBUDWCUV",
"name":"Serial Number(s) of Nonconforming Parts"
},
{
"guid":"2K4N6EL7NVEATCVEXDVS",
"name":"Inventory Impact?",
"value":"N/A"
},
{
"guid":"3L5O7FM8OWFBUDWFYEWF",
"name":"Inventory Impact description"
},
{
"guid":"4M6P8GN9PXGCVEXGZFXC",
"name":"Supplier Containment actions required"
},
{
"guid":"5N7Q9HOAQYHDWFYH0GYB",
"name":"Internal Containment actions required"
},
{
"guid":"6O8RAIPBRZIEXGZI1HZ1",
"name":"Customer Containment actions required",
"value":"Send notification email"
}
],
"completeDateTime":null,
"completeUser":null,
"dueDateTime":"2016-11-20T07:59:59Z",
"guid":"DVFYHPWIY6PL4N6P82C8",
"name":"Immediate Containment",

©2022 Arena, A PTC Business www.arenasolutions.com 512

 Arena REST API Developer Guide Endpoints

"order":3,
"status":"OPEN",
"type":"REGULAR"
}

Returns an error if the GUID is not valid:

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"CUB5FVEN6P8RAQI\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 513

 Arena REST API Developer Guide Endpoints

POST Quality Process Step Complete

/qualityprocesses/statuschanges

Completes a specific Quality Process step.

NOTES:

1. Assigned Quality Process steps (excluding sign-off steps) can be completed by the Quality Process Step
Assignee or the Quality Process Owner.

2. Quality Process steps without an assignee (excluding sign-off steps) can be completed by any user with
permissions.

3. Quality Process steps (exluding sign-off steps) cannot be completed if the Quality Process itself is completed.

4. Quality Process sign-off steps cannot be completed by this endpoint.

5. For Access Policies: A user must have the Quality Edit Details rule enabled to complete a Quality Process
step.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"qualityProcess":{
"guid":"K2M5O1MD03MI1K3MVZIC",
"step":
"guid": "8QAT748L1KFYH0JOGNB"
},
"complete":true,
"comment":"Problem Description fields have been entered."
}

Response Codes

Code Description
201 Success
400 Failure

©2022 Arena, A PTC Business www.arenasolutions.com 514

 Arena REST API Developer Guide Endpoints

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Complete a quality process step

/qualityprocesses/statuschanges

{
"qualityProcess":{
"completedDateTime":"2019-07-05T21:57:22Z",
"creationDateTime":"2017-01-20T19:35:37Z",
"creator":{
"fullName":"Heidi W",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"currentStep":{
"approvals":null,
"attributes":null,
"guid":"Q6Q9S5QH47QMFO7QZ3MG"
},
"description":"Products have been melting at high temps.",
"guid":"K2M5O1MD03ML1K3MVZIC",
"name":"Everyroad bezels melted/burned.",
"number":"CAR-000003",
"owner":{
"fullName":"Heidi W",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"status":"COMPLETED",
"statusMode":"AUTOMATIC",
"targetCompletionDateTime":"2017-02-04T07:59:59Z",
"template":{
"active":null,
"guid":"2KN4N6J4VIL40J2L4N0B3"
},
"type":NULL
"complete": true,
"comment": "Problem Description fields have been entered."
}

Returns an error if the Quality Process step is already completed.

©2022 Arena, A PTC Business www.arenasolutions.com 515

 Arena REST API Developer Guide Endpoints

{
"status": 400,
"errors": [
{
"code": 3089,
"message": "The quality process step is already completed."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 516

 Arena REST API Developer Guide Endpoints

POST Quality Process Step Reopen

/qualityprocesses/statuschanges

Reopens a Quality Process step.

NOTES:

1. Assigned Quality Process steps (excluding sign-off steps) can be reopened by the Quality Process Step
Assignee or the Quality Process Owner.

2. Quality Process steps without an assignee (excluding sign-off steps) can be reopened by any user with
permissions.

3. Quality Process steps (exluding sign-off steps) cannot be reopened if the Quality Process itself is completed.

4. Quality Process approved sign-off steps cannot be reopened or reversed by this endpoint.

5. For Access Policies: A user must have the Quality Edit Details rule enabled to reopen a Quality Process step.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"qualityProcess":{
"guid":"K2M5O1MD03MI1K3MVZIC",
"step":
"guid": "8QAT748L1KFYH0JOGNB"
},
"complete": false,
"comment": "Correcting typos within the Problem Description field."
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response

©2022 Arena, A PTC Business www.arenasolutions.com 517

 Arena REST API Developer Guide Endpoints

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Reopens a quality process step

/qualityprocesses/statuschanges

{
"qualityProcess":{
"completedDateTime":"2019-07-25T13:51:25Z",
"creationDateTime":"2017-01-20T19:35:37Z",
"creator":{
"fullName":"Heidi W",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"currentStep":{
"approvals":null,
"attributes":null,
"guid":"Q6Q9S5QH47QMFO7QZ3MG"
},
"description":"Products have been melting at high temps.",
"guid":"K2M5O1MD03ML1K3MVZIC",
"name":"Everyroad bezels melted/burned.",
"number":"CAR-000003",
"owner":{
"fullName":"Heidi W",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"status":"COMPLETED",
"statusMode":"AUTOMATIC",
"targetCompletionDateTime":"2017-02-04T07:59:59Z",
"template":{
"active":null,
"guid":"2KN4N6J4VIL40J2L4N0B3"
},
"type":NULL
"complete": false,
"comment": "Correcting typos within the Problem Description field."
}

Returns an error if the Quality Process is already open.

{
"status": 400,

©2022 Arena, A PTC Business www.arenasolutions.com 518

 Arena REST API Developer Guide Endpoints

"errors": [
{
"code": 3089,
"message": "The quality process is already open."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 519

 Arena REST API Developer Guide Endpoints

GET Tickets
/tickets

Returns a collection of Ticket objects matching the given search criteria.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all
changes where results should begin. All
changes before the offset in the search
results are ignored. The default value is 0.
limit integer Specifies the number of results that should
be returned. By default the maximum
number of items is 20. Can return up 400
changes.

Searchable Attributes

Name Value Description

[additional attribute guid value] string This special search permits searching for
strings in additional attribute values. For
example GET
/tickets?VDXGZ7E0GO5N6P8PR55G=*100pF
where VDXGZ7E0GO5N6P8PR55G is the
GUID of a custom attribute and we are
searching for all items whose value for this
attribute include the string "100pF". The
ability to search for more than one value is
available for the following attribute field
types: DROP_DOWN & FIXED_DROPDOWN
(where multi-select is true). See note below
this table for additional details.

Additional attributes, also known as custom

attributes, support the date field type. Users
can perform searches by additional
attributes with a date field type by using
the format yyyy-mm-dd. In the following

©2022 Arena, A PTC Business www.arenasolutions.com 520

 Arena REST API Developer Guide Endpoints

Name Value Description

example, the user is using the following to
search for a date field type custom attribute
with a value of April 1, 2019:

GET
/tickets?4M6PUJNPNM3L4N25ZZ5F=2019-04-01
template.guid string template unique ID
status string status of the ticket. Values can be
NOT_STARTED, IN_PROGRESS, or COMPLETE.
number string number of the ticket
title string title of the ticket

Note: Search behavior in the Arena REST API differs from search behavior in the Arena application. In the API, a
trailing asterisk (wildcard) is required to return results that start with a string; in the Arena application, a trailing
asterisk is always implied.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all tickets

GET /tickets

{
"count": 6,
"results": [
{
"additionalAttributes": [
{

©2022 Arena, A PTC Business www.arenasolutions.com 521

 Arena REST API Developer Guide Endpoints

"apiName": "ASCVERC3QTASBUDWFYJ0",
"fieldType": "MULTI_LINE_TEXT",
"guid": "ASCVERC3QTASBUDWFYJ0",
"name": "Reason",
"value": "Exceeding max power draw can result in overheating and
melting."
},
{
"apiName": "9RBUDQB2PS9RATCVEXID",
"fieldType": "MULTI_LINE_TEXT",
"guid": "9RBUDQB2PS9RATCVEXID",
"name": "Risk",
"value": "Risk of fire"
},
{
"apiName": "6O8RAN8ZMP6O7Q9SBUGT",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "6O8RAN8ZMP6O7Q9SBUGT",
"name": "Components",
"value": null
},
{
"apiName": "5N7Q9M7YLO5N6P8RATF6",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "5N7Q9M7YLO5N6P8RATF6",
"name": "Labels",
"value": null
}
],
"assignee": null,
"creationDateTime": "2017-03-17T22:27:02Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "",
"fixVersion": null,
"guid": "ASCVERC3QTAP8RATCUF0",
"modifyDateTime": "2017-03-17T22:27:39Z",
"title": "500 PCBA: Max Power draw 10V",
"number": "REQ-000005",
"priority": "Critical",
"status": {
"guid": "TBVEXAVM9CTP8RATCVFU",
"value": "Not Started"
},
"template": {
"guid": "9RBUDQB2PS94N6P8RA7Y",
"name": "Requirements"
}
},
{
"additionalAttributes": [
{

©2022 Arena, A PTC Business www.arenasolutions.com 522

 Arena REST API Developer Guide Endpoints

"apiName": "6O8RAN8ZMP6O7Q9SBUGT",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "6O8RAN8ZMP6O7Q9SBUGT",
"name": "Components",
"value": null
},
{
"apiName": "5N7Q9M7YLO5N6P8RATF6",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "5N7Q9M7YLO5N6P8RATF6",
"name": "Labels",
"value": null
}
],
"assignee": {
"email": "[email protected]",
"fullName": "John Parker",
"guid": "XFZI1EZQDGXGZI1KTJQ2"
},
"creationDateTime": "2017-03-17T22:48:02Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "<p>The power draw is too high on the 500 board, violating
the requirement.</p>",
"fixVersion": null,
"foundOn": null,
"guid": "GYI1KXI9WZGVEXGZI0K9",
"modifyDateTime": "2017-03-21T23:32:18Z",
"title": "500 board drawing 10.5V",
"number": "DEF-000002",
"priority": "Critical",
"status": {
"guid": "R9TCV8TK7ARN6P8RATDZ",
"value": "In Progress"
},
"template": {
"guid": "8QATCPA1OR83M5O7Q967",
"name": "Defects"
}
},
{
"additionalAttributes": [
{
"apiName": "5N7Q9M7YLO5N6P8RATF6",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "5N7Q9M7YLO5N6P8RATF6",
"name": "Labels",
"value": null
},
{
"apiName": "6O8RAN8ZMP6O7Q9SBUGT",
"fieldType": "SINGLE_LINE_TEXT",

©2022 Arena, A PTC Business www.arenasolutions.com 523

 Arena REST API Developer Guide Endpoints

"guid": "6O8RAN8ZMP6O7Q9SBUGT",
"name": "Components",
"value": "Model 600"
}
],
"assignee": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"creationDateTime": "2021-09-06T23:47:26Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "<p>Screws on Chassis Prone to rust.</p><p>We switched
screws in release 2.50 to reduce cost, but QA has observed that the screws are more
prone to rust.</p>",
"fixVersion": null,
"foundOn": "3.0",
"guid": "YG0J2F0REHYDWFYH0YI1",
"modifyDateTime": "2021-09-06T23:47:27Z",
"title": "Screws on Chassis Prone to Rust",
"number": "DEF-000003",
"priority": "High",
"status": {
"guid": "Q8SBU7SJ69QM5O7Q9SCG",
"value": "Not Started"
},
"template": {
"guid": "8QATCPA1OR83M5O7Q967",
"name": "Defects"
}
},
...
]
}

Get tickets with a status of IN_PROGRESS and a template of Defects

GET <url>/tickets?status=IN_PROGRESS&template.guid=8QATCPA1OR83M5O7Q967

{
"count": 1,
"results": [
{
"additionalAttributes": [
{
"apiName": "6O8RAN8ZMP6O7Q9SBUGT",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "6O8RAN8ZMP6O7Q9SBUGT",
"name": "Components",
"value": null
},

©2022 Arena, A PTC Business www.arenasolutions.com 524

 Arena REST API Developer Guide Endpoints

{
"apiName": "5N7Q9M7YLO5N6P8RATF6",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "5N7Q9M7YLO5N6P8RATF6",
"name": "Labels",
"value": null
}
],
"assignee": {
"email": "[email protected]",
"fullName": "John Parker",
"guid": "XFZI1EZQDGXGZI1KTJQ2"
},
"creationDateTime": "2017-03-17T22:48:02Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "<p>The power draw is too high on the 500 board, violating
the requirement.</p>",
"fixVersion": null,
"foundOn": null,
"guid": "GYI1KXI9WZGVEXGZI0K9",
"modifyDateTime": "2017-03-21T23:32:18Z",
"title": "500 board drawing 10.5V",
"number": "DEF-000002",
"priority": "Critical",
"status": {
"guid": "R9TCV8TK7ARN6P8RATDZ",
"value": "In Progress"
},
"template": {
"guid": "8QATCPA1OR83M5O7Q967",
"name": "Defects"
}
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 525

 Arena REST API Developer Guide Endpoints

GET Ticket
/tickets/<GUID>

Returns a Ticket object with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a ticket with a unique GUID

GET /tickets/<GUID>

{
"additionalAttributes": [
{
"apiName": "6O8RAN8ZMP6O7Q9SBUGT",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "6O8RAN8ZMP6O7Q9SBUGT",
"name": "Components",
"value": null
},
{
"apiName": "5N7Q9M7YLO5N6P8RATF6",
"fieldType": "SINGLE_LINE_TEXT",

©2022 Arena, A PTC Business www.arenasolutions.com 526

 Arena REST API Developer Guide Endpoints

"guid": "5N7Q9M7YLO5N6P8RATF6",
"name": "Labels",
"value": null
}
],
"assignee": {
"email": "[email protected]",
"fullName": "John Parker",
"guid": "XFZI1EZQDGXGZI1KTJQ2"
},
"creationDateTime": "2017-03-17T22:48:02Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "<p>The power draw is too high on the 500 board, violating the
requirement.</p>",
"fixVersion": null,
"foundOn": null,
"guid": "GYI1KXI9WZGVEXGZI0K9",
"modifyDateTime": "2017-03-21T23:32:18Z",
"title": "500 board drawing 10.5V",
"number": "DEF-000002",
"priority": "Critical",
"status": {
"guid": "R9TCV8TK7ARN6P8RATDZ",
"value": "In Progress"
},
"template": {
"guid": "8QATCPA1OR83M5O7Q967",
"name": "Defects"
}
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"ASCVERC3QTCFYGPWW1WCS\" is not valid"
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 527

 Arena REST API Developer Guide Endpoints

POST Ticket Create

/tickets

Users can assign a Ticket number in via the following methods.

1. Specify the numberSequencePrefix in the request body. User specifies the prefix while Arena auto-generates
the next values to complete the Ticket number.

2. Specify the number in the request body. User defines the entire Ticket number in the endpoint.

3. User specifies neither of the above. The default numbering for the template will be used. If there are multiple
sequences for the number, the first alphabetic prefix will be selected.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Create Ticket. Specify numberSequencePrefix.

POST /tickets

Request

©2022 Arena, A PTC Business www.arenasolutions.com 528

 Arena REST API Developer Guide Endpoints

{
"additionalAttributes": [
{
"guid": "6O8RAN8ZMP6O7Q9SBUGT",
"value": "Model 20000"
}
],
"template": {
"guid": "8QATCPA1OR83M5O7Q967"
},
"numberSequencePrefix": {
"value": "DEF-"
},
"title": "Paint chipping on new Model 20000",
"fixVersion": "2.0",
"foundOn": "1.0",
"priority": "Critical",
"assignee": {
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
}

Response

{
"additionalAttributes": [
{
"apiName": "5N7Q9M7YLO5N6P8RATF6",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "5N7Q9M7YLO5N6P8RATF6",
"name": "Labels",
"value": "Model 20000"
}
],
"assignee": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"creationDateTime": "2021-09-07T05:24:08Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "",
"fixVersion": "2.0",
"foundOn": "1.0",
"guid": "1J3M5I3UHK1GZI1K31L4",
"modifyDateTime": "2021-09-07T05:24:08Z",
"title": "Paint chipping on new Model 20000",
"number": "DEF-000004",
"priority": "Critical",
"status": {
"guid": "Q8SBU7SJ69QM5O7Q9SCG",

©2022 Arena, A PTC Business www.arenasolutions.com 529

 Arena REST API Developer Guide Endpoints

"value": "Not Started"

},
"template": {
"guid": "8QATCPA1OR83M5O7Q967",
"name": "Defects"
}
}

Create Ticket. Specify entire ticket number.

POST /tickets

Request

{
"additionalAttributes": [
{
"guid": "6O8RAN8ZMP6O7Q9SBUGT",
"value": "Model 20000"
}
],
"template": {
"guid": "8QATCPA1OR83M5O7Q967"
},
"number": "DEF-000009",
"title": "Paint chipping on new Model 20000",
"fixVersion": "2.0",
"foundOn": "1.0",
"priority": "Critical",
"assignee": {
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
}

Response

{
"additionalAttributes": [
{
"apiName": "5N7Q9M7YLO5N6P8RATF6",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "5N7Q9M7YLO5N6P8RATF6",
"name": "Labels",
"value": "Model 20000"
}
],
"assignee": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"creationDateTime": "2021-09-07T05:25:10Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",

©2022 Arena, A PTC Business www.arenasolutions.com 530

 Arena REST API Developer Guide Endpoints

"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "",
"fixVersion": "2.0",
"foundOn": "1.0",
"guid": "1J3M5I3UHK1GZI1K31L4",
"modifyDateTime": "2021-09-07T05:25:10Z",
"title": "Paint chipping on new Model 20000",
"number": "DEF-000009",
"priority": "Critical",
"status": {
"guid": "Q8SBU7SJ69QM5O7Q9SCG",
"value": "Not Started"
},
"template": {
"guid": "8QATCPA1OR83M5O7Q967",
"name": "Defects"
}
}

©2022 Arena, A PTC Business www.arenasolutions.com 531

 Arena REST API Developer Guide Endpoints

PUT Ticket Edit

/tickets/<GUID>

Updates information for a Tickets with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Edit a Ticket.

PUT /requests/<GUID>

Request

{
"additionalAttributes": [
{
"guid": "6O8RAN8ZMP6O7Q9SBUGT",
"value": "Model 3000"
}
],
"title": "Paint chipping on new Model 3000",

©2022 Arena, A PTC Business www.arenasolutions.com 532

 Arena REST API Developer Guide Endpoints

"fixVersion": "3.0",
"foundOn": "2.0",
"priority": "Critical",
"assignee": {
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
}

Response

{
"additionalAttributes": [
{
"apiName": "6O8RAN8ZMP6O7Q9SBUGT",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "6O8RAN8ZMP6O7Q9SBUGT",
"name": "Components",
"value": "Model 3000"
}
],
"assignee": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"creationDateTime": "2021-09-07T05:24:08Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "",
"fixVersion": "3.0",
"foundOn": "2.0",
"guid": "1J3M5I3UHK1GZI1K31L4",
"modifyDateTime": "2021-09-07T05:51:59Z",
"title": "Paint chipping on new Model 3000",
"number": "DEF-000004",
"priority": "Critical",
"status": {
"guid": "Q8SBU7SJ69QM5O7Q9SCG",
"value": "Not Started"
},
"template": {
"guid": "8QATCPA1OR83M5O7Q967",
"name": "Defects"
}
}

Request with invalid GUID

{
"status":400,
"errors":[
{

©2022 Arena, A PTC Business www.arenasolutions.com 533

 Arena REST API Developer Guide Endpoints

"code":3011,
"message":"The guid \"ASCVERC3QTCFYGPWW1WCS\" is not valid"
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 534

 Arena REST API Developer Guide Endpoints

POST Ticket Status Change

/tickets/statuschanges

Users can change the status of a Ticket through this endpoint. Supported statuses: NOT_STARTED, IN_PROGRESS,
and COMPLETE.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Upgrade the status of a Ticket from NOT_STARTED to IN_PROGRESS.

POST /tickets/statuschanges

Request

{
"ticket": {
"guid": "1J3M5I3UHK1GZI1K31L4"
},
"status": "IN_PROGRESS"
}

©2022 Arena, A PTC Business www.arenasolutions.com 535

 Arena REST API Developer Guide Endpoints

Response

{
"additionalAttributes": [
{
"apiName": "5N7Q9M7YLO5N6P8RATF6",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "5N7Q9M7YLO5N6P8RATF6",
"name": "Labels",
"value": "Model 20000"
},
{
"apiName": "6O8RAN8ZMP6O7Q9SBUGT",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "6O8RAN8ZMP6O7Q9SBUGT",
"name": "Components",
"value": "Model 3000"
}
],
"assignee": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"creationDateTime": "2021-09-07T05:24:08Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "",
"fixVersion": "3.0",
"foundOn": "2.0",
"guid": "1J3M5I3UHK1GZI1K31L4",
"modifyDateTime": "2021-09-07T06:13:33Z",
"title": "Paint chipping on new Model 3000",
"number": "DEF-000004",
"priority": "Critical",
"status": {
"guid": "R9TCV8TK7ARN6P8RATDZ",
"value": "In Progress"
},
"template": {
"guid": "8QATCPA1OR83M5O7Q967",
"name": "Defects"
}
}

©2022 Arena, A PTC Business www.arenasolutions.com 536

 Arena REST API Developer Guide Endpoints

DELETE Ticket
/tickets/<GUID>

Deletes a Ticket with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response.

Request with invalid GUID

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 537

 Arena REST API Developer Guide Endpoints

GET Ticket Files

/tickets/<GUID>/files

/tickets/<GUID>/files/<GUID>

Returns a collection of files associated with a Ticket object. These are files located within the Files view of a
Ticket. Appending a GUID to the URL returns the file with that GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all files associated with a ticket

GET /tickets/<GUID>/files

{
"count": 3,
"results": [
{
"file": {
"author": {
"fullName": "Heidi Walker"
},
"category": {

©2022 Arena, A PTC Business www.arenasolutions.com 538

 Arena REST API Developer Guide Endpoints

"guid": "2K4N6J4VIL4EXGV223PR",
"name": "-uncategorized-"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2016-09-02T19:05:15Z",
"description": null,
"edition": "1",
"format": "pdf",
"guid": "8QATCPA1ORAQ9SIYLDC6",
"hasMarkup": false,
"lastModifiedDateTime": "2016-09-02T19:05:15Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/pdf",
"name": "020-00006 SOP, Risk Management.pdf",
"number": "FILE-000971",
"private": true,
"size": 92123,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "020-00006 SOP, Risk Management"
},
"guid": "N5P8R4PG36JO7Q9R58BB",
"latestEditionAssociation": true
},
{
"file": {
"author": {
"fullName": "Heidi Walker"
},
"category": {
"guid": "2K4N6J4VIL4EXGV223PR",
"name": "-uncategorized-"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2016-09-02T19:05:53Z",
"description": null,
"edition": "1",
"format": "pdf",
"guid": "J1L4N0LCZ2L1K3T9WOMD",
"hasMarkup": false,
"lastModifiedDateTime": "2016-09-02T19:05:53Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/pdf",
"name": "020-00007 SOP, Supplier Quality Management.pdf",
"number": "FILE-000973",
"private": true,
"size": 92171,
"storageMethod": 0,
"storageMethodName": "FILE",

©2022 Arena, A PTC Business www.arenasolutions.com 539

 Arena REST API Developer Guide Endpoints

"title": "020-00007 SOP, Supplier Quality Management"

},
"guid": "P7RAT6RI58LQ9SBT7AD2",
"latestEditionAssociation": true
},
{
"file": {
"author": {
"fullName": "Heidi Walker"
},
"category": {
"guid": "2K4N6J4VIL4EXGV223PR",
"name": "-uncategorized-"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2016-09-02T19:06:25Z",
"description": null,
"edition": "1",
"format": "pdf",
"guid": "R9TCV8TK7AT9SB1H4WUE",
"hasMarkup": false,
"lastModifiedDateTime": "2016-09-02T19:06:25Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/pdf",
"name": "020-00008 SOP, Production and Process Management.pdf",
"number": "FILE-000975",
"private": true,
"size": 92192,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "020-00008 SOP, Production and Process Management"
},
"guid": "O6Q9S5QH47KP8RAS69CA",
"latestEditionAssociation": true
}
]
}

Get a specific file with a specific GUID attached to a ticket of a specific GUID

GET /tickets/<GUID>/files/<GUID>

{
"file": {
"author": {
"fullName": "Heidi Walker"
},
"category": {
"guid": "2K4N6J4VIL4EXGV223PR",
"name": "-uncategorized-"
},
"checkedOut": false,

©2022 Arena, A PTC Business www.arenasolutions.com 540

 Arena REST API Developer Guide Endpoints

"corrected": false,
"creationDateTime": "2016-09-02T19:05:15Z",
"description": null,
"edition": "1",
"format": "pdf",
"guid": "8QATCPA1ORAQ9SIYLDC6",
"hasMarkup": false,
"lastModifiedDateTime": "2016-09-02T19:05:15Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/pdf",
"name": "020-00006 SOP, Risk Management.pdf",
"number": "FILE-000971",
"private": true,
"size": 92123,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "020-00006 SOP, Risk Management"
},
"guid": "N5P8R4PG36JO7Q9R58BB",
"latestEditionAssociation": true
}

©2022 Arena, A PTC Business www.arenasolutions.com 541

 Arena REST API Developer Guide Endpoints

POST Tickets Files View Add Existing File

/tickets/<GUID>/files

Associates an existing file to the Files view of a ticket.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Sample Request Body

{
"file": {
"guid": "8QATCPA1ORAQ9SIYLDC6"
}
}

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Tickets Files View Association

POST <url>/tickets/<GUID>/files

{
"file": {

©2022 Arena, A PTC Business www.arenasolutions.com 542

 Arena REST API Developer Guide Endpoints

"author": {
"fullName": "Heidi Walker"
},
"category": {
"guid": "2K4N6J4VIL4EXGV223PR",
"name": "-uncategorized-"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2016-09-02T19:05:15Z",
"description": null,
"edition": "1",
"format": "pdf",
"guid": "8QATCPA1ORAQ9SIYLDC6",
"hasMarkup": false,
"lastModifiedDateTime": "2016-09-02T19:05:15Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/pdf",
"name": "020-00006 SOP, Risk Management.pdf",
"number": "FILE-000971",
"private": true,
"size": 92123,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "020-00006 SOP, Risk Management"
},
"guid": "N5P8R4PG36JO7Q9R58BB",
"latestEditionAssociation": true
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 543

 Arena REST API Developer Guide Endpoints

DELETE Ticket Remove File Association

/tickets/<GUID>/files/<GUID>

Removes a File with a specific GUID from associating with a Ticket with a specific GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response.

Request with invalid GUID

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 544

 Arena REST API Developer Guide Endpoints

GET Ticket Changes

/tickets/<GUID>/changes

/tickets/<GUID>/changes/<GUID>

Returns a collection of changes added as references to a Ticket object. Appending a GUID to the URL returns
the change with that GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all changes added as references to a specific ticket

GET /tickets/<GUID>/changes

{
"count": 3,
"results": [
{
"change": {
"guid": "BTDWFSD4RUDGZHX2V463",
"number": "MCO-000004"
},
"guid": "FXH0JWH8VYF9SBUCQTT8"

©2022 Arena, A PTC Business www.arenasolutions.com 545

 Arena REST API Developer Guide Endpoints

},
{
"change": {
"guid": "4M6P8L6XKN69SAQQTS0P",
"number": "MCO-000008"
},
"guid": "EWGZIVG7UXE8RATBPSS9"
},
{
"change": {
"guid": "5N7Q9M7YLO7ATBRRUT1K",
"number": "MCO-000009"
},
"guid": "DVFYHUF6TWD7Q9SAORRW"
}
]
}

Get a specific change with a specific GUID added as a reference to a ticket of a specific GUID

GET /tickets/<GUID>/changes/<GUID>

{
"change": {
"guid": "BTDWFSD4RUDGZHX2V463",
"number": "MCO-000004"
},
"guid": "FXH0JWH8VYF9SBUCQTT8"
}

©2022 Arena, A PTC Business www.arenasolutions.com 546

 Arena REST API Developer Guide Endpoints

POST Tickets Add Change Reference

/tickets/<GUID>/changes

Adds a Change as a reference to a ticket.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Sample Request Body

{
"change": {
"guid": "CUEXGOODHCVYHZI360DQ"
}
}

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Adds a Change as a reference to a ticket.

POST <url>/tickets/<GUID>/changes

{
"change": {

©2022 Arena, A PTC Business www.arenasolutions.com 547

 Arena REST API Developer Guide Endpoints

"guid": "CUEXGOODHCVYHZI360DQ",
"number": "DCO-000001"
},
"guid": "O6Q9S5QH47OI1K3HK2JR"
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 548

 Arena REST API Developer Guide Endpoints

DELETE Ticket Remove Change Association

/tickets/<GUID>/changes/<GUID>

Removes a change with a specific GUID from a ticket with a specific GUID. The change is removed as a reference
from the ticket.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response.

Request with invalid GUID

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 549

 Arena REST API Developer Guide Endpoints

GET Ticket Items

/tickets/<GUID>/items

/tickets/<GUID>/items/<GUID>

Returns a collection of items added as references to a ticket object. Appending a GUID to the URL returns the
item with that GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all items added as references to a ticket

GET /tickets/<GUID>/items

{
"count": 3,
"results": [
{
"guid": "UCWFYBWNADUO7Q9R58AA",
"item": {
"guid": "WEYH0DYPCFY6P4SMJ3DL",
"name": "SOP, Risk Management",
"number": "020-00006",

©2022 Arena, A PTC Business www.arenasolutions.com 550

 Arena REST API Developer Guide Endpoints

"revision": "A",
"revisionStatus": "EFFECTIVE"
}
},
{
"guid": "WEYH0DYPCFWQ9SBT7ACL",
"item": {
"guid": "7P9SBO90NQ9H0F3XUEJR",
"name": "SOP, Production and Process Management",
"number": "020-00008",
"revision": "A",
"revisionStatus": "EFFECTIVE"
}
},
{
"guid": "VDXGZCXOBEVP8RAS69BZ",
"item": {
"guid": "HZJ2LYJAX0JRAPD74OXR",
"name": "SOP, Supplier Quality Management",
"number": "020-00007",
"revision": "A",
"revisionStatus": "EFFECTIVE"
}
}
]
}

Get a specific item with a specific GUID added as a reference to a ticket of a specific GUID

GET /tickets/<GUID>/items/<GUID>

{
"guid": "UCWFYBWNADUO7Q9R58AA",
"item": {
"guid": "WEYH0DYPCFY6P4SMJ3DL",
"name": "SOP, Risk Management",
"number": "020-00006",
"revision": "A",
"revisionStatus": "EFFECTIVE"
}
}

©2022 Arena, A PTC Business www.arenasolutions.com 551

 Arena REST API Developer Guide Endpoints

POST Tickets Add Item Reference

/tickets/<GUID>/items

Adds an item as a reference to a ticket.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Sample Request Body

{
"items": {
"guid": "WEYH0DYPCFY6P4SMJ3DL"
},
"latestRevisionAssociation": true
}

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Adds an item as a reference to a ticket.

POST <url>/tickets/<GUID>/items

©2022 Arena, A PTC Business www.arenasolutions.com 552

 Arena REST API Developer Guide Endpoints

{
"guid": "UCWFYBWNADUO7Q9R58AA",
"item": {
"guid": "WEYH0DYPCFY6P4SMJ3DL",
"name": "SOP, Risk Management",
"number": "020-00006",
"revision": "A",
"revisionStatus": "EFFECTIVE"
}
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 553

 Arena REST API Developer Guide Endpoints

DELETE Ticket Remove Item Association

/tickets/<GUID>/items/<GUID>

Removes an item with a specific GUID from a ticket with a specific GUID. The item is removed as a reference
from the ticket.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response.

Request with invalid GUID

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 554

 Arena REST API Developer Guide Endpoints

GET Ticket Quality Processes

/tickets/<GUID>/quality

/tickets/<GUID>/quality/<GUID>

Returns a collection of quality processes added as references to a ticket object. Appending a GUID to the URL
returns the quality process with that GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all quality processes added as references to a ticket

GET /tickets/<GUID>/quality

{
"count": 3,
"results": [
{
"guid": "0I2L4H2TGJ0UDWFXBEE0",
"quality": {
"guid": "FXH0JWH8VYHDWFYHTKDW",
"number": "NCMR-000002",
"step": {

©2022 Arena, A PTC Business www.arenasolutions.com 555

 Arena REST API Developer Guide Endpoints

"guid": "GYI1KXI9WZIEXGZIULEF",
"name": "Nonconformance Description"
}
}
},
{
"guid": "YG0J2F0REHYSBUDV9CCH",
"quality": {
"guid": "K2M5O1MD03MI1K3MVZIC",
"number": "CAR-000003",
"step": {
"guid": "P7RAT6RI58RN6P8R04NA",
"name": "Corrective Action"
}
}
},
{
"guid": "WEYH0DYPCFWQ9SBT7AAJ",
"quality": {
"guid": "0I2L4H2TGJ2YH0J2V0B1",
"number": "CAR-000004",
"step": {
"guid": "5N7Q9M7YLO73M5O705GA",
"name": "Corrective Action"
}
}
}
]
}

Get a specific quality process with a specific GUID added as a reference to a ticket of a specific GUID

GET /tickets/<GUID>/quality/<GUID>

{
"guid": "0I2L4H2TGJ0UDWFXBEE0",
"quality": {
"guid": "FXH0JWH8VYHDWFYHTKDW",
"number": "NCMR-000002",
"step": {
"guid": "GYI1KXI9WZIEXGZIULEF",
"name": "Nonconformance Description"
}
}
}

©2022 Arena, A PTC Business www.arenasolutions.com 556

 Arena REST API Developer Guide Endpoints

POST Tickets Add Quality Process Reference

/tickets/<GUID>/quality

Adds a quality process as a reference to a ticket.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Sample Request Body

{
"quality": {
"guid": "FXH0JWH8VYHDWFYHTKDW",
"step": {
"guid": "GYI1KXI9WZIEXGZIULEF"
}
}
}

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Adds a quality process as a reference to a ticket.

©2022 Arena, A PTC Business www.arenasolutions.com 557

 Arena REST API Developer Guide Endpoints

POST <url>/tickets/<GUID>/quality

{
"guid": "0I2L4H2TGJ0UDWFXBEE0",
"quality": {
"guid": "FXH0JWH8VYHDWFYHTKDW",
"number": "NCMR-000002",
"step": {
"guid": "GYI1KXI9WZIEXGZIULEF",
"name": "Nonconformance Description"
}
}
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 558

 Arena REST API Developer Guide Endpoints

DELETE Ticket Remove Quality Process Association

/tickets/<GUID>/quality/<GUID>

Removes a quality with a specific GUID from a ticket with a specific GUID. The quality process is removed as a
reference from the ticket.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response.

Request with invalid GUID

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 559

 Arena REST API Developer Guide Endpoints

GET Ticket Tickets

/tickets/<GUID>/tickets

/tickets/<GUID>/tickets/<GUID>

Returns a collection of tickets added as references to a ticket object. Appending a GUID to the URL returns the
ticket with that GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all tickets added as references to a ticket

GET /tickets/<GUID>/tickets

{
"count": 3,
"results": [
{
"guid": "7P9SBO90NQ71K3M4ILKN",
"ticket": {
"guid": "GYI1KXI9WZGVEXGZI0K9",
"number": "DEF-000002"
}

©2022 Arena, A PTC Business www.arenasolutions.com 560

 Arena REST API Developer Guide Endpoints

},
{
"guid": "5N7Q9M7YLO5ZI1K2GJIL",
"ticket": {
"guid": "YG0J2F0REHYDWFYH0YI1",
"number": "DEF-000003"
}
},
{
"guid": "2K4N6J4VIL2WFYHZDGG5",
"ticket": {
"guid": "4M6P8L6XKN4J2L4N64OR",
"number": "DEF-000005"
}
}
]
}

Get a specific ticket with a specific GUID added as a reference to a ticket of a specific GUID

GET /tickets/<GUID>/tickets/<GUID>

{
"guid": "7P9SBO90NQ71K3M4ILKN",
"ticket": {
"guid": "GYI1KXI9WZGVEXGZI0K9",
"number": "DEF-000002"
}
}

©2022 Arena, A PTC Business www.arenasolutions.com 561

 Arena REST API Developer Guide Endpoints

POST Tickets Add Ticket Reference

/tickets/<GUID>/tickets

Adds a ticket as a reference to a ticket.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Sample Request Body

{
"ticket": {
"guid": "GYI1KXI9WZGVEXGZI0K9"
}
}

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Adds a ticket as a reference to a ticket.

POST <url>/tickets/<GUID>/tickets

{
"guid": "7P9SBO90NQ71K3M4ILKN",

©2022 Arena, A PTC Business www.arenasolutions.com 562

 Arena REST API Developer Guide Endpoints

"ticket": {
"guid": "GYI1KXI9WZGVEXGZI0K9",
"number": "DEF-000002"
}
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 563

 Arena REST API Developer Guide Endpoints

DELETE Ticket Remove Ticket Association

/tickets/<GUID>/tickets/<GUID>

Removes a ticket with a specific GUID from a ticket with a specific GUID. The ticket is removed as a reference
from the ticket.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response.

Request with invalid GUID

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 564

 Arena REST API Developer Guide Endpoints

GET Triggers
/settings/integrations/triggers

Returns allthe triggers of a workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all
changes where results should begin. All
changes before the offset in the search
results are ignored. The default value is 0.
limit integer Specifies the number of results that should
be returned. By default the maximum
number of items is 20. Can return up 400
changes.

Searchable Attributes

Name Value Description

name string The name of the Trigger.
resource string The resource of the Trigger. Currently
supported resources:

ITEM

CHANGE

QUALITY
action string The action of the Trigger. Supported
actions:

CREATE

EDIT

WORKFLOW

©2022 Arena, A PTC Business www.arenasolutions.com 565

 Arena REST API Developer Guide Endpoints

Note: Search behavior in the Arena REST API differs from search behavior in the Arena application. In the API, a
trailing asterisk (wildcard) is required to return results that start with a string; in the Arena application, a trailing
asterisk is always implied.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all triggers in a workspace

GET /settings/integrations/triggers

{
"count": 4,
"results": [
{
"action": "WORKFLOW",
"creationDatetime": "2021-08-26T21:51:34Z",
"creator": {
"email": null,
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "Intended to queue up instances of Corrective Action
Reports transitioning from the Corrective Action Plan Approved? step to the Corrective
Action step.",
"guid": "L3N6P2NE14FCVEXGZIIQ",
"lastModifiedDateTime": null,
"modifyUser": null,
"name": "Corrective Action Report: Plan Step Approval",
"resource": "QUALITY"
},
{
"action": "WORKFLOW",

©2022 Arena, A PTC Business www.arenasolutions.com 566

 Arena REST API Developer Guide Endpoints

"creationDatetime": "2021-08-26T22:50:27Z",
"creator": {
"email": null,
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "Queues Temporary Changes once they're effective.",
"guid": "O6Q9S5QH47IFYH0J2LLA",
"lastModifiedDateTime": "2021-08-26T22:51:00Z",
"modifyUser": {
"email": null,
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "Deviations",
"resource": "CHANGE"
},
{
"action": "WORKFLOW",
"creationDatetime": "2021-08-06T21:38:31Z",
"creator": {
"email": null,
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "Queues all Changes with a category of Manufacturing Change
Order that move from lifecycle status of Submitted or Approved to Effective.",
"guid": "M4O7Q3OF25GDWFYH0JPT",
"lastModifiedDateTime": "2021-08-26T22:46:54Z",
"modifyUser": {
"email": null,
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "Manufacturing Change Order Release",
"resource": "CHANGE"
},
{
"action": "WORKFLOW",
"creationDatetime": "2021-08-18T18:20:48Z",
"creator": {
"email": null,
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "Queues up all Items that move into the Design Verification
Lifeycle phase.",
"guid": "R9TCV8TK7ALI1K3M5OQM",
"lastModifiedDateTime": "2021-08-26T22:45:35Z",
"modifyUser": {
"email": null,
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "Design Verification",

©2022 Arena, A PTC Business www.arenasolutions.com 567

 Arena REST API Developer Guide Endpoints

"resource": "ITEM"
}
]
}

Get triggers with a resource of QUALITY and an action of WORKFLOW

GET settings/integrations/triggers?resource=QUALITY&action=WORKFLOW

{
"count": 1,
"results": [
{
"action": "WORKFLOW",
"creationDatetime": "2021-08-26T21:51:34Z",
"creator": {
"email": null,
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "Intended to queue up instances of Corrective Action
Reports transitioning from the Corrective Action Plan Approved? step to the Corrective
Action step.",
"guid": "L3N6P2NE14FCVEXGZIIQ",
"lastModifiedDateTime": null,
"modifyUser": null,
"name": "Corrective Action Report: Plan Step Approval",
"resource": "QUALITY"
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 568

 Arena REST API Developer Guide Endpoints

GET Trigger
/settings/integrations/triggers/<GUID>

Returns a Trigger with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a trigger with a unique GUID

GET /settings/integrations/triggers/<GUID>

{
"count": 1,
"results": [
{
"action": "WORKFLOW",
"creationDatetime": "2021-08-26T21:51:34Z",
"creator": {
"email": null,
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "Intended to queue up instances of Corrective Action

©2022 Arena, A PTC Business www.arenasolutions.com 569

 Arena REST API Developer Guide Endpoints

Reports transitioning from the Corrective Action Plan Approved? step to the Corrective
Action step.",
"guid": "L3N6P2NE14FCVEXGZIIQ",
"lastModifiedDateTime": null,
"modifyUser": null,
"name": "Corrective Action Report: Plan Step Approval",
"resource": "QUALITY"
}
]
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"ASCVERC3QTCFYGPWW1WCS\" is not valid"
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 570

 Arena REST API Developer Guide Endpoints

GET Outbound-Events Integrations (Search)

/outboundevents

Returns a collection of outbound event integrations objects matching the given search criteria.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Searchable Attributes

Name Value Description

enabled string Indicates if an Integration is enabled. The
value is true if the integration is enabled.
The value is false if the integration is
disabled.
name string The name of the outbound integration.

Note: Search behavior in the Arena REST API differs from search behavior in the Arena application. In the API, a
trailing asterisk (wildcard) is required to return results that start with a string; in the Arena application, a trailing
asterisk is always implied.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 571

 Arena REST API Developer Guide Endpoints

Sample Response Body

Get all outbound event integrations

GET /outboundevents

{
"count": 3,
"results": [
{
"creationDateTime": "2021-07-29T23:00:02Z",
"creator": {
"email": "[email protected]",
"fullName": "Craig Stone",
"guid": "FXH0JWH8VYFYH0J25014"
},
"enabled": false,
"guid": "5D2V6J4VILWUDWFYH3FBG",
"lastModifiedDateTime": "2021-08-01T21:41:31Z",
"modifyUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "EveryHome Outbound Event Integration Clovex",
"status": "NEEDS_ATTENTION"
},
{
"creationDateTime": "2021-07-20T23:32:02Z",
"creator": {
"email": "[email protected]",
"fullName": "Craig Stone",
"guid": "FXH0JWH8VYFYH0J25014"
},
"enabled": true,
"guid": "2K4N6J4VILWUDWFYH3YT",
"lastModifiedDateTime": "2021-08-06T21:41:31Z",
"modifyUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "EveryHome Outbound Event Integration",
"status": "NEEDS_ATTENTION"
},
{
"creationDateTime": "2021-07-28T12:32:02Z",
"creator": {
"email": "[email protected]",
"fullName": "Craig Stone",
"guid": "FXH0JWH8VYFYH0J25014"
},
"enabled": false,
"guid": "M4O7QY5R7FY8RATAYXNX",
"lastModifiedDateTime": "2021-08-12T21:41:31Z",

©2022 Arena, A PTC Business www.arenasolutions.com 572

 Arena REST API Developer Guide Endpoints

"modifyUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "EveryHome Outbound Event Gamma Integration",
"status": "NEEDS_ATTENTION"
}
]
}

Get outbound events integrations that are enabled

GET <url>/outboundevents?enabled=true

{
"count": 1,
"results": [
{
"creationDateTime": "2021-07-20T23:32:02Z",
"creator": {
"email": "[email protected]",
"fullName": "Craig Stone",
"guid": "FXH0JWH8VYFYH0J25014"
},
"enabled": true,
"guid": "2K4N6J4VILWUDWFYH3YT",
"lastModifiedDateTime": "2021-08-06T21:41:31Z",
"modifyUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "EveryHome Outbound Event Integration",
"status": "NEEDS_ATTENTION"
}
]
}

Request with an invalid search attribute.

GET /outboundevents?transferType=Item Revision

{
"status":400,
"errors":[
{
"code":3003,
"message":"The value for the attribute \"trasnferType\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 573

 Arena REST API Developer Guide Endpoints

GET Outbound-Event Integrations

/outboundevents/<guid>

Returns a specific outbound event integration matching the given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a specific outbound event integration.

GET /outboundevents/<GUID>

{
"creationDateTime": "2021-07-20T23:32:02Z",
"creator": {
"email": "[email protected]",
"fullName": "Craig Stone",
"guid": "FXH0JWH8VYFYH0J25014"
},
"enabled": true,
"guid": "2K4N6J4VILWUDWFYH3YT",
"lastModifiedDateTime": "2021-08-06T21:41:31Z",

©2022 Arena, A PTC Business www.arenasolutions.com 574

 Arena REST API Developer Guide Endpoints

"modifyUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "EveryHome Outbound Event Integration",
"status": "NEEDS_ATTENTION"
}

Request with an invalid GUID.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"5N7Q9M7YL0Z6P8RATFCI\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 575

 Arena REST API Developer Guide Endpoints

GET Outbound-Event Integration Triggers

/outboundevents/<GUID>/triggers

Returns all the triggers for a specific outbound event integration.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all triggers associated with a specific outbound event integration.

GET /outboundevents/<GUID>/triggers

{
"count": 3,
"results": [
{
"action": "WORKFLOW",
"description": "Queues up all Items that move into the Design Verification
Lifeycle phase.",
"guid": "R9TCV8TK7ALI1K3M5OQM",
"name": "Design Verification",
"resource": "ITEM"

©2022 Arena, A PTC Business www.arenasolutions.com 576

 Arena REST API Developer Guide Endpoints

},
{
"action": "WORKFLOW",
"description": "Intended to queue up instances of Corrective Action
Reports transitioning from the Corrective Action Plan Approved? step to the Corrective
Action step.",
"guid": "L3N6P2NE14FCVEXGZIIQ",
"name": "Corrective Action Report: Plan Step Approval",
"resource": "QUALITY"
},
{
"action": "WORKFLOW",
"description": "Queues all Changes with a category of Manufacturing Change
Order that move from lifecycle status of Submitted or Approved to Effective.",
"guid": "M4O7Q3OF25GDWFYH0JPT",
"name": "Manufacturing Change Order Release",
"resource": "CHANGE"
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 577

 Arena REST API Developer Guide Endpoints

GET Outbound-Event Integration Trigger

/outboundevents/<GUID>/triggers/<GUID>

Returns a specific trigger for an outbound event integration with a specific GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a specific outbound event integration trigger.

GET /outboundevents/<GUID>/triggers/<GUID>

{
"action": "WORKFLOW",
"description": "Intended to queue up instances of Corrective Action Reports
transitioning from the Corrective Action Plan Approved? step to the Corrective Action
step.",
"guid": "L3N6P2NE14FCVEXGZIIQ",
"name": "Corrective Action Report: Plan Step Approval",
"resource": "QUALITY"
}

©2022 Arena, A PTC Business www.arenasolutions.com 578

 Arena REST API Developer Guide Endpoints

Request with an invalid GUID.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"5N7Q9M7YL0Z6P8RATFCI\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 579

 Arena REST API Developer Guide Endpoints

GET Integration Administrators

/outboundevents/<GUID>/administrators

Returns all the integration administrators of a specific outbound event integration matching the given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get the integration administrators of a specific outbound events integration.

GET /outboundevents/<GUID>/administrators

{
"count": 3,
"results": [
{
"email": "[email protected]",
"fullName": "Rachael Borger",
"guid": "VDXGZCXOBEVEXGZIRHOJ"
},
{
"email": "[email protected]",

©2022 Arena, A PTC Business www.arenasolutions.com 580

 Arena REST API Developer Guide Endpoints

"fullName": "Heidi Walker",

"guid": "WEYH0DYPCFWFYH0JSIPD"
},
{
"email": "[email protected]",
"fullName": "Eleanor Canard",
"guid": "1J3M5I3UHK1K3M5OXNUV"
}
]
}

Request with an invalid GUID.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"5D7Q9M7YL0Z6P8RATBDS\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 581

 Arena REST API Developer Guide Endpoints

GET Outbound-Events Integration Events

/outboundevents/<GUID>/events

Returns all the events for a specific outbound event integration.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all items where results should begin. All items before the
offset in the search results are ignored. The default value is 0.
limit integer Specifies the number of results that should be returned. By default the maximum number of
items is 20. Can return up to 400 objects.

Searchable Attributes

Name Value Description

resourcesReconciled Boolean Indicates if an event is reconciled. If set
equal to true it returns only events that are
reconciled.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count

©2022 Arena, A PTC Business www.arenasolutions.com 582

 Arena REST API Developer Guide Endpoints

Name Value Description

X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all events associated with a specific outbound event integration.

GET /outboundevents/<GUID>/events

{
"count": 6,
"results": [
{
"creationDateTime": "2021-08-28T05:36:50Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"eventType": "OUTBOUND_EVENT",
"guid": "R9TCV8TK7ALL4N6P8NY5",
"resourcesReconciled": false,
"status": "NEEDS_UPDATE",
"triggers": [
{
"action": "WORKFLOW",
"description": "Queues all Changes with a category of Manufacturing
Change Order that move from lifecycle status of Submitted or Approved to Effective.",

"guid": "M4O7Q3OF25GDWFYH0JPT",
"name": "Manufacturing Change Order Release",
"resource": "CHANGE"
}
]
},
{
"creationDateTime": "2021-08-26T22:42:43Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"eventType": "OUTBOUND_EVENT",
"guid": "ASCVERC3QT44N6P8R6HC",
"resourcesReconciled": false,
"status": "NEEDS_UPDATE",
"triggers": [
{
"action": "WORKFLOW",
"description": "Intended to queue up instances of Corrective
Action Reports transitioning from the Corrective Action Plan Approved? step to the
Corrective Action step.",
"guid": "L3N6P2NE14FCVEXGZIIQ",

©2022 Arena, A PTC Business www.arenasolutions.com 583

 Arena REST API Developer Guide Endpoints

"name": "Corrective Action Report: Plan Step Approval",

"resource": "QUALITY"
}
]
},
{
"creationDateTime": "2021-08-26T22:28:58Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"eventType": "OUTBOUND_EVENT",
"guid": "2K4N6J4VILWWFYH0JYA9",
"resourcesReconciled": false,
"status": "NEEDS_UPDATE",
"triggers": [
{
"action": "WORKFLOW",
"description": "Intended to queue up instances of Corrective
Action Reports transitioning from the Corrective Action Plan Approved? step to the
Corrective Action step.",
"guid": "L3N6P2NE14FCVEXGZIIQ",
"name": "Corrective Action Report: Plan Step Approval",
"resource": "QUALITY"
}
]
},
...
]
}

Get all reconciled vents associated with a specific outbound event integration.

GET /outboundevents/<GUID>/events?resourcesReconciled=true

{
"count": 3,
"results": [
{
"creationDateTime": "2021-08-06T21:49:40Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"eventType": "OUTBOUND_EVENT",
"guid": "4M6P8L6XKNYYH0J2L10Y",
"resourcesReconciled": true,
"status": "RECONCILED",
"triggers": [
{
"action": "WORKFLOW",
"description": "Queues all Changes with a category of Manufacturing
Change Order that move from lifecycle status of Submitted or Approved to Effective.",

©2022 Arena, A PTC Business www.arenasolutions.com 584

 Arena REST API Developer Guide Endpoints

"guid": "M4O7Q3OF25GDWFYH0JPT",
"name": "Manufacturing Change Order Release",
"resource": "CHANGE"
}
]
},
{
"creationDateTime": "2021-08-18T18:22:56Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"eventType": "OUTBOUND_EVENT",
"guid": "0I2L4H2TGJUUDWFYHXJX",
"resourcesReconciled": true,
"status": "RECONCILED",
"triggers": [
{
"action": "WORKFLOW",
"description": "Queues up all Items that move into the Design
Verification Lifeycle phase.",
"guid": "R9TCV8TK7ALI1K3M5OQM",
"name": "Design Verification",
"resource": "ITEM"
}
]
},
{
"creationDateTime": "2021-08-09T05:27:28Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"eventType": "OUTBOUND_EVENT",
"guid": "2K4N6J4VILWWFYH0JZWU",
"resourcesReconciled": true,
"status": "RECONCILED",
"triggers": [
{
"action": "WORKFLOW",
"description": "Queues all Changes with a category of Manufacturing
Change Order that move from lifecycle status of Submitted or Approved to Effective.",

"guid": "M4O7Q3OF25GDWFYH0JPT",
"name": "Manufacturing Change Order Release",
"resource": "CHANGE"
}
]
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 585

 Arena REST API Developer Guide Endpoints

GET Outbound-Event Integration Event

/outboundevents/<GUID>/events/<GUID>

Returns a specific event for an outbound-event integration with a specific GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a specific outbound-event integration event.

GET /outboundevents/<GUID>/events/<GUID>

{
"creationDateTime": "2021-08-26T22:28:58Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"eventType": "OUTBOUND_EVENT",
"guid": "2K4N6J4VILWWFYH0JYA9",
"resourcesReconciled": false,

©2022 Arena, A PTC Business www.arenasolutions.com 586

 Arena REST API Developer Guide Endpoints

"status": "NEEDS_UPDATE",
"triggers": [
{
"action": "WORKFLOW",
"description": "Intended to queue up instances of Corrective Action
Reports transitioning from the Corrective Action Plan Approved? step to the Corrective
Action step.",
"guid": "L3N6P2NE14FCVEXGZIIQ",
"name": "Corrective Action Report: Plan Step Approval",
"resource": "QUALITY"
}
]
}

Request with an invalid GUID.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"5N7Q9M7YL0Z6P8RATFCI\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 587

 Arena REST API Developer Guide Endpoints

GET Outbound-Event Integration Items Event

/outboundevents/<GUID>/events/<GUID>/items

/outboundevents/<GUID>/events/<GUID>/items/<GUID>

Returns item results from a specific event specified by triggers from an outbound-event integration.

Appending a GUID to the URL returns the specific item result guid from that event.

The examples below will display responses for events generated by triggers that contain Item as a resource
and Create, Edit, and Workflow as actions.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Searchable Attributes

Name Value Description

reconciled boolean If set to false it returns all item events that are not reconciled.

If set to true it returns all item events that are reconciled.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 588

 Arena REST API Developer Guide Endpoints

Sample Response Body

Get item-events from a specific event from a specific outbound-event integration.

The results from the specific event are generated by a trigger with item as a resource and create as an action.

GET /outboundevents/<GUID>/events/<GUID>/items?reconciled=false

{
"count": 5,
"results": [
{
"guid": "I0K3MZKBY1KSBP7DYNR7",
"postEvent": {
"guid": "I0K3MZKBY1KSBP7DYNR7"
},
"preEvent": null,
"reconciled": false
},
{
"guid": "P2C3MZKBY1KSBP7BCVH9",
"postEvent": {
"guid": "P2C3MZKBY1KSBP7BCVH9"
},
"preEvent": null,
"reconciled": false
},
...
]
}

Get a specific item-event from a specific event from a specific outbound-event integration.

The specific result from the event below is generated by a trigger with item as a resource and create as an
action.

GET /outboundevents/<GUID>/events/<GUID>/items/<GUID>

{
"guid": "I0K3MZKBY1KSBP7DYNR7",
"postEvent": {
"guid": "I0K3MZKBY1KSBP7DYNR7"
},
"preEvent": null,
"reconciled": false
}

Get item-events from a specific event from a specific outbound-event integration.

The results from the specific event are generated by a trigger with item as a resource and edit as an action.

GET /outboundevents/<GUID>/events/<GUID>/items?reconciled=false

{
"count": 3,
"results": [

©2022 Arena, A PTC Business www.arenasolutions.com 589

 Arena REST API Developer Guide Endpoints

{
"guid": "XFZI1EZQDGZ7Q4MSD254",
"postEvent": {
"additionalAttributes": [
{
"apiName": "M4O7Q3OF25M4N6NM8LYP",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "M4O7Q3OF25M4N6NM8LYP",
"name": "Material",
"value": "Acrylic"
},
{
"apiName": "0I2L4H2TGJ0I1KZ25KEL",
"fieldType": "DROP_DOWN",
"guid": "0I2L4H2TGJ0I1KZ25KEL",
"name": "Product Line",
"value": "EveryHome"
}
],
"name": "Artwork for SmartTable Delux Model",
"owner": {
"fullName": "Helen Shaughnessy"
}
},
"preEvent": {
"additionalAttributes": [
{
"apiName": "M4O7Q3OF25M4N6NM8LYP",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "M4O7Q3OF25M4N6NM8LYP",
"name": "Material",
"value": null
},
{
"apiName": "0I2L4H2TGJ0I1KZ25KEL",
"fieldType": "DROP_DOWN",
"guid": "0I2L4H2TGJ0I1KZ25KEL",
"name": "Product Line",
"value": null
}
],
"name": "Artwork for SmartTable Delux",
"owner": {
"fullName": "Heidi Walker"
}
},
"reconciled": false
},
...
]
}

Get a specific item-event from a specific event from a specific outbound-event integration.

The specific result from the event below is generated by a trigger with item as a resource and edit as an action.

©2022 Arena, A PTC Business www.arenasolutions.com 590

 Arena REST API Developer Guide Endpoints

GET /outboundevents/<GUID>/events/<GUID>/items/<GUID>

{
"guid": "XFZI1EZQDGZ7Q4MSD254",
"postEvent": {
"additionalAttributes": [
{
"apiName": "M4O7Q3OF25M4N6NM8LYP",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "M4O7Q3OF25M4N6NM8LYP",
"name": "Material",
"value": "Acrylic"
},
{
"apiName": "0I2L4H2TGJ0I1KZ25KEL",
"fieldType": "DROP_DOWN",
"guid": "0I2L4H2TGJ0I1KZ25KEL",
"name": "Product Line",
"value": "EveryHome"
}
],
"name": "Artwork for SmartTable Delux Model",
"owner": {
"fullName": "Helen Shaughnessy"
}
},
"preEvent": {
"additionalAttributes": [
{
"apiName": "M4O7Q3OF25M4N6NM8LYP",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "M4O7Q3OF25M4N6NM8LYP",
"name": "Material",
"value": null
},
{
"apiName": "0I2L4H2TGJ0I1KZ25KEL",
"fieldType": "DROP_DOWN",
"guid": "0I2L4H2TGJ0I1KZ25KEL",
"name": "Product Line",
"value": null
}
],
"name": "Artwork for SmartTable Delux",
"owner": {
"fullName": "Heidi Walker"
}
},
"reconciled": false
}

Get item-events from a specific event from a specific outbound-event integration.

The results from the specific event below are generated by a trigger with item as a resource and workflow as
an action.

©2022 Arena, A PTC Business www.arenasolutions.com 591

 Arena REST API Developer Guide Endpoints

GET /outboundevents/<GUID>/events/<GUID>/items?reconciled=false

{
"count": 2,
"results": [
{
"guid": "2K4N6J4VIL4CV9RXI7BS",
"postEvent": {
"lifecyclePhase": {
"guid": "ASCVERC3QTBEXGZIY3IC",
"name": "Design Verification"
}
},
"preEvent": {
"lifecyclePhase": {
"guid": "4M6P8L6XKN58RATCU9I6",
"name": "Concept"
}
},
"reconciled": false
},
{
"guid": "DVFYHUF6TWFN6K28TILX",
"postEvent": {
"lifecyclePhase": {
"guid": "ASCVERC3QTBEXGZIY3IC",
"name": "Design Verification"
}
},
"preEvent": {
"lifecyclePhase": {
"guid": "4M6P8L6XKN58RATCU9I6",
"name": "Concept"
}
},
"reconciled": false
}
]
}

Get a specific item-event from a specific event from a specific outbound-event integration.

The specific item event below is generated by a trigger with item as a resource and workflow as an action.

GET /outboundevents/<GUID>/events/<GUID>/items/<GUID>

{
"guid": "2K4N6J4VIL4CV9RXI7BS",
"postEvent": {
"lifecyclePhase": {
"guid": "ASCVERC3QTBEXGZIY3IC",
"name": "Design Verification"
}
},
"preEvent": {

©2022 Arena, A PTC Business www.arenasolutions.com 592

 Arena REST API Developer Guide Endpoints

"lifecyclePhase": {
"guid": "4M6P8L6XKN58RATCU9I6",
"name": "Concept"
}
},
"reconciled": false
}

©2022 Arena, A PTC Business www.arenasolutions.com 593

 Arena REST API Developer Guide Endpoints

GET Outbound-Event Integration Changes Event

/outboundevents/<GUID>/events/<GUID>/changes

/outboundevents/<GUID>/events/<GUID>/changes/<GUID>

Returns change results from a specific event specified by triggers from an outbound-event integration.

Appending a GUID to the URL returns the specific change result guid from that event.

The examples below will display responses for events generated by triggers that contain Change as a resource
and Create, Edit, and Workflow as actions.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Searchable Attributes

Name Value Description

reconciled boolean If set to false it returns all item events that are not reconciled.

If set to true it returns all item events that are reconciled.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 594

 Arena REST API Developer Guide Endpoints

Sample Response Body

Get change-events from a specific event from a specific outbound-event integration.

The results from the specific event are generated by a trigger with change as a resource and create as an action.

GET /outboundevents/<GUID>/events/<GUID>/changes?reconciled=false

{
"count": 1,
"results": [
{
"guid": "O6Q9S5QH47QTCUAAC81E",
"postEvent": {
"guid": "O6Q9S5QH47QTCUAAC81E"
},
"preEvent": null,
"reconciled": false
}
]
}

Get a specific change-event from a specific event from a specific outbound-event integration.

The specific result from the event below is generated by a trigger with change as a resource and create as an
action.

GET /outboundevents/<GUID>/events/<GUID>/changes/<GUID>

{
"guid": "O6Q9S5QH47QTCUAAC81E",
"postEvent": {
"guid": "O6Q9S5QH47QTCUAAC81E"
},
"preEvent": null,
"reconciled": false
}

Get change-events from a specific event from a specific outbound-event integration.

The results from the specific event are generated by a trigger with change as a resource and edit as an action.

GET /outboundevents/<GUID>/events/<GUID>/changes?reconciled=false

{
"count": 1,
"results": [
{
"guid": "O6Q9S5QH47QTCUAAC81E",
"postEvent": {
"guid": "O6Q9S5QH47QTCUAAC81E"
},
"preEvent": null,
"reconciled": false
}

©2022 Arena, A PTC Business www.arenasolutions.com 595

 Arena REST API Developer Guide Endpoints

]
}

Get a specific change-event from a specific event from a specific outbound-event integration.

The specific result from the event below is generated by a trigger with change as a resource and edit as an
action.

GET /outboundevents/<GUID>/events/<GUID>/changes/<GUID>

{
"guid": "O6Q9S5QH47QTCUAAC81E",
"postEvent": {
"additionalAttributes": [
{
"apiName": "1J3M5I3UHK1J2L27F31R",
"fieldType": "FIXED_DROP_DOWN",
"guid": "1J3M5I3UHK1J2L27F31R",
"name": "Validation Review?",
"value": "Yes"
},
{
"apiName": "DVFYHUF6TWDVEXEJRFTJ",
"fieldType": "FIXED_DROP_DOWN",
"guid": "DVFYHUF6TWDVEXEJRFTJ",
"name": "Priority",
"value": "Critical"
}
],
"description": "Release of new artwork for the Fall 2021 season."
},
"preEvent": {
"additionalAttributes": [
{
"apiName": "1J3M5I3UHK1J2L27F31R",
"fieldType": "FIXED_DROP_DOWN",
"guid": "1J3M5I3UHK1J2L27F31R",
"name": "Validation Review?",
"value": "Pending"
},
{
"apiName": "DVFYHUF6TWDVEXEJRFTJ",
"fieldType": "FIXED_DROP_DOWN",
"guid": "DVFYHUF6TWDVEXEJRFTJ",
"name": "Priority",
"value": "High"
}
],
"description": "Release of new artwork."
},
"reconciled": false
}

Get change-events from a specific event from a specific outbound-event integration.

©2022 Arena, A PTC Business www.arenasolutions.com 596

 Arena REST API Developer Guide Endpoints

The results from the specific event below are generated by a trigger with change as a resource and workflow
as an action.

GET /outboundevents/<GUID>/events/<GUID>/changes?reconciled=false

{
"count": 1,
"results": [
{
"guid": "SAUDW9UL8BUXGYEEGQCB",
"postEvent": {
"lifecycleStatus": {
"type": "APPROVED"
}
},
"preEvent": {
"lifecycleStatus": {
"type": "SUBMITTED_FOR_APPROVAL"
}
},
"reconciled": false
}
]
}

Get a specific change-event from a specific event from a specific outbound-event integration.

The specific change event below is generated by a trigger with change as a resource and workflow as an action.

GET /outboundevents/<GUID>/events/<GUID>/changes/<GUID>

{
"guid": "SAUDW9UL8BUXGYEEGQCB",
"postEvent": {
"lifecycleStatus": {
"type": "APPROVED"
}
},
"preEvent": {
"lifecycleStatus": {
"type": "SUBMITTED_FOR_APPROVAL"
}
},
"reconciled": false
}

©2022 Arena, A PTC Business www.arenasolutions.com 597

 Arena REST API Developer Guide Endpoints

GET Outbound-Event Integration Quality Event

/outboundevents/<GUID>/events/<GUID>/qualityprocesses

/outboundevents/<GUID>/events/<GUID>/qualityprocesses/<GUID>

Returns quality process results from a specific event specified by triggers from an outbound-event integration.

Appending a GUID to the URL returns the specific quality process result guid from that event.

The examples below will display responses for events generated by triggers that contain Quality as a resource
and Create, Edit, and Workflow as actions.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Searchable Attributes

Name Value Description

reconciled boolean If set to false it returns all item events that are not reconciled.

If set to true it returns all item events that are reconciled.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 598

 Arena REST API Developer Guide Endpoints

Sample Response Body

Get quality process-events from a specific event from a specific outbound-event integration.

The results from the specific event are generated by a trigger with quality as a resource and create as an action.

GET /outboundevents/<GUID>/events/<GUID>/qualityprocesses?reconciled=false

{
"count": 1,
"results": [
{
"guid": "UCWFYBWNADWSBUDWPF1I",
"postEvent": {
"guid": "UCWFYBWNADWSBUDWPF1I"
},
"preEvent": null,
"reconciled": false
}
]
}

Get a specific quality process-event from a specific event from a specific outbound-event integration.

The specific result from the event below is generated by a trigger with quality as a resource and create as an
action.

GET /outboundevents/<GUID>/events/<GUID>/qualityprocesses/<GUID>

{
"guid": "UCWFYBWNADWSBUDWPF1I",
"postEvent": {
"guid": "UCWFYBWNADWSBUDWPF1I"
},
"preEvent": null,
"reconciled": false
}

Get quality process-events from a specific event from a specific outbound-event integration.

The results from the specific event are generated by a trigger with quality as a resource and edit as an action.

GET /outboundevents/<GUID>/events/<GUID>/qualityprocesses?reconciled=false

{
"count": 1,
"results": [
{
"guid": "UCWFYBWNADWSBUDWPF1I",
"postEvent": {
"description": "Matier, Newsome, and Tallenger reports model 3000s
came in unassembled.",
"name": "Reviewing Customer Complaints on Unassembled models",
"targetCompletionDateTime": "2021-09-30T00:00:00Z"
},
"preEvent": {

©2022 Arena, A PTC Business www.arenasolutions.com 599

 Arena REST API Developer Guide Endpoints

"description": "Matier and associates reports model 3000s came in

unassembled.",
"name": "Reviewing Customer Complaints",
"targetCompletionDateTime": null
},
"reconciled": false
}
]
}

Get a specific quality process-event from a specific event from a specific outbound-event integration.

The specific result from the event below is generated by a trigger with quality as a resource and edit as an
action.

GET /outboundevents/<GUID>/events/<GUID>/qualityprocesses/<GUID>

{
"guid": "UCWFYBWNADWSBUDWPF1I",
"postEvent": {
"description": "Matier, Newsome, and Tallenger reports model 3000s came in
unassembled.",
"name": "Reviewing Customer Complaints on Unassembled models",
"targetCompletionDateTime": "2021-09-30T00:00:00Z"
},
"preEvent": {
"description": "Matier and associates reports model 3000s came in
unassembled.",
"name": "Reviewing Customer Complaints",
"targetCompletionDateTime": null
},
"reconciled": false
}

Get quality process-events from a specific event from a specific outbound-event integration.

The results from the specific event below are generated by a trigger with quality as a resource and workflow
as an action.

GET /outboundevents/<GUID>/events/<GUID>/qualityprocesses?reconciled=false

{
"count": 1,
"results": [
{
"guid": "UCWFYBWNADWSBUDWPF1I",
"postEvent": {
"currentStep": {
"guid": "ZH1K3G1SFI1XGZI1UK6H",
"name": "Corrective Action"
}
},
"preEvent": {
"currentStep": {
"guid": "YG0J2F0REH0WFYH0TJ56",

©2022 Arena, A PTC Business www.arenasolutions.com 600

 Arena REST API Developer Guide Endpoints

"name": "Corrective Action Plan Approved?"

}
},
"reconciled": false
}
]
}

Get a specific quality process-event from a specific event from a specific outbound-event integration.

The specific event below is generated by a trigger with quality as a resource and workflow as an action.

GET /outboundevents/<GUID>/events/<GUID>/qualityprocesses/<GUID>

{
"guid": "UCWFYBWNADWSBUDWPF1I",
"postEvent": {
"currentStep": {
"guid": "ZH1K3G1SFI1XGZI1UK6H",
"name": "Corrective Action"
}
},
"preEvent": {
"currentStep": {
"guid": "YG0J2F0REH0WFYH0TJ56",
"name": "Corrective Action Plan Approved?"
}
},
"reconciled": false
}

©2022 Arena, A PTC Business www.arenasolutions.com 601

 Arena REST API Developer Guide Endpoints

PUT Outbound-Event Event Item Reconcile

/outboundevents/<GUID>/events/<GUID>/items/<GUID>

Marks an item in an event as reconciled if reconciled is set to true within the request body.

The user must be an integration administrator for the integration in order to perform this activity.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

Request body with reonciled set to true marks an item in a specific event as reconciled.

{
"reconciled": true
}

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Marks as reconciled the specific item within an a specific event of a specific outbound-event integration.

/outboundevents/<GUID>/events/<GUID>/items/<GUID>

©2022 Arena, A PTC Business www.arenasolutions.com 602

 Arena REST API Developer Guide Endpoints

{
"guid": "I0K3MZKBY1KSBP7DYNR7",
"postEvent": {
"guid": "I0K3MZKBY1KSBP7DYNR7"
},
"preEvent": null,
"reconciled": true,
"reconciledDatetime": "2021-09-10T23:58:21Z",
"reconciledUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
}

If the request body has a reconciled value of false, the response would resemble below.

{
"guid": "I0K3MZKBY1KSBP7DYNR7",
"postEvent": {
"guid": "I0K3MZKBY1KSBP7DYNR7"
},
"preEvent": null,
"reconciled": false
}

©2022 Arena, A PTC Business www.arenasolutions.com 603

 Arena REST API Developer Guide Endpoints

PUT Outbound-Event Event Change Reconcile

/outboundevents/<GUID>/events/<GUID>/changes/<GUID>

Marks a change in an event as reconciled if reconciled is set to true within the request body.

The user must be an integration administrator for the integration in order to perform this activity.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

Request body with reonciled set to true marks a change in a specific event as reconciled.

{
"reconciled": true
}

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Marks as reconciled the specific change within an a specific event of a specific outbound-event integration.

/outboundevents/<GUID>/events/<GUID>/changes/<GUID>

©2022 Arena, A PTC Business www.arenasolutions.com 604

 Arena REST API Developer Guide Endpoints

{
"guid": "SAUDW9UL8BUXGYEEGQCB",
"postEvent": {
"lifecycleStatus": {
"type": "APPROVED"
}
},
"preEvent": {
"lifecycleStatus": {
"type": "SUBMITTED_FOR_APPROVAL"
}
},
"reconciled": true,
"reconciledDatetime": "2021-09-11T01:02:18Z",
"reconciledUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
}

If the request body has a reconciled value of false, the response would resemble below.

{
"guid": "SAUDW9UL8BUXGYEEGQCB",
"postEvent": {
"lifecycleStatus": {
"type": "APPROVED"
}
},
"preEvent": {
"lifecycleStatus": {
"type": "SUBMITTED_FOR_APPROVAL"
}
},
"reconciled": false
}

©2022 Arena, A PTC Business www.arenasolutions.com 605

 Arena REST API Developer Guide Endpoints

PUT Outbound-Event Event Quality Reconcile

/outboundevents/<GUID>/events/<GUID>/qualityprocesses/<GUID>

Marks a change in an event as reconciled if reconciled is set to true within the request body.

The user must be an integration administrator for the integration in order to perform this activity.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

Request body with reonciled set to true marks a quality process in a specific event as reconciled.

{
"reconciled": true
}

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Marks as reconciled the specific quality process within an a specific event of a specific outbound-event
integration.

©2022 Arena, A PTC Business www.arenasolutions.com 606

 Arena REST API Developer Guide Endpoints

/outboundevents/<GUID>/events/<GUID>/qualityprocesses/<GUID>

{
"guid": "UCWFYBWNADWSBUDWPF1I",
"postEvent": {
"currentStep": {
"guid": "ZH1K3G1SFI1XGZI1UK6H",
"name": "Corrective Action"
}
},
"preEvent": {
"currentStep": {
"guid": "YG0J2F0REH0WFYH0TJ56",
"name": "Corrective Action Plan Approved?"
}
},
"reconciled": true,
"reconciledDatetime": "2021-09-11T01:06:50Z",
"reconciledUser": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
}

If the request body has an reconciled value of false, the response would resemble below.

{
"guid": "UCWFYBWNADWSBUDWPF1I",
"postEvent": {
"currentStep": {
"guid": "ZH1K3G1SFI1XGZI1UK6H",
"name": "Corrective Action"
}
},
"preEvent": {
"currentStep": {
"guid": "YG0J2F0REH0WFYH0TJ56",
"name": "Corrective Action Plan Approved?"
}
},
"reconciled": false
}

©2022 Arena, A PTC Business www.arenasolutions.com 607

 Arena REST API Developer Guide Endpoints

GET Recent Activity - User Access

/settings/recentactivities/useraccesses

Returns an array of Login objects.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all logins
where results should begin. All logins before
the offset in the search results are ignored.
The default value is 0.
limit integer Specifies the maximum number of returned
results. The default value (no specified limit)
is 20, the maximum is 400.

Searchable Attributes

Name Value Description

DateTimeFrom string Include all logins after this date and time
DateTimeTo string Include all logins before this date and time

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions

©2022 Arena, A PTC Business www.arenasolutions.com 608

 Arena REST API Developer Guide Endpoints

Name Value Description

X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Get all user logins on January 1st 2017 (no offset, 50 result limit)

GET /settings/recentactivities/useraccesses?offset=0&limit=50&dateTimeFrom=
2017-01-01T00:00:00Z&dateTimeFrom=2017-01-01T23:59:59Z

{
"count":50,
"results":[
{
"connectedThrough":"ARENA_PLM",
"domain":"everyroadgps.com",
"duration":265,
"loginDateTime":"2016-09-03T22:57:02Z",
"logoutDateTime":"2016-09-03T22:59:12Z",
"originatingIp":"71.94.69.211",
"user":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"7P9S6379K1KUDW8FUIY9"
}
},
…
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 609

 Arena REST API Developer Guide Endpoints

GET Recent Activity - Exports

/settings/recentactivities/exports

Returns an array of Export Event objects.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all exports
where results should begin. All exports
before the offset in the search results are
ignored. The default value is 0.
limit integer Specifies the maximum number of returned
results. The default value (no specified limit)
is 20, the maximum is 400.

Searchable Attributes

Name Value Description

DateTimeFrom string Include all exports after this date and time
DateTimeTo string Include all exports before this date and time

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions

©2022 Arena, A PTC Business www.arenasolutions.com 610

 Arena REST API Developer Guide Endpoints

Name Value Description

X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all exports between August 1st, 2016, 11:59pm and 59 seconds and October 14th, 2016, 11:59pm and 59
seconds

GET /settings/recentactivities/exports?dateTimeFrom="2016-08-01T11:59:59Z"&
dateTimeTo="2016-10-01T11:59:59Z"

{
"count":325,
"results":[
{
"configuration":"Item Export (Found Items)",
"dateTime":"2007-07-10T15:37:55Z",
"numberOfResources":384,
"type":"Items",
"user":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"7P9S6379K1KUDW8FUIY9"
}
},
…
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 611

 Arena REST API Developer Guide Endpoints

GET Recent Activity - Report Runs

/settings/recentactivities/reportruns

Returns an array of Report Run objects.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all report
runs where results should begin. All report
runs before the offset in the search results
are ignored. The default value is 0.
limit integer Specifies the maximum number of returned
results. The default value (no specified limit)
is 20, the maximum is 400.

Searchable Attributes

Name Value Description

DateTimeFrom string Include all report runs after this date and
time
DateTimeTo string Include all report runs before this date and
time

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response

©2022 Arena, A PTC Business www.arenasolutions.com 612

 Arena REST API Developer Guide Endpoints

Name Value Description

Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all report run events between August 1st, 2016, 11:59pm and 59 seconds and October 14th, 2016, 11:59pm
and 59 seconds

GET /settings/recentactivities/reportruns?dateTimeFrom="2016-08-01T11:59:59Z"&
dateTimeTo="2016-10-01T11:59:59Z"

{
"count":325,
"results":[
{
"dateTime":"2012-07-16T23:12:52Z",
"description":"single-source items",
"numberOfObjects":214,
"report":{
"guid":"ASCV0QRR07Q7Q511F7V0",
"title":"Change Report",
"type":"Changes: Lifecycle History",
"visibility":"SHARED"
},
"user":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"7P9S6379K1KUDW8FUIY9"
}
},
…
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 613

 Arena REST API Developer Guide Endpoints

GET Recent Activity - File Access

/settings/recentactivities/fileaccesses

Returns an array of File Access Event objects.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all access
events where results should begin. All
events before the offset in the search results
are ignored. The default value is 0.
limit integer Specifies the maximum number of returned
results. The default value (no specified limit)
is 20, the maximum is 400.

Searchable Attributes

Name Value Description

DateTimeFrom string Include all access events after this date and
time
DateTimeTo string Include all access events before this date
and time

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response

©2022 Arena, A PTC Business www.arenasolutions.com 614

 Arena REST API Developer Guide Endpoints

Name Value Description

Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all file access events between August 1st, 2016, 11:59pm and 59 seconds and October 14th, 2016, 11:59pm
and 59 seconds

GET
/settings/recentactivities/fileaccesses?dateTimeFrom="2016-08-01T11:59:59Z"&
dateTimeTo="2016-10-01T11:59:59Z"

{
"count":325,
"results":[
{
"activity":"New Edition created",
"comments":"Editing for grammar and typos",
"dateTime":"2016-09-14T21:37:09Z",
"file":{
"edition":"3",
"guid":"8QAT748AL2LVEXDVFJKI",
"name":"assy_instr.docx",
"title":"Assy Instructions",
"markup":{
"guid":"UCWFKABBKRAGZINDEEM1",
"title":"Assy Instructions",
"name":"assy_instr.docx"
},
"user":{
"email":"[email protected]",
"guid":"7P9S6379K1KUDW8FUIY9",
"fullName":"Heidi Walker"
}
}
},
…
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 615

 Arena REST API Developer Guide Endpoints

GET Item Attributes

/settings/items/attributes

/settings/items/attributes/<GUID>

Returns Attributes available for Items. By adding a valid Item Attribute GUID at the end of the URL, the endpoint
returns a single unique Item attribute.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

includePossibleValues true or false If this is set to true, it returns all the possible
values for Drop Down List attributes. The
default value is false.
creatableOnly true or false If this is set to true, it returns only creatable
attributes, which can be set during creation
of an item. The default value is false.
editableOnly true or false If this is set to true, it returns only editable
attributes, which can be set during update
of an item. The default value is false.
searchableOnly true or false If this is set to true, it returns only searchable
attributes, which are searchable when
getting items.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions

©2022 Arena, A PTC Business www.arenasolutions.com 616

 Arena REST API Developer Guide Endpoints

Name Value Description

X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all item attributes with possible values included

GET /settings/items/attributes?includePossibleValues=true

{
"count":51,
"results":[
{
"allowsExplicitNullValue":true,
"apiName":"DVFYHPYYVCTBUDWDIYP0",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"SINGLE_LINE_TEXT",
"global":false,
"guid":"DVFYHPYYVCTBUDWDIYP0",
"name":"Capacitance",
"revisionControlled":true,
"searchable":true
},
{
"active":true,
"allowsExplicitNullValue":true,
"apiName":"UCWFY6FFCTA2L4N6P7AM",
"costCalculation":"ROLLUP",
"creatable":true,
"currency":"USD",
"custom":true,
"decimalPlaces":2,
"editable":true,
"fieldType":"COST",
"global":true,
"guid":"UCWFY6FFCTA2L4N6P7AM",
"name":"Cost Option A",
"private":false,
"required":false,
"revisionControlled":false,
"searchable":true
},
{
"active":true,
"allowsExplicitNullValue":true,
"apiName":"VDXGZ7GGDUB3M5O7Q8BS",
"costCalculation":"ROLLUP",
"creatable":true,
"currency":"USD",

©2022 Arena, A PTC Business www.arenasolutions.com 617

 Arena REST API Developer Guide Endpoints

"custom":true,
"decimalPlaces":2,
"editable":true,
"fieldType":"COST",
"global":true,
"guid":"VDXGZ7GGDUB3M5O7Q8BS",
"name":"Cost Option B",
"private":false,
"required":false,
"revisionControlled":false,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"EWGZIQZZWDUCVEXEJZQF",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"SINGLE_LINE_TEXT",
"global":false,
"guid":"EWGZIQZZWDUCVEXEJZQF",
"name":"Current",
"revisionControlled":true,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"FXH0JR00XEVDWFYFK0R2",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"SINGLE_LINE_TEXT",
"global":false,
"guid":"FXH0JR00XEVDWFYFK0R2",
"name":"Diameter",
"revisionControlled":true,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"HZJ2LT22ZGXFYH0HM2TN",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"SINGLE_LINE_TEXT",
"global":false,
"guid":"HZJ2LT22ZGXFYH0HM2TN",
"name":"EOQ",
"revisionControlled":true,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"K2M5OW552J0I1K3KP5WX",
"creatable":true,

©2022 Arena, A PTC Business www.arenasolutions.com 618

 Arena REST API Developer Guide Endpoints

"custom":true,
"editable":true,
"fieldType":"FIXED_DROP_DOWN",
"global":false,
"guid":"K2M5OW552J0I1K3KP5WX",
"maxSelections":10,
"multiSelect":true,
"name":"Head Type",
"possibleValues":[
"Pan",
"Round",
"Binding",
"Fillister",
"One way",
"Slat and oval",
"Square",
"Indented hexagonal",
"Indented hexagonal washer",
"Hexagonal",
"Hex flange"
],
"revisionControlled":true,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"L3N6PX663K1J2L4LQ6XP",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"SINGLE_LINE_TEXT",
"global":false,
"guid":"L3N6PX663K1J2L4LQ6XP",
"name":"Length",
"revisionControlled":true,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"M4O7QY774L2K3M5MR7YT",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"SINGLE_LINE_TEXT",
"global":false,
"guid":"M4O7QY774L2K3M5MR7YT",
"name":"MOQ",
"revisionControlled":true,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"N5P8RZ885M3L4N6NS8Z0",
"creatable":true,
"custom":true,

©2022 Arena, A PTC Business www.arenasolutions.com 619

 Arena REST API Developer Guide Endpoints

"editable":true,
"fieldType":"SINGLE_LINE_TEXT",
"global":false,
"guid":"N5P8RZ885M3L4N6NS8Z0",
"name":"Material",
"revisionControlled":true,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"O6Q9S0996N4M5O7OT90B",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"SINGLE_LINE_TEXT",
"global":false,
"guid":"O6Q9S0996N4M5O7OT90B",
"name":"Package",
"revisionControlled":true,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"Q8SBU2BB8P6O7Q9QVB2N",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"SINGLE_LINE_TEXT",
"global":false,
"guid":"Q8SBU2BB8P6O7Q9QVB2N",
"name":"Power",
"revisionControlled":true,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"R9TCV3CC9Q7P8RARWC3A",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"SINGLE_LINE_TEXT",
"global":false,
"guid":"R9TCV3CC9Q7P8RARWC3A",
"name":"Resistance",
"revisionControlled":true,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"ZH1K3BKKHYFXGZIZ31DJ",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"DATE",
"global":false,

©2022 Arena, A PTC Business www.arenasolutions.com 620

 Arena REST API Developer Guide Endpoints

"guid":"ZH1K3BKKHYFXGZIZ31DJ",
"name":"Yearly service check",
"revisionControlled":true,
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"category",
"creatable":true,
"custom":false,
"developerNotes":"Defaults to -uncategorized- if no default is set",
"editable":true,
"fieldType":"OBJECT",
"global":true,
"guid":"R9TCV3CC9Q8VEXGZI1K0",
"inViews":[
"ITEM_SPECS"
],
"required":false,
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"creationDateTime",
"creatable":false,
"custom":false,
"editable":false,
"fieldType":"DATETIME",
"global":true,
"inViews":[
"ITEM_SPECS"
],
"searchable":false
},
{
"allowLowerCase":true,
"allowNumbers":true,
"allowUpperCase":true,
"allowsExplicitNullValue":false,
"apiName":"description",
"creatable":true,
"custom":false,
"editable":true,
"excludedValues":[
";",
"-"
],
"fieldType":"MULTI_LINE_TEXT",
"global":true,
"guid":"SAUDW4DDAR9WFYH0J2LG",
"inViews":[
"ITEM_SPECS"
],
"maxLength":255,
"required":false,

©2022 Arena, A PTC Business www.arenasolutions.com 621

 Arena REST API Developer Guide Endpoints

"searchable":true
},
...
]
}

Get a single Item attribute with a specific GUID.

GET /settings/items/attributes/EWGZIVG7UXEWFYFE0DQN

{
"allowsExplicitNullValue": true,
"apiName": "EWGZIVG7UXEWFYFE0DQN",
"creatable": true,
"custom": true,
"editable": true,
"example": "100pF",
"fieldType": "SINGLE_LINE_TEXT",
"global": false,
"guid": "EWGZIVG7UXEWFYFE0DQN",
"maxLength": 1000,
"name": "Capacitance",
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": false
}

©2022 Arena, A PTC Business www.arenasolutions.com 622

 Arena REST API Developer Guide Endpoints

GET BOM Attributes

/settings/items/bom/attributes

Returns Attributes available for BOMs.

Note: Inactive attributes are not returned.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

includePossibleValues true or false If this is set to true, it returns all the possible
values for Drop Down List attributes. The
default value is false.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length Number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all BOM attributes with possible values included

GET /settings/items/bom/attributes?includePossibleValues=true

©2022 Arena, A PTC Business www.arenasolutions.com 623

 Arena REST API Developer Guide Endpoints

{
"count":7,
"results":[
{
"active":true,
"allowsExplicitNullValue":true,
"apiName":"4M6P8GPPM3K2L4N6P8I6",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"SINGLE_LINE_TEXT",
"guid":"4M6P8GPPM3K2L4N6P8I6",
"name":"Bin #",
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"guid",
"creatable":false,
"custom":false,
"editable":false,
"fieldType":"GUID",
"inViews":[
"ITEM_BOM",
"ITEM_WHEREUSED"
],
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"item",
"creatable":true,
"custom":false,
"editable":false,
"fieldType":"OBJECT",
"inViews":[
"ITEM_BOM",
"ITEM_WHEREUSED"
],
"required":true,
"searchable":false
},
{
"allowNegatives":false,
"allowsExplicitNullValue":false,
"apiName":"lineNumber",
"creatable":true,
"custom":false,
"editable":true,
"fieldType":"NUMBER",
"inViews":[
"ITEM_BOM",
"ITEM_WHEREUSED"
],
"maxValue":9999,

©2022 Arena, A PTC Business www.arenasolutions.com 624

 Arena REST API Developer Guide Endpoints

"required":false,
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"notes",
"creatable":true,
"custom":false,
"editable":true,
"fieldType":"MULTI_LINE_TEXT",
"inViews":[
"ITEM_BOM",
"ITEM_WHEREUSED"
],
"maxLength":4000,
"required":false,
"searchable":false
},
{
"allowNegatives":false,
"allowsExplicitNullValue":false,
"apiName":"quantity",
"creatable":true,
"custom":false,
"editable":true,
"fieldType":"NUMBER",
"inViews":[
"ITEM_BOM",
"ITEM_WHEREUSED"
],
"maxValue":1000000,
"required":true,
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"refDes",
"creatable":true,
"custom":false,
"editable":true,
"fieldType":"SINGLE_LINE_TEXT",
"inViews":[
"ITEM_BOM",
"ITEM_WHEREUSED"
],
"maxLength":32000,
"required":false,
"searchable":false
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 625

 Arena REST API Developer Guide Endpoints

GET Item Categories

/settings/items/categories

/settings/items/categories/<GUID>

This returns Category objects available for Items. Appending a GUID to the URL returns the Category with that
GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

path string This is used to filter out categories. The root
of path for item is "item". If you want to get
all the categories under the root category
which start with A, you can send a request
as
api.arenasolutions.com/items/categories?
path=item\A*, where "\" is the separator
between parent category and child
category.
includeDeleted Boolean This is used to include deleted Categories.
If includeDeleted is true, then deleted
Categories will be included in the results. If
includeDeleted is false, then deleted
Categories will not be included in the
results. Omitting the includeDeleted
parameter altogether in this call will also
exclude deleted Categories from the results.

Response Codes

Code Description
200 Success
400 Failure

©2022 Arena, A PTC Business www.arenasolutions.com 626

 Arena REST API Developer Guide Endpoints

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all non-deleted item categories

GET /settings/items/categories

{
"count":70,
"results":[
{
"activated":true,
"assignable":true,
"creationDateTime":"2008-03-04T20:04:47Z",
"creator":{
"email": "[email protected]",
"fullName":"Heidi Walker",
"guid": "4M6P8GPPM3K3M507QMJ9"
},
"description":"Item is a system-defined category",
"guid":"0I2LQGHHQXGQ9S4C0TYC",
"level":1,
"name":"Item",
"parentCategory":{
"guid": "L3N6B134HGZ9SBNVJQVC"
},
"path":"Item",
"requirements":[
{
"evidenceType":"DIRECT_FILES",
"mark":null,
"rationale":null,
"requirement":{
"guid":"EWGZIQXJZ7PP8RASY3JE",
"name":"api-requirement1"
},
"status":"EXEMPT"
},
{
"evidenceType":"AML_AND_FILES",
"mark":"dd Compliance Mark 2",
"rationale":"dd Rationale 2",

©2022 Arena, A PTC Business www.arenasolutions.com 627

 Arena REST API Developer Guide Endpoints

"requirement":{
"guid":"M4O7QY5R7FXXGZI07XHU",
"name":"RoHS (2002/95/EC)"
},
"status":"UNKNOWN"
}
],
"structural": false,
"systemDefined": true
},
{
"activated":true,
"assignable":true,
"creationDateTime":"2008-03-05T13:26:37Z",
"creator":{
"email": "[email protected]",
"fullName":"Heidi Walker",
"guid": "4M6P8GPPM3K3M507QMJ9"
},
"description":null,
"guid":"DVFY3TUU3AT3M5HPD6CB",
"level":2,
"name":"Document",
"numberFormat":{
"guid":"P7Q9SBU3M5LMFGCG"
},
"parentCategory":{
"guid": "Z9Q49PGTY8659JHSN"
},
"path":"Item\Document",
"structural": false,
"systemDefined": false
},
{
"activated":true,
"assignable":true,
"creationDateTime":"2010-09-05T15:45:31Z",
"creator":{
"email": "[email protected]",
"fullName":"Heidi Walker",
"guid": "4M6P8GPPM3K3M507QMJ9"
},
"description":null,
"guid":"I0K38Y01EDW6P8KSGNS2",
"level":3,
"name":"Artwork - SmartHOME",
"numberFormat":{
"guid":"P7Q9SBU3M5LMFGCG"
},
"path":"Item\Document\Artwork",
"parentCategory": {
"guid": "ADT9879H3W6182WND"
},
"requirements":[],
"structural": false,

©2022 Arena, A PTC Business www.arenasolutions.com 628

 Arena REST API Developer Guide Endpoints

"systemDefined": false
},
...
]
}

Get all item categories including deleted categories

GET settings/items/categories?includeDeleted=true

{
"count":98,
"results":[
{
"activated":true,
"assignable":true,
"creationDateTime":"2008-03-04T20:04:47Z",
"creator":{
"email": "[email protected]",
"fullName":"Heidi Walker",
"guid": "4M6P8GPPM3K3M507QMJ9"
},
"description":"Item is a system-defined category",
"guid":"0I2LQGHHQXGQ9S4C0TYC",
"level":1,
"name":"Item",
"parentCategory":{
"guid": "L3N6B134HGZ9SBNVJQVC"
},
"path":"Item",
"requirements":[
{
"evidenceType":"DIRECT_FILES",
"mark":null,
"rationale":null,
"requirement":{
"guid":"EWGZIQXJZ7PP8RASY3JE",
"name":"api-requirement1"
},
"status":"EXEMPT"
},
{
"evidenceType":"AML_AND_FILES",
"mark":"dd Compliance Mark 2",
"rationale":"dd Rationale 2",
"requirement":{
"guid":"M4O7QY5R7FXXGZI07XHU",
"name":"RoHS (2002/95/EC)"
},
"status":"UNKNOWN"
}
],
"structural": false,
"systemDefined": true
},

©2022 Arena, A PTC Business www.arenasolutions.com 629

 Arena REST API Developer Guide Endpoints

{
"activated":true,
"assignable":true,
"creationDateTime":"2008-03-05T13:26:37Z",
"creator":{
"email": "[email protected]",
"fullName":"Heidi Walker",
"guid": "4M6P8GPPM3K3M507QMJ9"
},
"description":null,
"guid":"DVFY3TUU3AT3M5HPD6CB",
"level":2,
"name":"Document",
"numberFormat":{
"guid":"P7Q9SBU3M5LMFGCG"
},
"parentCategory":{
"guid": "Z9Q49PGTY8659JHSN"
},
"path":"Item\Document",
"structural": false,
"systemDefined": false
},
{
"activated":true,
"assignable":true,
"creationDateTime":"2010-09-05T15:45:31Z",
"creator":{
"email": "[email protected]",
"fullName":"Heidi Walker",
"guid": "4M6P8GPPM3K3M507QMJ9"
},
"description":null,
"guid":"I0K38Y01EDW6P8KSGNS2",
"level":3,
"name":"Artwork - SmartHOME",
"numberFormat":{
"guid":"P7Q9SBU3M5LMFGCG"
},
"path":"Item\Document\Artwork",
"parentCategory": {
"guid": "ADT9879H3W6182WND"
},
"requirements":[],
"structural": false,
"systemDefined": false
},
{
"activated":true,
"assignable":false,
"creationDateTime":"2008-03-05T13:27:31Z",
"creator":{
"email": "[email protected]",
"fullName":"Heidi Walker",
"guid": "4M6P8GPPM3K3M507QMJ9"

©2022 Arena, A PTC Business www.arenasolutions.com 630

 Arena REST API Developer Guide Endpoints

},
"deletionDateTime": "2020-08-25T18:45:40Z",
"description":null,
"guid":"M4O7C233CJ2CVEQYMFLW",
"level":3,
"name":"Artwork-Chi",
"numberFormat":{
"guid":"P7Q9SBU3M5LMFGCG"
},
"path":"Item\Document\Artwork-Chi",
"parentCategory": {
"guid": "ADT9879H3W6182WND"
},
"requirements":[],
"structural": false,
"systemDefined": false
},
{
"activated":true,
"assignable":false,
"creationDateTime":"2020-09-11T05:38:59Z",
"creator":{
"email": "[email protected]",
"fullName":"Heidi Walker",
"guid": "4M6P8GPPM3K3M507QMJ9"
},
"deletionDateTime": "2020-09-11T05:40:23Z",
"description":null,
"guid":"SAUDI7B9E3K3M5O784TO",
"level":3,
"name":"Artwork-SF",
"numberFormat":{
"guid":"P7Q9SBU3M5LMFGCG"
},
"path":"Item\Document\Artwork-SF",
"parentCategory": {
"guid": "ADT9879H3W6182WND"
},
"requirements":[],
"structural": false,
"systemDefined": false
},
...
]
}

Get all item categories that begin with A

GET settings/items/categories?path=item\A

{
"count":6,
"results":[
{
"activated":true,

©2022 Arena, A PTC Business www.arenasolutions.com 631

 Arena REST API Developer Guide Endpoints

"assignable":false,
"creationDateTime":"2011-02-05T01:05:49Z",
"creator":{
"email": "[email protected]",
"fullName":"Heidi Walker",
"guid": "4M6P8GPPM3K3M507QMJ9"
},
"description":null,
"guid":"ZH1K3BKKHYHRATCTHTHN",
"level":2,
"name":"Assembly",
"numberFormat":{
"guid":"VDXGZ7GGDUDM5O7OL7R3"
},
"path":"Item\Assembly",
"parentCategory": {
"guid": "K2M5A023GFY8RAMUIPU5"
},
"requirements":[],
"structural": false,
"systemDefined":false
},
{
"activated":true,
"assignable":true,
"creationDateTime":"2011-02-05T01:06:44Z",
"creator":{
"email": "[email protected]",
"fullName":"Heidi Walker",
"guid": "4M6P8GPPM3K3M507QMJ9"
},
"description":"Shippable ERGPS Product Assemblies",
"guid":"0I2L4CLLIZISBUDUIUI5",
"level":3,
"name":"Finished Good",
"numberFormat":{
"guid":"VDXGZ7GGDUDM5O7OL7R3"
},
"path":"Item\Assembly\Finished Good",
"parentCategory": {
"guid": "EWGZ4UWXA9S2L4G0CJNL"
},
"requirements":[],
"structural": false,
"systemDefined":false
},
...
]
}

Get a single item category

GET /settings/items/categories/UCWFKABBKRAK3MY6UNTU

©2022 Arena, A PTC Business www.arenasolutions.com 632

 Arena REST API Developer Guide Endpoints

{
"activated":true,
"assignable":true,
"creationDateTime":"2008-03-04T22:56:04Z",
"creator":{
"email": "[email protected]",
"fullName":"Heidi Walker",
"guid": "4M6P8GPPM3K3M507QMJ9"
},
"description":null,
"guid":"UCWFKABBKRAK3MY6UNTU",
"level":4,
"name":"Printed Circuit Board Assembly",
"numberFormat":{
"guid":"N5O7Q9S1K3JKDEAJ"
"fields": [
{
"guid": "M4O7LIMOZGXK3M4CZINO",
"value": "110"
},
{
"guid": "VDXGURVX8P8EXGL9SY9Q",
"value": "-5"
}
],
},
"path":"Item\Part\Assembly\Printed Circuit Board Assembly",
"parentCategory": {
"guid": "ZH1KPFHIVUBUDWFYUEB"
},
"requirements":[],
"structural": false,
"systemDefined":false
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 633

 Arena REST API Developer Guide Endpoints

GET Item Category Attributes

/settings/items/categories/<GUID>/attributes

This returns Attributes for a given Item category. There are two types of attributes:

• System attributes are included in every category.

• Custom attributes are defined by an Account Admin in a workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

includePossibleValues true or false If this is set to true, it returns all the possible
values for Drop Down List attributes. The
default value is false.

Response Codes

Code Description
200 Success
400 Failure

Response Headers

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

GET all attributes for a given category with possible values included

©2022 Arena, A PTC Business www.arenasolutions.com 634

 Arena REST API Developer Guide Endpoints

/settings/items/categories/<GUID>/attributes?includePossibleValues=true

{
"count": 32,
"results": [
{
"active": true,
"allowsExplicitNullValue": true,
"apiName": "UCWFY6FFCTA2L4N6P7AM",
"costCalculation": "ROLLUP",
"creatable": true,
"currency": "USD",
"custom": true,
"decimalPlaces": 2,
"editable": true,
"fieldType": "COST",
"global": true,
"guid": "UCWFY6FFCTA2L4N6P7AM",
"name": "Cost Option A",
"private": false,
"required": false,
"revisionControlled": false,
"searchable": true
},
{
"active": true,
"allowsExplicitNullValue": true,
"apiName": "VDXGZ7GGDUB3M5O7Q8BS",
"costCalculation": "ROLLUP",
"creatable": true,
"currency": "USD",
"custom": true,
"decimalPlaces": 2,
"editable": true,
"fieldType": "COST",
"global": true,
"guid": "VDXGZ7GGDUB3M5O7Q8BS",
"name": "Cost Option B",
"private": false,
"required": false,
"revisionControlled": false,
"searchable": true
},
{
"allowsExplicitNullValue": true,
"apiName": "HZJ2LT22ZGXFYH0HM2TN",
"creatable": true,
"custom": true,
"editable": true,
"fieldType": "SINGLE_LINE_TEXT",
"global": false,
"guid": "HZJ2LT22ZGXFYH0HM2TN",
"name": "EOQ",
"required": false,
"revisionControlled": true,

©2022 Arena, A PTC Business www.arenasolutions.com 635

 Arena REST API Developer Guide Endpoints

"searchable": true
},
{
"allowsExplicitNullValue": true,
"apiName": "M4O7QY774L2K3M5MR7YT",
"creatable": true,
"custom": true,
"editable": true,
"fieldType": "SINGLE_LINE_TEXT",
"global": false,
"guid": "M4O7QY774L2K3M5MR7YT",
"name": "MOQ",
"required": false,
"revisionControlled": true,
"searchable": true
},
{
"allowsExplicitNullValue": true,
"apiName": "N5P8RZ885M3L4N6NS8Z0",
"creatable": true,
"custom": true,
"editable": true,
"fieldType": "SINGLE_LINE_TEXT",
"global": false,
"guid": "N5P8RZ885M3L4N6NS8Z0",
"name": "Material",
"required": false,
"revisionControlled": true,
"searchable": true
},
{
"allowsExplicitNullValue": false,
"apiName": "category",
"creatable": true,
"custom": false,
"developerNotes": "Defaults to -uncategorized- if no default is set",
"editable": true,
"fieldType": "OBJECT",
"global": true,
"guid": "R9TCV3CC9Q8VEXGZI1K0",
"inViews": [
"ITEM_SPECS"
],
"required": false,
"searchable": true
},
{
"allowsExplicitNullValue": false,
"apiName": "creationDateTime",
"creatable": false,
"custom": false,
"editable": false,
"fieldType": "DATETIME",
"global": true,
"inViews": [

©2022 Arena, A PTC Business www.arenasolutions.com 636

 Arena REST API Developer Guide Endpoints

"ITEM_SPECS"
],
"searchable": false
},
{
"allowsExplicitNullValue": false,
"apiName": "creator",
"creatable": false,
"custom": false,
"editable": false,
"fieldType": "OBJECT",
"global": true,
"inViews": [
"ITEM_SPECS"
],
"searchable": true
},
{
"allowLowerCase": true,
"allowNumbers": true,
"allowUpperCase": true,
"allowsExplicitNullValue": false,
"apiName": "description",
"creatable": true,
"custom": false,
"editable": true,
"excludedValues": [
";",
"-",
"words"
],
"fieldType": "MULTI_LINE_TEXT",
"global": true,
"guid": "SAUDW4DDAR9WFYH0J2LG",
"inViews": [
"ITEM_SPECS"
],
"maxLength": 255,
"required": false,
"searchable": true
},
{
"allowsExplicitNullValue": false,
"apiName": "deviated",
"creatable": false,
"custom": false,
"editable": false,
"fieldType": "BOOLEAN",
"global": true,
"inViews": [
"ITEM_SPECS"
],
"searchable": false
},
{

©2022 Arena, A PTC Business www.arenasolutions.com 637

 Arena REST API Developer Guide Endpoints

"allowsExplicitNullValue": false,
"apiName": "effectiveDateTime",
"creatable": false,
"custom": false,
"editable": false,
"fieldType": "DATETIME",
"global": true,
"inViews": [
"ITEM_SPECS"
],
"searchable": true
},
...
]
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 638

 Arena REST API Developer Guide Endpoints

POST Items Category

/settings/items/categories

Creates an Items Category object. In other words, it creates a new Item Category in Workspace Settings.

Executing this endpoint requires an access policy rule that allows users to edit the Categories, Items view in
Workspace Settings.

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Creates an Item Category.

POST /settings/items/categories

Request

{
"activated": true,

©2022 Arena, A PTC Business www.arenasolutions.com 639

 Arena REST API Developer Guide Endpoints

"description": "Fluted Plastic",

"name": "Corrugated Plastic",
"numberFormat": {
"fields": [
{
"guid": "ASCVERC3QTAXGZH1W5OJ",
"value": "432"
}
],
"guid": "0I2L4H2TGJ2BUDUB16MW"
},
"parentCategory": {
"guid": "6O8RAN8ZMP8I1KZ667SV"
},
"requirements": [
{
"evidenceType": "AML_AND_FILES",
"mark": null,
"rationale": null,
"requirement": {
"guid": "EWGZIVG7UXFCVEWFO5IT"
},
"status": "NON_COMPLIANT"
}
],
"structural": false
}

Response

{
"activated": true,
"assignable": true,
"creationDateTime": "2021-07-06T19:36:05Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "Fluted Plastic",
"guid": "M4O7Q3OF25OYH0CIM6FG",
"level": 4,
"name": "Corrugated Plastic",
"numberFormat": {
"fields": [
{
"guid": "ASCVERC3QTAXGZH1W5OJ",
"value": "432"
}
],
"guid": "0I2L4H2TGJ2BUDUB16MW"
},
"parentCategory": {
"guid": "6O8RAN8ZMP8I1KZ667SV"
},

©2022 Arena, A PTC Business www.arenasolutions.com 640

 Arena REST API Developer Guide Endpoints

"path": "Item\\Part\\Mechanical\\Corrugated Plastic",

"requirements": [
{
"evidenceType": "AML_AND_FILES",
"mark": null,
"rationale": null,
"requirement": {
"guid": "EWGZIVG7UXFCVEWFO5IT",
"name": "2011/65/EU"
},
"status": "NON_COMPLIANT"
}
],
"structural": false,
"systemDefined": false
}

©2022 Arena, A PTC Business www.arenasolutions.com 641

 Arena REST API Developer Guide Endpoints

POST Items Specs Attribute Cost

/settings/items/attributes

Creates an Item Specs Attribute object with a field type of Cost. The Item Specs attribute is also known as the
Item custom attribute.

Executing this endpoint requires an access policy rule that allows users to edit the Items, Attributes view in
Workspace Settings.

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Creates Item custom attribute with a field type of number

POST /settings/items/attributes

Request

©2022 Arena, A PTC Business www.arenasolutions.com 642

 Arena REST API Developer Guide Endpoints

{
"active": true,
"allowNegatives": true,
"decimalPlaces": 2,
"defaultValue": 12.00,
"description": "This call creates an Item custom attribute with a field type of
Number. It's listed in the Specs view of an Item.",
"example": "12.00",
"fieldType": "NUMBER",
"global": true,
"maxValue": 1000.00,
"name": "Number Example",
"required": false,
"visibleWhenBlank": true
}

Response

{
"allowNegatives": true,
"allowsExplicitNullValue": true,
"apiName": "WEYH0DYPCFWEXGVYL85Z",
"creatable": true,
"custom": true,
"decimalPlaces": 2,
"defaultValue": 12,
"description": "This call creates an Item custom attribute with a field type of
Number. It's listed in the Specs view of an Item.",
"editable": true,
"example": "12.00",
"fieldType": "NUMBER",
"global": true,
"guid": "WEYH0DYPCFWEXGVYL85Z",
"name": "Number Example",
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
}

©2022 Arena, A PTC Business www.arenasolutions.com 643

 Arena REST API Developer Guide Endpoints

POST Items Specs Attribute Date

/settings/items/attributes

Creates an Item Specs Attribute object with a field type of Date. The Item Specs attribute is also known as the
Item custom attribute.

Executing this endpoint requires an access policy rule that allows users to edit the Items, Attributes view in
Workspace Settings.

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Creates Item custom attribute with a field type of Date.

POST /settings/items/attributes

Request

©2022 Arena, A PTC Business www.arenasolutions.com 644

 Arena REST API Developer Guide Endpoints

{
"active": true,
"defaultValue": "TODAY",
"description": "The date a customer expects their order to arrive at a facility.",

"example": "2020-03-04T00:00:00Z",
"fieldType": "DATE",
"global": true,
"name": "Dock Date",
"required": false,
"visibleWhenBlank": true
}

Response

{
"allowsExplicitNullValue": true,
"apiName": "2K4N6J4VIL2K3M14RE8G",
"creatable": true,
"custom": true,
"defaultValue": "TODAY",
"description": "The date a customer expects their order to arrive at a facility.",

"editable": true,
"example": "2020-03-04T00:00:00Z",
"fieldType": "DATE",
"global": true,
"guid": "2K4N6J4VIL2K3M14RE8G",
"name": "Dock Date",
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
}

©2022 Arena, A PTC Business www.arenasolutions.com 645

 Arena REST API Developer Guide Endpoints

POST Items Specs Attribute Drop-Down

/settings/items/attributes

Creates an Item Specs Attribute object with a field type of Drop-Down menu. The Item Specs attribute is also
known as the Item custom attribute.

Executing this endpoint requires an access policy rule that allows users to edit the Items, Attributes view in
Workspace Settings.

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Creates Item custom attribute with a field type of Drop-Down Menu.

POST /settings/items/attributes

Request

©2022 Arena, A PTC Business www.arenasolutions.com 646

 Arena REST API Developer Guide Endpoints

{
"active": true,
"defaultValue": "One",
"description": "An Item custom attribute drop down example.",
"example": "Two",
"fieldType": "DROP_DOWN",
"global": true,
"name": "Custom Attribute Drop Down Example",
"required": false,
"visibleWhenBlank": true
}

Response

{
"allowsExplicitNullValue": true,
"apiName": "L3N6P2NE14L3M5KNAXQW",
"creatable": true,
"custom": true,
"defaultValue": "One",
"description": "An Item custom attribute drop down example.",
"editable": true,
"example": "Two",
"fieldType": "DROP_DOWN",
"global": true,
"guid": "L3N6P2NE14L3M5KNAXQW",
"maxLength": 1000,
"name": "Custom Attribute Drop Down Example",
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
}

©2022 Arena, A PTC Business www.arenasolutions.com 647

 Arena REST API Developer Guide Endpoints

POST Items Specs Attribute Fixed Drop-Down Single Selection

/settings/items/attributes

Creates an Item Specs Attribute object with a field type of a Predefined Drop-Down menu. This variant of the
Predefined Drop-Down Menu allows the user to select a single value. The Item Specs attribute is also known
as the Item custom attribute.

Executing this endpoint requires an access policy rule that allows users to edit the Items, Attributes view in
Workspace Settings.

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Creates Item custom attribute with a field type of a Predefined Drop-Down Menu.

POST /settings/items/attributes

Request

©2022 Arena, A PTC Business www.arenasolutions.com 648

 Arena REST API Developer Guide Endpoints

{
"active": true,
"defaultValue": "California",
"description": "State Office where device was manufactured.",
"example": "Two",
"fieldType": "FIXED_DROP_DOWN",
"global": true,
"multiSelect": false,
"name": "State of Origin",
"possibleValues": ["California", "Florida", "Texas", "New York"],
"required": false,
"visibleWhenBlank": true
}

Response

{
"allowsExplicitNullValue": true,
"apiName": "UCWFYBWNADUCVETWJ6ZU",
"creatable": true,
"custom": true,
"defaultValue": "California",
"description": "State Office where device was manufactured.",
"editable": true,
"example": "Two",
"fieldType": "FIXED_DROP_DOWN",
"global": true,
"guid": "UCWFYBWNADUCVETWJ6ZU",
"multiSelect": false,
"name": "State of Origin",
"possibleValues": [
"California",
"Florida",
"Texas",
"New York"
],
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
}

©2022 Arena, A PTC Business www.arenasolutions.com 649

 Arena REST API Developer Guide Endpoints

POST Items Specs Attribute Fixed Drop-Down Multiple Selection

/settings/items/attributes

Creates an Item Specs Attribute object with a field type of a Predefined Drop-Down menu. This variant of the
Predefined Drop-Down Menu allows the user to select multiple values. The Item Specs attribute is also known
as the Item custom attribute.

Executing this endpoint requires an access policy rule that allows users to edit the Items, Attributes view in
Workspace Settings.

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Creates Item custom attribute with a field type of a Predefined Drop-Down Menu.

POST /settings/items/attributes

Request

©2022 Arena, A PTC Business www.arenasolutions.com 650

 Arena REST API Developer Guide Endpoints

{
"active": true,
"defaultValue": "North America",
"description": "Markets Intended for EveryHome Products",
"example": "North America",
"fieldType": "FIXED_DROP_DOWN",
"global": true,
"maxSelections": 4,
"multiSelect": true,
"name": "Projected Markets",
"possibleValues": ["Africa", "Asia", "Europe", "North America"],
"required": false,
"visibleWhenBlank": true
}

Response

{
"allowsExplicitNullValue": true,
"apiName": "9RBUDQB2PS9RAT8BYLBK",
"creatable": true,
"custom": true,
"defaultValue": [
"North America"
],
"description": "Markets Intended for EveryHome Products",
"editable": true,
"example": "North America",
"fieldType": "FIXED_DROP_DOWN",
"global": true,
"guid": "9RBUDQB2PS9RAT8BYLBK",
"maxSelections": 4,
"multiSelect": true,
"name": "Projected Markets",
"possibleValues": [
"Africa",
"Asia",
"Europe",
"North America"
],
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
}

©2022 Arena, A PTC Business www.arenasolutions.com 651

 Arena REST API Developer Guide Endpoints

POST Items Specs Attribute Multi Line Text

/settings/items/attributes

Creates an Item Specs Attribute object with a field type of Multi Line Text. The Item Specs attribute is also
known as the Item custom attribute.

Executing this endpoint requires an access policy rule that allows users to edit the Items, Attributes view in
Workspace Settings.

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Creates Item custom attribute with a field type of Multi Line Text. Use \n to create new lines.

POST /settings/items/attributes

Request

©2022 Arena, A PTC Business www.arenasolutions.com 652

 Arena REST API Developer Guide Endpoints

{
"active": true,
"defaultValue": "Empty\nLines",
"description": "A multi line text Item Custom Attribute example.",
"example": "Full",
"fieldType": "MULTI_LINE_TEXT",
"global": true,
"name": "Multi Line Text Example",
"required": false,
"visibleWhenBlank": true
}

Response

{
"allowsExplicitNullValue": true,
"apiName": "I0K3MZKBY1I0J2HK7UNO",
"creatable": true,
"custom": true,
"defaultValue": "Empty\nLines",
"description": "A multi line text Item Custom Attribute example.",
"editable": true,
"example": "Full",
"fieldType": "MULTI_LINE_TEXT",
"global": true,
"guid": "I0K3MZKBY1I0J2HK7UNO",
"maxLength": 4000,
"name": "Multi Line Text Example",
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
}

©2022 Arena, A PTC Business www.arenasolutions.com 653

 Arena REST API Developer Guide Endpoints

POST Items Specs Attribute Number

/settings/items/attributes

Creates an Item Specs Attribute object. The Item Specs attribute is also known as the Item custom attribute.

Executing this endpoint requires an access policy rule that allows users to edit the Items, Attributes view in
Workspace Settings.

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Creates Item custom attribute with a field type of number

POST /settings/items/attributes

Request

{
"active": true,

©2022 Arena, A PTC Business www.arenasolutions.com 654

 Arena REST API Developer Guide Endpoints

"allowNegatives": true,
"decimalPlaces": 2,
"defaultValue": 12.00,
"description": "This call creates an Item custom attribute with a field type of
Number. It's listed in the Specs view of an Item.",
"example": "12.00",
"fieldType": "NUMBER",
"global": true,
"maxValue": 1000.00,
"name": "Number Example",
"required": false,
"visibleWhenBlank": true
}

Response

{
"allowNegatives": true,
"allowsExplicitNullValue": true,
"apiName": "WEYH0DYPCFWEXGVYL85Z",
"creatable": true,
"custom": true,
"decimalPlaces": 2,
"defaultValue": 12,
"description": "This call creates an Item custom attribute with a field type of
Number. It's listed in the Specs view of an Item.",
"editable": true,
"example": "12.00",
"fieldType": "NUMBER",
"global": true,
"guid": "WEYH0DYPCFWEXGVYL85Z",
"name": "Number Example",
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
}

©2022 Arena, A PTC Business www.arenasolutions.com 655

 Arena REST API Developer Guide Endpoints

POST Items Specs Attribute Single Line Text

/settings/items/attributes

Creates an Item Specs Attribute object with a field type of Single Line Text. The Item Specs attribute is also
known as the Item custom attribute.

Executing this endpoint requires an access policy rule that allows users to edit the Items, Attributes view in
Workspace Settings.

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Creates Item custom attribute with a field type of Single Line Text.

POST /settings/items/attributes

Request

©2022 Arena, A PTC Business www.arenasolutions.com 656

 Arena REST API Developer Guide Endpoints

{
"active": true,
"defaultValue": "Empty",
"description": "The net rate of flow of electric charge through a surface.",
"example": "Full",
"fieldType": "SINGLE_LINE_TEXT",
"global": true,
"name": "Current",
"required": false,
"visibleWhenBlank": true
}

Response

{
"allowsExplicitNullValue": true,
"apiName": "0I2L4H2TGJ0I1KZ2PC66",
"creatable": true,
"custom": true,
"defaultValue": "Empty",
"description": "The net rate of flow of electric charge through a surface.",
"editable": true,
"example": "Full",
"fieldType": "SINGLE_LINE_TEXT",
"global": true,
"guid": "0I2L4H2TGJ0I1KZ2PC66",
"maxLength": 1000,
"name": "Current",
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
}

©2022 Arena, A PTC Business www.arenasolutions.com 657

 Arena REST API Developer Guide Endpoints

DELETE Item Category Attribute

/settings/items/categories/<GUID>/attributes/<GUID>

Deletes an item category custom attribute with a given GUID.

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response

Request with invalid GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"KJWQ0GZGZDJ015987\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 658

 Arena REST API Developer Guide Endpoints

DELETE Item Specs Attribute

/settings/items/attributes/<GUID>

Deletes an item custom Attribute with a given GUID.

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response

Request with invalid GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"KJWQ0GZGZDJ015987\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 659

 Arena REST API Developer Guide Endpoints

PUT Items Specs Attribute Cost

/settings/items/attributes/<GUID>

Edits an Item Specs Attribute object with a field type of Cost. The Item Specs attribute is also known as the
Item custom attribute.

Executing this endpoint requires an access policy rule that allows users to edit the Items, Attributes view in
Workspace Settings.

Note that the following attribute object attributes are not editable: name and fieldType

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Edits Item custom attribute with a field type of Cost.

PUT /settings/items/attributes/<GUID>

Request

©2022 Arena, A PTC Business www.arenasolutions.com 660

 Arena REST API Developer Guide Endpoints

{
"active": true,
"currency": "USD",
"description": "Editing an Item Cost Attribute with a Field Type of Cost",
"example": "12.00",
"name": "Cost Example",
"private": false,
"visibleWhenBlank": true
}

Response

{
"allowNegatives": true,
"allowsExplicitNullValue": true,
"apiName": "WEYH0DYPCFWEXGVYL85Z",
"creatable": true,
"custom": true,
"decimalPlaces": 2,
"defaultValue": 16,
"description": "Editing an Item Cost Attribute with a Field Type of Cost",
"editable": true,
"example": "12.00",
"fieldType": "NUMBER",
"global": true,
"guid": "WEYH0DYPCFWEXGVYL85Z",
"name": "Number Example",
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
}

Request with an invalid GUID.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"KJWQ0GZGZDJ015987\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 661

 Arena REST API Developer Guide Endpoints

PUT Items Specs Attribute Date

/settings/items/attributes/<GUID>

Edits an Item Specs Attribute object with a field type of Date. The Item Specs attribute is also known as the
Item custom attribute.

Executing this endpoint requires an access policy rule that allows users to edit the Items, Attributes view in
Workspace Settings.

Note that the following attribute object attributes are not editable: name and fieldType

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Edits Item custom attribute with a field type of Date.

PUT /settings/items/attributes/<GUID>

Request

©2022 Arena, A PTC Business www.arenasolutions.com 662

 Arena REST API Developer Guide Endpoints

{
"active": true,
"defaultValue": "TODAY",
"description": "Editing Example Date.",
"example": "2021-07-04T00:00:00Z",
"global": false,
"required": false,
"visibleWhenBlank": true
}

Response

{
"allowsExplicitNullValue": true,
"apiName": "2K4N6J4VIL2K3M14RE8G",
"creatable": true,
"custom": true,
"description": "Editing Example Date.",
"editable": true,
"example": "2021-07-04T00:00:00Z",
"fieldType": "DATE",
"global": false,
"guid": "2K4N6J4VIL2K3M14RE8G",
"name": "Dock Date",
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
}

Request with an invalid GUID.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"KJWQ0GZGZDJ015987\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 663

 Arena REST API Developer Guide Endpoints

PUT Items Specs Attribute Drop-Down

/settings/items/attributes/<GUID>

Edits an Item Specs Attribute object with a field type of Drop Down. The Item Specs attribute is also known as
the Item custom attribute.

Executing this endpoint requires an access policy rule that allows users to edit the Items, Attributes view in
Workspace Settings.

Note that the following attribute object attributes are not editable: name, fieldType, and possibleValues.

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Edits Item custom attribute with a field type of Drop Down.

PUT /settings/items/attributes/<GUID>

Request

©2022 Arena, A PTC Business www.arenasolutions.com 664

 Arena REST API Developer Guide Endpoints

{
"active": false,
"defaultValue": "One",
"description": "A an example of an edited Item custom attribute with a field type
of drop down.",
"example": "Two",
"global": true,
"required": true,
"visibleWhenBlank": true
}

Response

{
"allowsExplicitNullValue": false,
"apiName": "L3N6P2NE14L3M5KNAXQW",
"creatable": true,
"custom": true,
"defaultValue": "One",
"description": "A an example of an edited Item custom attribute with a field type
of drop down.",
"editable": true,
"example": "Two",
"fieldType": "DROP_DOWN",
"global": true,
"guid": "L3N6P2NE14L3M5KNAXQW",
"maxLength": 1000,
"name": "Custom Attribute Drop Down Example",
"required": true,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
}

Request with an invalid GUID.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"KJWQ0GZGZDJ015987\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 665

 Arena REST API Developer Guide Endpoints

PUT Items Specs Attribute Fixed Drop-Down Single

/settings/items/attributes/<GUID>

Edits an Item Specs Attribute object with a field type of Fixed Drop Down. This variant of the Predefined
Drop-Down Menu allows the user to select a single value. The Item Specs attribute is also known as the Item
custom attribute.

Executing this endpoint requires an access policy rule that allows users to edit the Items, Attributes view in
Workspace Settings.

Note that the following attribute object attributes are not editable: name and fieldType.

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Edits Item custom attribute with a field type of Fixed Drop Down. This version only allows selection of one
value.

PUT /settings/items/attributes/<GUID>

©2022 Arena, A PTC Business www.arenasolutions.com 666

 Arena REST API Developer Guide Endpoints

Request

{
"active": true,
"defaultValue": "California",
"description": "State Office where device was manufactured.",
"example": "Two",
"global": true,
"possibleValues": ["California", "Florida", "Texas", "New York", "Arizona"],
"required": false,
"visibleWhenBlank": true
}

Response

{
"allowsExplicitNullValue": true,
"apiName": "UCWFYBWNADUCVETWJ6ZU",
"creatable": true,
"custom": true,
"defaultValue": "California",
"description": "State Office where device was manufactured.",
"editable": true,
"example": "Two",
"fieldType": "FIXED_DROP_DOWN",
"global": true,
"guid": "UCWFYBWNADUCVETWJ6ZU",
"multiSelect": false,
"name": "State of Origin",
"possibleValues": [
"California",
"Florida",
"Texas",
"New York",
"Arizona"
],
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
}

Request with an invalid GUID.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"KJWQ0GZGZDJ015987\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 667

 Arena REST API Developer Guide Endpoints

PUT Items Specs Attribute Fixed Drop-Down Multiple

/settings/items/attributes/<GUID>

Edits an Item Specs Attribute object with a field type of Fixed Drop Down. This variant of the Predefined
Drop-Down Menu allows the user to select multiple values. The Item Specs attribute is also known as the Item
custom attribute.

Executing this endpoint requires an access policy rule that allows users to edit the Items, Attributes view in
Workspace Settings.

Note that the following attribute object attributes are not editable: name, fieldType, and possibleValues.

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Edits Item custom attribute with a field type of Fixed Drop Down. This version only allows selection of multiple
values.

PUT /settings/items/attributes/<GUID>

©2022 Arena, A PTC Business www.arenasolutions.com 668

 Arena REST API Developer Guide Endpoints

Request

{
"active": true,
"defaultValue": "N. America",
"description": "Markets Intended for EveryHome Products",
"example": "Europe",
"global": true,
"multiSelect": true,
"possibleValues": ["Africa", "Asia", "Europe", "N. America"],
"required": false,
"visibleWhenBlank": true
}

Response

{
"allowsExplicitNullValue": true,
"apiName": "9RBUDQB2PS9RAT8BYLBK",
"creatable": true,
"custom": true,
"defaultValue": [
"N. America"
],
"description": "Markets Intended for EveryHome Products",
"editable": true,
"example": "Europe",
"fieldType": "FIXED_DROP_DOWN",
"global": true,
"guid": "9RBUDQB2PS9RAT8BYLBK",
"maxSelections": 4,
"multiSelect": true,
"name": "Projected Markets",
"possibleValues": [
"Africa",
"Asia",
"Europe",
"N. America"
],
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
}

Request with an invalid GUID.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"KJWQ0GZGZDJ015987\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 669

 Arena REST API Developer Guide Endpoints

PUT Items Specs Attribute Single Line Text

/settings/items/attributes/<GUID>

Edits an Item Specs Attribute object with a field type of Single Line Text. The Item Specs attribute is also known
as the Item custom attribute.

Executing this endpoint requires an access policy rule that allows users to edit the Items, Attributes view in
Workspace Settings.

Note that the following attribute object attributes are not editable: name and fieldType

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Edits Item custom attribute with a field type of Single Line Text.

PUT /settings/items/attributes/<GUID>

Request

©2022 Arena, A PTC Business www.arenasolutions.com 670

 Arena REST API Developer Guide Endpoints

{
"active": true,
"defaultValue": "Empty",
"description": "The net rate of flow of electronic charge through a surface.
EDITED.",
"example": "Full",
"global": true,
"maxLength": 1000,
"required": false,
"visibleWhenBlank": true
}

Response

{
"allowsExplicitNullValue": true,
"apiName": "0I2L4H2TGJ0I1KZ2PC66",
"creatable": true,
"custom": true,
"defaultValue": "Empty",
"description": "The net rate of flow of electronic charge through a surface.
EDITED.",
"editable": true,
"example": "Full",
"fieldType": "SINGLE_LINE_TEXT",
"global": true,
"guid": "0I2L4H2TGJ0I1KZ2PC66",
"maxLength": 1000,
"name": "Electric Current",
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
}

Request with an invalid GUID.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"KJWQ0GZGZDJ015987\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 671

 Arena REST API Developer Guide Endpoints

PUT Items Specs Attribute Number

/settings/items/attributes/<GUID>

Edits an Item Specs Attribute object with a field type of Number. The Item Specs attribute is also known as the
Item custom attribute.

Executing this endpoint requires an access policy rule that allows users to edit the Items, Attributes view in
Workspace Settings.

Note that the following attribute object attributes are not editable: name, decimalPlaces, and fieldType

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Edits Item custom attribute with a field type of Number.

PUT /settings/items/attributes/<GUID>

Request

©2022 Arena, A PTC Business www.arenasolutions.com 672

 Arena REST API Developer Guide Endpoints

{
"active": true,
"defaultValue": 16.00,
"description": "This call edits an existing Item Custom Attribute with a field
type of Number",
"example": "12.00",
"global": true,
"maxValue": 1000.00,
"required": false,
"visibleWhenBlank": true
}

Response

{
"allowNegatives": true,
"allowsExplicitNullValue": true,
"apiName": "WEYH0DYPCFWEXGVYL85Z",
"creatable": true,
"custom": true,
"decimalPlaces": 2,
"defaultValue": 16,
"description": "This call edits an existing Item Custom Attribute with a field
type of Number",
"editable": true,
"example": "12.00",
"fieldType": "NUMBER",
"global": true,
"guid": "WEYH0DYPCFWEXGVYL85Z",
"name": "Number Example",
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
}

Request with an invalid GUID.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"DPLQ0GZGZDJ0159TF\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 673

 Arena REST API Developer Guide Endpoints

PUT Items Specs Attribute Multi Line Text

/settings/items/attributes/<GUID>

Edits an Item Specs Attribute object with a field type of Multi Line Text. The Item Specs attribute is also known
as the Item custom attribute.

Executing this endpoint requires an access policy rule that allows users to edit the Items, Attributes view in
Workspace Settings.

Note that the following attribute object attributes are not editable: name and fieldType

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Edits Item custom attribute with a field type of Multi Line Text.

PUT /settings/items/attributes/<GUID>

Request

©2022 Arena, A PTC Business www.arenasolutions.com 674

 Arena REST API Developer Guide Endpoints

{
"active": true,
"defaultValue": "\n Line A \n Line B",
"description": "A multi line text example.",
"example": "Full",
"global": true,
"maxLength": 1000,
"required": false,
"visibleWhenBlank": true
}

Response

{
"allowsExplicitNullValue": true,
"apiName": "I0K3MZKBY1I0J2HK7UNO",
"creatable": true,
"custom": true,
"defaultValue": "\n Line A \n Line B",
"description": "A multi line text example.",
"editable": true,
"example": "Full",
"fieldType": "MULTI_LINE_TEXT",
"global": true,
"guid": "I0K3MZKBY1I0J2HK7UNO",
"maxLength": 4000,
"name": "Multi Line Text Example",
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
}

Request with an invalid GUID.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"KJWQ0GZGZDJ015987\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 675

 Arena REST API Developer Guide Endpoints

PUT Item Category Attribute

/settings/items/categories/<GUID>/attributes/<GUID>

Edits an existing Item Category Attributes in Workspace Settings.

Executing this endpoint requires an access policy rule that allows users to edit the Categories, Items view in
Workspace Settings.

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Edits an existing Item Category Attribute in Workspace Settings .

PUT /settings/items/categories/<GUID>/attributes/<GUID>

Request

{
"defaultValue": "30 uF",

©2022 Arena, A PTC Business www.arenasolutions.com 676

 Arena REST API Developer Guide Endpoints

"required": true
}

Response

{
"allowsExplicitNullValue": false,
"apiName": "EWGZIVG7UXEWFYFE0DQN",
"creatable": true,
"custom": true,
"defaultValue": "30 uF",
"editable": true,
"example": "100pF",
"fieldType": "SINGLE_LINE_TEXT",
"global": false,
"guid": "EWGZIVG7UXEWFYFE0DQN",
"maxLength": 1000,
"name": "Capacitance",
"required": true,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": false
}

Request with an invalid GUID.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"DPLQ0GZGZDJ0159TF\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 677

 Arena REST API Developer Guide Endpoints

PUT Item Category

/settings/items/categories/<GUID>

Edits an existing Item Category in Workspace Settings.

Executing this endpoint requires an access policy rule that allows users to edit the Categories, Items view in
Workspace Settings.

Note that the following attribute object attributes are not editable: name and parentCategory.

Warning: While supported, Arena does not recommend using this endpoint as it can have significant
impact on the product data within your workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Requests and Responses

Edits an existing Item Category in Workspace Settings .

PUT /settings/items/categories/<GUID>

Request

©2022 Arena, A PTC Business www.arenasolutions.com 678

 Arena REST API Developer Guide Endpoints

{
"activated": true,
"description": "Fluted Plastic",
"numberFormat": {
"fields": [
{
"guid": "ASCVERC3QTAXGZH1W5OJ",
"value": "432"
}
],
"guid": "0I2L4H2TGJ2BUDUB16MW"
},
"requirements": [
{
"evidenceType": "AML_AND_FILES",
"mark": null,
"rationale": null,
"requirement": {
"guid": "EWGZIVG7UXFCVEWFO5IT"
},
"status": "NON_COMPLIANT"
}
],
"structural": false
}

Response

{
"activated": true,
"assignable": true,
"creationDateTime": "2021-07-06T19:36:05Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "Fluted Plastic",
"guid": "M4O7Q3OF25OYH0CIM6FG",
"level": 4,
"name": "Corrugated Plastic",
"numberFormat": {
"fields": [
{
"guid": "ASCVERC3QTAXGZH1W5OJ",
"value": "432"
}
],
"guid": "0I2L4H2TGJ2BUDUB16MW"
},
"parentCategory": {
"guid": "6O8RAN8ZMP8I1KZ667SV"
},
"path": "Item\\Part\\Mechanical\\Corrugated Plastic",
"requirements": [

©2022 Arena, A PTC Business www.arenasolutions.com 679

 Arena REST API Developer Guide Endpoints

{
"evidenceType": "AML_AND_FILES",
"mark": null,
"rationale": null,
"requirement": {
"guid": "EWGZIVG7UXFCVEWFO5IT",
"name": "2011/65/EU"
},
"status": "NON_COMPLIANT"
}
],
"structural": false,
"systemDefined": false
}

Request with an invalid GUID.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"DPLQ0GZGZDJ0159TF\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 680

 Arena REST API Developer Guide Endpoints

GET Item Number Formats

/settings/items/numberformats

/settings/items/numberformats/<GUID>

This returns Compact Item Number Formats. Appending a GUID to the URL returns an Item Number Format
(including all fields) with that GUID.

Number formats in Arena are constructed as multiple fields of the following types:

• Free Text (a specified number of characters)

• Delimiter (a character that acts as a separator)

• Pre-Defined Code List (a drop-down list that the user can pick from when creating a new Item Number. In
the API, it is called VALUE_LIST)

• Auto-Generated Sequence (an incrementing number)

For more on Item Numbers in Arena, see Arena Help or download the Arena User Manual.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in the response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 681

 Arena REST API Developer Guide Endpoints

Sample Response Body

Get all item number formats

GET /settings/items/numberformats

{
"count":6,
"results":[
{
"creationDateTime":"2011-02-05T00:08:14Z",
"default":false,
"exampleNumber":"150-0001",
"guid":"VDXGZ7GGDUDM5O7OL7R3",
"name":"Assembly"
},
{
"creationDateTime":"2011-01-05T00:26:30Z",
"default":false,
"exampleNumber":null,
"guid":"WEYH08HHEVEN6P8PM8SK",
"name":"Basic Item Number"
},
{
"creationDateTime":"2015-06-25T18:32:14Z",
"default":false,
"exampleNumber":"084-0071-0001",
"guid":"FXH0JR00XEX6P8R839NG",
"name":"Discrete Components"
},
{
"creationDateTime":"2011-02-05T00:03:24Z",
"default":false,
"exampleNumber":"070-0001",
"guid":"YG0J2AJJGXGP8RAROAUE",
"name":"Electrical"
},
{
"creationDateTime":"2011-02-05T00:22:21Z",
"default":false,
"exampleNumber":"060-0001",
"guid":"ZH1K3BKKHYHQ9SBSPBVT",
"name":"Labels and Packaging"
},
{
"creationDateTime":"2011-02-05T00:13:34Z",
"default":false,
"exampleNumber":"081-0001",
"guid":"0I2L4CLLIZIRATCTQCWD",
"name":"Mechanical"
}
]
}

Get an item number format with a specific GUID

©2022 Arena, A PTC Business www.arenasolutions.com 682

 Arena REST API Developer Guide Endpoints

/settings/items/numberformats/YG0J2AJJGXGP8RAROAUE

{
"creationDateTime":"2011-02-05T00:03:24Z",
"default":false,
"exampleNumber":"070-0001",
"fields":[
{
"apiName":"6O8RAIRRO5M9SBUBJWGL",
"guid":"6O8RAIRRO5M9SBUBJWGL",
"maxLength":null,
"name":"Component Type",
"possibleValues":[
{
"description":"Capacitor",
"value":"070"
},
{
"description":"Resistor",
"value":"071"
},
{
"description":"Connector",
"value":"072"
},
{
"description":"Crystal",
"value":"073"
},
{
"description":"Integrated Circuit",
"value":"074"
},
...
],
"type":"VALUE_LIST",
"value":null
},
{
"apiName":"BTDWFNWWTAREXGZGO0JH",
"guid":"BTDWFNWWTAREXGZGO0JH",
"maxLength":null,
"name":null,
"possibleValues":[

],
"type":"DELIMITER",
"value":"-"
},
{
"apiName":"CUEXGOXXUBSFYH0HP1KR",
"guid":"CUEXGOXXUBSFYH0HP1KR",
"maxLength":null,
"name":"Sequence",
"possibleValues":[

©2022 Arena, A PTC Business www.arenasolutions.com 683

 Arena REST API Developer Guide Endpoints

],
"type":"AUTO_SEQUENCE",
"value":null
}
],
"guid":"YG0J2AJJGXGP8RAROAUE",
"name":"Electrical"
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 684

 Arena REST API Developer Guide Endpoints

GET Item Lifecycle Phases

/settings/items/lifecyclephases

This returns all Item Lifecycle Phases defined for the workspace.

Reuqest Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all item lifecycle phases

GET /settings/items/lifecyclephases

{
"count":7,
"results":[
{
"active":true,
"guid":"9RBUDLUUR8QTCVEXGVB9",
"name":"Abandoned",
"shortName":"Aban",
"stage":"DESIGN",
"used":true

©2022 Arena, A PTC Business www.arenasolutions.com 685

 Arena REST API Developer Guide Endpoints

},
{
"active":true,
"guid":"8QATCKTTQ7PSBUDWFUA1",
"name":"Deprecated",
"shortName":"Depr",
"stage":"PRODUCTION",
"used":true
},
{
"active":true,
"guid":"BTDWFNWWTASVEXGZIXDY",
"name":"In Design",
"shortName":"In Des",
"stage":"DESIGN",
"used":true
},
{
"active":true,
"guid":"K2M5OW552J14N6P8R6JI",
"name":"Prototype",
"shortName":"Proto",
"stage":"DESIGN",
"used":true
},
{
"active":true,
"guid":"ASCVEMVVS9RUDWFYHWC3",
"name":"In Production",
"shortName":"In Prod",
"stage":"PRODUCTION",
"used":true
},
{
"active":true,
"guid":"7P9SBJSSP6ORATCVET9H",
"name":"Obsolete",
"shortName":"Obs",
"stage":"PRODUCTION",
"used":false
},
{
"active":true,
"guid":"6O8RAIRRO5NQ9SBUDS87",
"name":"Unreleased",
"shortName":"Unrel",
"stage":"PRELIMINARY",
"used":true
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 686

 Arena REST API Developer Guide Endpoints

GET Item Compliance Requirements

/settings/items/requirements

/settings/items/requirements/<GUID>

Returns Compliance Requirements avaialble for items in the workspace. Appending a GUID to the URL returns
the requirement with that GUID.

Note in the evidenceLocation attribute, if the allFileCategories attribute is set to false, the fileCategories attribute
gives the categories in which evidence can be located.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all compliance requirements for items in the workspace

GET /settings/items/requirements

{
"count":5,
"results":[
{

©2022 Arena, A PTC Business www.arenasolutions.com 687

 Arena REST API Developer Guide Endpoints

"defaultEvidenceType":"AML_AND_FILES",
"evidenceLocation":{
"allFileCategories":false,
"fileCategories":[
{
"guid":"BTDWFNUGW4NXGZIZNMDM"
},
{
"guid":"K2M5OW3P5DW6P8R8WVLS"
}
]
},
"guid":"M4O7QY5R7FXXGZI07XHU",
"invalidationRule":"RESET_ALL",
"name":"RoHS (2002/95/EC)",
"propagate":true,
"rationaleHint":"- All off-the-shelf ...",
"statementOfRequirement":"This Item ..."
},
{
"defaultEvidenceType":"NONE",
"evidenceLocation":{
"allFileCategories":true
},
"guid":"EWGZIQXJZ7PP8RASY3JE",
"invalidationRule":"RESET_ALL",
"name":"api-requirement1",
"propagate":false,
"rationaleHint":"some rationale hint",
"statementOfRequirement":"some statement of requirement"
},
...
]
}

Get an item compliance requirements with a specific GUID

GET /settings/items/requirements/M4O7QY5R7FXXGZI07XHU

{
"defaultEvidenceType":"AML_AND_FILES",
"evidenceLocation":{
"allFileCategories":false,
"fileCategories":[
{
"guid":"BTDWFNUGW4NXGZIZNMDM"
},
{
"guid":"K2M5OW3P5DW6P8R8WVLS"
}
]
},
"guid":"M4O7QY5R7FXXGZI07XHU",
"invalidationRule":"RESET_ALL",
"name":"RoHS (2002/95/EC)",

©2022 Arena, A PTC Business www.arenasolutions.com 688

 Arena REST API Developer Guide Endpoints

"propagate":true,
"rationaleHint":"- All off-the-shelf ...",
"statementOfRequirement":"This Item ..."
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 689

 Arena REST API Developer Guide Endpoints

GET Export Setting Attributes

/settings/export/attributes

Returns attributes available for an Item export definition. By adding a parameter of includePossibleValues set
to true and , the endpoint returns a single unique Item attribute.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

includePossibleValues true or false If this is set to true, it returns all the possible
values for Drop Down List attributes. The
default value is false.
creatableOnly true or false If this is set to true, it returns only creatable
attributes, which can be set during creation
of an item. The default value is false.
editableOnly true or false If this is set to true, it returns only editable
attributes, which can be set during update
of an item. The default value is false.
searchableOnly true or false If this is set to true, it returns only searchable
attributes, which are searchable when
getting items.
world items If set to items, returns the options and
criteria attributes.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions

©2022 Arena, A PTC Business www.arenasolutions.com 690

 Arena REST API Developer Guide Endpoints

Name Value Description

X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all export attributes with possible values included for the items world.

GET /settings/export/attributes?includePossibleValues=true&world=items

{
"count": 9,
"results": [
{
"allowsExplicitNullValue": false,
"apiName": "creationDateTime",
"creatable": false,
"editable": false,
"fieldType": "DATETIME",
"inViews": [
"EXPORT_SUMMARY"
],
"searchable": false
},
{
"allowsExplicitNullValue": false,
"apiName": "creator",
"creatable": false,
"editable": false,
"fieldType": "OBJECT",
"inViews": [
"EXPORT_SUMMARY"
],
"searchable": true
},
{
"allowsExplicitNullValue": false,
"apiName": "criteria",
"creatable": true,
"editable": false,
"fieldType": "OBJECT",
"inViews": [
"EXPORT_SUMMARY"
],
"required": false,
"searchable": false
},
{
"allowsExplicitNullValue": false,
"apiName": "description",
"creatable": true,
"editable": false,

©2022 Arena, A PTC Business www.arenasolutions.com 691

 Arena REST API Developer Guide Endpoints

"fieldType": "SINGLE_LINE_TEXT",
"inViews": [
"EXPORT_SUMMARY"
],
"maxLength": 4000,
"required": false,
"searchable": true
},
{
"allowsExplicitNullValue": false,
"apiName": "guid",
"creatable": false,
"editable": false,
"fieldType": "GUID",
"inViews": [
"EXPORT_SUMMARY"
],
"searchable": false
},
{
"allowsExplicitNullValue": false,
"apiName": "name",
"creatable": true,
"editable": false,
"fieldType": "SINGLE_LINE_TEXT",
"inViews": [
"EXPORT_SUMMARY"
],
"maxLength": 100,
"required": true,
"searchable": true
},
{
"allowsExplicitNullValue": false,
"apiName": "number",
"creatable": false,
"editable": false,
"fieldType": "NUMBER",
"inViews": [
"EXPORT_SUMMARY"
],
"searchable": true
},
{
"allowsExplicitNullValue": false,
"apiName": "options",
"creatable": true,
"editable": false,
"fieldType": "OBJECT",
"inViews": [
"EXPORT_SUMMARY"
],
"required": false,
"searchable": false
},

©2022 Arena, A PTC Business www.arenasolutions.com 692

 Arena REST API Developer Guide Endpoints

{
"allowsExplicitNullValue": false,
"apiName": "world",
"creatable": true,
"editable": false,
"fieldType": "FIXED_DROP_DOWN",
"inViews": [
"EXPORT_SUMMARY"
],
"possibleValues": [
"ITEMS"
],
"required": true,
"searchable": false
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 693

 Arena REST API Developer Guide Endpoints

GET Requests Categories

/settings/requests/categories

/settings/requests/categories/<GUID>

Returns Categories available for Requests. Appending a GUID to the URL returns the category with that GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all request categories

GET /settings/requests/categories

{
"count": 14,
"results": [
{
"activated": true,
"assignable": true,
"creationDateTime": "2008-03-07T19:02:39Z",
"creator": {
"email": "nlx.hmlrgfolhzmviz@[email protected]",
"fullName": "Eprn )Amviz( Nzeroofh",

©2022 Arena, A PTC Business www.arenasolutions.com 694

 Arena REST API Developer Guide Endpoints

"guid": "VDXGZCXOBEVEXGZI1T4Q"
},
"description": null,
"evaluatorGroupDefault": null,
"guid": "FXH0JWH8VYHRAT8FFG40",
"level": 3,
"name": "Compliance Change Request",
"numberingSequencePrefixDefault": {
"guid": "7P9SBO90NQ62L4MOAVK1",
"value": "CCR-"
},
"parentCategory": {
"guid": "L3N6P2NE14NXGZELLMAW",
"name": "Change Request"
},
"path": "Request\\Change Request\\Compliance Change Request",
"structural": false,
"systemDefined": false
},
{
"activated": true,
"assignable": true,
"creationDateTime": "2008-03-07T19:05:17Z",
"creator": {
"email": "nlx.hmlrgfolhzmviz@[email protected]",
"fullName": "Eprn )Amviz( Nzeroofh",
"guid": "VDXGZCXOBEVEXGZI1T4Q"
},
"description": null,
"evaluatorGroupDefault": null,
"guid": "GYI1KXI9WZISBU9GGH53",
"level": 3,
"name": "Document Change Request",
"numberingSequencePrefixDefault": {
"guid": "8QATCPA1OR73M5NPBWL9",
"value": "DCR-"
},
"parentCategory": {
"guid": "L3N6P2NE14NXGZELLMAW",
"name": "Change Request"
},
"path": "Request\\Change Request\\Document Change Request",
"structural": false,
"systemDefined": false
},
{
"activated": true,
"assignable": true,
"creationDateTime": "2008-03-07T19:15:34Z",
"creator": {
"email": "nlx.hmlrgfolhzmviz@[email protected]",
"fullName": "Eprn )Amviz( Nzeroofh",
"guid": "VDXGZCXOBEVEXGZI1T4Q"
},
"description": "User this for Engineering changes",

©2022 Arena, A PTC Business www.arenasolutions.com 695

 Arena REST API Developer Guide Endpoints

"evaluatorGroupDefault": null,
"guid": "HZJ2LYJAX0JTCVAHHI66",
"level": 3,
"name": "Engineering Change Request",
"numberingSequencePrefixDefault": {
"guid": "ASCVERC3QT95O7PRDYND",
"value": "ECR-"
},
"parentCategory": {
"guid": "L3N6P2NE14NXGZELLMAW",
"name": "Change Request"
},
"path": "Request\\Change Request\\Engineering Change Request",
"structural": false,
"systemDefined": false
},
...
]
}

Get a Request category with a specific GUID

GET /settings/requests/categories/guid

{
"activated": true,
"assignable": true,
"creationDateTime": "2008-03-07T19:15:34Z",
"creator": {
"email": "nlx.hmlrgfolhzmviz@[email protected]",
"fullName": "Eprn )Amviz( Nzeroofh",
"guid": "VDXGZCXOBEVEXGZI1T4Q"
},
"description": "User this for Engineering changes",
"evaluatorGroupDefault": null,
"guid": "HZJ2LYJAX0JTCVAHHI66",
"level": 3,
"name": "Engineering Change Request",
"numberingSequencePrefixDefault": {
"guid": "ASCVERC3QT95O7PRDYND",
"value": "ECR-"
},
"parentCategory": {
"guid": "L3N6P2NE14NXGZELLMAW",
"name": "Change Request"
},
"path": "Request\\Change Request\\Engineering Change Request",
"structural": false,
"systemDefined": false
}

©2022 Arena, A PTC Business www.arenasolutions.com 696

 Arena REST API Developer Guide Endpoints

GET Request Attributes

/settings/requests/attributes

Returns Attributes available for Requests.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

includePossibleValues true or false If this is set to true, it returns all the possible
values for Drop Down List attributes. The
default value is false.
creatableOnly true or false If this is set to true, it returns only creatable
attributes, which are settable during
creation of an item. The default value is
false.
editableOnly true or false If this is set to true, it returns only editable
attributes, which are settable during update
of an item. The default value is false.
searchableOnly true or false If this is set to true, it returns only searchable
attributes, which are searchable when
getting items.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count

©2022 Arena, A PTC Business www.arenasolutions.com 697

 Arena REST API Developer Guide Endpoints

Name Value Description

X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all request attributes with possible values included

GET /settings/requests/attributes?includePossibleValues=true

{
"count": 23,
"results": [
{
"active": true,
"allowsExplicitNullValue": true,
"apiName": "XFZI1EZQDGXFYHYLDXPT",
"creatable": true,
"custom": true,
"deleted": false,
"editable": true,
"fieldType": "SINGLE_LINE_TEXT",
"global": true,
"guid": "XFZI1EZQDGXFYHYLDXPT",
"maxLength": 1000,
"name": "Expected Completion Date",
"required": false,
"searchable": true
},
{
"active": true,
"allowsExplicitNullValue": true,
"apiName": "ZH1K3G1SFIZH0J0NFZRC",
"creatable": true,
"custom": true,
"deleted": false,
"editable": true,
"fieldType": "SINGLE_LINE_TEXT",
"global": false,
"guid": "ZH1K3G1SFIZH0J0NFZRC",
"maxLength": 1000,
"name": "Problem Description",
"searchable": true
},
{
"active": true,
"allowsExplicitNullValue": true,
"apiName": "0I2L4H2TGJ0I1K1OG0SM",
"creatable": true,
"custom": true,
"deleted": false,
"editable": true,
"fieldType": "SINGLE_LINE_TEXT",
"global": false,

©2022 Arena, A PTC Business www.arenasolutions.com 698

 Arena REST API Developer Guide Endpoints

"guid": "0I2L4H2TGJ0I1K1OG0SM",
"maxLength": 1000,
"name": "Root Cause",
"searchable": true
},
...
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 699

 Arena REST API Developer Guide Endpoints

GET Request Category Attributes

/settings/requests/categories/<GUID>/attributes

Returns Attributes available for a Request category with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all attributes available for a request category with a given GUID

GET /settings/requests/categories/GUID/attributes

{
"count": 20,
"results": [
{
"active": true,
"allowsExplicitNullValue": true,
"apiName": "XFZI1EZQDGXFYHYLDXPT",
"creatable": true,
"custom": true,
"deleted": false,
"editable": true,
"fieldType": "SINGLE_LINE_TEXT",

©2022 Arena, A PTC Business www.arenasolutions.com 700

 Arena REST API Developer Guide Endpoints

"global": true,
"guid": "XFZI1EZQDGXFYHYLDXPT",
"maxLength": 1000,
"name": "Expected Completion Date",
"required": false,
"searchable": true
},
{
"active": true,
"allowsExplicitNullValue": true,
"apiName": "YG0J2F0REHYGZIZMEYQ8",
"creatable": true,
"custom": true,
"deleted": false,
"editable": true,
"fieldType": "FIXED_DROP_DOWN",
"global": true,
"guid": "YG0J2F0REHYGZIZMEYQ8",
"multiSelect": false,
"name": "Urgency",
"required": false,
"searchable": true
},
{
"allowsExplicitNullValue": false,
"apiName": "category",
"creatable": true,
"custom": false,
"developerNotes": "Defaults to -uncategorized- if no default is set",
"editable": true,
"fieldType": "OBJECT",
"global": true,
"inViews": [
"REQUEST_SUMMARY"
],
"required": false,
"searchable": true
},
...
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 701

 Arena REST API Developer Guide Endpoints

GET Request Item Attributes

/settings/requests/items/attributes

Returns Attributes available for Requests.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

includePossibleValues true or false If this is set to true, it returns all the possible
values for Drop Down List attributes. The
default value is false.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all modified item attributes, showing all possible values

GET /settings/requests/items/attributes?includePossibleValues=true

{
"count": 3,
"results": [

©2022 Arena, A PTC Business www.arenasolutions.com 702

 Arena REST API Developer Guide Endpoints

{
"allowsExplicitNullValue": false,
"apiName": "guid",
"creatable": false,
"custom": false,
"editable": false,
"fieldType": "GUID",
"inViews": [
"REQUEST_ITEMS"
],
"searchable": false
},
{
"allowsExplicitNullValue": false,
"apiName": "item",
"creatable": true,
"custom": false,
"developerNotes": "Item Revision that is affected",
"editable": false,
"fieldType": "OBJECT",
"inViews": [
"REQUEST_ITEMS"
],
"required": false,
"searchable": false
},
{
"allowsExplicitNullValue": false,
"apiName": "notes",
"creatable": true,
"editable": true,
"fieldType": "MULTI_LINE_TEXT",
"inViews": [
"REQUEST_ITEMS"
],
"maxLength": 4000,
"searchable": false
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 703

 Arena REST API Developer Guide Endpoints

GET Request Number Prefixes

/settings/requests/numbersequenceprefixes

This returns all Request Number Prefixes available for the workspace.

Request number formats in Arena consist of a prefix (such as ECR) and a six-digit autogenerating sequence
(such as 000001), separated by a dash.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in the response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all requests number prefixes

GET /settings/requests/numbersequenceprefixes

{
"count": 13,
"results": [
{
"guid": "8QATCPA1OR73M5NPBWL9",
"value": "DCR-"
},

©2022 Arena, A PTC Business www.arenasolutions.com 704

 Arena REST API Developer Guide Endpoints

{
"guid": "ASCVERC3QT95O7PRDYND",
"value": "ECR-"
},
{
"guid": "CUEXGTE5SVB7Q9RTF0P8",
"value": "MCR-"
},
...
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 705

 Arena REST API Developer Guide Endpoints

GET Request Number Sequences

/settings/requests/numbersequences

/settings/requests/numbersequences/<GUID>

This returns Request Number Sequences available in the workspace. Appending a GUID to the URL returns the
number format with that GUID.

Request Number Sequences consist of a list of prefixes and an auto-incrementing number field.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in the response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all Request number formats defined for the workspace

/settings/requests/numbersequences

{
"count": 13,
"results": [
{
"creationDateTime": "2008-03-07T18:40:23Z",

©2022 Arena, A PTC Business www.arenasolutions.com 706

 Arena REST API Developer Guide Endpoints

"guid": "R9TCV8TK7AQN6P76AXNQ",
"lastUsed": "000000",
"name": "Document Change Request",
"nextValue": "000001",
"prefixes": [
{
"guid": "8QATCPA1OR73M5NPBWL9",
"value": "DCR-"
}
]
},
{
"creationDateTime": "2008-03-04T20:04:47Z",
"guid": "O6Q9S5QH47NK3M437UKO",
"lastUsed": "000005",
"name": "Engineering Change Request",
"nextValue": "000009",
"prefixes": [
{
"guid": "ASCVERC3QT95O7PRDYND",
"value": "ECR-"
}
]
},
{
"creationDateTime": "2008-03-04T20:04:47Z",
"guid": "N5P8R4PG36MJ2L326TJ8",
"lastUsed": "000003",
"name": "Manufacturing Change Request",
"nextValue": "000004",
"prefixes": [
{
"guid": "CUEXGTE5SVB7Q9RTF0P8",
"value": "MCR-"
}
]
},
...
]
}

Get a Request number format with a specific GUID

/settings/requests/numbersequences/R9TCV8TK7AQN6P76AXNQ

{
"creationDateTime": "2008-03-07T18:40:23Z",
"guid": "R9TCV8TK7AQN6P76AXNQ",
"lastUsed": "000000",
"name": "Document Change Request",
"nextValue": "000001",
"prefixes": [
{
"guid": "8QATCPA1OR73M5NPBWL9",
"value": "DCR-"

©2022 Arena, A PTC Business www.arenasolutions.com 707

 Arena REST API Developer Guide Endpoints

}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 708

 Arena REST API Developer Guide Endpoints

GET Request Administrators

/settings/requests/administrators

/settings/requests/administrators/<GUID>

Returns all the request administrators of a workspace. If appended with the guid of a specific administrator,
returns the specific information of the specified request administrator.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get the Request administrators of a workspace.

GET /settings/requests/administrators

{
"count": 3,
"results": [
{
"email": "[email protected]",
"fullName": "Toshiro Makamuri",
"guid": "J1L4N0LCZ2J2L4N6F6ZL"

©2022 Arena, A PTC Business www.arenasolutions.com 709

 Arena REST API Developer Guide Endpoints

},
{
"email": "[email protected]",
"fullName": "John Parker",
"guid": "XFZI1EZQDGXGZI1KTJQ2"
},
{
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
]
}

Get a specific Request Administrator with a given GUID.

GET /settings/requests/administrators/WEYHODYPCFWFYHOJSIPD

{
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}

©2022 Arena, A PTC Business www.arenasolutions.com 710

 Arena REST API Developer Guide Endpoints

GET Request Evaluator Groups

/settings/requests/evaluatorgroups

/settings/requests/evaluatorgroups/<GUID>

Returns Evaluator Groups available for Requests. Appending a GUID to the URL returns the routing with that
GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all request evaluator groups

GET /settings/requests/evaluatorgroups

{
"count": 6,
"results": [
{
"guid": "4M6P8L6XKN4L4N6P7X7E",
"name": "Engineering plus Board Supplier"
},
{
"guid": "3L5O7K5WJM3K3M5O5JDC",

©2022 Arena, A PTC Business www.arenasolutions.com 711

 Arena REST API Developer Guide Endpoints

"name": "Product Enhancement"

},
{
"guid": "SAUDW9UL8BS9SBUDUHW0",
"name": "ECR Review Board"
},
...
]
}

Get a request evaluator group with a specific GUID

GET /settings/requests/evaluatorgroups/GUID

{
"guid": "SAUDW9UL8BS9SBUDUHW0",
"name": "ECR Review Board"
}

©2022 Arena, A PTC Business www.arenasolutions.com 712

 Arena REST API Developer Guide Endpoints

GET Change Administrators

/settings/changes/administrators

/settings/changes/administrators/<GUID>

Returns all the change administrators of a workspace. If appended with a valid guid, it returns the information
of that specific change administrator.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get the Change Administrators of a workspace.

GET /settings/changes/administrators

{
"count": 3,
"results": [
{
"email": "[email protected]",
"fullName": "Toshiro Makamuri",
"guid": "J1L4N0LCZ2J2L4N6F6ZL"

©2022 Arena, A PTC Business www.arenasolutions.com 713

 Arena REST API Developer Guide Endpoints

},
{
"email": "[email protected]",
"fullName": "John Parker",
"guid": "XFZI1EZQDGXGZI1KTJQ2"
},
{
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
]
}

Get a specific Change Administrator with a given GUID.

GET /settings/changes/administrators/WEYHODYPCFWFYHOJSIPD

{
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}

©2022 Arena, A PTC Business www.arenasolutions.com 714

 Arena REST API Developer Guide Endpoints

GET Change Attributes

/settings/changes/attributes

Returns Attributes available for Changes.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

includePossibleValues true or false If this is set to true, it returns all the possible
values for Drop Down List attributes. The
default value is false.
creatableOnly true or false If this is set to true, it returns only creatable
attributes, which are settable during
creation of an item. The default value is
false.
editableOnly true or false If this is set to true, it returns only editable
attributes, which are settable during update
of an item. The default value is false.
searchableOnly true or false If this is set to true, it returns only searchable
attributes, which are searchable when
getting items.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count

©2022 Arena, A PTC Business www.arenasolutions.com 715

 Arena REST API Developer Guide Endpoints

Name Value Description

X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all change attributes with possible values included

GET /settings/changes/attributes?includePossibleValues=true

{
"count":26,
"results":[
{
"allowsExplicitNullValue":false,
"apiName":"ZH1K3BKKHYFXGZI0528P",
"creatable":true,
"custom":true,
"defaultValue":"No",
"editable":true,
"fieldType":"FIXED_DROP_DOWN",
"global":true,
"guid":"ZH1K3BKKHYFXGZI0528P",
"name":"Cost over $500?",
"possibleValues":[
"Yes",
"No"
],
"required":true,
"searchable":true
},
{
"allowNegatives":false,
"allowsExplicitNullValue":false,
"apiName":"0I2L4CLLIZGYH0J1639I",
"creatable":true,
"custom":true,
"decimalPlaces":0,
"defaultValue":2,
"editable":true,
"fieldType":"NUMBER",
"global":true,
"guid":"0I2L4CLLIZGYH0J1639I",
"name":"Priority (1-5)",
"required":true,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"FXH0JR00XEVDWFYGNJQZ",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"FIXED_DROP_DOWN",

©2022 Arena, A PTC Business www.arenasolutions.com 716

 Arena REST API Developer Guide Endpoints

"global":false,
"guid":"FXH0JR00XEVDWFYGNJQZ",
"name":"Urgency",
"possibleValues":[
"Critical",
"High",
"Medium",
"Low"
],
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"approvalDeadlineDateTime",
"creatable":true,
"custom":false,
"editable":true,
"fieldType":"DATETIME",
"global":true,
"inViews":[
"CHANGE_SUMMARY"
],
"required":false,
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"canceledDateTime",
"creatable":false,
"custom":false,
"editable":false,
"fieldType":"DATETIME",
"global":true,
"inViews":[
"CHANGE_SUMMARY"
],
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"category",
"creatable":true,
"custom":false,
"developerNotes":"Defaults to -uncategorized- if no default is set",
"editable":true,
"fieldType":"OBJECT",
"global":true,
"guid":"2K4N6ENNK1J6P8RATCVD",
"inViews":[
"CHANGE_SUMMARY"
],
"required":false,
"searchable":true
},
{

©2022 Arena, A PTC Business www.arenasolutions.com 717

 Arena REST API Developer Guide Endpoints

"allowLowerCase":true,
"allowNumbers":true,
"allowUpperCase":true,
"allowsExplicitNullValue":false,
"apiName":"description",
"creatable":true,
"custom":false,
"editable":true,
"fieldType":"MULTI_LINE_TEXT",
"global":true,
"guid":"1J3M5DMMJ0I5O7Q9SBUV",
"inViews":[
"CHANGE_SUMMARY"
],
"maxLength":32000,
"required":false,
"searchable":false
},
...
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 718

 Arena REST API Developer Guide Endpoints

GET Change Item Attributes

/settings/changes/items/attributes

Returns Attributes (including inventory disposition) available for Changes.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

includePossibleValues true or false If this is set to true, it returns all the possible
values for Drop Down List attributes. The
default value is false.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all modified item attributes, showing all possible values

GET /settings/changes/items/attributes?includePossibleValues=true

{
"count":14,
"results":[

©2022 Arena, A PTC Business www.arenasolutions.com 719

 Arena REST API Developer Guide Endpoints

{
"allowsExplicitNullValue":true,
"apiName":"custom4168105",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"FIXED_DROP_DOWN",
"guid":"CUEXGOXXUBTGZI1IKR6B",
"name":"Finished Goods",
"possibleValues":[
"N/A",
"Ship-as-is",
"Rework",
"Scrap",
"See Notes"
],
"required":false,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"custom4168107",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"FIXED_DROP_DOWN",
"guid":"EWGZIQZZWDVI1K3KMT8M",
"name":"In Stock",
"possibleValues":[
"N/A",
"Build-out",
"Rework",
"Scrap",
"See Notes"
],
"required":false,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"custom4168106",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"FIXED_DROP_DOWN",
"guid":"DVFYHPYYVCUH0J2JLS71",
"name":"In the Field",
"possibleValues":[
"N/A",
"Do Nothing",
"Notify",
"Rework",
"Recall",
"See Notes"
],

©2022 Arena, A PTC Business www.arenasolutions.com 720

 Arena REST API Developer Guide Endpoints

"required":false,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"custom4168103",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"FIXED_DROP_DOWN",
"guid":"ASCVEMVVS9REXGZGIP4A",
"name":"On Order",
"possibleValues":[
"N/A",
"Accept to stock",
"Cancel",
"Scrap",
"See Notes"
],
"required":false,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"custom2269737",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"FIXED_DROP_DOWN",
"guid":"9RBUDLUUR8QDWFYGNJQP",
"name":"Urgency",
"possibleValues":[
"Critical",
"High",
"Medium",
"Low"
],
"required":true,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"custom4168104",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"FIXED_DROP_DOWN",
"guid":"BTDWFNWWTASFYH0HJQ5Q",
"name":"WIP",
"possibleValues":[
"N/A",
"Build-out",
"Rework",
"Scrap",
"See Notes"

©2022 Arena, A PTC Business www.arenasolutions.com 721

 Arena REST API Developer Guide Endpoints

],
"required":false,
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"affectedItemRevision",
"creatable":true,
"custom":false,
"developerNotes":"Item Revision that is affected",
"editable":false,
"fieldType":"OBJECT",
"inViews":[
"CHANGE_ITEMS"
],
"required":true,
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"bomView",
"creatable":false,
"custom":false,
"editable":false,
"fieldType":"OBJECT",
"inViews":[
"CHANGE_ITEMS"
],
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"filesView",
"creatable":false,
"custom":false,
"editable":false,
"fieldType":"OBJECT",
"inViews":[
"CHANGE_ITEMS"
],
"searchable":false
},
{
"allowsExplicitNullValue":true,
"apiName":"materialEffectivityDateTime",
"creatable":true,
"custom":false,
"editable":true,
"fieldType":"DATETIME",
"inViews":[
"CHANGE_ITEMS"
],
"required":false,
"searchable":false
},

©2022 Arena, A PTC Business www.arenasolutions.com 722

 Arena REST API Developer Guide Endpoints

{
"allowsExplicitNullValue":false,
"apiName":"newItemRevision",
"creatable":false,
"custom":false,
"developerNotes":"Item Revision to be made effective",
"editable":false,
"fieldType":"OBJECT",
"inViews":[
"CHANGE_ITEMS"
],
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"newLifecyclePhase",
"creatable":true,
"custom":false,
"developerNotes":"New Revision for effective item",
"editable":true,
"fieldType":"OBJECT",
"inViews":[
"CHANGE_ITEMS"
],
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"sourcingView",
"creatable":false,
"custom":false,
"editable":false,
"fieldType":"OBJECT",
"inViews":[
"CHANGE_ITEMS"
],
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"specsView",
"creatable":false,
"custom":false,
"editable":false,
"fieldType":"OBJECT",
"inViews":[
"CHANGE_ITEMS"
],
"searchable":false
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 723

 Arena REST API Developer Guide Endpoints

GET Change Number Prefixes

/settings/changes/numbersequenceprefixes

This returns all Change Number Prefixes available for the workspace.

Change number formats in Arena consist of a prefix (such as ECO) and a six-digit autogenerating sequence
(such as 000001), separated by a dash.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in the response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all change number prefixes

GET /settings/changes/numbersequenceprefixes

{
"count":7,
"results":[
{
"guid":"QCCLWNGXUH1VAQZSV6XB",
"value":"CCO-"
}

©2022 Arena, A PTC Business www.arenasolutions.com 724

 Arena REST API Developer Guide Endpoints

{
"guid":"F54NB3G08DIVT5DZS3FD",
"value":"DEV-"
}
{
"guid":"T35HQJRC1U0QRCBLHA7C",
"value":"DCO-"
}
{
"guid":"P7RATAT95I1ATCVEXGWY",
"value":"ECO-"
}
{
"guid":"G84PT70BWBL2Y8JN4ZS6",
"value":"MCO-"
}
{
"guid":"RZAMSRGGOK2CIUD3Y3X0",
"value":"PRO-"
}
{
"guid":"YKIQM9VCSGQ254DJ5VVS",
"value":"SS-"
}
]
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 725

 Arena REST API Developer Guide Endpoints

GET Change Category Attributes

/settings/changes/categories/<GUID>/attributes

Returns Attributes available for a Change category with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all attributes available for a change category with a given GUID

GET /settings/changes/categories/GUID/attributes

{
"count":26,
"results":[
{
"allowsExplicitNullValue":false,
"apiName":"ZH1K3BKKHYFXGZI0528P",
"creatable":true,
"custom":true,
"defaultValue":"No",
"editable":true,
"fieldType":"FIXED_DROP_DOWN",
"global":true,

©2022 Arena, A PTC Business www.arenasolutions.com 726

 Arena REST API Developer Guide Endpoints

"guid":"ZH1K3BKKHYFXGZI0528P",
"name":"Cost over $500?",
"required":true,
"searchable":true
},
{
"allowNegatives":false,
"allowsExplicitNullValue":false,
"apiName":"0I2L4CLLIZGYH0J1639I",
"creatable":true,
"custom":true,
"decimalPlaces":0,
"defaultValue":2,
"editable":true,
"fieldType":"NUMBER",
"global":true,
"guid":"0I2L4CLLIZGYH0J1639I",
"name":"Priority (1-5)",
"required":true,
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"FXH0JR00XEVDWFYGNJQZ",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"FIXED_DROP_DOWN",
"global":false,
"guid":"FXH0JR00XEVDWFYGNJQZ",
"name":"Urgency",
"required":true,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"approvalDeadlineDateTime",
"creatable":true,
"custom":false,
"editable":true,
"fieldType":"DATETIME",
"global":true,
"inViews":[
"CHANGE_SUMMARY"
],
"required":false,
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"canceledDateTime",
"creatable":false,
"custom":false,
"editable":false,
"fieldType":"DATETIME",

©2022 Arena, A PTC Business www.arenasolutions.com 727

 Arena REST API Developer Guide Endpoints

"global":true,
"inViews":[
"CHANGE_SUMMARY"
],
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"category",
"creatable":true,
"custom":false,
"developerNotes":"Defaults to -uncategorized- if no default is set",
"editable":true,
"fieldType":"OBJECT",
"global":true,
"guid":"2K4N6ENNK1J6P8RATCVD",
"inViews":[
"CHANGE_SUMMARY"
],
"required":false,
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"creationDateTime",
"creatable":false,
"custom":false,
"editable":false,
"fieldType":"DATETIME",
"global":true,
"inViews":[
"CHANGE_SUMMARY"
],
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"creator",
"creatable":false,
"custom":false,
"editable":false,
"fieldType":"OBJECT",
"global":true,
"inViews":[
"CHANGE_SUMMARY"
],
"searchable":true
},
{
"allowLowerCase":true,
"allowNumbers":true,
"allowUpperCase":true,
"allowsExplicitNullValue":false,
"apiName":"description",
"creatable":true,

©2022 Arena, A PTC Business www.arenasolutions.com 728

 Arena REST API Developer Guide Endpoints

"custom":false,
"editable":true,
"excludedValues":[
";",
"-",
"string"
],
"fieldType":"MULTI_LINE_TEXT",
"global":true,
"guid":"1J3M5DMMJ0I5O7Q9SBUV",
"inViews":[
"CHANGE_SUMMARY"
],
"maxLength":32000,
"required":false,
"searchable":false
},
...
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 729

 Arena REST API Developer Guide Endpoints

GET Change Categories

/settings/changes/categories

/settings/changes/categories/<GUID>

Returns Categories available for Changes. Appending a GUID to the URL returns the category with that GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all change categories

GET /settings/changes/categories

{
"count":9,
"results":[
{
"activated":true,
"allowDuplicateRevisions":true,
"allowManualRevisionEntry":true,
"assignable":true,
"creationDateTime":"2011-01-05T00:26:30Z",
"creator":{

©2022 Arena, A PTC Business www.arenasolutions.com 730

 Arena REST API Developer Guide Endpoints

"email":"[email protected]",
"fullName":"Chris Vickery",
"guid":"VDXGZ7GGDUBUDWFYHI7P"
},
"description":"Change is a system-defined category",
"effectivityType":null,
"enforceDefaultEffectivityType":false,
"enforceDefaultNumberSequence":false,
"guid":"SAUDW4DDARAK3M5MAMDU",
"initialImplementationStatus":null,
"level":1,
"name":"Change",
"numberingSequencePrefixDefault":null,
"path":"Change",
"systemDefined":true
},
{
"activated":true,
"allowDuplicateRevisions":true,
"allowManualRevisionEntry":true,
"assignable":false,
"creationDateTime":"2011-02-08T22:08:49Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"description":null,
"effectivityType":"PERMANENT_ON_APPROVAL",
"enforceDefaultEffectivityType":false,
"enforceDefaultNumberSequence":false,
"guid":"Q8SBU2BB8P8I1K3K8KBY",
"initialImplementationStatus":"BLANK",
"level":2,
"name":"Change Order",
"numberingSequencePrefixDefault":null,
"path":"Change\\Change Order",
"systemDefined":false
},
{
"activated":true,
"allowDuplicateRevisions":true,
"allowManualRevisionEntry":true,
"assignable":true,
"creationDateTime":"2011-02-08T22:09:30Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"description":null,
"effectivityType":"PERMANENT_ON_APPROVAL",
"enforceDefaultEffectivityType":true,
"enforceDefaultNumberSequence":true,
"guid":"R9TCV3CC9Q9J2L4L9LC9",

©2022 Arena, A PTC Business www.arenasolutions.com 731

 Arena REST API Developer Guide Endpoints

"initialImplementationStatus":"NOT_STARTED",
"level":3,
"name":"Compliance Change Order",
"numberingSequencePrefixDefault":{
"guid":"FXH0JR00XEVSBUDUTRCG",
"value":"CCO-"
},
"path":"Change\\Change Order\\Compliance Change Order",
"systemDefined":false
},
...
]
}

Get a Change category with a specific GUID

GET /settings/changes/categories/guid

{
"activated":true,
"allowDuplicateRevisions":true,
"allowManualRevisionEntry":true,
"assignable":true,
"creationDateTime":"2011-02-08T22:09:30Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"description":null,
"effectivityType":"PERMANENT_ON_APPROVAL",
"enforceDefaultEffectivityType":true,
"enforceDefaultNumberSequence":true,
"guid":"R9TCV3CC9Q9J2L4L9LC9",
"initialImplementationStatus":"NOT_STARTED",
"level":3,
"name":"Compliance Change Order",
"numberingSequencePrefixDefault":{
"guid":"FXH0JR00XEVSBUDUTRCG",
"value":"CCO-"
},
"path":"Change\\Change Order\\Compliance Change Order",
"systemDefined":false
}

©2022 Arena, A PTC Business www.arenasolutions.com 732

 Arena REST API Developer Guide Endpoints

GET Change Routings

/settings/changes/routings

/settings/changes/routings/<GUID>

Returns Routings available for Changes. Appending a GUID to the URL returns the routing with that GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all change routings

GET /settings/changes/routings

{
"count":4,
"results":[
{
"description":"To be used for all changes where working modifications are
being made effective without a phase change.",
"guid":"J1L4NV441IZ2L4N6P3EZ",
"name":"Approval Routing"
},
{

©2022 Arena, A PTC Business www.arenasolutions.com 733

 Arena REST API Developer Guide Endpoints

"description":null,
"guid":"L3N6PX663K14N6P8R5GB",
"name":"CTO Approval Only"
},
{
"description":"To be used for updating sourcing information on parts. Also
responsible for part obsolescence.",
"guid":"K2M5OW552J03M5O7Q4F0",
"name":"Component Librarian"
},
{
"description":"This routing approves releases to Design or Production",
"guid":"N5P8RZ885M36P8RAT7H0",
"name":"Phase Changes"
}
]
}

Get a change routing with a specific GUID

GET /settings/changes/routings/GUID

{
"description":"To be used for updating sourcing information on parts. Also
responsible for part obsolescence.",
"guid":"K2M5OW552J03M5O7Q4F0",
"name":"Component Librarian"
}

©2022 Arena, A PTC Business www.arenasolutions.com 734

 Arena REST API Developer Guide Endpoints

GET Supplier Attributes

/settings/suppliers/attributes

Returns Attributes available for suppliers.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

includePossibleValues true or false If this is set to true, it returns all the possible
values for Drop Down List attributes. The
default value is false.
creatableOnly true or false If this is set to true, it returns only creatable
attributes, which are settable during
creation of a supplier. The default value is
false.
editableOnly true or false If this is set to true, it returns only editable
attributes, which are settable during update
of a supplier. The default value is false.
searchableOnly true or false If this is set to true, it returns only searchable
attributes, which are searchable when
getting supplier.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count

©2022 Arena, A PTC Business www.arenasolutions.com 735

 Arena REST API Developer Guide Endpoints

Name Value Description

X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all supplier attributes with possible values included

GET /settings/suppliers/attributes?includePossibleValues=true

{
"count":14,
"results":[
{
"allowsExplicitNullValue":true,
"apiName":"HZJ2LT22ZGXFYH0J8J6T",
"creatable":true,
"custom":true,
"defaultValue":"No",
"editable":true,
"fieldType":"FIXED_DROP_DOWN",
"guid":"HZJ2LT22ZGXFYH0J8J6T",
"name":"At-Risk Supplier?",
"possibleValues":[
"Yes",
"No"
],
"required":false,
"searchable":true
},
{
"allowNegatives":false,
"allowsExplicitNullValue":false,
"apiName":"O6Q9S0996N4M5O7QFORI",
"creatable":true,
"custom":true,
"decimalPlaces":1,
"defaultValue":10,
"editable":true,
"fieldType":"NUMBER",
"guid":"O6Q9S0996N4M5O7QFORI",
"name":"Rating 1-10",
"required":true,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"I0K3MU330HYGZI1K9K72",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"DATE",
"guid":"I0K3MU330HYGZI1K9K72",
"name":"Re-Evaluate On",

©2022 Arena, A PTC Business www.arenasolutions.com 736

 Arena REST API Developer Guide Endpoints

"required":false,
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"accountNumber",
"creatable":true,
"custom":false,
"editable":true,
"fieldType":"SINGLE_LINE_TEXT",
"inViews":[
"SUPPLIER_PROFILE"
],
"maxLength":40,
"required":false,
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"addresses",
"creatable":true,
"custom":false,
"editable":true,
"fieldType":"OBJECT",
"inViews":[
"SUPPLIER_PROFILE"
],
"required":false,
"searchable":false
},
...
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 737

 Arena REST API Developer Guide Endpoints

GET Supplier Item Attributes

/settings/supplieritems/attributes

Returns Attributes available for Supplier Items.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

includePossibleValues true or false If this is set to true, it returns all the possible
values for Drop Down List attributes. The
default value is false.
creatableOnly true or false If this is set to true, it returns only creatable
attributes, which are settable during
creation of a supplier item. The default
value is false.
editableOnly true or false If this is set to true, it returns only editable
attributes, which are settable during update
of a supplier item. The default value is false.
searchableOnly true or false If this is set to true, it returns only searchable
attributes, which are searchable when
getting supplier items.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count

©2022 Arena, A PTC Business www.arenasolutions.com 738

 Arena REST API Developer Guide Endpoints

Name Value Description

X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all supplier item attributes with possible values included

GET /settings/supplieritems/attributes?includePossibleValues=true

{
"count":13,
"results":[
{
"allowsExplicitNullValue":true,
"apiName":"L3N6PX663K1J2L4NNT4Z",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"DROP_DOWN",
"guid":"L3N6PX663K1J2L4NNT4Z",
"name":"First Article Tester",
"required":false,
"searchable":true
},
{
"allowsExplicitNullValue":true,
"apiName":"J1L4NV441IZH0J2LLR20",
"creatable":true,
"custom":true,
"editable":true,
"fieldType":"MULTI_LINE_TEXT",
"guid":"J1L4NV441IZH0J2LLR20",
"name":"Notes",
"required":false,
"searchable":true
},
{
"allowNegatives":false,
"allowsExplicitNullValue":true,
"apiName":"K2M5OW552J0I1K3MMS3M",
"creatable":true,
"custom":true,
"decimalPlaces":0,
"editable":true,
"fieldType":"NUMBER",
"guid":"K2M5OW552J0I1K3MMS3M",
"name":"Stock EOQ",
"required":false,
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"creationDateTime",

©2022 Arena, A PTC Business www.arenasolutions.com 739

 Arena REST API Developer Guide Endpoints

"creatable":false,
"custom":false,
"editable":false,
"fieldType":"DATETIME",
"inViews":[
"SI_SPECS"
],
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"creator",
"creatable":false,
"custom":false,
"editable":false,
"fieldType":"OBJECT",
"inViews":[
"SI_SPECS"
],
"required":false,
"searchable":false
},
...
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 740

 Arena REST API Developer Guide Endpoints

GET Supplier Item Compliance Requirements

/settings/supplieritems/requirements

/settings/supplieritems/requirements/<GUID>

Returns all supplier item Compliance Requirement objects in the workspace. Appending a GUID to the URL
returns the requirement with that GUID.

Note in the evidenceLocation attribute, if the allFileCategories attribute is set to false, the fileCategories attribute
gives the categories in which evidence can be located.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all compliance requirements for supplier items in the workspace

GET /settings/supplieritems/requirements

{
"count":3,
"results":[
{

©2022 Arena, A PTC Business www.arenasolutions.com 741

 Arena REST API Developer Guide Endpoints

"defaultEvidenceType":"DIRECT_FILES",
"evidenceLocation":{
"allFileCategories":false,
"fileCategories":[
{
"guid":"5N7QVLMMV2LVEX9H5Y6T"
},
{
"guid":"I0K38YZZ8FY8RAMUIBIK"
}
]
},
"guid":"8QATYOPPY5NM5O61JCQW",
"name":"2002/95/EC RoHS (Sample)",
"rationaleHint":"- This Supplier Item has been verified to meet the RoHS
requirement.\n- This is a make-to-specification Supplier Item. RoHS requirements
called out by design & mfr requirements. See Item specs files. Verified by sample at
IQA during production, documented in IQA test reports.",
"statementOfRequirement":"This Item, and all its approved sourced Supplier
Items, meet the 2002/95/EC RoHS requirements of Pb<0.1%, Hg<0.1%, Cr6<0.1%, PBB<0.1%,
PBDE<0.1%, Cd<0.01% by weight in each homogeneous material in each Supplier Item."
},
...
]
}

Get a single supplier item compliance requirement

GET /settings/supplieritems/requirements/8QATYOPPY5NM5O61JCQW

{
"defaultEvidenceType":"DIRECT_FILES",
"evidenceLocation":{
"allFileCategories":false,
"fileCategories":[
{
"guid":"5N7QVLMMV2LVEX9H5Y6T"
},
{
"guid":"I0K38YZZ8FY8RAMUIBIK"
}
]
},
"guid":"8QATYOPPY5NM5O61JCQW",
"name":"2002/95/EC RoHS (Sample)",
"rationaleHint":"- This Supplier Item has been verified to meet the RoHS
requirement.\n- This is a make-to-specification Supplier Item. RoHS requirements
called out by design & mfr requirements. See Item specs files. Verified by sample at
IQA during production, documented in IQA test reports.",
"statementOfRequirement":"This Item, and all its approved sourced Supplier Items,
meet the 2002/95/EC RoHS requirements of Pb<0.1%, Hg<0.1%, Cr6<0.1%, PBB<0.1%,
PBDE<0.1%, Cd<0.01% by weight in each homogeneous material in each Supplier Item."
}

Request with bad GUID

©2022 Arena, A PTC Business www.arenasolutions.com 742

 Arena REST API Developer Guide Endpoints

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 743

 Arena REST API Developer Guide Endpoints

GET File Attributes

/settings/files/attributes

Returns Attributes available for Files.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

includePossibleValues true or false If this is set to true, it returns all the possible
values for Drop Down List attributes. The
default value is false.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all file attributes with possible values included

GET /settings/files/attributes?includePossibleValues=true

©2022 Arena, A PTC Business www.arenasolutions.com 744

 Arena REST API Developer Guide Endpoints

{
"count":38,
"results":[
{
"allowsExplicitNullValue":false,
"apiName":"author",
"creatable":true,
"editable":true,
"fieldType":"OBJECT",
"inViews":[
"ITEM_FILES",
"FILE_SUMMARY",
"SI_FILES"
],
"required":true,
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"category",
"creatable":true,
"editable":true,
"fieldType":"OBJECT",
"inViews":[
"ITEM_FILES",
"FILE_SUMMARY",
"SI_FILES"
],
"required":true,
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"creationDateTime",
"creatable":false,
"editable":false,
"fieldType":"DATETIME",
"inViews":[
"ITEM_FILES",
"FILE_SUMMARY",
"SI_FILES"
],
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"description",
"creatable":true,
"editable":true,
"fieldType":"SINGLE_LINE_TEXT",
"inViews":[
"ITEM_FILES",
"FILE_SUMMARY",
"SI_FILES"
],

©2022 Arena, A PTC Business www.arenasolutions.com 745

 Arena REST API Developer Guide Endpoints

"maxLength":4000,
"required":false,
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"format",
"creatable":true,
"editable":true,
"fieldType":"DROP_DOWN",
"inViews":[
"ITEM_FILES",
"FILE_SUMMARY",
"SI_FILES"
],
"maxLength":100,
"required":false,
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"guid",
"creatable":false,
"editable":false,
"fieldType":"GUID",
"inViews":[
"ITEM_FILES",
"FILE_SUMMARY",
"SI_FILES"
],
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"storageMethod",
"creatable":true,
"deprecated":true,
"developerNotes":"This attribute is deprecated and storageMethodName must
be used instead",
"editable":false,
"fieldType":"INTEGER",
"inViews":[
"ITEM_FILES",
"FILE_SUMMARY",
"SI_FILES"
],
"required":true,
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"storageMethodName",
"creatable":true,
"editable":false,
"fieldType":"FIXED_DROP_DOWN",

©2022 Arena, A PTC Business www.arenasolutions.com 746

 Arena REST API Developer Guide Endpoints

"inViews":[
"ITEM_FILES",
"FILE_SUMMARY",
"SI_FILES"
],
"required":true,
"searchable":false
},
…
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 747

 Arena REST API Developer Guide Endpoints

GET File Categories

/settings/files/categories

/settings/files/categories/<GUID>

This returns Categories available for Files. Appending a GUID to the URL returns the category with that GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

Path string This is used to filter out categories. The root
of path for files is "file". If you want to get
all the categories under the root category
which start with A, you can send a request
as
api.arenasolutions.com/v1/settings/files/categories
?path=item\A, where "\" is the separator
between parent category and child
category.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 748

 Arena REST API Developer Guide Endpoints

Sample Response Body

Get all file categories

GET /settings/files/categories

{
"count":46,
"results":[
{
"activated":true,
"assignable":true,
"creationDateTime":"2011-01-05T00:26:30Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"description":"File is a system defined category",
"guid":"I0K3MU330H0ATCVC0C11",
"level":1,
"name":"-uncategorized-",
"path":"File",
"requirements":[],
"systemDefined":true
},
{
"activated":true,
"assignable":false,
"creationDateTime":"2011-02-08T22:28:52Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"description":null,
"guid":"9RBUDLUUR8R1K3M3R3T6",
"level":2,
"name":"Internal File",
"path":"File\\Internal File",
"requirements":[],
"systemDefined":false
},
{
"activated":true,
"assignable":true,
"creationDateTime":"2011-02-08T22:29:31Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"description":null,
"guid":"SAUDW4DDARAK3M5MAMCT",
"level":3,

©2022 Arena, A PTC Business www.arenasolutions.com 749

 Arena REST API Developer Guide Endpoints

"name":"Artwork",
"path":"File\\Internal File\\Artwork",
"requirements":[],
"systemDefined":false
},
{
"activated":true,
"assignable":true,
"creationDateTime":"2011-02-08T22:29:55Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"description":null,
"guid":"ASCVEMVVS9S2L4N4S4UK",
"level":3,
"name":"Assembly Specification",
"path":"File\\Internal File\\Assembly Specification",
"requirements":[],
"systemDefined":false
},
...
]
}

Get all file categories that begin with C

GET settings/files/categories?path=item\C

{
"count":1,
"results":[
{
"activated":true,
"assignable":null,
"creationDateTime":"2008-03-05T13:55:30Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"description":null,
"guid":"8F8ALDIEN3QDGOWI7V7G",
"level":2,
"name":"Confidential File",
"objectType":"FILE",
"path":"File\Confidential File",
"requirements":[],
"systemDefined":false
}
]
}

Get a single file category

©2022 Arena, A PTC Business www.arenasolutions.com 750

 Arena REST API Developer Guide Endpoints

GET settings/files/categories/9RBUZPQQZ6PZI1DL92A2

{
"activated":true,
"assignable":null,
"creationDateTime":"2008-03-05T13:56:22Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"description":null,
"guid":"9RBUZPQQZ6PZI1DL92A2",
"level":3,
"name":"CAD Data",
"objectType":"FILE",
"path":"File\Internal File\CAD Data",
"requirements":[],
"systemDefined":false
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 751

 Arena REST API Developer Guide Endpoints

GET Quality Process Templates

/settings/qualityprocesses/templates

/settings/qualityprocesses/templates/<GUID>

This returns Quality Process Templates available for Quality Processes in the workspace. Appending a GUID to
the URL returns the template with that GUID.

All Quality Processes must be created based on templates. These templates are administrator-defined and can
include Steps and Sign-Off Steps. In the response, Steps are indicated as Type=REGULAR and Sign-Off Steps
are indicated as Type=SIGNOFF.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all Quality Process Templates defined for the workspace

GET /settings/qualityprocesses/templates

{
"count":3,
"results":[
{
"active":true,

©2022 Arena, A PTC Business www.arenasolutions.com 752

 Arena REST API Developer Guide Endpoints

"creationDateTime":"2015-12-14T19:49:08Z",
"creator":{
"fullName":"Cole Agustin"
},
"defaultNumberFormat":{
"guid":"YG0J2A8OX0JSBUDWFUYM"
},
"defaultOwner":{
"fullName":"Roy Stafford",
"guid":"GY116WXX6DUDWFYHPRY3"
},
"description":"Eight Discipline (8D)",
"guid":"HZJ2LTR7GJ2YH0J2LJAP",
"name":"Eight Discipline (8D) Template",
"numberFormats":[
{
"guid":"YG0J2A8OX0JSBUDWFUYM",
"lastUsed":null,
"prefixes":[
{
"guid":"SAUDW42IRUCWFYH0JYZ4",
"value":"8D-"
}
]
}
],
"shortName":"8D",
"steps":[
{
"attributes":[
{
"guid":"I0K3MUS8HK3ZI1K3MZ01",
"name":"Team Members"
}
],
"guid":"K2M5OWUAJM51K3M5OMD8",
"name":"Form Team",
"order":1,
"type":"REGULAR"
},
{
"attributes":[
{
"guid":"J1L4NVT9IL40J2L4N01K",
"name":"Problem Description"
}
],
"guid":"L3N6PXVBKN62L4N6PNE3",
"name":"Problem Description",
"order":2,
"type":"REGULAR"
},
{
"attributes":[
{

©2022 Arena, A PTC Business www.arenasolutions.com 753

 Arena REST API Developer Guide Endpoints

"guid":"K2M5OWUAJM51K3M5O12L",
"name":"Serial Number(s) of Nonconforming Parts"
},
{
"guid":"L3N6PXVBKN62L4N6P23P",
"name":"Inventory Impact?"
},
...
],
"guid":"M4O7QYWCLO73M5O7QOFJ",
"name":"Immediate Containment",
"order":3,
"type":"REGULAR"
},
{
"attributes":[
{
"guid":"Q8SBU20GPSB7Q9SBU78L",
"name":"Possible Causes"
},
{
"guid":"R9TCV31HQTC8RATCV891",
"name":"5 Whys"
},
...
],
"guid":"N5P8RZXDMP84N6P8RPGH",
"name":"Root Cause Analysis",
"order":4,
"type":"REGULAR"
},
{
"attributes":[
{
"guid":"TBVEX53JSVEATCVEXABV",
"name":"Corrective Action"
}
],
"guid":"P7RAT1ZFORA6P8RATRHW",
"name":"Corrective Action Plans",
"order":5,
"type":"REGULAR"
},
{
"allowOwnerToAddApprovers":true,
"approvers":[
{
"fullName":"Dhana Prakash"
},
{
"fullName":"Heidi Walker"
}
],
"guid":"GNFSTNO51TW4EJ211ZCW",
"name":"Corrective Action Plan Approval",

©2022 Arena, A PTC Business www.arenasolutions.com 754

 Arena REST API Developer Guide Endpoints

"order":6,
"type":"SIGNOFF"
},
{
"attributes":[
{
"guid":"UCWFY64KTWFBUDWFYBCW",
"name":"Implemented?"
},
...
],
"guid":"Q8SBU20GPSB7Q9SBUSI4",
"name":"Implement and Verify Corrective Actions",
"order":7,
"type":"REGULAR"
},
{
"attributes":[
{
"guid":"XFZI197NWZIEXGZI1EF1",
"name":"Preventive Action"
},
{
"guid":"UCWFY64KTWFBUDWFYBCW",
"name":"Implemented?"
},
...
],
"guid":"R9TCV31HQTC8RATCVTJB",
"name":"Prevent Recurrence",
"order":8,
"type":"REGULAR"
},
{
"allowOwnerToAddApprovers":null,
"approvers":null,
"attributes":[
{
"guid":"1J3M5DBR03MI1K3M5II4",
"name":"Lessons Learned"
}
],
"guid":"SAUDW42IRUD9SBUDWUK3",
"name":"Closure and Team Celebration",
"order":9,
"type":"REGULAR"
}
]
},
...
],
"statusCode":0
}

Get a single Quality Process Template

©2022 Arena, A PTC Business www.arenasolutions.com 755

 Arena REST API Developer Guide Endpoints

GET /settings/qualityprocesses/templates/GNFSTNO51TW4EJ211ZCW

{
"active":true,
"creationDateTime":"2015-12-14T19:49:08Z",
"creator":{
"fullName":"Cole Agustin"
},
"defaultNumberFormat":{
"guid":"YG0J2A8OX0JSBUDWFUYM"
},
"defaultOwner":{
"fullName":"Roy Stafford",
"guid":"GY116WXX6DUDWFYHPRY3"
},
"description":"Eight Discipline (8D)",
"guid":"HZJ2LTR7GJ2YH0J2LJAP",
"name":"Eight Discipline (8D) Template",
"numberFormats":[
{
"guid":"YG0J2A8OX0JSBUDWFUYM",
"lastUsed":null,
"prefixes":[
{
"guid":"SAUDW42IRUCWFYH0JYZ4",
"value":"8D-"
}
]
}
],
"shortName":"8D",
"steps":[
{
"attributes":[
{
"guid":"I0K3MUS8HK3ZI1K3MZ01",
"name":"Team Members"
}
],
"guid":"K2M5OWUAJM51K3M5OMD8",
"name":"Form Team",
"order":1,
"type":"REGULAR"
},
{
"attributes":[
{
"guid":"J1L4NVT9IL40J2L4N01K",
"name":"Problem Description"
}
],
"guid":"L3N6PXVBKN62L4N6PNE3",
"name":"Problem Description",
"order":2,
"type":"REGULAR"

©2022 Arena, A PTC Business www.arenasolutions.com 756

 Arena REST API Developer Guide Endpoints

},
{
"attributes":[
{
"guid":"K2M5OWUAJM51K3M5O12L",
"name":"Serial Number(s) of Nonconforming Parts"
},
{
"guid":"L3N6PXVBKN62L4N6P23P",
"name":"Inventory Impact?"
},
...
],
"guid":"M4O7QYWCLO73M5O7QOFJ",
"name":"Immediate Containment",
"order":3,
"type":"REGULAR"
},
{
"attributes":[
{
"guid":"Q8SBU20GPSB7Q9SBU78L",
"name":"Possible Causes"
},
{
"guid":"R9TCV31HQTC8RATCV891",
"name":"5 Whys"
},
...
],
"guid":"N5P8RZXDMP84N6P8RPGH",
"name":"Root Cause Analysis",
"order":4,
"type":"REGULAR"
},
{
"attributes":[
{
"guid":"TBVEX53JSVEATCVEXABV",
"name":"Corrective Action"
}
],
"guid":"P7RAT1ZFORA6P8RATRHW",
"name":"Corrective Action Plans",
"order":5,
"type":"REGULAR"
},
{
"allowOwnerToAddApprovers":true,
"approvers":[
{
"fullName":"Dhana Prakash"
},
{
"fullName":"Heidi Walker"

©2022 Arena, A PTC Business www.arenasolutions.com 757

 Arena REST API Developer Guide Endpoints

}
],
"guid":"GNFSTNO51TW4EJ211ZCW",
"name":"Corrective Action Plan Approval",
"order":6,
"type":"SIGNOFF"
},
{
"attributes":[
{
"guid":"UCWFY64KTWFBUDWFYBCW",
"name":"Implemented?"
},
...
],
"guid":"Q8SBU20GPSB7Q9SBUSI4",
"name":"Implement and Verify Corrective Actions",
"order":7,
"type":"REGULAR"
},
{
"attributes":[
{
"guid":"XFZI197NWZIEXGZI1EF1",
"name":"Preventive Action"
},
{
"guid":"UCWFY64KTWFBUDWFYBCW",
"name":"Implemented?"
},
...
],
"guid":"R9TCV31HQTC8RATCVTJB",
"name":"Prevent Recurrence",
"order":8,
"type":"REGULAR"
},
{
"allowOwnerToAddApprovers":null,
"approvers":null,
"attributes":[
{
"guid":"1J3M5DBR03MI1K3M5II4",
"name":"Lessons Learned"
}
],
"guid":"SAUDW42IRUD9SBUDWUK3",
"name":"Closure and Team Celebration",
"order":9,
"type":"REGULAR"
}
]
}

Request with bad GUID

©2022 Arena, A PTC Business www.arenasolutions.com 758

 Arena REST API Developer Guide Endpoints

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 759

 Arena REST API Developer Guide Endpoints

GET Quality Process Number Formats

/settings/qualityprocesses/numberformats

/settings/qualityprocesses/numberformats/<GUID>

This returns Quality Process Number Formats available in the workspace. Appending a GUID to the URL returns
the number format with that GUID.

Quality Process Number Formats consist of a list of prefixes and an auto-incrementing number field.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in the response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all Quality Process number formats defined for the workspace

/settings/qualityprocesses/numberformats

{
"count":3,
"results":[
{
"creationDateTime":"2015-12-14T19:40:54Z",

©2022 Arena, A PTC Business www.arenasolutions.com 760

 Arena REST API Developer Guide Endpoints

"guid":"YG0J2A8OX0JSBUDWFUYM",
"lastUsed":"000000",
"name":"8D",
"nextValue":"000001",
"prefixes":[
{
"guid":"SAUDW42IRUCWFYH0JYZ4",
"value":"8D-"
}
]
},
{
"creationDateTime":"2015-12-14T19:40:54Z",
"guid":"ZH1K3B9PY1KTCVEXGVZ3",
"lastUsed":"000000",
"name":"CAR",
"nextValue":"000001",
"prefixes":[
{
"guid":"5N7Q9HFV47P9SBUDWBK4",
"value":"CAR-"
}
]
},
{
"creationDateTime":"2015-12-14T19:40:54Z",
"guid":"0I2L4CAQZ2LUDWFYHW0U",
"lastUsed":"000000",
"name":"NCMR",
"nextValue":"000001",
"prefixes":[
{
"value":"NCMR-",
"guid":"6O8RAIGW58QATCVEXCLD"
},
{
"value":"NCMR2-",
"guid":"7F7LWXOV17KWPAUDNCIT"
}
]
}
],
"statusCode":0
}

Get a Quality Process number format with a specific GUID

/settings/qualityprocesses/numberformats/SAUDW42IRUCWFYH0JYZ4

{
"creationDateTime":"2015-12-14T19:40:54Z",
"guid":"YG0J2A8OX0JSBUDWFUYM",
"lastUsed":"000000",
"name":"8D",
"nextValue":"000001",

©2022 Arena, A PTC Business www.arenasolutions.com 761

 Arena REST API Developer Guide Endpoints

"prefixes":[
{
"guid":"SAUDW42IRUCWFYH0JYZ4",
"value":"8D-"
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 762

 Arena REST API Developer Guide Endpoints

GET Quality Process Attributes

/settings/qualityprocesses/attributes

Returns Attributes available for the Summary view of Quality Processes.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

includePossibleValues true or false If this is set to true, it returns all the possible
values for Drop Down List attributes. The
default value is false.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all Quality Process summary attributes including possible values

GET /settings/qualityprocesses/attributes?includePossibleValues=true

©2022 Arena, A PTC Business www.arenasolutions.com 763

 Arena REST API Developer Guide Endpoints

{
"count":14,
"results":[
{
"allowsExplicitNullValue":false,
"apiName":"completedDateTime",
"creatable":false,
"editable":false,
"fieldType":"DATETIME",
"inViews":[
"QUALITY_SUMMARY"
],
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"creationDateTime",
"creatable":false,
"editable":false,
"fieldType":"DATETIME",
"inViews":[
"QUALITY_SUMMARY"
],
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"creator",
"creatable":false,
"editable":false,
"fieldType":"OBJECT",
"inViews":[
"QUALITY_SUMMARY"
],
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"currentStep",
"creatable":false,
"editable":false,
"fieldType":"OBJECT",
"inViews":[
"QUALITY_SUMMARY"
],
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"description",
"creatable":true,
"editable":true,
"fieldType":"MULTI_LINE_TEXT",
"inViews":[
"QUALITY_SUMMARY"

©2022 Arena, A PTC Business www.arenasolutions.com 764

 Arena REST API Developer Guide Endpoints

],
"maxLength":4000,
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"guid",
"creatable":false,
"editable":false,
"fieldType":"GUID",
"inViews":[
"QUALITY_SUMMARY"
],
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"name",
"creatable":true,
"editable":true,
"fieldType":"SINGLE_LINE_TEXT",
"inViews":[
"QUALITY_SUMMARY"
],
"maxLength":200,
"required":true,
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"number",
"creatable":false,
"editable":false,
"fieldType":"SINGLE_LINE_TEXT",
"inViews":[
"QUALITY_SUMMARY"
],
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"owner",
"creatable":true,
"defaultValue":"Settings/Quality/Templates/Default Owner",
"editable":true,
"fieldType":"OBJECT",
"inViews":[
"QUALITY_SUMMARY"
],
"required":false,
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"status",

©2022 Arena, A PTC Business www.arenasolutions.com 765

 Arena REST API Developer Guide Endpoints

"creatable":false,
"editable":false,
"fieldType":"FIXED_DROP_DOWN",
"inViews":[
"QUALITY_SUMMARY"
],
"possibleValues":[
"OPEN",
"COMPLETED"
],
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"statusMode",
"creatable":false,
"editable":false,
"fieldType":"FIXED_DROP_DOWN",
"inViews":[
"QUALITY_SUMMARY"
],
"possibleValues":[
"MANUAL",
"AUTOMATIC"
],
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"targetCompletionDateTime",
"creatable":true,
"editable":true,
"fieldType":"DATETIME",
"inViews":[
"QUALITY_SUMMARY"
],
"required":false,
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"template",
"creatable":true,
"editable":false,
"fieldType":"OBJECT",
"inViews":[
"QUALITY_SUMMARY"
],
"required":true,
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"type",
"creatable":true,

©2022 Arena, A PTC Business www.arenasolutions.com 766

 Arena REST API Developer Guide Endpoints

"editable":true,
"fieldType":"DROP_DOWN",
"inViews":[
"QUALITY_SUMMARY"
],
"possibleValues":[
"Critical",
"Low",
"Normal"
],
"required":false,
"searchable":true
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 767

 Arena REST API Developer Guide Endpoints

GET Quality Process Step Attributes

/settings/qualityprocesses/steps/attributes

Returns Step Attributes available for Steps in Quality Processes.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

includePossibleValues true or false If this is set to true, it returns all the possible
values for Drop Down List attributes. The
default value is false.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all Quality Process Step attributes including possible values

GET /settings/qualityprocesses/steps/attributes?includePossibleValues=true

©2022 Arena, A PTC Business www.arenasolutions.com 768

 Arena REST API Developer Guide Endpoints

{
"count":48,
"results":[
{
"active":true,
"allowsExplicitNullValue":true,
"apiName":"GYI1KS11YFWEXGZI1KF5",
"creatable":false,
"custom":true,
"defaultValue":"Why 1:\nResponse:\nWhy 2:\nResponse:\nWhy 3:\nResponse:\nWhy
4:\nResponse:\nWhy 5:\nResponse:",
"editable":true,
"fieldType":"MULTI_LINE_TEXT",
"guid":"GYI1KS11YFWEXGZI1KF5",
"name":"5 Whys",
"required":false,
"searchable":true
},
{
"active":true,
"allowsExplicitNullValue":true,
"apiName":"CUEXGOXXUBSATCVEXGAG",
"creatable":false,
"custom":true,
"editable":true,
"fieldType":"MULTI_LINE_TEXT",
"guid":"CUEXGOXXUBSATCVEXGAG",
"name":"Action",
"required":false,
"searchable":true
},
{
"active":true,
"allowsExplicitNullValue":true,
"apiName":"HZJ2LT22ZGXFYH0J2KMI",
"creatable":false,
"custom":true,
"defaultValue":"Date audit was performed eg. 1 January, 2014",
"editable":true,
"fieldType":"SINGLE_LINE_TEXT",
"guid":"HZJ2LT22ZGXFYH0J2KMI",
"name":"Audit date",
"required":false,
"searchable":true
},
{
"active":true,
"allowsExplicitNullValue":true,
"apiName":"GYI1KS11YFWEXGZI1JLW",
"creatable":false,
"custom":true,
"defaultValue":"List auditors here.",
"editable":true,
"fieldType":"SINGLE_LINE_TEXT",
"guid":"GYI1KS11YFWEXGZI1JLW",

©2022 Arena, A PTC Business www.arenasolutions.com 769

 Arena REST API Developer Guide Endpoints

"name":"Auditor (s)",
"required":false,
"searchable":true
},
{
"active":true,
"allowsExplicitNullValue":true,
"apiName":"ASCVEMVVS9Q8RATCVDGH",
"creatable":false,
"custom":true,
"defaultValue":"List controls here. If there are control documents, attach
them as affected objects below.",
"editable":true,
"fieldType":"MULTI_LINE_TEXT",
"guid":"ASCVEMVVS9Q8RATCVDGH",
"name":"Controls",
"required":false,
"searchable":true
},
...
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 770

 Arena REST API Developer Guide Endpoints

GET Quality Process Owners

/settings/qualityprocesses/owners

This returns all Quality Process Owners for a workspace.

When creating a Quality Process, if no default owner is specified for the template, you must include the GUID
of an eligible owner named in this list. Otherwise, the Create Quality Process endpoint will return an error.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all Quality Process Owners in the workspace

GET /settings/qualityprocesses/owners

{
"count":17,
"results":[
{
"fullName":"James Deckard",
"emailAddress":"[email protected]",
"guid":"BJ4T3W9KW9TEWUKEFLLN"

©2022 Arena, A PTC Business www.arenasolutions.com 771

 Arena REST API Developer Guide Endpoints

},
{
"fullName":"Heidi Walker",
"emailAddress":"[email protected]",
"guid":"BJ4T3W9KW9TEWUKEFLLN"
},
{
"fullName":"Toshiro Makamuri",
"emailAddress":"[email protected]",
"guid":"BJ4T3W9KW9TEWUKEFLLN"
},
...
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 772

 Arena REST API Developer Guide Endpoints

GET Tickets Attributes

/settings/tickets/attributes

Returns Attributes available for Tickets.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

includePossibleValues true or false If this is set to true, it returns all the possible
values for Drop Down List attributes. The
default value is false.
creatableOnly true or false If this is set to true, it returns only creatable
attributes, which are settable during
creation of an item. The default value is
false.
editableOnly true or false If this is set to true, it returns only editable
attributes, which are settable during update
of an item. The default value is false.
searchableOnly true or false If this is set to true, it returns only searchable
attributes, which are searchable when
getting items.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count

©2022 Arena, A PTC Business www.arenasolutions.com 773

 Arena REST API Developer Guide Endpoints

Name Value Description

X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all tickets attributes with possible values included

GET /settings/tickets/attributes

{
"count": 19,
"results": [
{
"active": true,
"allowsExplicitNullValue": true,
"apiName": "6O8RAN8ZMP6O7Q9SBUGT",
"creatable": true,
"custom": true,
"deleted": false,
"description": "Components",
"editable": true,
"example": "1",
"fieldType": "SINGLE_LINE_TEXT",
"global": true,
"guid": "6O8RAN8ZMP6O7Q9SBUGT",
"maxLength": 1000,
"name": "Components",
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
},
{
"active": true,
"allowsExplicitNullValue": true,
"apiName": "5N7Q9M7YLO5N6P8RATF6",
"creatable": true,
"custom": true,
"deleted": false,
"description": "Labels",
"editable": true,
"example": "1",
"fieldType": "SINGLE_LINE_TEXT",
"global": true,
"guid": "5N7Q9M7YLO5N6P8RATF6",
"maxLength": 1000,
"name": "Labels",
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
},
{

©2022 Arena, A PTC Business www.arenasolutions.com 774

 Arena REST API Developer Guide Endpoints

"active": true,
"allowsExplicitNullValue": true,
"apiName": "ASCVERC3QTASBUDWFYJ0",
"creatable": true,
"custom": true,
"deleted": false,
"description": "Reason",
"editable": true,
"example": "1",
"fieldType": "MULTI_LINE_TEXT",
"global": true,
"guid": "ASCVERC3QTASBUDWFYJ0",
"maxLength": 4000,
"name": "Reason",
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
},
...
}

©2022 Arena, A PTC Business www.arenasolutions.com 775

 Arena REST API Developer Guide Endpoints

GET Tickets Number Sequence Prefixes

/settings/tickets/numbersequenceprefixes

This returns all Tickets Number Sequences Prefixes available for the workspace.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in the response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all tickets number prefixes

GET /settings/tickets/numbersequenceprefixes

{
"count": 2,
"results": [
{
"guid": "M4O7Q3OF25LH0J2L4NWL",
"value": "DEF-"
},
{
"guid": "L3N6P2NE14KGZI1K3MVY",
"value": "REQ-"

©2022 Arena, A PTC Business www.arenasolutions.com 776

 Arena REST API Developer Guide Endpoints

}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 777

 Arena REST API Developer Guide Endpoints

GET Tickets Number Sequences

/settings/tickets/numbersequences

/settings/tickets/numbersequences/<GUID>

This returns Tickets Number Sequences available in the workspace. Appending a GUID to the URL returns the
number format with that GUID.

Tickets Number Sequences consist of a list of prefixes and an auto-incrementing number field.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in the response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all Tickets number sequences defined for the workspace

/settings/tickets/numbersequences

{
"count": 2,
"results": [
{
"creationDateTime": "2016-12-13T19:24:21Z",

©2022 Arena, A PTC Business www.arenasolutions.com 778

 Arena REST API Developer Guide Endpoints

"guid": "3L5O7K5WJM2ZI1K3M5F5",
"lastUsed": "000002",
"name": "Defects",
"nextValue": "000003",
"prefixes": [
{
"guid": "M4O7Q3OF25LH0J2L4NWL",
"value": "DEF-"
}
]
},
{
"creationDateTime": "2016-12-13T19:24:21Z",
"guid": "2K4N6J4VIL1YH0J2L4EI",
"lastUsed": "000005",
"name": "Requirements",
"nextValue": "000006",
"prefixes": [
{
"guid": "L3N6P2NE14KGZI1K3MVY",
"value": "REQ-"
}
]
}
]
}

Get a Tickets number sequences with a specific GUID

/settings/tickets/numbersequences/<GUID>

{
"creationDateTime": "2016-12-13T19:24:21Z",
"guid": "3L5O7K5WJM2ZI1K3M5F5",
"lastUsed": "000002",
"name": "Defects",
"nextValue": "000003",
"prefixes": [
{
"guid": "M4O7Q3OF25LH0J2L4NWL",
"value": "DEF-"
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 779

 Arena REST API Developer Guide Endpoints

GET Tickets Templates

/settings/tickets/templates

/settings/tickets/templates/<GUID>

Returns templates available for Tickets. Appending a GUID to the URL returns the category with that GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all ticket templates

GET /settings/tickets/templates

{
"count": 3,
"results": [
{
"active": false,
"allowUserDefinedNumber": false,
"creationDateTime": "2017-03-21T23:40:43Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",

©2022 Arena, A PTC Business www.arenasolutions.com 780

 Arena REST API Developer Guide Endpoints

"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"defaultAssignee": {
"email": "[email protected]",
"fullName": "Tony Shaftoe",
"guid": "0I2L4H2TGJ0J2L4NWMTA"
},
"defaultNumberSequence": {
"guid": "O6Q9S5QH47QZI1K3M5F4",
"name": "Defects",
"prefixes": [
{
"guid": "M4O7Q3OF25LH0J2L4NWL",
"value": "DEF-"
}
]
},
"defaultTemplate": false,
"description": "Use for all bugs",
"guid": "2K4N6J4VIL2XGZI1K138",
"name": "Bugs",
"numberSequences": [
{
"guid": "O6Q9S5QH47QZI1K3M5F4",
"name": "Defects",
"prefixes": [
{
"guid": "M4O7Q3OF25LH0J2L4NWL",
"value": "DEF-"
}
]
}
]
},
{
"active": true,
"allowUserDefinedNumber": true,
"creationDateTime": "2016-11-13T17:12:52Z",
"creator": {
"email": null,
"fullName": "Arena Solutions",
"guid": "CUEXGTE5SVCVEXGZI1K2"
},
"defaultAssignee": null,
"defaultNumberSequence": {
"guid": "O6Q9S5QH47QZI1K3M5F4",
"name": "Defects",
"prefixes": [
{
"guid": "M4O7Q3OF25LH0J2L4NWL",
"value": "DEF-"
}
]
},
"defaultTemplate": false,

©2022 Arena, A PTC Business www.arenasolutions.com 781

 Arena REST API Developer Guide Endpoints

"description": "Seeded Template for Defects",

"guid": "8QATCPA1OR83M5O7Q967",
"name": "Defects",
"numberSequences": [
{
"guid": "O6Q9S5QH47QZI1K3M5F4",
"name": "Defects",
"prefixes": [
{
"guid": "M4O7Q3OF25LH0J2L4NWL",
"value": "DEF-"
}
]
}
]
},
{
"active": true,
"allowUserDefinedNumber": true,
"creationDateTime": "2016-11-13T17:12:52Z",
"creator": {
"email": null,
"fullName": "Arena Solutions",
"guid": "CUEXGTE5SVCVEXGZI1K2"
},
"defaultAssignee": null,
"defaultNumberSequence": {
"guid": "N5P8R4PG36PYH0J2L4EY",
"name": "Requirements",
"prefixes": [
{
"guid": "L3N6P2NE14KGZI1K3MVY",
"value": "REQ-"
}
]
},
"defaultTemplate": false,
"description": "Seeded Template for Requirements",
"guid": "9RBUDQB2PS94N6P8RA7Y",
"name": "Requirements",
"numberSequences": [
{
"guid": "N5P8R4PG36PYH0J2L4EY",
"name": "Requirements",
"prefixes": [
{
"guid": "L3N6P2NE14KGZI1K3MVY",
"value": "REQ-"
}
]
}
]
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 782

 Arena REST API Developer Guide Endpoints

Get a ticket template with a specific GUID

GET /settings/tickets/templates/guid

{
"activated": true,
"assignable": true,
"creationDateTime": "2008-03-07T19:15:34Z",
"creator": {
"email": "nlx.hmlrgfolhzmviz@[email protected]",
"fullName": "Eprn )Amviz( Nzeroofh",
"guid": "VDXGZCXOBEVEXGZI1T4Q"
},
"description": "User this for Engineering changes",
"evaluatorGroupDefault": null,
"guid": "HZJ2LYJAX0JTCVAHHI66",
"level": 3,
"name": "Engineering Change Request",
"numberingSequencePrefixDefault": {
"guid": "ASCVERC3QT95O7PRDYND",
"value": "ECR-"
},
"parentCategory": {
"guid": "L3N6P2NE14NXGZELLMAW",
"name": "Change Request"
},
"path": "Request\\Change Request\\Engineering Change Request",
"structural": false,
"systemDefined": false
}

©2022 Arena, A PTC Business www.arenasolutions.com 783

 Arena REST API Developer Guide Endpoints

GET Tickets Templates Attributes

/settings/tickets/templates/<GUID>/attributes

Returns Attributes available for a Tickets template with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

includePossibleValues true or false If this is set to true, it returns all the possible values for Drop-DOwn List
attributes. The default value is false.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all attributes available for a tickets template with a given GUID including all possible values for drop-down
list attributes.

GET /settings/tickets/templates/GUID/attributes?includePossibleValues=true

{
"count": 13,
"results": [

©2022 Arena, A PTC Business www.arenasolutions.com 784

 Arena REST API Developer Guide Endpoints

{
"allowsExplicitNullValue": false,
"apiName": "guid",
"creatable": false,
"custom": false,
"editable": false,
"fieldType": "GUID",
"inViews": [
"VERIFY_SUMMARY"
],
"searchable": false
},
{
"allowsExplicitNullValue": false,
"apiName": "title",
"creatable": true,
"custom": false,
"editable": true,
"fieldType": "SINGLE_LINE_TEXT",
"inViews": [
"VERIFY_SUMMARY"
],
"required": true,
"searchable": true
},
{
"allowsExplicitNullValue": false,
"apiName": "description",
"creatable": true,
"custom": false,
"editable": true,
"fieldType": "RICH_TEXT",
"inViews": [
"VERIFY_SUMMARY"
],
"searchable": false
},
...
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 785

 Arena REST API Developer Guide Endpoints

GET Users
/settings/users

/settings/users/<GUID>

Returns an array of Users matching the given search criteria. Appending a GUID to the URL returns the user
with that GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all users
where results should begin. All users before
the offset in the search results are ignored.
The default value is 0.
limit integer Specifies the maximum number of returned
results. The default value (no specified limit)
is 20, the maximum is 400.

Searchable Attributes

Name Value Description

firstName string The first name of the user
lastName string The last name of the user
fullName string The full (first and last) name of the user
email valid email string The email address of the user
type string The user type of the user. Values can be
EMPLOYEE, PARTNER, BASIC_SUPPLIER,
ADVANCED_SUPPLIER, or INTEGRATION.
enabled boolean Whether or not a user account is enabled
in the workspace. Values are True or False.

Response Codes

Code Description
200 Success

©2022 Arena, A PTC Business www.arenasolutions.com 786

 Arena REST API Developer Guide Endpoints

Code Description
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all users

GET /settings/users

{
"count":25,
"results":[
{
"email":"[email protected]",
"enabled":true,
"firstName":"John",
"fullName":"John Smith",
"guid":"1J3MRHIIRYFYH0J258QX",
"lastName":"Smith",
"type":"EMPLOYEE"
},
{
"email":"[email protected]",
"enabled":true,
"firstName":"Vihaan",
"fullName":"Vihaan Luthra",
"guid":"8QATYOPPY5M5O7Q9C30O",
"lastName":"Luthra",
"type":"PARTNER"
},
{
"email":"[email protected]",
"enabled":true,
"firstName":"Jensen",
"fullName":"Jensen Chang",
"guid":"7IJQWBOOA8J8O2D7C20PL",
"lastName":"Chang",
"type":"ADVANCED_SUPPLIER"

©2022 Arena, A PTC Business www.arenasolutions.com 787

 Arena REST API Developer Guide Endpoints

},
...
]
}

Get all users with the string john in the fullName attribute

GET /settings/users?fullName=*john

{
"count":2,
"results":[
{
"email":"[email protected]",
"enabled":true,
"firstName":"John",
"fullName":"John Parker",
"guid":"7P9SBJSSP6N6P8RATPM6",
"lastName":"Parker",
"type":"EMPLOYEE"
},
{
"email":"[email protected]",
"enabled":true,
"firstName":"John",
"fullName":"John Welles",
"guid":"8QATCKTTQ7O7Q9SBUQNX",
"lastName":"Welles",
"type":"EMPLOYEE"
}
]
}

Get all advanced supplier users

GET /settings/users?type=ADVANCED_SUPPLIER

{
"count":2,
"results":[
{
"email":"[email protected]",
"enabled":true,
"firstName":"Robert",
"fullName":"Robert Morgan",
"guid":"8QATCTCSO1I1K3M5OKFT",
"lastName":"Morgan",
"type":"ADVANCED_SUPPLIER"
},
{
"email":"[email protected]",
"enabled":true,
"firstName":"Henry",
"fullName":"Henry Tully",
"guid":"9RBUDUDTP2J2L4N6PLGN",

©2022 Arena, A PTC Business www.arenasolutions.com 788

 Arena REST API Developer Guide Endpoints

"lastName":"Tully",
"type":"ADVANCED_SUPPLIER"
}
]
}

Get a single user

GET /settings/users/N5P8R8R73GXGZI1K3YH7

{
"email":"[email protected]",
"enabled":true,
"firstName":"Ellen",
"fullName":"Ellen Andersen",
"guid":"N5P8R8R73GXGZI1K3YH7",
"lastName":"Andersen",
"type":"EMPLOYEE"
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 789

 Arena REST API Developer Guide Endpoints

GET User Groups

/settings/usergroups

Returns an array of User Groups.

This endpoint can only be used in Access Policies enabled workspaces.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all User Groups

GET /settings/usergroups

{
"count": 6,
"results": [
{
"assignability": [
"ACCESS_POLICIES",
"CHANGES",
"QUALITY"

©2022 Arena, A PTC Business www.arenasolutions.com 790

 Arena REST API Developer Guide Endpoints

],
"creationDateTime": "2020-12-02T06:30:40Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "Limited Workspace Access to Non-Admins",
"enabled": true,
"guid": "N5P8R4PG36CZI1K3MNJE",
"lastModifiedDateTime": "2020-12-02T06:30:40Z",
"modifiedBy": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "Level 3 Partial Administrator"
},
{
"assignability": [
"CHANGES",
"QUALITY"
],
"creationDateTime": "2020-12-21T07:23:48Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": null,
"enabled": true,
"guid": "BTDWFSD4RU0N6P8RA955",
"lastModifiedDateTime": "2020-12-21T07:23:48Z",
"modifiedBy": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "Quality Assurance"
},
{
"assignability": [
"ACCESS_POLICIES"
],
"creationDateTime": "2020-12-21T17:56:29Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": null,
"enabled": true,
} "guid": "CUEXGTE5SV1O7Q9SBA60",
"lastModifiedDateTime": "2020-12-22T19:31:49Z",
"modifiedBy": {

©2022 Arena, A PTC Business www.arenasolutions.com 791

 Arena REST API Developer Guide Endpoints

"email": "[email protected]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "*Level 3 Administrator -User Group"
},
...
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 792

 Arena REST API Developer Guide Endpoints

GET User Group

/settings/usergroups/<GUID>

Returns a specific User Group with a given GUID.

This endpoint can only be used in Access Policies enabled workspaces.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a specific User Group

GET /settings/usergroups/<GUID>

{
"guid": "L3N6KHLNYFY8RAQ8SWYT",
"name": "Quality Assurance",
"description": "QA Team",
"enabled": true,
"creator": {
"email": "[email protected]",
"fullName": "Don Sullivan",

©2022 Arena, A PTC Business www.arenasolutions.com 793

 Arena REST API Developer Guide Endpoints

"guid": "K2M5JGKMXEVEXGZI1T4P"
},
"creationDateTime": "2008-03-07T19:58:40Z",
"lastModifiedDateTime": "2017-06-18T22:52:40Z",
"modifiedBy": {
"email": "[email protected]",
"fullName": "Don Sullivan",
"guid": "K2M5JGKMXEVEXGZI1T4P"
},
"assignability": ["QUALITY", "CHANGES", "POLICIES"]
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 794

 Arena REST API Developer Guide Endpoints

GET User Group Employees

/settings/usergroups/<GUID>/employees

Returns a list of employees in a specific User Group.

This endpoint can only be used in Access Policies enabled workspaces.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all employees in a User Group.

GET /settings/usergroups/<GUID>

{
"count":25,
"results":[
{
"email":"[email protected]",
"enabled":true,
"firstName":"John",
"fullName":"John Smith",

©2022 Arena, A PTC Business www.arenasolutions.com 795

 Arena REST API Developer Guide Endpoints

"guid":"1J3MRHIIRYFYH0J258QX",
"lastName":"Smith",
"type":"EMPLOYEE"
},
{
"email":"[email protected]",
"enabled":true,
"firstName":"Vihaan",
"fullName":"Vihaan Luthra",
"guid":"8QATYOPPY5M5O7Q9C30O",
"lastName":"Luthra",
"type":"EMPLOYEE"
},
{
"email":"[email protected]",
"enabled":true,
"firstName":"Jason",
"fullName":"Jason Chang",
"guid":"7IJQWBOOA8J8O2D7C20PL",
"lastName":"Chang",
"type":"EMPLOYEE"
},
...
]
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 796

 Arena REST API Developer Guide Endpoints

GET User Group Employee

/settings/usergroups/<GUID>/employees/<GUID>

Returns an employee user of a specific User Group.

This endpoint can only be used in Access Policies enabled workspaces.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get an employee user of a specific User Group

GET /settings/usergroups/<GUID>/employees/<GUID>

{
"user": {
"email": "[email protected]",
"enabled": true,
"firstName": "Joe",
"fullName": "Joe Appria",
"guid": "9RBU859BM3K3M5O7915S",
"lastName": "Appria",

©2022 Arena, A PTC Business www.arenasolutions.com 797

 Arena REST API Developer Guide Endpoints

"type": "EMPLOYEE"
}
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 798

 Arena REST API Developer Guide Endpoints

GET User Group Partners

/settings/usergroups/<GUID>/partners

Returns a list of Partners from a specific User Group.

This endpoint can only be used in Access Policies enabled workspaces.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get partner users of a specific User Group.

GET /settings/usergroups/<GUID>/partners

{
"count":25,
"results":[
{
"email":"[email protected]",
"enabled":true,
"firstName":"John",
"fullName":"John Smith",

©2022 Arena, A PTC Business www.arenasolutions.com 799

 Arena REST API Developer Guide Endpoints

"guid":"1J3MRHIIRYFYH0J258QX",
"lastName":"Smith",
"type":"PARTNER"
},
{
"email":"[email protected]",
"enabled":true,
"firstName":"Marie",
"fullName":"Marie Patel",
"guid":"8QATYOPPY5M5O7Q9C30O",
"lastName":"Patel",
"type":"PARTNER"
},
{
"email":"[email protected]",
"enabled":true,
"firstName":"Jensen",
"fullName":"Jensen Chang",
"guid":"7IJQWBOOA8J8O2D7C20PL",
"lastName":"Chang",
"type":"PARTNER"
},
...
]
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 800

 Arena REST API Developer Guide Endpoints

GET User Group Partner

/settings/usergroups/<GUID>/partners/<GUID>

Returns a Partner user of a User Group.

This endpoint can only be used in Access Policies enabled workspaces.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a specific Partner user of a specific User Group.

GET /settings/usergroups/<GUID>/partners/<GUID>

{
"user": {
"email": "[email protected]",
"enabled": true,
"firstName": "Joe",
"fullName": "Joe Patria",
"guid": "K2M5JGKMXEVEXGZI1T4P",
"lastName": "Partner",

©2022 Arena, A PTC Business www.arenasolutions.com 801

 Arena REST API Developer Guide Endpoints

"type": "PARTNER"
}
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 802

 Arena REST API Developer Guide Endpoints

GET User Group Users

/settings/usergroups/<GUID>/users

Returns users of a specific User Group.

This endpoint can only be used in Access Policies enabled workspaces.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all users in a specific User Group.

GET /settings/usergroups/<GUID>/users

{
"count": 2,
"results": [
{
"email": "[email protected]",
"enabled": false,
"firstName": "Jackie",
"fullName": "Jackie Welles",

©2022 Arena, A PTC Business www.arenasolutions.com 803

 Arena REST API Developer Guide Endpoints

"guid": "GYI1KSQSFEVEXGZI007P",
"lastName": "Welles",
"type": "EMPLOYEE"
},
{
"email": "[email protected]",
"enabled": false,
"firstName": "Marie",
"fullName": "Marie DeShawn",
"guid": "EWGZIQOQDCTCVEXGZOZL",
"lastName": "DeShawn",
"type": "PARTNER"
}
]
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 804

 Arena REST API Developer Guide Endpoints

GET User Group User

/settings/usergroups/<GUID>/users/<GUID>

Returns a specific user of a specific User Group.

This endpoint can only be used in Access Policies enabled workspaces.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a user of a specific User Group.

GET /settings/usergroups/<GUID>/users/<GUID>

{
"email": "[email protected]",
"enabled": true,
"firstName": "Judy",
"fullName": "Judy Herrera",
"guid": "XFZI1979WVCVEXGZI9IT",
"lastName": "Herrera",

©2022 Arena, A PTC Business www.arenasolutions.com 805

 Arena REST API Developer Guide Endpoints

"type": "PARTNER"
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 806

 Arena REST API Developer Guide Endpoints

GET Suppliers
/suppliers

Returns a collection of Supplier objects matching the given search criteria.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all
suppliers where results should begin. All
suppliers before the offset in the search
results are ignored. The default value is 0.
limit integer Specifies the number of results that should
be returned. By default the maximum
number of suppliers is 20. Can return up
400 suppliers.

Searchable Attributes

Name Value Description

[additional attribute guid value] string This special search permits searching for
strings in additional attribute values. For
example GET
/items?VDXGZ7E0GO5N6P8PR55G=*100pF
where VDXGZ7E0GO5N6P8PR55G is the
GUID of a custom attribute and we are
searching for all items whose value for this
attribute include the string "100pF". The
ability to search for more than one value is
available for the following attribute field
types: DROP_DOWN & FIXED_DROPDOWN.
See note below this table for additional
details.

Additional attributes, also known as custom

attributes, support the date field type. Users
can perform searches by additional
attributes with a date field type by using
the format yyyy-mm-dd. In the following

©2022 Arena, A PTC Business www.arenasolutions.com 807

 Arena REST API Developer Guide Endpoints

Name Value Description

example, the user is using the following to
search for a date field type custom attribute
with a value of April 1, 2019:

GET
/suppliers?UCWFY6FFCTCI1K3B82OC=2019-04-01
name string supplier name
supplierId string The unique identifier of a supplier in the
Arena database

Note: Search behavior in the Arena REST API differs from search behavior in the Arena application. In the API, a
trailing asterisk (wildcard) is required to return results that start with a string; in the Arena application, a trailing
asterisk is always implied.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all suppliers whose name includes the string "board"

/suppliers?name=*board

{
"count":2,
"results":[
{
"accountNumber":null,
"addresses":null,
"approvalStatus":"unrated",
"creationDateTime":"2011-02-11T17:13:07Z",

©2022 Arena, A PTC Business www.arenasolutions.com 808

 Arena REST API Developer Guide Endpoints

"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker"
},
"description":"Full service board supplier",
"guid":"YG0J2AJJGXGM5O7FOOG1",
"name":"Adaptive Circuit Boards",
"phoneNumbers":null,
"supplierId":"Adaptive",
"website":"www.zombo.com"
},
{
"accountNumber":"1",
"addresses":null,
"approvalStatus":"approved",
"creationDateTime":"2018-04-27T00:18:52Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker"
},
"description":"Board house",
"guid":"UCWFY6FFCTCI1K3B82OC",
"name":"The Board Room",
"phoneNumbers":null,
"supplierId":"theboardroominc,
"website":"www.zombo.com"
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 809

 Arena REST API Developer Guide Endpoints

GET Supplier (Profile)

/suppliers/<GUID>

Returns a Supplier object with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a supplier with a given GUID

/suppliers/<GUID>

{
"accountNumber":"1",
"additionalAttributes":[
{
"apiName":"custom1411225",
"fieldType":"DATE",
"guid":"HZJ2LT22ZGXFYH0J8J6T",
"name":"Re-Evaluate On",
"value":"2019-01-01T07:59:59Z"
},

©2022 Arena, A PTC Business www.arenasolutions.com 810

 Arena REST API Developer Guide Endpoints

{
"apiName":"custom1411226",
"fieldType":"FIXED_DROP_DOWN",
"guid":"I0K3MU330HYGZI1K9K72",
"name":"At-Risk Supplier?",
"value":"Yes"
},
{
"apiName":"custom1411227",
"fieldType":"DROP_DOWN",
"guid":"J1L4NV441IZH0J2LAL8A",
"name":"Product Line",
"value":"Persephone"
},
{
"apiName":"custom1411228",
"fieldType":"MULTI_LINE_TEXT",
"guid":"K2M5OW552J0I1K3MBM9V",
"name":"Internal reviews",
"value":"Good results. Good shipping."
}
],
"addresses":[
{
"address":{
"address1":"1 Main St",
"address2":"Box 100",
"city":"San Bruno",
"country":"United States",
"label":"hq",
"postalCode":"94066",
"province":null,
"state":"CALIFORNIA"
},
"primary":true
}
],
"approvalStatus":"approved",
"creationDateTime":"2018-04-27T00:18:52Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker"
},
"description":"Board house",
"guid":"UCWFY6FFCTCI1K3B82OC",
"name":"The Board Room",
"phoneNumbers":[
{
"comment":null,
"extension":null,
"label":"Main",
"number":"111-111-1111"
},
{
"comment":null,

©2022 Arena, A PTC Business www.arenasolutions.com 811

 Arena REST API Developer Guide Endpoints

"extension":null,
"label":"Fax",
"number":"111-111-1110"
}
],
"supplierId":"atrisksupplier",
"website":"www.zombo.com"
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 812

 Arena REST API Developer Guide Endpoints

POST Supplier Create

/suppliers

Creates a new Supplier object.

NOTES:

1. The values you specify for attributes must match the attribute types specified in the workspace. For example,
when specifying a value for a predefined list, the value must be one of the allowed values.

2. Number values must appear in quotation marks.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"accountNumber":"1",
"additionalAttributes":[
{
"guid":"I0K3MU330HYGZI1K9K72",
"value":"Yes"
},
{
"guid":"K2M5OW552J0I1K3MBM9V",
"value":"Good results. Good shipping."
},
{
"guid":"J1L4NV441IZH0J2LAL8A",
"value":"Persephone"
},
{
"guid":"HZJ2LT22ZGXFYH0J8J6T",
"value":"2019-01-01T06:59:59Z"
},
{
"guid":"9RBUZPLU2XEWFYHUORWT",
"value":"2018-03-21T22:40:10Z"
}
],
"addresses":[
{
"primary":true,
"address":{
"label":"HQ",
"address1":"1 Main St",
"address2":"Box 100",

©2022 Arena, A PTC Business www.arenasolutions.com 813

 Arena REST API Developer Guide Endpoints

"city":"San Bruno",
"state":"California",
"province":"",
"postalCode":"94066",
"country":"United States"
}
}
],
"approvalStatus":"approved",
"description":"Board house",
"name":"The Board Room",
"phoneNumbers":[
{
"number":"111-111-1111",
"label":"Main"
},
{
"number":"111-111-1110",
"label":"Fax"
}
],
"supplierId":"theboardroominc",
"website":"www.zombo.com"
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Create a new supplier

/suppliers

©2022 Arena, A PTC Business www.arenasolutions.com 814

 Arena REST API Developer Guide Endpoints

{
"accountNumber":"1",
"additionalAttributes":[
{
"apiName":"custom1411225",
"fieldType":"DATE",
"guid":"HZJ2LT22ZGXFYH0J8J6T",
"name":"Re-Evaluate On",
"value":"2019-01-01T07:59:59Z"
},
{
"apiName":"custom1411226",
"fieldType":"FIXED_DROP_DOWN",
"guid":"I0K3MU330HYGZI1K9K72",
"name":"At-Risk Supplier?",
"value":"Yes"
},
{
"apiName":"custom1411227",
"fieldType":"DROP_DOWN",
"guid":"J1L4NV441IZH0J2LAL8A",
"name":"Product Line",
"value":"Persephone"
},
{
"apiName":"custom1411228",
"fieldType":"MULTI_LINE_TEXT",
"guid":"K2M5OW552J0I1K3MBM9V",
"name":"Internal reviews",
"value":"Good results. Good shipping."
}
],
"addresses":[
{
"address":{
"address1":"1 Main St",
"address2":"Box 100",
"city":"San Bruno",
"country":"United States",
"label":"hq",
"postalCode":"94066",
"province":null,
"state":"CALIFORNIA"
},
"primary":true
}
],
"approvalStatus":"approved",
"creationDateTime":"2018-04-27T00:18:52Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker"
},
"description":"Board house",
"guid":"UCWFY6FFCTCI1K3B82OC",

©2022 Arena, A PTC Business www.arenasolutions.com 815

 Arena REST API Developer Guide Endpoints

"name":"The Board Room",

"phoneNumbers":[
{
"comment":null,
"extension":null,
"label":"Main",
"number":"111-111-1111"
},
{
"comment":null,
"extension":null,
"label":"Fax",
"number":"111-111-1110"
}
],
"supplierId": "theboardroominc",
"website":"www.zombo.com"
}

Request with invalid country or state

{
"status":400,
"errors":[
{
"code":3045,
"message":"The country or state is invalid for the supplier address."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 816

 Arena REST API Developer Guide Endpoints

PUT Supplier Update

/suppliers/<GUID>

Updates the metadata of a supplier with a given GUID. To update values for additional attributes, first retrieve
the GUID of each attribute using the GET Supplier Item endpoint. Updated values must be valid for the attribute.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"additionalAttributes":[
{
"guid":"I0K3MU330HYGZI1K9K72",
"value":"No"
},
{
"guid":"K2M5OW552J0I1K3MBM9V",
"value":"Failed to meet deadline."
},
{
"guid":"J1L4NV441IZH0J2LAL8A",
"value":"Hades"
},
{
"guid":"HZJ2LT22ZGXFYH0J8J6T",
"value":"2019-02-01T06:59:59Z"
}
],
"accountNumber":"1",
"addresses":[
{
"primary":true,
"address":{
"label":"HQ",
"address1":"1 Main St",
"address2":"Box 100",
"city":"San Bruno",
"state":"California",
"province":"",
"postalCode":"94066",
"country":"United States"
}
},
{
"primary":false,
"address":{

©2022 Arena, A PTC Business www.arenasolutions.com 817

 Arena REST API Developer Guide Endpoints

"label":"sales",
"address1":"1313 Mockingbird Lane",
"city":"Smalltown",
"state":"New York",
"province":"",
"postalCode":"01234",
"country":"United States"
}
}
],
"approvalStatus":"approved",
"description":"Full service board house",
"name":"The Board Room",
"phoneNumbers":[
{
"number":"111-111-1111",
"label":"Main"
},
{
"number":"111-111-1110",
"label":"Fax"
}
],
"supplierId": "theboardroomllc",
"website":"www.zombo.com"
}

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Update the metadata for a supplier

©2022 Arena, A PTC Business www.arenasolutions.com 818

 Arena REST API Developer Guide Endpoints

/suppliers/<GUID>

{
"accountNumber":"1",
"additionalAttributes":[
{
"apiName":"custom1411225",
"fieldType":"DATE",
"guid":"HZJ2LT22ZGXFYH0J8J6T",
"name":"Re-Evaluate On",
"value":"2019-02-01T06:59:59Z"
},
{
"apiName":"custom1411226",
"fieldType":"FIXED_DROP_DOWN",
"guid":"I0K3MU330HYGZI1K9K72",
"name":"At-Risk Supplier?",
"value":"No"
},
{
"apiName":"custom1411227",
"fieldType":"DROP_DOWN",
"guid":"J1L4NV441IZH0J2LAL8A",
"name":"Product Line",
"value":"Hades"
},
{
"apiName":"custom1411228",
"fieldType":"MULTI_LINE_TEXT",
"guid":"K2M5OW552J0I1K3MBM9V",
"name":"Internal reviews",
"value":"Failed to meet deadline."
}
],
"addresses":[
{
"address":{
"address1":"1 Main St",
"address2":"Box 100",
"city":"San Bruno",
"country":"United States",
"label":"hq",
"postalCode":"94066",
"province":null,
"state":"CALIFORNIA"
},
"primary":true
},
{
"address":{
"label":"sales",
"address1":"1313 Mockingbird Lane",
"city":"Smalltown",
"state":"New York",
"province":"",

©2022 Arena, A PTC Business www.arenasolutions.com 819

 Arena REST API Developer Guide Endpoints

"postalCode":"01234",
"country":"United States"
},
"primary":false
}
],
"approvalStatus":"approved",
"creationDateTime":"2018-04-27T00:18:52Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker"
},
"description":"Full service board house",
"guid":"UCWFY6FFCTCI1K3B82OC",
"name":"The Board Room",
"phoneNumbers":[
{
"comment":null,
"extension":null,
"label":"Main",
"number":"111-111-1111"
},
{
"comment":null,
"extension":null,
"label":"Fax",
"number":"111-111-1110"
}
],
"supplierId":"theboardroomllc",
"website":"www.zombo.com"
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 820

 Arena REST API Developer Guide Endpoints

DELETE Supplier
/suppliers/<GUID>

Deletes a supplier with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response

Returns an error if the GUID is not valid

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 821

 Arena REST API Developer Guide Endpoints

GET Supplier Address

/suppliers/<GUID>/addresses/<GUID>

Returns a specific address with a given GUID of a Supplier object with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get the address with a given GUID of a supplier with a given GUID

/suppliers/<GUID>/addresses/<GUID>

{
"address": {
"address1": "459 Embarcadero",
"address2": null,
"city": "San Francisco",
"country": "United States",
"guid": "5N7Q9M7YLOZ3M5GLXZ0K",
"label": "SF Office",
"postalCode": "94003",
"province": null,

©2022 Arena, A PTC Business www.arenasolutions.com 822

 Arena REST API Developer Guide Endpoints

"state": "CALIFORNIA"
},
"primary": false
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 823

 Arena REST API Developer Guide Endpoints

GET Supplier Addresses

/suppliers/<GUID>/addresses

Returns the addresses a Supplier object with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get the addresses of a supplier with a given GUID

/suppliers/<GUID>/addresses

{
"count": 2,
"results": [
{
"address": {
"address1": "459 Embarcadero",
"address2": null,
"city": "San Francisco",
"country": "United States",
"guid": "5N7Q9M7YLOZ3M5GLXZ0K",

©2022 Arena, A PTC Business www.arenasolutions.com 824

 Arena REST API Developer Guide Endpoints

"label": "SF Office",

"postalCode": "94003",
"province": null,
"state": "CALIFORNIA"
},
"primary": false
},
{
"address": {
"address1": "No.37 Xiangyang Rd.",
"address2": null,
"city": "Taipei City",
"country": "Taiwan",
"guid": "ZH1K3G1SFITXGZBRWP1K",
"label": "main",
"postalCode": "100",
"province": null,
"state": null
},
"primary": false
}
]
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 825

 Arena REST API Developer Guide Endpoints

GET Supplier Profile Phone Numbers

/suppliers/<GUID>/phonenumbers

Returns the phone numbers of a Supplier object with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Retrieves he phone numbers of a supplier with a given GUID

/suppliers/<GUID>/phonenumbers

{
"count": 3,
"results": [
{
"comment": null,
"extension": null,
"guid": "6O8RAN8ZMP02L4DEIMG2",
"label": "main",
"number": "+886-2-2332-4239"
},

©2022 Arena, A PTC Business www.arenasolutions.com 826

 Arena REST API Developer Guide Endpoints

{
"comment": null,
"extension": null,
"guid": "8QATCPA1OR24N6FGKOHB",
"label": "fax",
"number": "+886-2-2391-5143"
},
{
"comment": "SF Regional Office",
"extension": "x2289",
"guid": "8QATCPA1OR24N6DFIPX3",
"label": "main",
"number": "415-968-3232"
}
]
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 827

 Arena REST API Developer Guide Endpoints

GET Supplier Phone Number

/suppliers/<GUID>/phonenumbers/<GUID>

Returns a specific phone number with a given GUID of a Supplier object with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a specific phone number with a given GUID of a supplier with a given GUID

/suppliers/<GUID>/phonenumbers/<GUID>

{
"comment": "Rosalind Noyles",
"extension": "x2490"
"guid": "0I2L4CC150GZI1KTEM6N"
"label": "Main",
"number": "408-946-3581"
}

Request with bad GUID

©2022 Arena, A PTC Business www.arenasolutions.com 828

 Arena REST API Developer Guide Endpoints

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 829

 Arena REST API Developer Guide Endpoints

POST Supplier Profile Address Create

/suppliers/<GUID>/addresses

Creates new addresses for a Supplier object.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"address": {
"address1": "1738 Lundy Ave.",
"address2": null,
"city": "San Jose",
"country": "United States",
"label": "Main",
"postalCode": "95131",
"province": null,
"state": "CALIFORNIA"
},
"primary": false
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 830

 Arena REST API Developer Guide Endpoints

Sample Response Body

Create a new supplier address.

/suppliers/<GUID>/addresses

{
"address": {
"address1": "1738 Lundy Ave.",
"address2": null,
"city": "San Jose",
"country": "United States",
"guid": "0I2L4CLLIZISBUDUIUI4"
"label": "Main",
"postalCode": "95131",
"province": null,
"state": "CALIFORNIA"
},
"primary": false
}

Request with invalid country or state

{
"status":400,
"errors":[
{
"code":3045,
"message":"The country or state is invalid for the supplier address."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 831

 Arena REST API Developer Guide Endpoints

POST Supplier Phone Number Create

/suppliers/<GUID>/phonenumbers

Creates a new phone number for a Supplier object.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"comment": "Rosalind Noyles",
"extension": "x2490",
"label": "Main",
"number": "408-946-3581"
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Create a new supplier phone number.

/suppliers/<GUID>/phonenumbers

©2022 Arena, A PTC Business www.arenasolutions.com 832

 Arena REST API Developer Guide Endpoints

{
"comment": "Rosalind Noyles",
"extension": "x2490"
"guid": "0I2L4CC150GZI1KTEM6N"
"label": "Main",
"number": "408-946-3581"
}

©2022 Arena, A PTC Business www.arenasolutions.com 833

 Arena REST API Developer Guide Endpoints

PUT Supplier Profile Address Edit

/suppliers/<GUID>/addresses/<GUID>

Updates an existing specific phone numbers of a supplier with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"address": {
"address1": "2222 South 48th St",
"address2": null,
"city": "Phoenix",
"country": "United States",
"label": "Main",
"postalCode": "85034",
"province": null,
"state": "ARIZONA"
},
"primary": false
}

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 834

 Arena REST API Developer Guide Endpoints

Sample Response Body

Updates a specific address for a supplier.

/suppliers/<GUID>/addresses/<GUID>

{
"address": {
"address1": "2222 South 48th St",
"address2": null,
"city": "Phoenix",
"country": "United States",
"guid": "ZH1JUUK1WRASBUDQT110",
"label": "Main",
"postalCode": "85034",
"province": null,
"state": "ARIZONA"
},
"primary": false
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 835

 Arena REST API Developer Guide Endpoints

PUT Supplier Phone Number Edit

/suppliers/<GUID>/phonenumbers/<GUID>

Updates the existing phone numbers of a supplier with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"comment": "Priya Chang",
"extension": "x3910",
"label": "Main Researcher",
"number": "512-746-3781"
}

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Update a specific phone number of a supplier.

/suppliers/<GUID>/phonenumbers/<GUID>

©2022 Arena, A PTC Business www.arenasolutions.com 836

 Arena REST API Developer Guide Endpoints

{
"comment": "Priya Chang",
"extension": "x3910",
"guid":"I0K3MU330HYGZI1K9K72",
"label": "Main Researcher",
"number": "512-746-3781"
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 837

 Arena REST API Developer Guide Endpoints

DELETE Supplier Address

/suppliers/<GUID>/addresses/<GUID>

Deletes a specific Supplier address with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response

Returns an error if the GUID is not valid

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 838

 Arena REST API Developer Guide Endpoints

DELETE Supplier Phone Number

/suppliers/<GUID>/phonenumbers/<GUID>

Deletes a specific Supplier phone number with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response

Returns an error if the GUID is not valid

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 839

 Arena REST API Developer Guide Endpoints

GET Supplier File Associations

/Supplier/<GUID>/files

Returns a collection of File objects belonging to a Supplier with a given GUID. To return a specific File association
for an Item, append the GUID of the association.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

GET all files associated with a Supplier

GET /suppliers/VDXGZ7GGDUDUDRYLY132/files

{
"count": 2,
"results": [
{
"file": {
"author": {
"fullName": "Yvette Keller"
},
"category": {

©2022 Arena, A PTC Business www.arenasolutions.com 840

 Arena REST API Developer Guide Endpoints

"guid": "7P9SBO90NQ9J2L0778VN"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2011-07-05T23:25:38Z",
"description": null,
"edition": "1",
"format": "pdf",
"guid": "FXH0JWH8VYHXGZ2TFLZS",
"hasMarkup": false,
"lastModifiedDateTime": "2011-07-05T23:26:08Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/pdf",
"name": "RoHS Certificate of Compliance 2.pdf",
"number": "FILE-000942",
"private": false,
"size": 29846,
"storageMethodName": "FILE",
"title": "RoHS Certificate of Compliance"
},
"guid": "9RBUDQB2PS9H0J0S5FOB"
},
{
"file": {
"author": {
"fullName": "Kathy Davies"
},
"category": {
"guid": "CUEXGTE5SVEO7Q5CCD07"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2011-06-16T21:36:24Z",
"description": "Rendered and color from 20-0002 base drawing",
"edition": "2",
"format": "png",
"guid": "CUEXGTE5SVEUDWZQCIWW",
"hasMarkup": false,
"lastModifiedDateTime": "2011-06-16T21:36:24Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "image/x-png",
"name": "EveryRoad Render4.png",
"number": "FILE-000875",
"private": false,
"size": 74607,
"storageMethodName": "FILE",
"title": "EveryRoad GPS Car Navigation Unit - Model 300, Rendering"
},
"guid": "ASCVERC3QTAI1K1T6GP6"
},
...

©2022 Arena, A PTC Business www.arenasolutions.com 841

 Arena REST API Developer Guide Endpoints

]
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 842

 Arena REST API Developer Guide Endpoints

GET Supplier File Association

/suppliers/<GUID>/files/<GUID>

Returns a Supplier File association object with a given GUID belonging to an item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

GET a specific file associated with a Supplier.

GET /suppliers/QDXGZ7GGDUDUDRYLY138/files/9L5O7FOOL2LXGZIY5X2Z

{
"file":{
"author":{
"fullName":"George C Lewis"
},
"category":{
"guid":"Z9O7QY5R7FY8RATAYWBF",
"name":"Design Drawing",
"path":"File\\Engineering\\Model File"
},

©2022 Arena, A PTC Business www.arenasolutions.com 843

 Arena REST API Developer Guide Endpoints

"checkedOut": false,
"creationDateTime":"2011-02-11T17:54:40Z",
"description":null,
"edition":"1",
"format":"pdf",
"guid":"VDXGZ7GGDUDTCVENSKLI",
"hasMarkup":false,
"lastModifiedDateTime":"2011-02-12T01:54:40Z",
"latest":true,
"location":null,
"locked":true,
"mimeType":"application/pdf",
"name":"EveryRoad PCBA Model 500.pdf",
"number":"FILE-000059",
"private":false,
"size":416233,
"smartLink":"https://files.sand.bom.com:8041/p/ Q7Q6-P8RA-QO30-O53P-SCDY-CYF3",

"storageMethod":0,
"storageMethodName":"FILE",
"title":"EveryRoad PCBA Model 500"
},
"guid":"3L5O7FOOL2LXGZIY5X2M",
"latestEditionAssociation":true,
"primary":true
}

Produces an error if the GUID is not valid.

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 844

 Arena REST API Developer Guide Endpoints

POST Supplier File Add Existing

/suppliers/<GUID>/files

Associates an existing File Association object with an Supplier with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Sample Request Body

{
"file": {
"guid": "5N7Q9M7YLO7N6PSJ5BPC"
}
}

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Associate an existing file with a Supplier.

/suppliers/<GUID>/files

{
"file": {

©2022 Arena, A PTC Business www.arenasolutions.com 845

 Arena REST API Developer Guide Endpoints

"author": {
"fullName": "Helen Shaughnessy"
},
"category": {
"guid": "3L5O7K5WJM5FYHW334R7"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2011-06-02T19:30:28Z",
"description": "Datasheet for BASF Terluran GP-22 ABS",
"edition": "1",
"format": "pdf",
"guid": "5N7Q9M7YLO7N6PSJ5BPC",
"hasMarkup": false,
"lastModifiedDateTime": "2011-06-02T19:30:28Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/pdf",
"name": "BASF Terluran GP-22 (ABS) Datasheet.pdf",
"number": "FILE-000888",
"private": false,
"size": 35086,
"storageMethodName": "FILE",
"title": "BASF Terluran GP-22 (ABS) Datasheet"
},
"guid": "BTDWFSD4RUBJ2L2U7HQD"
}

An error is returned if:

1. The GUID is not valid.

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 846

 Arena REST API Developer Guide Endpoints

DELETE Supplier File Association

/suppliers/<GUID>/files/<GUID>

Removes a File association from a Supplier with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response.

Produces an error if the requested file association does not exist.

{
"status": 400,
"errors": [
{
"code": 3029,
"message": "The file association does not exist between object
\"Q8SBG6CHGDWDWB7W8EJG\" and object \"EWGZ4U0541K0J2TJSQGG\"."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 847

 Arena REST API Developer Guide Endpoints

DELETE Supplier File

suppliers/<GUID>/files/<GUID>

Deletes a File associated to a specific Supplier.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response.

Request with bad GUID

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 848

 Arena REST API Developer Guide Endpoints

GET Supplier Quality Processes

GET /suppliers/<GUID>/quality

GET /suppliers/<GUID>/quality/<GUID>

Returns a collection of Quality Process objects for a supplier with a given GUID (all Quality Processes in which
the Supplier is an affected object).

If the endpoint is apprended with a valid GUID, it returns a specific Quality Process and the step information
where the specified Supplier has been added as an affected object.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get quality processes for a supplier

GET /suppliers/<GUID>/quality

{
"count":1,
"results":[
{

©2022 Arena, A PTC Business www.arenasolutions.com 849

 Arena REST API Developer Guide Endpoints

"guid":"3L5OTIZD0J0GZI1KTNOH",
"notes":"Trilby fabricates the bezels. Jensen Chang is our contact there",
"qualityProcess":{
"guid":"K2M5AZC4QSB7Q9SBK8IN",
"name":"Everyroad bezels melted/burned",
"number":"SCAR-000003",
"step":{
"guid":"ASCV0P2UGI1XGZI1AYAF",
"name":"Root Cause Analysis"
},
"type":"Compliance"
}
}
]
}

Gets a specific Quality Process (and specific step information) where the specified Supplier has been added as
an affected object.

GET /suppliers/<GUID>/quality/<GUID>

{
"guid": "YG0J2F0REHZATCVDR9KV",
"notes": null,
"qualityProcess": {
"guid": "M4O7Q3OF25OK3M5OHUQ2",
"name": "Manufacturing flaws on 175-00001 boards",
"number": "CAR-000007",
"step": {
"guid": "N5P8R4PG36PL4N6PIVRR",
"name": "Problem Description"
},
"type": null
}
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 850

 Arena REST API Developer Guide Endpoints

GET Supplier Items

/supplieritems

Returns an array of Supplier Item objects matching the given search criteria.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all
supplier items where results should begin.
All supplier items before the offset in the
search results are ignored. The default value
is 0.
limit integer Specifies the number of results that should
be returned. By default the maximum
number of supplier items is 20. Can return
up 400 supplier items.

Searchable Attributes

Name Value Description

[additional attribute guid value] string This special search permits searching for
strings in additional attribute values. For
example GET
/items?VDXGZ7E0GO5N6P8PR55G=*100pF
where VDXGZ7E0GO5N6P8PR55G is the
GUID of a custom attribute and we are
searching for all items whose value for this
attribute include the string "100pF". The
ability to search for more than one value is
available for the following attribute field
types: DROP_DOWN & FIXED_DROPDOWN.
See note below this table for additional
details.

Additional attributes, also known as custom

attributes, support the date field type. Users
can perform searches by additional
attributes with a date field type by using

©2022 Arena, A PTC Business www.arenasolutions.com 851

 Arena REST API Developer Guide Endpoints

Name Value Description

the format yyyy-mm-dd. In the following
example, the user is using the following to
search for a date field type custom attribute
with a value of April 1, 2019:

GET
/supplieritems?HZJ2LT22ZGZ5O7QY77YO=2019-04-01
name string supplier item name
number true or false supplier item number
supplier.name string supplier name
supplier.guid string supplier unique identifier

Note: Search behavior in the Arena REST API differs from search behavior in the Arena application. In the API, a
trailing asterisk (wildcard) is required to return results that start with a string; in the Arena application, a trailing
asterisk is always implied.

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all supplier items where the name includes "capacitor"

/supplieritems?name=*capacitor

{
"count":20,
"results":[
{
"creationDateTime":"2011-02-11T17:13:08Z",

©2022 Arena, A PTC Business www.arenasolutions.com 852

 Arena REST API Developer Guide Endpoints

"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker"
},
"description":null,
"guid":"GYI1KS11YFY3M5OVMVS1",
"name":"Capacitor; Ceramic",
"number":"CC1206KKX7R7BB10",
"offTheShelf":true,
"supplier":{
"guid":"K2M5OW552J28RAT1AA1X"
},
"type":"PART",
"uom":"each"
},
{
"creationDateTime":"2011-02-11T17:13:09Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker"
},
"description":null,
"guid":"ASCVEMVVS9SXGZIPGPK7",
"name":"Capacitor; Ceramic",
"number":"NMC0603X7R103K50TRPF",
"offTheShelf":true,
"supplier":{
"guid":"HZJ2LT22ZGZ5O7QY77YO"
},
"type":"PART",
"uom":"each"
},
...
]
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 853

 Arena REST API Developer Guide Endpoints

GET Supplier Item Specs

/supplieritems/<GUID>

Returns a Supplier Item object with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a supplier item with a given GUID

/supplieritems/<GUID>

{
"additionalAttributes":[
{
"apiName":"custom903623",
"fieldType":"DROP_DOWN",
"guid":"L3N6PX663K1J2L4NNT4Z",
"name":"First Article Tester",
"value":"John Parker"
},
{

©2022 Arena, A PTC Business www.arenasolutions.com 854

 Arena REST API Developer Guide Endpoints

"apiName":"custom903621",
"fieldType":"MULTI_LINE_TEXT",
"guid":"J1L4NV441IZH0J2LLR20",
"name":"Notes",
"value":"FXH0JR00XEX3M5OW55VA"
},
{
"apiName":"custom903622",
"fieldType":"NUMBER",
"guid":"K2M5OW552J0I1K3MMS3M",
"name":"Stock EOQ",
"value":100
}
],
"creationDateTime":"2011-02-11T17:13:11Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker"
},
"description":null,
"guid":"I0K3MU330H05O7QXOXQY",
"name":"Logic Output Photo Detector",
"number":"SFH5110-40",
"offTheShelf":true,
"supplier":{
"guid":"FXH0JR00XEX3M5OW55VA"
},
"type":"PART",
"uom":"each"
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 855

 Arena REST API Developer Guide Endpoints

POST Supplier Item Create

/supplieritems

Creates a new Supplier Item object.

NOTES:

1. The values you specify for attributes must match the attribute types specified in the workspace. For example,
when specifying a value for a predefined list, the value must be one of the allowed values.

2. Number values must appear in quotation marks.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"additionalAttributes":[
{
"guid":"ZH1K3BKKHYFXGZI118BV",
"value":"No"
},
{
"guid":"2K4N6ENNK1I0J2L44BET",
"value":"Testing Lead"
},
{
"guid":"0I2L4CLLIZGYH0J229CD",
"value":"Always check for stock"
},
{
"guid":"YG0J2AJJGXEWFYH007AO",
"value":"2019-01-01T06:59:59Z"
},
{
"guid":"1J3M5DMMJ0HZI1K33ADK",
"value":"100"
}
],
"description":"Rear board crescent moon",
"name":"Rear board crescent moon",
"number":"BHM-27B6",
"offTheShelf":true,
"supplier":{
"guid":"UCWFY6FFCTCI1K3B82OC"
},

©2022 Arena, A PTC Business www.arenasolutions.com 856

 Arena REST API Developer Guide Endpoints

"uom":"each"
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Create a new supplier item

/supplieritems

{
"additionalAttributes": [
{
"apiName": "custom902625",
"fieldType": "DROP_DOWN",
"guid": "2K4N6ENNK1I0J2L44BET",
"name": "First Article Tester",
"value": "Testing Lead"
},
{
"apiName": "custom902622",
"fieldType": "FIXED_DROP_DOWN",
"guid": "ZH1K3BKKHYFXGZI118BV",
"name": "Compliance Risk?",
"value": "No"
},
{
"apiName": "custom902623",
"fieldType": "MULTI_LINE_TEXT",
"guid": "0I2L4CLLIZGYH0J229CD",
"name": "Notes",
"value": "Always check for stock"

©2022 Arena, A PTC Business www.arenasolutions.com 857

 Arena REST API Developer Guide Endpoints

},
{
"apiName": "custom902624",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "1J3M5DMMJ0HZI1K33ADK",
"name": "Stock EOQ",
"value": "100"
},
{
"apiName": "custom902621",
"fieldType": "DATE",
"guid": "YG0J2AJJGXEWFYH007AO",
"name": "Re-Evaluate On",
"value": "2019-01-01T07:59:59Z"
}
],
"creationDateTime": "2018-04-27T22:55:36Z",
"creator": {
"email": "[email protected]",
"fullName": "Heidi Walker"
},
"description": "Rear board crescent moon",
"guid": "I0K3MU330H05O7QRXRV8",
"name": "Rear board crescent moon",
"number": "BHM-27B6",
"offTheShelf":true,
"supplier": {
"guid": "UCWFY6FFCTCI1K3B82OC"
},
"type": "PART",
"uom": "each"
}

Returns an error if:

1. the format of the request is incorrect:

{
"status":400,
"errors":[
{
"code":400,
"message":"The format of the request is not valid. Please check the syntax."

}
]
}

2. a general error occurs:

{
"status":400,
"errors":[
{
"code":4000,
"message":"Sorry, a system error occurred, please try again."

©2022 Arena, A PTC Business www.arenasolutions.com 858

 Arena REST API Developer Guide Endpoints

}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 859

 Arena REST API Developer Guide Endpoints

PUT Supplier Item Update

/supplieritems/<GUID>

Updates the metadata of a Supplier Item with a given GUID. To update values for additional attributes, first
retrieve the GUID of each attribute using the GET Supplier Item endpoint. Updated values must be valid for
the attribute.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"additionalAttributes":[
{
"guid":"ZH1K3BKKHYFXGZI118BV",
"value":"Yes"
},
{
"guid":"2K4N6ENNK1I0J2L44BET",
"value":"John Parker"
},
{
"guid":"0I2L4CLLIZGYH0J229CD",
"value":"Updated note"
},
{
"guid":"YG0J2AJJGXEWFYH007AO",
"value":"2020-01-01T06:59:59Z"
},
{
"guid":"1J3M5DMMJ0HZI1K33ADK",
"value":"10"
}
],
"description":"Rear board half moon",
"name":"Rear board half moon",
"number":"BHM-27B6",
"offTheShelf":true,
"type":"PART",
"uom":"each"
}

©2022 Arena, A PTC Business www.arenasolutions.com 860

 Arena REST API Developer Guide Endpoints

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Update a given supplier item

/supplieritems/<GUID>

{
"additionalAttributes":[
{
"apiName":"custom902625",
"fieldType":"DROP_DOWN",
"guid":"2K4N6ENNK1I0J2L44BET",
"name":"First Article Tester",
"value":"John Parker"
},
{
"apiName":"custom902622",
"fieldType":"FIXED_DROP_DOWN",
"guid":"ZH1K3BKKHYFXGZI118BV",
"name":"Compliance Risk?",
"value":"Yes"
},
{
"apiName":"custom902623",
"fieldType":"MULTI_LINE_TEXT",
"guid":"0I2L4CLLIZGYH0J229CD",
"name":"Notes",
"value":"Updated note"
},
{
"apiName":"custom902624",
"fieldType":"SINGLE_LINE_TEXT",

©2022 Arena, A PTC Business www.arenasolutions.com 861

 Arena REST API Developer Guide Endpoints

"guid":"1J3M5DMMJ0HZI1K33ADK",
"name":"Stock EOQ",
"value":"10"
},
{
"apiName":"custom902621",
"fieldType":"DATE",
"guid":"YG0J2AJJGXEWFYH007AO",
"name":"Re-Evaluate On",
"value":"2020-01-01T07:59:59Z"
}
],
"creationDateTime":"2018-04-27T22:55:36Z",
"creator":{
"email":"[email protected]",
"fullName":"Heidi Walker"
},
"description":"Rear board half moon",
"guid":"I0K3MU330H05O7QRXRV8",
"name":"Rear board half moon",
"number":"BHM-27B6",
"offTheShelf":true,
"supplier":{
"guid":"UCWFY6FFCTCI1K3B82OC"
},
"type":"PART",
"uom":"each"
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 862

 Arena REST API Developer Guide Endpoints

GET Supplier Item Thumbnail Image Content

GET /supplieritems/<GUID>/image/content

Returns the Supplier Item Thumbnail Image content with a given Supplier Item GUID. The Supplier Item
Thumbnail Image (also known as the Specs Image) is located within the Specs view of a Supplier Item.

Request Header Body

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response. Returns the content of the File as an Input Stream.

An error is returned if:

1. the GUID is not valid.

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}

©2022 Arena, A PTC Business www.arenasolutions.com 863

 Arena REST API Developer Guide Endpoints

]
}

2. An error is thrown by the file server

{
"status": 400,
"errors": [
{
"code": 3017,
"message": "The file with guid \"7P60AQ9P8RAS7F6J\" cannot be downloaded at
this time."
}
]
}

*If the file server is inaccessible, it may return a 400 status with no message.

©2022 Arena, A PTC Business www.arenasolutions.com 864

 Arena REST API Developer Guide Endpoints

POST Supplier Item Specs Thumbnail Image Create

POST /supplieritems/<GUID>/image

This endpoint uploads an image to the Supplier Item's Specs view thumbnail.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type multipart/form-data

Sample Request Body

File attribute:

content: [physical file]

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-FileGuid GUID string GUID for new file - only when including
content
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response if successful.

An error message is returned if the file is not a valid image file. In the example below, the error message was
encountered after attempting to upload an audio file as a thumbnail.

©2022 Arena, A PTC Business www.arenasolutions.com 865

 Arena REST API Developer Guide Endpoints

{
"status":400,
"errors": [
{
"code": 3094,
"message": "The specified file is not a valid image."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 866

 Arena REST API Developer Guide Endpoints

POST Supplier Item Specs Thumbnail Image Create From Files View
POST /supplieritems/<GUID>/image

This endpoint uploads an image to the Specs view thumbnail.

The guid must be an image file on the Files view of the Supplier Item.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"guid":"5N7Q9M7YLO7N6PSJ5BSL"
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-FileGuid GUID string GUID for new file - only when including
content
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
When creating a file with no uploaded content:

©2022 Arena, A PTC Business www.arenasolutions.com 867

 Arena REST API Developer Guide Endpoints

{
"guid":"5N7Q9M7YLO7N6PSJ5BSL"
}

Returns an error if the file is not a valid image file..

{
"status":400,
"errors":[
{
"code":3094,
"message":"The file must be associated with the item (supplier item)."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 868

 Arena REST API Developer Guide Endpoints

DELETE Supplier Item Thumbnail Image

DELETE /supplieritems/<GUID>/image

Deletes the Supplier Item Image Thumbnail Image of an Supplier Item with a specific GUID. The Supplier Item
Thumbnail Image is located in the Specs view of a Supplier Item.

Request Headers

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Headers

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Successful Response Body

no response

Unsuccessful Response Body

Name Description
status HTTP status
errors Collection of errors, including an Arena error code and message for each.

©2022 Arena, A PTC Business www.arenasolutions.com 869

 Arena REST API Developer Guide Endpoints

Sample Responses
No JSON response if successful.

Failure - 400

An error is returned if:

1. The GUID is not valid.

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 870

 Arena REST API Developer Guide Endpoints

DELETE Supplier Item

/supplieritems/<GUID>

Deletes a supplier item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
No JSON response

Returns an error if the GUID is not valid.

{
"status":403,
"errors":[
{
"code":3024,
"message":"Either you do not have privileges to access the requested data
or it does not exist."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 871

 Arena REST API Developer Guide Endpoints

GET Supplier Item Compliance

/supplieritems/<GUID>/compliance

Returns all Compliance Requirement objects for a supplier item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all Compliance Requirements applied to a supplier item

GET /supplieritems/GUID/compliance

{
"count":1,
"results":[
{
"evidenceType":"DIRECT_FILES",
"guid":"XFYH0J10J2CU9P5Z",
"lastModifiedBy":{
"email":"[email protected]",
"fullName":"Heidi Walker"
},

©2022 Arena, A PTC Business www.arenasolutions.com 872

 Arena REST API Developer Guide Endpoints

"lastModifiedDateTime":"07/05/2011 01:42:37 PM",

"mark":"RoHS logo on packaging",
"rationale":"Testing phase",
"requirement":{
"guid":"8QATYOPPY5NM5O61JCQW",
"name":"2002/95/EC RoHS"
},
"status":"UNKNOWN"
}
]
}

Request with bad GUID

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 873

 Arena REST API Developer Guide Endpoints

GET Supplier Item Compliance Requirement

GET /supplieritems/<GUID>/compliance/<GUID>

Returns a Compliance Requirement with a given GUID for a supplier item with a given GUID.

Request Headers

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Headers

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Successful Response Body

Name Description
result a single compliance requirement

Unsuccessful Response Body

Name Description
status HTTP status
errors Collection of errors, including an Arena error code and message for each.

©2022 Arena, A PTC Business www.arenasolutions.com 874

 Arena REST API Developer Guide Endpoints

Sample Responses
Get a single supplier item compliance requirement

GET /supplieritems/<GUID>/compliance/<GUID>

{
"evidenceType":"DIRECT_FILES",
"guid":"XFYH0J10J2CU9P5Z",
"lastModifiedBy":{
"email":"[email protected]",
"fullName":"Heidi Walker"
},
"lastModifiedDateTime":"07/05/2011 01:42:37 PM",
"mark":null,
"rationale":"- This Supplier Item has been verified to meet the RoHS requirement.",

"requirement":{
"guid":"8QATYOPPY5NM5O61JCQW",
"name":"2002/95/EC RoHS (Sample)"
},
"status":"COMPLIANT"
}

Request with bad GUID

{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 875

 Arena REST API Developer Guide Endpoints

PUT Supplier Item Compliance Update

PUT /supplierItems/<GUID>/compliance/<GUID>

Updates a Compliance Requirement object with a given GUID for a supplier item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"evidenceType":"DIRECT_FILES",
"mark":"blue checkmark on packaging",
"rationale":"evidence provided by files attached to supplier item",
"status":"COMPLIANT"
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Update a compliance requirement for a supplier item

PUT /supplieritems/<GUID>/compliance/<GUID>

©2022 Arena, A PTC Business www.arenasolutions.com 876

 Arena REST API Developer Guide Endpoints

{
"evidenceType":"DIRECT_FILES",
"guid":"WEXGZI0ZI1K30FUO",
"lastModifiedBy":{
"fullName":"Heidi Walker"
},
"lastModifiedDateTime":"07/31/2015 05:50:26 PM",
"mark":"blue checkmark on packaging",
"rationale":"evidence provided by files attached to supplier item",
"requirement":{
"guid":"GYI1KSZL19RQ9SBTZ4KV",
"name":"2011/65/EU RoHS"
},
"status":"COMPLIANT"
}

Returns an error if the evidence type or status is not valid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 877

 Arena REST API Developer Guide Endpoints

GET Supplier Item File Associations

/supplieritems/<GUID>/files

Returns an array of File objects belonging to a supplier item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get file associations for a given supplier item

/supplieritems/<GUID>/files

{
"count":2,
"results":[
{
"file":{
"author":{
"fullName":"Rachael Borg"
},
"category":{
"guid":"I0K38YZZ8FY8RAMUIBIK",

©2022 Arena, A PTC Business www.arenasolutions.com 878

 Arena REST API Developer Guide Endpoints

"name":"Design Drawing",
"path":"File\\Engineering\\Drawings"
},
"checkedOut": false,
"corrected": false,
"creationDateTime":"2011-06-02T19:30:28Z",
"description":null,
"edition":"1",
"format":"doc",
"guid":"BTDW1RSS18R7Q90RHOD5",
"hasMarkup":false,
"lastModifiedDateTime":"2011-06-02T19:30:28Z",
"latest":true,
"location":null,
"locked":false,
"mimeType":null,
"name":"7011X1-5.doc",
"number":"FILE-000814",
"private":false,
"size":31232,
"storageMethod":0,
"storageMethodName":"FILE",
"title":"7011X1-5"
},
"guid":"FXH05VWW5CUYH0W6I8ZD",
"primary":true
},
{
"file":{
"author":{
"fullName":"John Parker"
},
"category":{
"guid":"R9TCH788HO7H0JV3RKSA",
"name":"Design Drawing",
"path":"File\\Engineering\\Product Requirements Doc"
},
"checkedOut": false,
"creationDateTime":"2011-06-02T19:30:28Z",
"corrected": false,
"description":"Miniature Lamp Red/Green",
"edition":"1",
"format":"pdf",
"guid":"5N7QVLMMV2L1K3ULBI65",
"hasMarkup":false,
"lastModifiedDateTime":"2011-06-02T19:30:28Z",
"latest":true,
"location":null,
"mimeType":null,
"name":"7011X%20Series.pdf",
"number":"FILE-000843",
"private":false,
"size":28847,
"storageMethod":0,
"storageMethodName":"FILE",

©2022 Arena, A PTC Business www.arenasolutions.com 879

 Arena REST API Developer Guide Endpoints

"title":"Chicago Miniature Lamp 7011X Series Bicolor SMT LEDs"

},
"guid":"I0K38YZZ8FX1K3Z9LB19",
"primary":false
}
]
}

Returns an error if the GUID is not valid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 880

 Arena REST API Developer Guide Endpoints

GET Supplier Item File Association

/supplieritems/<GUID>/files/<GUID>

Returns a File Association object with a given GUID belonging to a supplier item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a single file association from a given supplier item

/supplieritems/<GUID>/files/<GUID>

{
"file":{
"author":{
"fullName":"John Parker"
},
"category":{
"guid":"Z9TCH788TO7H0JV3RPLF",
"name":"Design Drawing",
"path":"File\\Engineering\\Product Requirements Doc"
},

©2022 Arena, A PTC Business www.arenasolutions.com 881

 Arena REST API Developer Guide Endpoints

"checkedOut": false,
"corrected": false,
"creationDateTime":"2011-06-02T19:30:28Z",
"description":"Miniature Lamp Red/Green",
"edition":"1",
"format":"pdf",
"guid":"5N7QVLMMV2L1K3ULBI65",
"hasMarkup":false,
"lastModifiedDateTime":"2011-06-02T19:30:28Z",
"latest":true,
"location":null,
"locked":false,
"mimeType":null,
"name":"7011X%20Series.pdf",
"number":"FILE-000843",
"private":false,
"size":28847,
"storageMethod":0,
"storageMethodName":"FILE",
"title":"Chicago Miniature Lamp 7011X Series Bicolor SMT LEDs"
},
"guid":"I0K38YZZ8FX1K3Z9LB19",
"primary":false
}

Returns an error if the GUID is not valid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 882

 Arena REST API Developer Guide Endpoints

GET Supplier Item File Content

/suppplieritems/<GUID>/files/<GUID>/content

Returns file content belonging to a file with a given GUID, which is associated with a supplier item with a given
GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
Returns the content of the File as an InputStream.

An error is returned if:

1. the GUID is not valid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}

©2022 Arena, A PTC Business www.arenasolutions.com 883

 Arena REST API Developer Guide Endpoints

]
}

2. An error is thrown by the file server

{
"status":400,
"errors":[
{
"code":3017,
"message":"The file with guid \"7P60AQ9P8RAS7F6J\" cannot be downloaded
at this time."
}
]
}

*If the file server is inaccessible, it may return a 400 status with no message.

©2022 Arena, A PTC Business www.arenasolutions.com 884

 Arena REST API Developer Guide Endpoints

POST Supplier Item File Create

/supplieritems/<GUID>/files

Creates a new File Association object and associates it with a supplier item with a given GUID.

If you wish to create a File record with no uploaded content, construct a JSON request with a
storageMethodName of PLACE_HOLDER, FTP, or WEB. When the storageMethodName is FTP or WEB, the
location attribute should be the web or ftp address where the file resides.

If you wish to create a File record and upload file content to the Arena servers, construct a request that is
content type multipart/form-data and has a storageMethodName of FILE.

For File editions with storageMethodName FILE, the location attribute should be null.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type multipart/form-data

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-ItemFileAssociation-Guid GUID string GUID for new file association - only when
including content
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Request Body

• Creating a File and uploading content to Arena servers (text format):

©2022 Arena, A PTC Business www.arenasolutions.com 885

 Arena REST API Developer Guide Endpoints

Text attributes:

file.author.fullName: Heidi Walker

file.category.guid: WEYHMCDDMTCM5O08WPWY
file.description: Assembly Instructions
file.edition: 1
file.format: txt
file.private:false
file.storageMethodName: FILE
file.title: Assembly Instructions for 324-0263
latestEditionAssocation:true
primary:true

File attribute:

content: [physical file]

• Creating a File with no uploaded content (Web or FTP location/Placeholder):

{
"file":{
"author":{
"fullName":"Jensen Chang"
},
"category":{
"guid":"TBVEJ9AAJQ9J2LX5TMTB"
},
"description":"Trilby board spec",
"edition":"1",
"format":"pdf",
"location":"www.trilbytech.com/docs/104-80888.pdf",
"private":false,
"storageMethodName":"WEB",
"title":"Trilby Spec for 300 board"
}
}

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json
Date date today's date and time
Server ArenaSolutions
X-Arena-SupplierItemFileAssociation-Guid GUID string GUID for new file association - only when
including content
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 886

 Arena REST API Developer Guide Endpoints

Sample Response Body

• When creating a File object with uploaded content:

No JSON Response. Please refer to the response header for file information.

• When creating a File object with no uploaded content:

{
"file":{
"author":{
"fullName":"Jensen Chang"
},
"category":{
"guid":"TBVEJ9AAJQ9J2LX5TMTB"
},
"description":"Trilby board spec",
"format":"pdf",
"edition":"1",
"location":"www.trilbytech.com/docs/104-80888.pdf",
"mimeType":null,
"name":"104-80888.pdf",
"private":false,
"storageMethodName":"WEB",
"title":"Trilby Spec for 300 board"
}
}

Returns an error if:

1. the GUID is not valid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

2. A required metadata attribute is missing.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The attribute \"file.edition\" is required."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 887

 Arena REST API Developer Guide Endpoints

POST Supplier Item File Content Update

/supplieritems/<GUID>/files/<GUID>/content

Updates file content for an existing File with a given GUID associated with a supplier item with a given GUID.

Currently, only Files less than 2GB can be uploaded through this endpoint.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login

Sample Request Body

File attribute:

content: [physical file]

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type determined by file type content type of file
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Responses
no JSON response

An error is returned if:

1. The GUID is not valid.

©2022 Arena, A PTC Business www.arenasolutions.com 888

 Arena REST API Developer Guide Endpoints

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

2. a required metadata attribute is missing.

{
"status":400,
"errors":[
{
"code":3001,
"message":"The attribute \"edition\" is required."
}
]
}

3. Returns an error if File size is 2GB or higher.

{
"status": 400,
"errors": [
{
"code": 3033,
"message": "The file content is missing."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 889

 Arena REST API Developer Guide Endpoints

POST Supplier Item File Add Existing

/supplieritems/<GUID>/files

Associates an existing File Association object with a supplier item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Sample Request Body

{
"primary":false,
"file":{
"guid":" GYI16WXX6DVYH0J2LEV8"
}
}

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Associate an existing file with a supplier item

{
"file":{
"author":{

©2022 Arena, A PTC Business www.arenasolutions.com 890

 Arena REST API Developer Guide Endpoints

"fullName":"John Parker"
},
"category":{
"guid":"R9TCH788HO7H0JV3RKSA"
},
"creationDateTime":"2011-06-02T19:30:28Z",
"description":"Miniature Lamp Red/Green",
"edition":"1",
"format":"pdf",
"guid":"5N7QVLMMV2L1K3ULBI65",
"hasMarkup":false,
"lastModifiedDateTime":"2011-06-02T19:30:28Z",
"latest":true,
"location":null,
"locked":false,
"mimeType":"application/pdf",
"name":"7011X%20Series.pdf",
"number":"FILE-000843",
"private":false,
"size":28847,
"storageMethod":0,
"storageMethodName":"FILE",
"title":"Chicago Miniature Lamp 7011X Series Bicolor SMT LEDs"
},
"guid":"I0K38YZZ8FX1K3Z9LB19",
"primary":false
}

An error is returned if:

1. The GUID is not valid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

2. a required metadata attribute is missing.

{
"status":400,
"errors":[
{
"code":3001,
"message":"The attribute \"edition\" is required."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 891

 Arena REST API Developer Guide Endpoints

PUT Supplier Item File Association Update

/supplieritems/<GUID>/files/<GUID>

Updates information about (but not the content of) an existing File with a given GUID associated with a supplier
item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"primary":true
}

Response Codes

Code Description
201 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Update the details of a file associated with a supplier item

/supplieritems/<GUID>/files/<GUID>

{
"file":{
"author":{

©2022 Arena, A PTC Business www.arenasolutions.com 892

 Arena REST API Developer Guide Endpoints

"fullName":"John Parker"
},
"category":{
"guid":"9RBUZPQQZ6PZI1DL92A2"
},
"creationDateTime":"2011-06-02T19:30:28Z",
"description":"OrCAD native design file.",
"edition":"1",
"format":"DSN",
"guid":"N5P8D344DK3J2LC3T0OM",
"hasMarkup":false,
"lastModifiedDateTime":"2011-06-02T19:30:28Z",
"latest":true,
"location":null,
"locked":true,
"mimeType":"application/octet-stream",
"name":"OrcadCapture.DSN",
"number":"FILE-000825",
"private":false,
"size":463360,
"storageMethod":0,
"storageMethodName":"FILE",
"title":"OrCAD Schematic File"
},
"guid":"J1L49Z009GZBUD95YPP0",
"primary":false
}

An error is returned if the GUID is not valid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 893

 Arena REST API Developer Guide Endpoints

DELETE Supplier Item File Association

/supplieritems/<GUID>/files/<GUID>

Removes a File association with a given GUID from a Supplier Item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
204 Success
400 Failure

Response Header

Name Value Description

Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response

Produces an error if the requested file association does not exist.

{
"status":400,
"errors":[
{
"code":3029,
"message":"The file association does not exist between object
\"Q8SBG6CHGDWDWB7W8EJG\" and object \"EWGZ4U0541K0J2TJSQGG\"."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 894

 Arena REST API Developer Guide Endpoints

POST Supplier Item Compliance

POST /supplieritems/<GUID>/compliance

Creates a Compliance Requirement object with a given GUID for a Supplier Item with a given GUID.

Only one of each requirement can be added to a Supplier Item.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

{
"requirement":{
"guid":"HZJ2LYJAX0IEXGYHQ7KA",
},
"evidenceType":"DIRECT_FILES",
"mark":"the compliance mark",
"rationale":"This Supplier Item has been verified to meet the RoHS requirement.",

"status":"COMPLIANT"
}

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

©2022 Arena, A PTC Business www.arenasolutions.com 895

 Arena REST API Developer Guide Endpoints

Sample Response Body

Create a compliance requirement for a Supplier Item

POST /items/<GUID>/compliance

{
"evidenceType":"DIRECT_FILES",
"guid":"J1L4N0LCZ2KGZISABJ8Q",
"lastModifiedBy":{
"email":"[email protected]",
"fullName":"Heidi Walker"
},
"lastModifiedDateTime":"2020-11-04T19:28:23Z",
"mark":"the compliance mark",
"rationale":"This Supplier Item has been verified to meet the RoHS requirement.",

"requirement":{
"guid":"HZJ2LYJAX0IEXGYHQ7KA",
"name":"2002/95/EC RoHS (Sample)"
},
"status":"COMPLIANT"
}

Request with invalid evidence type or status

{
"status":400,
"errors":[
{
"code":3082,
"message":"Invalid evidence type."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 896

 Arena REST API Developer Guide Endpoints

DELETE Supplier Item Compliance

DELETE /supplieritems/<GUID>/compliance/<GUID>

Deletes a Compliance Requirement object with a given GUID for a Supplier Item with a given GUID.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

No JSON response.

Request with invalid evidence type or status

{
"status":400,
"errors":[
{
"code":3082,
"message":"Invalid evidence type."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 897

 Arena REST API Developer Guide Endpoints

GET Supplier Item Quality Processes

GET /supplieritems/<GUID>/quality

GET /supplieritems/<GUID>/quality/<GUID>

Returns an array of Quality Process objects for a Supplier Item with a given GUID (all Quality Processes in which
the Supplier Item is an affected object).

If the endpoint is apprended with a valid GUID, it returns a specific Quality Process and the step information
where the specified Supplier has been added as an affected object.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get all quality processes that include a given supplier item

GET /supplieritems/0I2LQGHHQXGXGVRR5XND/quality

{
"count":1,
"results":[
{

©2022 Arena, A PTC Business www.arenasolutions.com 898

 Arena REST API Developer Guide Endpoints

"guid":"4M6PUJ0E1K1H0J2LUOPL",
"notes":null,
"qualityProcess":{
"guid":"DVFYHPYYCT9SBUDV023",
"notes":"main PCBA in question",
"name":"FAI Failure: 056-0003 Everyroad Rear Panel",
"number":"FAFR-000001",
"step":{
"guid":"TBVEJ8P3Q9SO7Q9S68C4",
"name":"Gather Data"
},
"type":"Severe"
}
}
]
}

Gets a specific Quality Process (and specific step information) where the specified Supplier Item has been
added as an affected object.

GET /supplieritems/<GUID>/quality/<GUID>

{
"guid": "ZH1K3G1SFI0BUDWESALZ",
"notes": null,
"qualityProcess": {
"guid": "M4O7Q3OF25OK3M5OHUQ2",
"name": "Manufacturing flaws on 175-00001 boards",
"number": "CAR-000007",
"step": {
"guid": "N5P8R4PG36PL4N6PIVRR",
"name": "Problem Description"
},
"type": null
}
}

Produces an error if the GUID is not valid.

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"0I2LQGHHQXGXGVRR5XND\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 899

 Arena REST API Developer Guide Endpoints

GET Supplier Item Source Relationships

/supplieritems/<GUID>/sourcing

Returns a collection of Source Relationship objects for a supplier item with a given GUID.

The source relationship GUID in the responses is identical to the source relationship GUID for GET
items/<GUID>/sourcing.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all source
relationships where results should begin.
All relationships before the offset in the
search results are ignored. The default value
is 0.
limit integer Specifies the maximum number of returned
results. The default value (no specified limit)
is 20, the maximum is 400.
item.status number Specifies the revision types of items that
can be included in returned results. The
possible values are 0 (working), 1 (effective),
2 (superseded)

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time

©2022 Arena, A PTC Business www.arenasolutions.com 900

 Arena REST API Developer Guide Endpoints

Name Value Description

Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get source relationships for a supplier item

/supplieritems/<GUID>/sourcing

{
"count":2,
"results":[
{
"activeProduction":false,
"activePrototype":false,
"amlRank":null,
"amlSplit":null,
"approved":true,
"guid": "VDXGZCXOBEWDWFGK9D4A",
"item":{
"guid":"5N7QVLMMV2L2L0WWA3PY",
"name": "Capacitor, Ceramic Chip, 0.01uF, 0603",
"number": "120-00005",
"revisionNumber": "A",
"revisionStatus": "WORKING",
"status": 0,
"url": {
"api": "https://api.arenasolutions.com/v1/items/5N7QVLMMV2L2L0WWA3PY",

"app": "https://app.bom.com/5N7QVLMMV2L2L0WWA3PY"
}
},
"makeItem":false,
"mfrItem":{
"guid":"I0K38YZZ8FY3M55VE92O"
},
"notes":"Reel",
"vendorItem":{
"guid":"HZJ27XYY7EX2L44UD816"
},
"vendorItemConversionFactor":1
},
{
"activeProduction":false,
"activePrototype":false,
"amlRank":null,
"amlSplit":null,
"approved":true,
"guid": "VDXGZCXOBEWDWFGK9D4A",

©2022 Arena, A PTC Business www.arenasolutions.com 901

 Arena REST API Developer Guide Endpoints

"item":{
"guid":"VDXGLBCCLSBSBQMM0UZ1",
"name": "Capacitor, Ceramic Chip, 0.01uF, 0603",
"number": "120-00005",
"revisionNumber": "A",
"revisionStatus": "EFFEC|TIVE",
"status": 1,
"url": {
"api": "https://api.arenasolutions.com/v1/items/VDXGLBCCLSBSBQMM0UZ1",

"app": "https://app.bom.com/VDXGLBCCLSBSBQMM0UZ1"
}
},
"makeItem":false,
"mfrItem":{
"guid":"I0K38YZZ8FY3M55VE92O"
},
"notes":"Reel",
"vendorItem":{
"guid":"HZJ27XYY7EX2L44UD816"
},
"vendorItemConversionFactor":1
}
]
}

Request with bad GUID:

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"0I2LQGHHQXGXGVRR5XND\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 902

 Arena REST API Developer Guide Endpoints

GET Supplier Item Source Relationship

/supplieritems/<GUID>/sourcing/<GUID>

Returns a single Source Relationship objects for a supplier item with a given GUID.

The source relationship GUID in the response is identical to the source relationship GUID for GET
items/<GUID>/sourcing.

Request Header

Name Value Description

arena_session_id unique ID for session obtained from login
content-type application/json

Parameters

Name Value Description

offset integer Specifies the position in the list of all source
relationships where results should begin.
All relationships before the offset in the
search results are ignored. The default value
is 0.
limit integer Specifies the maximum number of returned
results. The default value (no specified limit)
is 20, the maximum is 400.
item.status number Specifies the revision types of items that
can be included in returned results. The
possible values are 0 (working), 1 (effective),
2 (superseded)

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description

Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time

©2022 Arena, A PTC Business www.arenasolutions.com 903

 Arena REST API Developer Guide Endpoints

Name Value Description

Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the
count
X-Arena-Requests-Remaining number how many calls left

Sample Response Body

Get a specific source relationships for a specific supplier item

/supplieritems/<GUID>/sourcing/<GUID>

{
"activeProduction": false,
"activePrototype": true,
"amlRank": null,
"amlSplit": null,
"approved": true,
"guid": "VDXGZCXOBEWDWFGK9D4A",
"item": {
"guid": "7P9SBO90NQ9H0ISBNGAO",
"name": "Resistor, 2M Ohm, 1/16W, 5%, 0603, SMD",
"number": "180-00011",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"status": 1,
"url": {
"api": "https://api.arenasolutions.com/v1/items/VDXGLBCCLSBSBQMM0UZ1",
"app": "https://app.bom.com/VDXGLBCCLSBSBQMM0UZ1"
}
},
"makeItem": false,
"mfrItem": {
"guid": "5N7Q9M7YLO7CVESUDFBC",
"number": "ERJ3GSYJ205V",
"supplier": {
"guid": "6O8RAN8ZMP8EXGRSZTP4",
"name": "Matsushita"
}
},
"notes": null,
"vendorItem": {
"guid": "3L5O7K5WJM5ATCQSBD9A",
"number": "ERJ3GSYJ205V",
"supplier": {
"guid": "3L5O7K5WJM5BUDOPWQM5",
"name": "Avnet"
}
},
"vendorItemConversionFactor": 1
}

©2022 Arena, A PTC Business www.arenasolutions.com 904

 Arena REST API Developer Guide Endpoints

Request with bad GUID:

{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"0I2LQGHHQXGXGVRR5XND\" is not valid."
}
]
}

©2022 Arena, A PTC Business www.arenasolutions.com 905

 Arena REST API Developer Guide Objects

Objects

When you send requests to the API service, you receive object information in response. The following shows
all the objects and their fields returned from API requests.

Note: Date and time fields conform to ISO 8601 (UTC/Zulu time YYYY-MM-DDTHH:MM:SSZ), the international
standard for representation of dates and time. However, dates stored in the Arena database are in Pacific time. You
may need to transform dates back to Pacific time to ensure your target system matches the Arena database time.

Address
Field Data Type Description
address1 String The street address for a Supplier
address2 String The second line of the street address for a Supplier
city String The city of a Supplier address
country String The country of a Supplier address
label String The label of a Supplier address (e.g. Home, Office, etc)
postalCode String The postal code (ZIP code) of a Supplier address
province String The province of a Supplier address
state String The state of a Supplier address

Attribute
Field Data Type Available when Description
allowLowerCase Boolean Item Description, Item Name, Indicates whether or not lowercase characters
Change Description, Change are allowed in values for this attribute
Title
allowNumbers Boolean Item Description, Item Name, Indicates whether or not number characters
Change Description, Change are allowed in values for this attribute
Title
allowUpperCase Boolean Item Description, Item Name, Indicates whether or not uppercase characters
Change Description, Change are allowed in values for this attribute
Title

©2022 Arena, A PTC Business www.arenasolutions.com 906

 Arena REST API Developer Guide Objects

Field Data Type Available when Description

allowNegatives Boolean fieldType is POSITIVE_DOUBLE Indicates whether or not negative numbers are
or NUMERIC allowed for the attribute value. The value can
be true or false.
allowsExplicitNullValue Boolean always available Indicates whether or not submitting a value of
null clears the field, resulting in no value. The
value can be true or false. This value is only true
for approvalDeadlineDateTime,
implementationStatus, and all attributes where
custom=true.
apiName String always available For system attributes (when custom=false), the
name of an attribute used in a request. For
additional attributes (when custom=true), the
API name is the same as the GUID.
creatable Boolean always available Indicates whether or not an attribute value can
be specified when an item is created. The value
can be true or false.
custom Boolean Item and BOM attributes Indicates whether or not an attribute is a
custom attribute (a non system-defined
attribute defined by an Account Administrator).
The value can be true or false.
decimalPlaces Integer fieldType is POSITIVE_DOUBLE The number of decimal places for a numeric
or NUMERIC value.
defaultValue String attribute is creatable and value The default value for an attribute. Only shown
is not null when its value is not null and creatable is True.
deprecated Boolean its value is True Indicates when an attribute is being phased
out of the Arena REST API.
developerNotes String its value is not null End user information about the attribute.
editable Boolean always available Indicates whether or not an attribute value can
be specified when an item is edited. The value
can be true or false.
excludedValues Collection of its value is not null Lists disallowed characters for the attribute
Strings value
fieldType String always available The type of attribute. This value can be
SINGLE_LINE_TEXT, MULTI_LINE_TEXT,
BOOLEAN, DROP_DOWN, POSITIVE_DOUBLE,
FIXED_DROPDOWN, NUMERIC, DATETIME
guid String custom is True Unique identifier for the attribute.
inViews Collection of custom is False A list of views in the Arena application in which
Strings the attribute is shown.
maxLength Number fieldType is SINGLE_LINE_TEXT, The maximum length of a text field. This is used
MULTI_LINE_TEXT, or for validation.
DROP_DOWN

©2022 Arena, A PTC Business www.arenasolutions.com 907

 Arena REST API Developer Guide Objects

Field Data Type Available when Description

maxSelections Number multiSelect is True Maximum number of values allowed for the
attribute.
maxValue Double fieldType is POSITIVE_DOUBLE The maximum value for an integer or double
or NUMERIC field. This is also used for validation.
multiSelect Boolean fieldType is Indicates whether or not an attribute can have
FIXED_DROP_DOWN multiple values. The value can be true or false.
name String custom is True The name of the attribute as it appears in the
Arena application.
possibleValues Array of fieldType is DROP_DOWN or All possible values for a drop-down list.
Strings FIXED_DROP_DOWN.
required Boolean creatable is True, global is True Indicates whether or not an attribute is
Required in the workspace (meaning a value
must be supplied.) Note that this value is true
when an attribute is Required in the workspace,
even when a default value exists and will be
selected automatically. (see the note below)
revisionControlled Boolean Item custom attributes Indicates whether or not edits to the attribute
trigger the Modified flag. The value can be true
or false. Only item custom attributes of type
COST can be revisionControlled=false. NOTE
non-revision controlled attributes appear and
can be edited on both the effective and
working revisions of items whereas in the
Arena application, they appear only on the
effective revision.
searchable Boolean always available Indicates whether or not an attribute can be
used as a search filter. The value can be true or
false.

Note on Required/Optional Behavior and Default Values

In Arena, attributes are global (they apply to all categories) or category-specific (they apply only to spceific
categories selected by Account Administrators). Global attributes return the required property in the GET Item
Attributes endpoint. Category-specific attributes return the required property in the GET Item Category
Attributes endpoint, because required/optional is defined per category.

"Required" means a value must exist for the attribute. During creation of a new Item, the user must supply a
value for required attributes with no default value. No value entry is necessary for required attributes that have
a default value.

©2022 Arena, A PTC Business www.arenasolutions.com 908

 Arena REST API Developer Guide Objects

BOM Settings
Field Data Type Description
automaticallyGenerateLineNumbers Boolean Determines if line numbers on a BOM are be generated
automatically (and have no significance) or entered
manually and retained. The value can be True or False.
checkReferenceDesignators Boolean Determines if reference designators are validated by
Arena for this BOM. The value can be True or False. If
set to true, Arena checks to see that the value conforms
to allowable formats and that reference designators
are unique across the BOM.

Category
Field Data Type Description
activated Boolean This indicates whether or not a category is activated for use in the
workspace. The value should be true or false.
allowDuplicateRevisions Boolean This indicates whether or not Items included in Changes of this
category can use the same start and end revision. A value of
True=allow reuse of revisions; a value of False=disallow reuse of
revisions
allowManualRevisionEntry Boolean This indicates whether or not users can manually enter an end
revision for Items included in Changes of this category. A value
of True=allow manual entry; a value of False=disallow manual
entry.
assignable Boolean This indicates that an Item can be assigned to the category.
Categories can be assignable to an object if activated.
True=assignable. False if not. Categories cannot be assignable if
deactivated, deleted, or structural.
creationDateTime Date-Formatted The date and time (in Zulu format) an object was created.
String
creator Reference The creator of a category. Contains the attributes email, fullName,
and guid.
description String The description of a category
deletionDateTime Date-Formatted The date and time (in Zulu format) the category was deleted.
String
effectivityType String The default effectivity type of a Change category. The value can
be IMMEDIATE, FUTURE, or TEMPORARY. Temporary Changes in
Arena are Deviations. (only used for Change categories)
enforceDefaultEffectivityType Boolean This indicates whether or not the default effectivityType should
be enforced for Changes assigned to this category. A value of
True=default value is enforced. A value of False=default value is
not enforced. When this is True, Changes assigned to the category
must match the default effectivityType.

©2022 Arena, A PTC Business www.arenasolutions.com 909

 Arena REST API Developer Guide Objects

Field Data Type Description

enforceDefaultNumberSequence Boolean This indicates whether or not the default numberingSequence
should be enforced for Changes assigned to this category. A value
of True=default value is enforced. A value of False=default value
is not enforced. When this is True, Changes assigned to the
category must match the default numberingSequence.
guid String The unique identifier for an object
initialImplementationStatus String The starting implementation status for Changes assigned to the
category.
level Integer The depth in the category tree at which a category appears. For
example: item\assembly has a level of 2, since the level of root
category "item" is 1.
name String The name of a category. For the system-defined category (root
category) for item, the name is "Item".
numberFormat Reference Details of the number format associated with the category. See
Item Number Format object. (only used for Item categories)
numberingSequencePrefixDefault Reference Details about the numbering sequence prefix used for Changes
assigned to this category. (only used for Change categories)
path String The path of a category, for example: item\assembly
parentCategory Reference Details of the category that exists in a direct hierarchical
relationship one order of magnitude higher than the category of
the object.
structural Boolean This indicates if a category is structural. Structural categories exist
only to support the structure of the category tree - no objects may
be assigned to it directly. The value should be true if structural
false if not structural.
systemDefined Boolean This indicates if a category is system-defined. The value should
be true or false. Only "Item" is a system-defined category.

Change
This object includes all fields in a Change.

Field Data Type Description

additionalAttributes Array of The additional attributes of a change. This is an array
Attributes of additional attributes. Each additional attribute entry
includes a guid, a name, and a value.
approvalDeadlineDateTime Date-Formatted The date and time (in Zulu format) before which a
String change must be approved. If enforceApprovalDeadline
is set to true, the change is automatically rejected once
this deadline is passed.
See the Note on Date/Time Handling
category Reference The category of a change. This compact category listing
includes guid, name, and path.

©2022 Arena, A PTC Business www.arenasolutions.com 910

 Arena REST API Developer Guide Objects

Field Data Type Description

creationDateTime Date-Formatted the date and time (in Zulu format) a change was
String created
creator Reference The user that created the change. Includes email,
fullName, and guid.
description String The description of a change
effectiveDateTime Date-Formatted the date and time (in Zulu format) when a change
String became effective
effectivityPlannedDateTime Date-Formated The date and time when a change will become effective
String after approval. This is required only for changes of
effectivityType PERMANENT_ON_DATE.
See the Note on Date/Time Handling
effectivityType String Indicates the type of effectivity for a change. Values
can be PERMANENT_ON_APPROVAL,
PERMANENT_ON_DATE, or TEMPORARY
enforceApprovalDeadline Boolean Indicates whether or not the approval deadline of a
change is enforced (if a change with an enforced
approval deadline reaches the deadline without being
approved, it is automatically rejected.) The value can
be true or false. Note that if this value is true,
approvalDeadlineDateTime must be specified.
expirationDateTime Date-Formatted The date and time when a change will expire. This is
String required only for changes of effectivityType
TEMPORARY. Can be edited by any userwhen a change
is in the Open and Unlocked lifecycle phase. Can be
edited only by a Change Administrator user in the
Effective or Submitted lifecycle phase.
See the Note on Date/Time Handling
guid String unique ID of a change
implementationStatus String Impementation status of a change. Values can be
NOT_STARTED, IN_PROGRESS, NEEDS_ATTENTION,
DONE, or NONE.
implementationStatusDateTime Date-Formatted the date and time (in Zulu format) the last
String implementation status edit occurred
implementationStatusEditor Date-Formatted The user who last edited the implementation status.
String Includes email, fullName, and guid.
lifecycleDateTime String the date and time (in Zulu format) the last lifecycle
phase change occurred
lifecycleStatus String The lifecycle status of the change. Values can be
OPEN_AND_UNLOCKED, OPEN_AND_LOCKED,
SUBMITTED_FOR_ROUTING,
SUBMITTED_FOR_APPROVAL, REJECTED, CANCELED,
APPROVED, EFFECTIVE, COMPLETED, or EXPIRED.
number String the number of a change

©2022 Arena, A PTC Business www.arenasolutions.com 911

 Arena REST API Developer Guide Objects

Field Data Type Description

routings Array of The routings (groups of users who vote) included in
References the change. Includes guid and name.
submissionDateTime String the date and time (in Zulu format) a change was
submitted for approval
submitter String the user who submitted the change for approval.
Includes email, fullName, and guid.
title String the title of a change

Change Compact
Field Data Type Description
category Reference The category of a change. This compact category listing includes
guid, name, and path.
creationDateTime Date-Formatted the date and time (in Zulu format) a change was created
String
creator Reference The user that created the change. Includes email, fullName, and
guid.
effectiveDateTime Date-Formatted the date and time (in Zulu format) when a change became
String effective
guid String unique ID of a change
implementationStatus String Impementation status of a change. Values can be NOT_STARTED,
IN_PROGRESS, NEEDS_ATTENTION, DONE, or NONE.
lifecycleDateTime Date-Formatted the date and time (in Zulu format) the last lifecycle phase change
String occurred
lifecycleStatus String The lifecycle status of the change. Values can be
OPEN_AND_UNLOCKED, OPEN_AND_LOCKED,
SUBMITTED_FOR_ROUTING, SUBMITTED_FOR_APPROVAL,
REJECTED, CANCELED, APPROVED, EFFECTIVE, COMPLETED, or
EXPIRED.
number String the number of a change
submissionDateTime Date-Formatted the date and time (in Zulu format) a change was submitted for
String approval
title String the title of a change

Change Affected Item

Change Affected Items appear in GET Change Item and GET Change Items responses and describe what
modifications are being made to Items included in a Change, including new lifecycle phase and revision,
inventory disposition information, and details about each view of the Item.

©2022 Arena, A PTC Business www.arenasolutions.com 912

 Arena REST API Developer Guide Objects

Field Data Type Description

affectedItemRevision Reference Details of an affected item revision included in a change. This is
the effective revision number. See Revision object.
bomView Reference Details about the BOM view of an item included in a change. See
Item View object
dispositionAttributes Collection of Details of the inventory disposition settings of an item (e.g. In
References Design). See Disposition Attribute object.
filesView Reference Details about the Files view of an item included in a change. See
Item View object
guid String unique ID for a modified item
materialEffectivityDateTime Date-Formatted date when inventory disposition settings for a change become
String effective
newItemRevision Reference Details of the item revision entered on the Specs view of the
working revision in the Items world. See Revision object.
newRevisionNumber Reference Details of the item revision that will be released by a change. (The
value on the Specs view of the working revision in the Items
world). See Revision object.
newLifecyclePhase Reference Details of the target lifecycle phase for an item included in a
change
sourcingView Reference Details about the Sourcing view of an item included in a change.
See Item View object.
specsView Reference Details about the Specs view of an item included in a change. See
Item View object.
url Array of References The direct urls of the object within the api and the application.

Change Item Disposition Attribute

Change Item Disposition Attributes appear in GET Change Item and GET Change Items responses and describe
what should be done wiith existing inventory of affected items included in a change. For example, units in the
field should be recalled; units on order should be scrapped.

Field Data Type Description

guid String unique ID for a disposition attribute
name String name of a disposition attribute
notes String notes entered about a disposition attribute
value String value of a disposition attribute

Change Number Prefix

Field Data Type Description
guid String unique identifier for the number prefix

©2022 Arena, A PTC Business www.arenasolutions.com 913

 Arena REST API Developer Guide Objects

Field Data Type Description

prefix String the string of letters and separator used as the first segment of a
change number

Change Routing
Change Routings are groups of users who vote on changes in Arena.

Field Data Type Description

description String The description of a routing
guid String The unique ID for a routing
name String The name of a routing

Compliance Requirement
Field Data Type Description
evidenceType String The type of evidence that proves the compliance status of an item
or supplier item. The value can be NONE, DIRECT_FILES,
AML_AND_FILES
guid String the unique identifier of a compliance requirement
lastModifiedBy String the user who last modified a compliance requirement
lastModifiedDateTime Date-Formatted the date and time (in Zulu format) a compliance requirement was
String last modified
mark String the mark of a compliance requirement (physical mark added to
product or packaging)
propagate (applies to Boolean Indicates whether or not a compliance requirement is propagated
Items only) to children. This value can be true or false.
rationale String the rationale of a compliance requirement (explanation of status)
requirement Reference Details of the requirement. See Requirement object.
status String The status of a compliance requirement. The value can be
UNKNOWN, COMPLIANT, EXEMPT, NA, NON_COMPLIANT

Export
Field Data Type Description
configuration String The configuration of the export, including whether an export is
of found Items or all Items in a workspace.
dateTime Date-Formatted the date and time (in Zulu format) an export began
String
numberOfResources String The number of resources included in the export

©2022 Arena, A PTC Business www.arenasolutions.com 914

 Arena REST API Developer Guide Objects

Field Data Type Description

type String The type of export. Values can be Changes: Attached Files;
Changes; Items; Suppliers; Supplier Items; Compliance BOM
Report; Items; Items: Costing; Items: Purchases; Items: Tickets;
Requests: Summary; Requests: Affected Items; Requests: Built
Changes; Requests: Lifecycle History; Requests: Recommendation;
Requests: Discussions (Issues/Responses); Users: Access History;
Users: Summary; Projects: Overview; Quality: Summary; Quality;
Details; Training: Records.
user Reference Details of the user logging in. See Compact User object.

Extract
Field Data Type Description
creationDateTime Date-Formatted the date and time (in Zulu format) an extract was created
String
creator Reference Details of the creator of the extract. This is the user under whose
credential the Extract runs.
enabled Boolean Indicates if an extract is enabled for runs. This value can be true
or false.
guid String The unique ID for an extract
name String The extract name

Extract Run
Field Data Type Description
completionDateTime Date-Formatted the date and time (in Zulu format) an extract run was completed
String
completionDate Date-Formatted the date and time (in Zulu format) an extract run was completed.
String DEPRECATED - Please Use completionDateTime
enabled Boolean Indicates if an extract is enabled for runs. This value can be true
or false.
guid String The unique ID for an extract run
name String The extract name
runDateTime Date-Formatted the date and time (in Zulu format) an extract run was started
String
scheduleDate Date-Formatted the date and time (in Zulu format) an extract run was scheduled
String
status String Indicates the status of an extract run. The value can be InProcess,
Completed, Failed, or Aborted.

©2022 Arena, A PTC Business www.arenasolutions.com 915

 Arena REST API Developer Guide Objects

Extract Run File Association

Field Data Type Description
downloadDateTime Date-Formatted the date and time (in Zulu format) a run was first downloaded,
String either by a user in the application, or by the API.
file Reference Details of the associated file. See File object.
guid String The unique identifier for a file association.

File
Field Data Type Description
author Reference The author of a file. Contains the attribute fullName.
category Reference Details of the category to which the file is assigned. See Category
object.
corrected Boolean Indicates whether a File has been corrected or not. True if
corrected. False if not.
creationDateTime Date-Formatted The date and time (in Zulu format) a file was created
String
description String The description of a file
edition String The edition identifier of a file
format String The format of a file (e.g. PDF, docx)
guid String The unique identifier for a file
hasMarkup Boolean Indicates whether or not a file has a markup.
lastModified Date-Formatted the date and time (in Zulu format) a file was modified
DateTime String
latest Boolean Indicates whether or not a file is the latest edition. The value can
be true or false.
location String When storageMethodName is WEB or FTP, the url of a file. When
storageMethodName is FILE or PLACE_HOLDER, the value is always
null and cannot be included in requests.
locked Boolean Indicates if a file edition is locked to edits. The value can be true
(locked) or false (not locked).
mimeType String The mime type of a file.
name String The name of a file. This attribute cannot be edited and is set by
Arena. When uploading file content (creating a File or File Edition
with storageMethodName "FILE"), Arena derives the name from
the content. For Files without content (a FIle with
storageMethodName "WEB", "FTP", or "PLACE_HOLDER"), the
value is null.
number String The number of a file
private Boolean Indicates if a file is hidden from all Supplier users. The value can
be true (private) or false (public).

©2022 Arena, A PTC Business www.arenasolutions.com 916

 Arena REST API Developer Guide Objects

Field Data Type Description

size Long The size of a file
storageMethod* Integer DEPRECATED - Please use storageMethodName. Indicates
whether or not a file is stored on the Arena servers. The value can
be - 0 (uploaded), 1 (place holder), 2 (ftp link), 3 (web link).
storageMethodName String Indicates where or not a file is stored on the Arena servers. The
value can be FILE (stored on Arena servers), PLACE_HOLDER
(placeholder for later upload), FTP (stored on user FTP server),
WEB (web link).
title String The title of a file

File Compact
Field Data Type Description
category reference The category to which a file is assigned. Contains a category GUID.
corrected boolean Indicates whether a File has been corrected or not. True if
corrected. False if not.
creationDateTime Date-Formatted the date and time (in Zulu format) (in Zulu time) at which a file
String edition was created
edition String The edition identifier of a file
format String The format of a file
guid String The unique identifier for a file
name String The name of a file. This attribute cannot be edited and is set by
Arena. When uploading file content (creating a File or File Edition
with storageMethodName "FILE"), Arena derives the name from
the content. For Files without content (a FIle with
storageMethodName "WEB", "FTP", or "PLACE_HOLDER"), the
value is null.
number String The number of a file
title String The title of a file

File Access Event

Field Data Type Description
dateTime Date-Formatted the date and time (in Zulu format) the file was accessed
String
activity String The recorded action on the file
comments String Comments entered when event occurred (if applicable, as when
creating a new edition)
file Reference Details of the file that was accessed. See Compact File object.
user Reference Details of the User logging in. See Compact User object.

©2022 Arena, A PTC Business www.arenasolutions.com 917

 Arena REST API Developer Guide Objects

File Assocation
Field Data Type Description
file Reference The associated file. See File object.
guid String The unique identifier for a file association.
primary Boolean Indicates whether or not a file is primary (primary files are linked
from the main view of objects to which they are associated.)

Item
Field Data Type Description
additionalAttributes Array of Attributes The additional attributes of an item. Each additional attribute
entry contains apiName, fieldType, guid, name, and value.
category Reference GUID of the category to which the item is assigned. See Category
object.
creationDateTime Date-Formatted the date and time (in Zulu format) an item was created
String
creator Reference The creator of an item. Contains the email and fullName.
description String The description of an item
deviated Boolean Indicates whether or not an item is currently affected by a
temporary change. The value can be true or false.
effectiveDateTime Date-Formatted the date and time (in Zulu format) the effective revision of an item
String was made effective.
guid String The unique identifier for an object
isAssembly Boolean Indicates whether or not an item is an assembly. The value can
be true or false.
lifecyclePhase Reference The lifecycle phase of an item (e.g. In Design). Contains GUID and
name. See Item Lifecycle Phase object.
name String The name of an item
modifiedBom Boolean Indicates whether or not the BOM view of an item contains
working modifications. The value can be true or false.
modifiedFiles Boolean Indicates whether or not the Files view of an item contains working
modifications. The value can be true or false.
modifiedSourcing Boolean Indicates whether or not the Sourcing view of an item contains
working modifications. The value can be true or false.
modifiedSpecs Boolean Indicates whether or not the Specs view of an item contains
working modifications. The value can be true or false.
name String The name of an item
number String The number of an item

©2022 Arena, A PTC Business www.arenasolutions.com 918

 Arena REST API Developer Guide Objects

Field Data Type Description

offTheShelf* Boolean DEPRECATED - Please use procurementType Indicates whether
or not an item's Procurement Type is off the shelf. The value can
be true or false.
owner Reference The owner of an item. Contains fullName.
procurementType String Indicates whether an Item is Off the Shelf (OTS) or Made to
Specification (MTS).
productionCost Double The production cost of an item
prototypeCost Double The prototype cost of an item
revisionNumber String The revision of an item
revisionStatus String The status of an Item revision. This value can be WORKING,
EFFECTIVE, or SUPERSEDED. See status.
shared Boolean Indicates whether or not an item is shared with suppliers. The
value can be true or false.
status* Integer DEPRECATED - Please use revisionStatus The status of an item
revision. This value can be 0 (working revision), 1 (effective) or 2
(superseded).
standardCost Double The standard cost of an item
supersededDateTime Date-Formatted The date and time upon which a revision became superseded (no
String longer the effective revision). Null unless you are returning a
superseded revision.
targetCost Double The target cost of an item
targetPrice Double The target price of an item
uom String The unit of measure of an item
url Array of References The direct urls of the object within the api and the application.

Item Compact
Field Data Type Description
category Reference GUID representing the category to which the item is assigned.
See Category object.
creationDateTime Date-Formatted the date and time (in Zulu format) an Item was created
String
guid String The unique identifier for an object
lifecyclePhase Reference GUID and name of the lifecycle phase of an item (e.g. In Design).
See Item Lifecycle Phase object.
name String The name of an item
number String The number of an item
revisionNumber String The revision of an item
url Array of References The direct urls of the object within the api and the application.

©2022 Arena, A PTC Business www.arenasolutions.com 919

 Arena REST API Developer Guide Objects

Item BOM Line

Field Data Type Description
additionalAttributes Array of additional The additional attributes of a BOM line. This is an array of
Attributes additional attributes. Each additional attribute entry includes a
value and apiName. The apiName is used to identify this additional
attribute.
guid Reference The unique identifier for the BOM Line.
item Reference The child item. Contains the attributes creationDateTime and
guid.
lineNumber Integer The BOM line number of a child item
notes String The BOM Notes of a child item
refDes String The reference designator values of a child item
quantity Integer The quantity of a child item
url Array of References The direct urls of the object within the api and the application.

Item Lifecycle Phase

Field Data Type Description
active Boolean This indicates whether or not a phase is activated for use in the
workspace. The value should be true or false.
guid String The unique identifier for an object
name String The name of a phase.
shortName String The short name for a phase
stage String The lifecycle stage in which the phase is located. Values can be
UNRELEASED, DESIGN, or PRODUCTION
used Boolean This indicates whether or not a custom lifecycle phase has been
used in the workspace. The value should be true or false.

Item Number Format

In addition to all the fields from Compact Number Format, Item Number Format has a "fields" field, which is
an array of the following fields:

Field Data Type Description

creationDateTime Date-Formatted the date and time (in Zulu format) a NumberFormat was created
String
exampleNumber String An example of a NumberFormat
fields Reference An array of the below fields
apiName String The unique name of a number format field
name String The name of a number format field

©2022 Arena, A PTC Business www.arenasolutions.com 920

 Arena REST API Developer Guide Objects

Field Data Type Description

possibleValues Array of Strings All possible values for a VALUE_LIST field. Each possible value
includes value and description fields.
type String Indicates the field type of a number format field. This value can
be VALUE_LIST, DELIMITER, FREE_TEXT, AUTO_SEQUENCE
value String The value of a number format field

Compact Item Number Format

Field Data Type Description
creationDateTime Date-Formatted the date and time (in Zulu format) a NumberFormat was created
String
exampleNumber String An example of a NumberFormat.
guid String The unique identifier for an object
name String The name of a NumberFormat

Item Revision
Field Data Type Description
change Reference Details of the change that released the revision. Includes
changeNumber, creationDateTime, deviated, and
effectiveDateTime
guid String The unique id for an item revision
lifecyclePhase Reference Details of the lifecycle phase of an item (e.g. In Design). See Item
Lifecycle Phase object.
number String The revision number
status Integer The status of an item revision. This value can be 0 (working
revision), 1 (latest released) or 2 (obsolete).

Item View
Item BOM, Costing, Files, Sourcing, and Specs views can be included in Changes.

Field Data Type Description

includedInThisChange Boolean Indicates whether or not the view is included in a Change. Values
can be true or false.
lockedByAnotherChange Boolean Indicates whether or not the view is locked by inclusion in another
change. Values can be true or false.
modifiedOnWorkingRev Boolean Indicates whether or not the view has modifications to its working
revision. Values can be true or false.
notes String User-entered notes about the item view entered on a change

©2022 Arena, A PTC Business www.arenasolutions.com 921

 Arena REST API Developer Guide Objects

Export Results: Item Specs

Item Specs attributes that are included in the SPECS CSV of the Export.

Field Data Type Description

number String Item Number.
guid String The unique identifier for an object
revisionNumber String Revision
name String Item Name
lifecyclePhase Reference The lifecycle phase of an Item
category Reference The category of an Item
description String The description of an Item
uom String The unit of measure for an Item
procurementType String OTS and MTS only
offTheShelf Boolean True if procurementType=OTS, else False
owner Reference The owner of an Item
creationDateTime Date-Formatted The date and time (in Zulu format) an Item was created.
String
shared Boolean Indicates whether or not an item is shared with Suppliers. The
value can be true or false
creator Reference The creator of an Item. Contains the email and fullName
deviated Boolean Indicates whether or not an Item is currently affected by a
temporary change. The value can be true or false.
effectiveDateTime Date-Formatted The date and time (in Zulu format) an Item was made effective
String
isAssembly Boolean Indicates whether or not an item is in an assembly. The value can
be true or false
modifiedBOM Boolean Indicates whether or not the BOM view of an item contains
working modifications. The value can be true or false
modifiedFiles Boolean Indicates whether or not the Files view of an item contains working
modifications. The value can be true or false.
modifiedSourcing Boolean Indicates whether or not the Sourcing view of an item contains
working modifications. The value can be true or false.
modifiedSpecs Boolean Indicates whether or not the Specs view of an item contains
working modifications. The value can be true or false.
modifiedCosting Boolean Indicates whether or not the Costing view of an item contains
working modifications. The value can be true or false.
productionCost Double The production cost of an Item.
prototypeCost Double The prototype cost of an Item.
targetCost Double The target cost of an Item.
targetPrice Double The target price of an Item.

©2022 Arena, A PTC Business www.arenasolutions.com 922

 Arena REST API Developer Guide Objects

Field Data Type Description

standardCost Double The standard cost of an Item.
revisionStatus String The Revision status of an Item. WORKING, EFFECTIVE, SUPERSEDED
supersededDateTime In Zulu format The date and time (in Zulu format) an Item was superseded.
M4O7LIMOZGZ7Q5TR50LG Custom Attribute An Item custom attribute.

Export Results: Item BOM

BOM attributes are listed in the order they appear in the BOM export CSV file.

Field Data Type Description

parent Reference The Parent Item. Includes Number, Name, and Revision
item Reference The Child Item. Includes Nunber, Name, and Revision
guid String The unique identifier for the BOM Line.
lineNumber Integer Empty if lineNumber is automatic
quantity Integer The quantity of a child Item
refDes String The Reference Designator of a child Item
notes String The BOM Notes of an Item
M4O7LIMOZGZ7Q5TR50LG String BOM Custom Attributes

Export Results: Item BOM Substitutes

BOM Substitutes attributes are listed in the order they appear in the BOM Substitutes CSV file.

Field Data Type Description

parent Reference Parent Item. Includes number, guid, revisionNumber, and name.
item Reference Child Item Number. Includes number, guid, revisionNumber, and
name.
substitute Reference Substitute Child Item. Includes number, guid, revisionNumber,
and name.
bom.guid String GUID of the BOM being substituted
guid String The unique identifier of the BOM substitute.
rank Integer The rank of the substitute
quantity Integer The quantity of the substitute.
notes String BOM Substitute notes

Export Results: Item Sourcing

Sourcing attributes are listed in the order that they appear in the CSV file..

©2022 Arena, A PTC Business www.arenasolutions.com 923

 Arena REST API Developer Guide Objects

Field Data Type Description

parent Reference Item that the source relationships is associated with. The parent
designation has no relation to BOM relationships in this specific
context. Includes GUID, revisionNumber, name, and Item.
mfrItem Reference Details of the manufacturer Item. See Supplier Item object.
vendorItem.number Reference Details of the vendor Item. See Supplier Item object.
approved Boolean Indicates if a source relationship is approed. This value can be true
or false.
guid String The unique id for a source relationship.
notes String The notes for a source relationship.
activeProduction Boolean Indicates if a source relationship is the active production
relationship. This value can be true or false.
activePrototype Boolean Indicates if a source relationship is the active prototype
relationship. This value can be true or false.
amlRank Integer The AML rank. This value is numeric.
amlSplit Integer The AM percentage.
vendorItemConversionFactor String The conversion factor of the vendor item (how many used per
one bougt. e.g. for a roll of 100 resistors, wen you use one at a
time, the conversion factor is 100), For a Make-Item Source
relationship, this must be null.,
makeItem Boolean Indicates whether or not an item is made internally. This value
can be true (made internally) or false (made by supplier).

Export Results: Item Files

File attributes are listed in the order that they appear in the CSV file..

Field Data Type Description

parent Reference The Item that the File is associated with. The parent designation
has no relation to BOM relationships in this specific context.
Includes GUID, revisionNumber, name, and Item.
file.name Reference The File associated with the Item. Includes name, file location,
guid, nunber, edition, title, and storageMethodName.
latestEditionAssociation Boolean Indicates whether or not a file is the latest edition. Can be true or
false.
primary Boolean Indicates whether or not a file is primary (primary files are linked
from the main view of objects to which they are associated.)
contentPath String Directory structure path to the location of the physical file in the
export zip file.

©2022 Arena, A PTC Business www.arenasolutions.com 924

 Arena REST API Developer Guide Objects

Export Results: File Summary

File Summary attributes are listed in the order that they appear in the CSV file..

Field Data Type Description

name String The name of the File.
location String Then storageMethodName is WEB or FTP, the url of a file. When
storageMethodName is FILE or PLACE_HOLDER, the value is always
null and cannot be included in requests.
number String The number of the File.
edition String The edition identifier of a File.
title String The title of a File.
storageMethodName String Indicates where or not a file is stored on the Arena servers. The
value can be FILE (stored on Arena servers), PLACE_HOLDER
(placeholder for later upload), FTP (stored on user FTP server),
WEB (web link).
category Reference The category of the File. Includes guid, name, and path.
guid String The unique id of the File Summary
description String The description of the File.
author.fullName String The author of a File.
format String The format of a File.
size Integer The size of a File.
creationDateTime Date-Formatted The date and time (in Zulu format) the File was created.
String
lastModifiedDataTime Date-Formatted The date and time (in Zulu format) a File was modified.
String
hasMarkup Boolean Indicates if a File has markups. Value can be true or false.
mimeType String Identifier for file formats and format contents transmitted on the
Internet
private Boolean Indicates if a FIle is private. Value can be true or false.
latest Boolean Indicates if a FIle is the latest edition. Value can be true or false.
locked Boolean Indicates if a File is locked. Value can be true or false.
contentPath String Directory structure path to the location of the physical file in the
export zip file.

Export Results: Sourcing Supplier Item Specs

Sourcing Supplier Item Specs attributes are listed in the order that they appear in the CSV file..

Field Data Type Description

number String The supplier item number

©2022 Arena, A PTC Business www.arenasolutions.com 925

 Arena REST API Developer Guide Objects

Field Data Type Description

supplier Reference Details of the Supplier. See Supplier object.
name String The supplier item name.
type StringPart, Process, The type of supplier item (basic category). This value can be PART,
Document PROCESS, or DOCUMENT
uom String The unit of measure of the supplier item.
description String The description of a supplier item.
procurementType String Procurement Type. Can be OTS or MTS.
offTheShelf Boolean True if procurment Type is OTS, else False
guid String The unique id for the Supplier Item Specs
creationDateTime Date-Formatted The date and time (in Zulu format) the the Supplier Item was
String created.
creator Reference The creator of the Supplier Item. Includes fullName and email.
M4O7LIMOZGZ7Q5TR50LG Custom attribute Supplier Item custom attribute.

Export Results: Sourcing Supplier Item Supplier Profile

Sourcing Supplier Item Supplier Profile attributes are listed in the order that they appear in the CSV file..

Field Data Type Notes

name String The name of the Supplier.
supplierId String The Supplier Identifier of the Supplier.
accountNumber String The account number of the Supplier.
description String The description of the Supplier
website String The website of the Supplier.
approvalStatus String The approval status of the Supplier. Possible values: approved,
unrated, disapproved
guid String The unique id of the Supplier
creationDateTime Date-Formatted The date and time (in Zulu format) the the Supplier was created.
String
creator Reference The creator of the Supplier. Includes fullName, guid, and email.
M4O7LIMOZGZ7Q5TR50LG Custom attribute A Supplier custom attribute.

Export Results: Sourcing Supplier Item Files

Sourcing Supplier Item File attributes are listed in the order that they appear in the CSV file..

Field Data Type Description

parent Reference The Supplier Item that the source relationships is associated with.
The parent designation has no relation to BOM relationships in

©2022 Arena, A PTC Business www.arenasolutions.com 926

 Arena REST API Developer Guide Objects

Field Data Type Description

this specific context. Includes number, supplier name, supplier
guid, guid, and name.
file Reference The File associated with the Supplier Item. Includes name, location,
number, edition, title, and strorageMethodName
guid String The unique id of the Supplier Item File.
primary True if primary file, Indicates whether or not a file is primary (primary files are linked
else False from the main view of objects to which they are associated.)
contentPath String Directory structure path to the location of the physical file in the
export zip file.

Event Queue: Integration Information

Field Data Type Description
guid String The unique id for the Integration. Currently only outbound
integrations are supported.
name String The name of the Integration.
status String The status of the Integration. Possible values: UP_TO_DATE,
DISABLED, IN_PROCESS, NEEDS_ATTENTION, NEEDS_UPDATE,
UPDATES_QUEUED, and RECONCILED.
type String The integration type. Currently only OUTBOUND_AUTOMATED
and OUTBOUND_MANAGED are supported.
transferType String The type of transfer being performed. Currently only
ITEM_REVISION and CHANGE is supported
integrationUser Reference Integration user information. fullName, guid, and email included.
enabled Boolean Determines whether Integration is enabled or disabled. Enabled
is true; disabled is false.
creator Reference User account information on the creator of the Integration.
Includes: fullName, guid, and email.
creationDateTime Date-Formatted The date and time (in Zulu format) the the Integration was created.
String
modifyUser Reference User who last modified the Integration. Included: fullName, guid
and email.
modifyDateTime Date-Formatted The date and time (in Zulu format) that the integration was last
String modified.

Event Queue: Integration Administrators

Field Data Type Description
administrators Reference User designated as an Integration Administrator.
fullName String Full name of the Integration Administrator.

©2022 Arena, A PTC Business www.arenasolutions.com 927

 Arena REST API Developer Guide Objects

Field Data Type Description

guid String Unique identifier for the Integration Administrator.
email String Email of the Integration Administrator.

Event Queue: Integration Event

Field Data Type Description
guid Reference The unique identifier for this particular event.
ItemsReconciled Boolean Indicates if all Items in the event are reconciled. True or False only
eventType String Identifies what caused the Event Items to become effective. Only
possible VALUES are: CHANGE and REVISIONING_EVENT
status String The status of the Integration Event. Possible values: UP_TO_DATE,
DISABLED, IN_PROCESS, NEEDS_ATTENTION, NEEDS_UPDATE,
UPDATES_QUEUED, and RECONCILED.
creator Reference User who caused the event. Included fields: email, fullName, and
guid.
creationDateTime Date-Formatted The data and time (in Zulu format) that this event was created.
String
change Reference Only appears if eventType is CHANGE. Included fields:
approvedOnDateTime, category, effectiveDateTime,
effectivityType, guid, number, and title.
revisioningEvent Reference Only appears if eventType is REVISIONING_EVENT. Included fields:
guid, number, and performedOnDateTime.

Event Queue: Integration Event Items

Field Data Type Description
guid String The unique identifier for this particular event Item.
effectiveItemRevision Reference The effective revision of the Event Item. Includes: guid, number,
revisionNumber, lifecyclePhase, modifiedBOM, modifiedFiles,
modifiedSourcing, and modifiedSpecs.
supersededItemRevision Reference The superseded revision of the Event Item. Includes: guid, number,
revisionNumber, lifecyclePhase, modifiedBOM, modifiedFiles,
modifiedSourcing, and modifiedSpecs.
reconciled Boolean Indicates whether an event Item is reconciled or not. True or False
values only.
reconciledDateTime The date and time (in Zulu format) when the event Item was
reconciled.
reconcileUser Reference The user who reconciled the Item. Included fields: guid, fullName,
and email.

©2022 Arena, A PTC Business www.arenasolutions.com 928

 Arena REST API Developer Guide Objects

Login
Field Data Type Description
loginDateTime Date-Formatted the date and time (in Zulu format) a user's session began
String
logoutDateTime Date-Formatted the date and time (in Zulu format) a user's session ended (null for
String currently logged in)
duration Integer The length in minutes of a session (null for currently logged in)
connectedThrough String The application Zone through which the user connected to Arena.
Values can be Arena; Arena-SolidWorks Integration; Arena
FileDrop; SmartLink; Arena PartsList; Arena REST API; Arena
Exchange; N/A
originatingIP String The IP from which the user connected to Arena
domain String The domain from which the user connected to Arena (null for
unknown)
user Reference The user logging in. See Compact User object.

Markup
Field Data Type Description
guid String The unique identifier for a file
title String The title of a file
name String The filename (with extension) of a file

Quality Number Format

Field Data Type Description
creationDateTime Date-Formatted the date and time (in Zulu format) a number Format was created
String
guid String The unique identifier for a number Format
lastUsed String The highest used value for the number format in the workspace
name String The name of a number format
nextValue String The next available value in the workspace for a number format
prefixes Array of strings The available prefixes for a number format. Each prefix contains
the attributes value and guid.

Quality Process
Field Data Type Description
completedDateTime Date-Formatted the date and time (in Zulu format) a Quality Process was
String completed

©2022 Arena, A PTC Business www.arenasolutions.com 929

 Arena REST API Developer Guide Objects

Field Data Type Description

creationDateTime Date-Formatted the date and time (in Zulu format) a Quality Process was created
String
creator Reference The user who created the Quality Process. Contains the atrributes
fullName and guid.
currentStep Reference Details of the current step of the Quality Process. This listing
includes the attributes approvals (null unless sign-off step),
attributes, and guid.
description String The description of a template
guid String The unique identifier for an object
name String The name of a Quality Process
number String The number of a Quality Process
owner Reference The name of the user who owns the Quality Process. Contains the
attributes fullName and guid.
status Boolean The status of a Quality Process. Value can be OPEN or COMPLETE.
statusMode Boolean The mode by which the status attribute advances from OPEN to
COMPLETE. Value can be AUTOMATIC or MANUAL. Default value
is MANUAL.
targetCompletionDate Date-Formatted The date a Quality Process is targeted for completion
String
template Reference Details of the template upon which a process was based. Contains
the attributes active and guid.
type String The type of the Quality Process. NOTE this always returns null.

Quality Process Step

Field Data Type Description
allowOwnerToAddApprovers Boolean Determines if a step owner can add users to the step
as approvers. Available only for steps of type SIGNOFF.
approvals Array of A reference to the approvals entered by approver users.
References Each value contains the attributes fullName and guid.
Available only for steps of type SIGNOFF.

Note: No approvals are shown in responses until all

approver users have entered a decision

assignee* String DEPRECATED - Please use assignees The user to

whom a step is assigned. Contains the attribute
fullName. Deprecated as of Winter 2021 release.
assignees Array of A reference to the assignee of a Quality step. Lists users
References if assignee is a single user. Lists userGroups if assignee
is a User Group.

©2022 Arena, A PTC Business www.arenasolutions.com 930

 Arena REST API Developer Guide Objects

Field Data Type Description

attributes Array of A reference to the attributes on a step. Each value
References contains the attributes apiName, fieldType, guid, name,
and value. Available only for steps of type REGULAR.
completeDateTime Date-Formatted the date and time (in Zulu format) a step was
String completed
completeUser String The user who completed the step. Contains the
attribute fullName.
dueDateTime Date-Formatted the date and time (in Zulu format) the step must be
String completed NOTE: Only the date portion of this string
is honored. Time always appears as 23:59:59 local time.
guid String The unique identifier for an object
name String The name of a step
order Integer The numeric value that determines a step's position in
a process
status Boolean The status of a Quality Process. Value can be OPEN or
COMPLETE
type Boolean Determines if a step includes approvals or not. Values
are REGULAR and SIGNOFF. Default value is REGULAR.
users String The user assigned to the Quality step. Also used to list
the members of a User Group.
userGroups String The User Group assigned to the quality step. Followed
by an array of users that comprise the User Group.

Quality Process Template

Field Data Type Description
active Boolean Indicates whether or not a template is available for users to select
when creating a quality process. The value can be true or false.
creationDateTime Date-Formatted the date and time (in Zulu format) a template was created
String
creator Reference The creator of a template. Contains the attribute fullName.
defaultNumberFormat Reference Details of the number format used by default for processes created
using a template. See Item Number Format object.
defaultOwner Reference The owner that is assigned by default to processes created based
upon a template
description String The description of a template
guid String The unique identifier for an object
name String The name of an item
numberFormats Reference Details of the number formats available for processes created
using a template. See Quality Process Number Format object.

©2022 Arena, A PTC Business www.arenasolutions.com 931

 Arena REST API Developer Guide Objects

Field Data Type Description

shortName String The short name for a template
steps Array of references A collection of references to steps included in a quality process
template.

Quality Process Template Step

Field Data Type Description
guid String The unique identifier for an object
name String The name of a step
order Integer The numeric value that determines a step's position in
a process
type Boolean Determines if a step includes approvers or not. Values
are REGULAR and SIGNOFF. Default value is REGULAR.
attributes Array of A reference to the attributes on a step. Each value
References contains the attribute guid. Available only for steps of
type REGULAR.
allowOwnerToAddApprovers Boolean Determines if a step owner can add users to the step
as approvers. Available only for steps of type SIGNOFF.
approvers Array of A reference to the approvers included in a step. Each
References value contains the attribute fullName. Available only
for steps of type SIGNOFF.

Quality Affected Object

Field Data Type Description
affected Reference The details of an affected object included in a quality
process step. See the Affected object
guid String The unique identifier for the affected object.
notes String Notes entered for the affected object.

Quality Affected
Field Data Type Description
description String description of the URL. This field is included when
Type=URL
display String Test string displayed within the application for this
URL. This field is included when Type=URL.
guid String The unique identifier for the affected object. This field
is included when Type=ITEM, QUALITY, or REQUEST.

©2022 Arena, A PTC Business www.arenasolutions.com 932

 Arena REST API Developer Guide Objects

Field Data Type Description

link String Internet address for this URL. This field is included when
Type=URL.
step Reference The specific step of the affected quality process that is
associated with this quality process step. This field is
included when Type=QUALITY.
type String The type of object associated with this quality process
step. Values can be ITEM, CHANGE, SUPPLIER, SUPPLIER
ITEM, FILE, QUALITY, or URL.

Report
Field Data Type Description
guid String the date and time (in Zulu format) an report began
title String The title of the report
type String The type of report. Values can be The type of export. Values can
be Changes: Modified Items; Changes: Lifecycle History; Changes:
Decision History; Changes: Attached Files; Changes:
Implementation; Changes: Summary; Changes; Items; Suppliers;
Supplier Items; Compliance BOM Report; Items: Summary; Items:
Costing; Items: Purchases; Items: Tickets; Requests: Summary;
Requests: Affected Items; Requests: Built Changes; Requests:
Lifecycle History; Requests: Recommendations; Requests:
Discussions (Issues/Responses); Users: Access History; Users:
Summary; Projects: Overview; Quality: Summary; Quality: Details;
Training: Records.
visibility Boolean Whether or not a report can be seen other users. Values can be
Personal - not visible or Shared - visible.

Report Run
Field Data Type Description
dateTime Date-Formatted the date and time (in Zulu format) an report began
String
description String The description of the report run
numberOfObjects Integer The number of objects in the report run
report Reference Details of the report. See Report object
user Reference The User who ran the report. See Compact User object.

Requirement
This object is only available through the Compliance Requirement object.

©2022 Arena, A PTC Business www.arenasolutions.com 933

 Arena REST API Developer Guide Objects

Field Data Type Description

guid String the unique identifier of a requirement
name String the name of a requirement

Source Relationship
Field Data Type Description
activeProduction Boolean Indicates if a source relationship is the active production
relationship. This value can be true or false.
activePrototype Boolean Indicates if a source relationship is the active prototype
relationship. This value can be true or false.
amlRank Integer The AML rank. This value is numeric.
approved Boolean Indicates if a source relationship is approved. This value can be
true or false.
creationDateTime Date-Formatted the date and time (in Zulu format) a source relationship was
String created
guid String The unique id for a source relationship
makeItem Boolean Indicates whether or not an item is made internally. This value
can be true (made internally) or false (made by supplier)
mfrItem Reference Details of the manufacturer Item. See Supplier Item object.
notes String The notes for a source relationship
vendorItem Reference Details of the vendor item. See Supplier Item object.
vendorItem String The conversion factor of the vendor item (how many used per
ConversionFactor one bought. e.g. for a roll of 100 resistors, when you use one at a
time, the conversion factor is 100). For a Make-Item Source
Relationship, this must be null.
url Array of References The direct urls of the object within the api and the application.

Quality Process Step Attribute

Field Data Type Description
active Boolean Indicates whether or not an attribute is available for Quality
Process steps. The value can be true or false.
allowNegatives Boolean Indicates whether or not a numeric value can be a negative
number. The value can be true or false.
creationDateTime Date-Formatted the date and time (in Zulu format) a step attribute was created.
String
decimalPlaces String Indicates the number of decimal places that should be specified
for the attribute.
defaultValue String The default value for an attribute
description String The description of an attribute

©2022 Arena, A PTC Business www.arenasolutions.com 934

 Arena REST API Developer Guide Objects

Field Data Type Description

displayAlways Boolean Indicates whether or not an attribute should always be displayed
for a step, even when no value has been entered. THe value can
be true or false.
example String Example values for an attribute. Examples can help users enter
acceptable values for an attribute.
fieldType String The type of attribute. This value can be SINGLE_LINE_TEXT,
MULTI_LINE_TEXT, DROP_DOWN, FIXED_DROPDOWN, DATE, or
NUMBER
guid String The unique identifier for an attribute. Step attributes always have
the guid field.
inViews String Specifies the views in which an attribute appears (e.g.
QUALITY_SUMMARY is the Summary view of a Quality Process).
This field is used only for Quality Processes.
maskingValue String If an attribute cannot be displayed to a user (most likely because
the user's access privileges do not allow them to view it), the
masking value determines what is displayed instead. maskingValue
is a system field and cannot be updated.
name String The name of the attribute
objectType String The type of object
required Boolean Indicates whether the attribute is required on creation.
possibleValues Array of Strings All possible values for a drop-down list. This field is used only for
attributes of type drop-down list.
userViewable Boolean Indicates whether an attribute is visible in the user interface. The
value can be true or false.

Supplier
Field Data Type Description
accountNumber Integer The account number of the supplier
additionalAttributes Array of Attributes The additional attributes of an item. This is an array of additional
attributes. Each additional attribute entry includes a value and
apiName. The apiName is used to identify this additional attribute.
addresses Array of addresses The addresses associated with a supplier. Each address entry
includes address1, address2, city, country, label, postalCode,
province, and state. Each address also includes the primary
attribute, which indicates whether or not an address is the primary
one for this supplier. For permissible vlues for country and state,
see the Create New Supplier workflow in the Arena application.
approvalStatus Boolean Indicates whether or not a supplier is listed as approved. This value
can be approved or disapproved.
creationDateTime Date-Formatted the date and time (in Zulu format) a supplier was created.
String

©2022 Arena, A PTC Business www.arenasolutions.com 935

 Arena REST API Developer Guide Objects

Field Data Type Description

creator Reference The creator of the supplier record. Contains the full name of the
creator.
description String The description of a supplier
guid String The unique identifier of a supplier
name String The name of a supplier
phoneNumbers Array of phone The phone numbers associated with a supplier. Each entry includes
numbers comment, extension, label, and number.
supplierId String The unique identifier of a supplier in the Arena database
website String The website of a supplier

Supplier Item
Field Data Type Description
additionalAttributes Array of Attributes The additional attributes of an item. This is an array of additional
attributes. Each additional attribute entry includes a value and
apiName. The apiName is used to identify this additional attribute.
creationDateTime* Date-Formatted DEPRECATED the date and time (in Zulu format) a supplier item
String was created.
Description String The description of a supplier item
guid String The unique id for a supplier item
name String The supplier item name
number String The supplier item number
offTheShelf Boolean Indicates whether or not the procurement type of the supplier
item is off the shelf. This value can be true (off-the-shelf) or false
(made-to-spec).
supplier Reference Details of the supplier. See Supplier object.
type String The type of supplier item (basic category). This value can be PART,
PROCESS, or DOCUMENT.
uom String The unit of measure of the supplier item

User
Field Data Type Description
email String The email address of the user
enabled Boolean Whether or not a user account is enabled in the workspace. Values
are True or False.
firstName String The first name of the user
fullName String The full (first and last) name of the user
guid String The unique identifier of a the user

©2022 Arena, A PTC Business www.arenasolutions.com 936

 Arena REST API Developer Guide Objects

Field Data Type Description

lastName String The last name of the user
type String The user type of the user. Values can be EMPLOYEE, PARTNER,
BASIC_SUPPLIER, ADVANCED_SUPPLIER, or INTEGRATION.

User Compact
Field Data Type Description
email String The email address of the user
fullName String The full (first and last) name of the user
guid String The unique identifier of a the user

Where Used Line

Field Data Type Description
lineNumber String The line number of the BOM where the Item appears
notes string notes entered for the BOM Line
quantity String the quantity of the Item on a BOM Line
refDes string The reference designator associated with the Item on a BOM Line

©2022 Arena, A PTC Business www.arenasolutions.com 937