Arena REST API Developer

Guide
REST API Guide
Version 2.60
Released on 3 December 2023
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.

2
Copyrights & Trademarks
Copyright © 2003-2023, 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.

3
 Change Log

Date Updates
December 1, 2023 The Import Engine now supports the creation editing,
overwriting, and deletion of Item-Files associations. By
extension the Import Engine also supports the reation,
editing, overwriting, and deletion of File resources.
API users can now approve quality process sign-off steps
with the new PUT Quality Process Decisions endpoint.
API users can now add approvers to a quality process sign-
off step with the new POST Quality Process Decisions
endpoint.
The GET Items Specs endpoint now includes the material
effectivity date, materialEffectivityDate, when the
responseView is set to full.
API users can now search for the routings available for a
specific change category through a new GET Settings
Change Category Routings endpoint.
API users can now obtain the current Arena version through
a new GET Settings Arena version endpoint.
To support the new restrict duplicate supplier item numbers
settings, API users can now add a string,
proceedOnWarning, of the POST Supplier Item and PUT
Supplier Item endpoints. When proceedOnWarning is set to
true, the Supplier Item endpoints will create a supplier item

4 Arena REST API Developer Guide

Date Updates
with a duplicate number even when workspace settings
explicitly restricts the creation of duplicate supplier item
numbers.
API users can now run execute a DataExtract run at a time
of their own choosing through a new POST Extracts
endpoint.
As a best practice, we encourage all users to include a
‘User-Agent’ within the header for each API call. For now,
check the note in the Arene REST API > About API Format
article.
May 20, 2023 Import Engine: Added import Definition endpoints and
import Run endpoints. Definition endpoints configure the
settings of an import. Run endpoints utilize the GUID
obtained from an import Definition and a source file to
import item specs and item BOM data into a workspace.
Added POST, PUT, GET, and Delete Change
Implementation Task endpoints. Similar endpoints added for
Change Implementation Task Notes and Change
Implementation task Files.
Change Item Attribute object now supports a new global
property.
The lifecycle phases and lifecycle phase changes endpoints
now support custom Abandoned, Deprecated and Obsolete
phases. Change item endpoints now support direct
revisioning of Abandoned, Deprecated, and Obsolete
phases.
The GET Tickets Templates and GET Quality Process
Templates endpoints now support two new search attributes:
name and active.
The GET /items and GET /items/GUID endpoints now
support a new parameter labeled responseview. The new
parameter responseview allows users to customize the
response data from the two GET items endpoints. By setting
responseview to a specific value, users can change the
default data for each GET items endpoint.
The GET, POST, and PUT endpoints that reference Change
resources now return a new property labeled url. Url returns
two references that are direct urls for the Change resource:
api and app. Note that the url property was added for items
endpoints in April of 2022.

Change Log 5
Date Updates
The POST changes/GUID/items endpoint no longer requires
the newLifecyclePhase attribute within the request body.
January 6, 2023 Arena REST API capability expands to the Request view of
a Change and includes the following new endpoints:
Ability to perform a general search for the Requests to a
specific Change.
Ability to perform a GUID search for a specific Request to a
specific Change.
Ability to add a Request to a specific Change.
Ability to remove a Request from a specific Change.
Arena REST API also now includes two new endpoints for
searching Changes associated with a Request:
Ability to perform a general search for Changes associated
to a specific Request.
Ability to perform a search by GUID for a specific Change
associated to a Request.
With Event Engine support for Requests, Arena REST API
now includes the following endpoints:
Ability to perform a general search for Request related
events from a specific event in a specific outbound-event
integration.
Ability to perform a search for a specific Request event
from a specific event in a specific outbound-event
integration.
Ability to reconcile or unreconcile a Request specific event.
In addition to the above endpoints, the existing GET
Triggers, GET Outbound-Event Integration Triggers, and
the GET Outbound-Events Integration Events endpoints
(and their specific variants) now support the Request world.
To support the new After Approval option for Retrain when
adding Training Plan Items to a Change, a new retraining
attribute is now included in the Change Affected Item object
used in GET Change Items, GET Change Item, POST
Change Items, and PUT Change Items. The retraining
attribute supports the values NO_RETRAIN, AFTER_
APPROVED, and AFTER_EFFECTIVE. The existing

6 Arena REST API Developer Guide

Date Updates
retrainingRequired attribute is used in the GET endpoints,
but not in the request body for the GET POST Change Items
and PUT Change Items endpoints.
GET Items now supports the inAssembly and assemblyType
attributes. Additionally inAssembly and assemblyType are
now included in the Item objects for the GET Items and the
GUID specific GET Items earch. For for more details see
the Winter 2023 release notes.
The GET Request Attributes and GET Request Category
Attributes now include support for editable Request core
attributes.
Developers can now set specific attributes to null through a
PUT endpoint. To set an attribute to null, users can append
the PUT endpoint with "setnull=true". The table below
summarizes the attributes that can be set to null. For for
more details see the Winter 2023 release notes.
To better assist Arena API developers, API error codes are
now unique. Previously, duplicate error codes represented
different errors. In conjunction with the Arena-Onshape
integration, a new section of Arena Help now details 59
errors that deal with possible Arena-Onshape integration
issues with item and login endpoints. While introduced as
possible errors for the Arena-Onshape integration, the error
codes also apply to errors for item and login Arena API
endpoints. A table that compares the old error codes with
new error codes is available in Arena Help. A more
complete and detailed list of possible API error codes will
be included in future releases.
June 26, 2022 • Added endpoints that support Training Plans. Includes
creating, editing, searching, deleting, and status
modification of a Training Plan. Also added endpoints
for searching, editing, and removing objects from the
following Training Plan views: Items, Users,
References, Records, and Files. Also added endpoints
for returning training managers and training number
sequences.
• Added Item endpoints and File endpoints that return all
Training Plans that incorporate those Items and Files.
GET Quality Process Step Affected objects endpoints
now return Training Plans that include the Quality
Process as a reference.

Change Log 7
Date Updates
• Added five POST endpoints that process the workflows
of Requests. The following functions are supported:
Submitting a Request, Withdraing a Request, Deferring
a Request, and Closing a Request. Also added is a GET
endpoint that returns the request attributes used when a
request undergoes a lifecycle status change.
• The GET BOM endpoint now documents support for
the includeAdditionalAttributes parameter. If included
and set to true, it returns additional attributes (also
referred to as BOM attributes) for each child item.
• GET category attribute endpoints for Items, Changes,
and Requests include a new attribuite field labeled
origin. Origin returns information on the inheritance of
an Attribute object. When used in conjunction with the
global field, users can determine if an object attribute
originates from inheritance from a parent category, from
being defined in the object category, or from being
defined as a global attribute. Origin consists of a GUID
and a name field.
• All POST, PUT, and DELETE Settings endpoints have
been removed from all API documentation.
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.

8 Arena REST API Developer Guide

Date Updates
• 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.
• Triggers with edit actions now create events based on
the pre-event state of the category, edited attributes, and

Change Log 9
Date Updates
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

10 Arena REST API Developer Guide

Date Updates
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.
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.

Change Log 11
Date Updates
• 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.
• 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

12 Arena REST API Developer Guide

Date Updates
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

Change Log 13
Date Updates
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.
• 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

14 Arena REST API Developer Guide

Date Updates
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, • GET Item Categories no longer includes deleted
2020 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.
• 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
[Link] using the GUID for uncategorized.
The [Link] works for all other categorized
GUIDs. To run an export for uncategorized Items
use the following criteria: attribute is euqal to
[Link], 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

Change Log 15
Date Updates
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, Added support for Allow/Disallow Duplicate and Allow/
2018 Disallow Manual Revision Entry by Change category. This
affects GET Change Categories.
September 16, Added support for Enforce Default options for Effectivity
2018 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

16 Arena REST API Developer Guide

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, Small updates from December 3 release, including Path
2017 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, Minor updates to GET Items and GET Item Categories.
2017
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, Added Get Recent Activity endpoints
2016
November 13, Added Get User and Get Users endpoints

Change Log 17
Date Updates
2016
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, Updated Arena DataExtract run endpoints; Added Item and
2015 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
December 21, Added Supplier Item sourcing, compliance, and file
2014 endpoints
November 2, 2014 Added some fixes around searchable attributes in GET calls
Added Supplier, Supplier Item, and Source Relationship
October 26, 2014 EDIT and DELETE endpoints. Added Arena DataExtract
endpoints.
Added Supplier, Supplier Item, and Source Relationship
August 3, 2014
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

18 Arena REST API Developer Guide

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

19
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 N/A ✔ ✔ ✔ ✔
Lines
Item Source N/A ✔ ✔ ✔ ✔
Relation-
ships
Item N/A ✔* ✔ N/A N/A
Revisions
Item Files N/A ✔ ✔ ✔ ✔
Associa-
tions
Item N/A ✔ ✔ ✔ -
Compliance
Require-
ments
Item Where N/A N/A ✔ N/A N/A
Used
Item ✔
Lifecycle
Item Export ✔ ✔ ✔ N/A N/A
Change ✔ ✔ ✔ ✔ ✔
Summary
Records
Change ✔ ✔ ✔ ✔ ✔
Affected
Items
Supplier ✔ ✔ ✔ ✔ ✔
Profile
Supplier ✔
Quality

20 Arena REST API Developer Guide

 Search Create Read Update Delete
Supplier ✔ ✔ ✔ ✔ ✔
Item
Summary
Supplier N/A ✔ ✔ ✔ ✔
Item File
Associa-
tions
Supplier N/A ✔ ✔ ✔ -
Item
Compliance
Require-
ments
Supplier ✔
Item
Sourcing
File ✔ ✔ ✔ ✔ ✔
Records
File ✔ ✔
Editions
File ✔
Associa-
tions
Quality ✔ ✔ ✔ ✔ ✔
Process
Summary
Quality N/A - ✔ - -
Process
Details
Quality ✔ ✔ ✔ ✔ ✔
Process
Step/
Affected
Objects
DataExtract ✔
Outbound ✔ ✔ ✔
Integrations
Recent ✔
Activity

NOTES

Theory of Operation 21
* Item Revisions are created using the items/lifecyclephasechanges endpoint.

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 [Link] the base API URL
is [Link]
For example, a request to return all Items in a workspace would be
[Link]
If the user's workspace is accessed through [Link] the base API
URL is [Link]
For example, a request to return all Items in a workspace would be
[Link]
If the user's workspace is accessed through [Link] the
base API URL is [Link]
For example, a request to return all Items in a workspace would be
[Link] .
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")

22 Arena REST API Developer Guide

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.
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)

Note
As of our Fall 2023 release, we now encourage all users to submit a
meaningful attribute labeled ‘User-Agent’ within the request header. User-
Agent is used to identify the user who is calling the API.
User-Agent should follow the following format: “Name/Version [Optional
Comment”. Example: “Arena Solutions ERP Integration/1.1”
Within the following releases, we’ll be updating the API documentation to
reflect this change.

Connecting and Permissions

Connect to the Arena API service by providing your Arena login credentials
(username and password) in a Log In on page 45 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.

Theory of Operation 23
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 arena-sales@[Link].
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:
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.

24 Arena REST API Developer Guide

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
[Link]
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>"
},
…
]
}

When a request returns one or more errors:

{
"errors": [

Theory of Operation 25
 {
"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.

26 Arena REST API Developer Guide

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 returned if the item number already exists and
exists duplicate item numbers are not allowed in the
workspace.
415 Unsupported media returned if no content-type/wrong content-type is
type 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. Users can reach the Downloads
page by selecting the Downloads option within the Help drop-down menu. 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.

Theory of Operation 27
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 BOM Setting When this is set to ON for a BOM, Arena
Designator 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.
Automatic BOM Setting When this is set to ON for a BOM, Items added
Line Number to the BOM are sorted by Item Number, and a
Generation line number is assigned automatically. When set
to OFF for a BOM, you can specify a persistent
line number for each BOM Item.
Reference Workspace When this is set to ON for a workspace, Arena
Designator Setting enforces the following when creating a new
Checking for assembly:
New 1. the quantity for a row must match the
Assemblies 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 Workspace When this is set to YES for a workspace, you
Quantities Setting can specify a negative quantity for a BOM Line.
Allowed When set to NO for a workspace, negative
quantities will result in an error.

28 Arena REST API Developer Guide

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 on page 1103 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.

Theory of Operation 29
 2
Endpoints
GET Arena Version....................................................................................................45
POST Log In .............................................................................................................45
PUT Log Out.............................................................................................................48
GET Extracts Search .................................................................................................49
GET Extract ..............................................................................................................51
GET Extract Runs Search ..........................................................................................53
GET Extract Run .......................................................................................................57
GET Data Extract Latest ............................................................................................59
GET Extract Run Files ...............................................................................................61
GET Extract Run File .................................................................................................64
GET Extract Run File Content ....................................................................................66
POST Run DataExtract..............................................................................................68
GET Files Search ......................................................................................................69
GET File Summary ....................................................................................................73
GET File Content.......................................................................................................74
POST File Create ......................................................................................................76
PUT File Summary Update.........................................................................................78
POST File Content Update.........................................................................................83
DELETE File .............................................................................................................84
GET File Editions ......................................................................................................85
GET File Corrections .................................................................................................87
GET File Correction...................................................................................................89
POST File Edition Create ...........................................................................................91
POST File Correct .....................................................................................................94
POST File Check Out ................................................................................................97
POST Cancel File Check Out .....................................................................................99
POST File Check In ................................................................................................. 101
GET File Markups ................................................................................................... 103
GET File Markup ..................................................................................................... 105
GET File Markup Content......................................................................................... 107
POST File Markup Create ........................................................................................ 108

30 Arena REST API Developer Guide

PUT File Markup Update.......................................................................................... 112
DELETE File Markup ............................................................................................... 116
GET File Item Associations ...................................................................................... 117
GET File Item Association........................................................................................ 119
GET File Supplier Item Associations ......................................................................... 120
GET File Supplier Item Association........................................................................... 122
GET File Supplier Associations ................................................................................ 124
GET File Supplier Association .................................................................................. 125
GET File Change Associations ................................................................................. 126
GET File Change Association................................................................................... 128
GET File Change Implementation Associations ......................................................... 129
GET File Change Implementation Association ........................................................... 131
GET File Request Associations ................................................................................ 132
GET File Request Association .................................................................................. 134
GET File Quality Process Associations ..................................................................... 135
GET File Quality Process Association ....................................................................... 137
GET Training Plans Associated With A File ............................................................... 139
GET A Training Plan Associated With A File .............................................................. 140
GET Items (Search)................................................................................................. 141
GET Items (Search) Criteria Parameter..................................................................... 150
GET Item Specs...................................................................................................... 158
POST Item Create ................................................................................................... 162
PUT Item Update..................................................................................................... 171
GET Item Thumbnail Image Content ......................................................................... 179
POST Item Specs Thumbnail Image Create .............................................................. 180
POST Item Specs Thumbnail Image Create From Files View...................................... 182
DELETE Item Thumbnail Image ............................................................................... 183
DELETE Item.......................................................................................................... 184
GET BOM............................................................................................................... 185
GET BOM Line........................................................................................................ 191
GET BOM Settings .................................................................................................. 194
POST BOM Line Create........................................................................................... 195
PUT BOM Line Update ............................................................................................ 199
PUT BOM Settings Update....................................................................................... 204
DELETE BOM Line.................................................................................................. 205
GET BOM Subsitutes .............................................................................................. 207
GET BOM Subsitute ................................................................................................ 209
POST BOM Substitute Create .................................................................................. 210
PUT BOM Substitute Create .................................................................................... 212
DELETE BOM Substitute ......................................................................................... 214
GET Item Compliance Requirements ........................................................................ 215
GET Item Compliance Requirement.......................................................................... 217
PUT Item Compliance Update .................................................................................. 218
GET Item File Associations ...................................................................................... 220
GET Item File Association........................................................................................ 222
GET Item File Content ............................................................................................. 224
POST Item File Create............................................................................................. 225

Endpoints 31
POST Item File Add Existing .................................................................................... 228
POST Item File Content Update ............................................................................... 231
POST File Update ................................................................................................... 232
PUT Item File Association Update ............................................................................ 234
DELETE Item File Association.................................................................................. 236
POST Item Lifecycle Phase Change ......................................................................... 237
GET Item Quality Processes .................................................................................... 240
GET Item Revisions................................................................................................. 242
GET Item Future Changes ....................................................................................... 245
GET Item Source Relationships................................................................................ 247
GET Item Source Relationship ................................................................................. 251
POST Item Source Relationship Create .................................................................... 253
PUT Item Source Relationship Update ...................................................................... 256
DELETE Item Source Relationship ........................................................................... 258
POST Item Compliance ........................................................................................... 259
DELETE Item Compliance ....................................................................................... 261
GET Where Used .................................................................................................... 263
GET Training Plans Associated With An Item ............................................................ 265
GET A Training Plan Associated With An Item............................................................ 266
GET Training Records Associated With An Item ........................................................ 267
GET A Training Record Associated With An Item ....................................................... 269
GET Item-To-Item References.................................................................................. 270
GET Item-To-Item Reference ................................................................................... 272
POST Item-To-Item Reference Create ...................................................................... 273
PUT Item-To-Item Reference Update ........................................................................ 275
DELETE Item-To-Item Reference ............................................................................. 278
GET Item Quality Processes .................................................................................... 279
GET Item Ticket References .................................................................................... 280
About Criteria and Options in API Export ................................................................... 282
Export Options ........................................................................................................ 283
Export Criteria ......................................................................................................... 285
Criteria: Attributes and Operators ............................................................................. 288
About Export Results and the JSON Format .............................................................. 293
POST Export Definition............................................................................................ 295
GET Export Definitions (Search)............................................................................... 305
GET Export Definition .............................................................................................. 312
POST Export Run.................................................................................................... 314
POST Export Run (Multiple Guids) ........................................................................... 317
GET Export Runs .................................................................................................... 320
GET Export Run...................................................................................................... 324
GET Export Run File Metadata ................................................................................. 326
GET Export Run File Content (Download) ................................................................. 328
GET Integrations (Search) ....................................................................................... 330
GET Integrations ..................................................................................................... 333
GET Integration Administrators ................................................................................ 334
GET Events (Search)............................................................................................... 336
GET Event .............................................................................................................. 342

32 Arena REST API Developer Guide

GET Event Item Guids ............................................................................................. 344
PUT Event .............................................................................................................. 346
GET Event Items ..................................................................................................... 349
GET Event Item....................................................................................................... 360
PUT Event Item....................................................................................................... 362
About the Import Engine .......................................................................................... 365
Import Engine: Best Practices Overview.................................................................... 366
Import Engine Best Practices: Create the Import Definition ......................................... 368
Import Engine Best Practices: Run the Import............................................................ 370
Import Engine Best Practices: Check if the data is ready ............................................ 370
Import Engine Best Practices: Commit the Import ...................................................... 372
Import Engine: File Associations and File Creation..................................................... 373
Import Engine Modes............................................................................................... 374
Import Options (Item Specs and Item BOM)............................................................... 375
Import Mapping: Items Specs ................................................................................... 383
Import Mapping: Item BOM ...................................................................................... 384
Import Mapping: Item Files ....................................................................................... 385
Import Mapping: File Summary................................................................................. 387
Import Engine Source File........................................................................................ 389
GET Import Definitions (Search) ............................................................................... 389
GET Import Definition .............................................................................................. 396
POST Item Definition ............................................................................................... 398
PUT Import Definition Edit........................................................................................ 404
GET Import Run ...................................................................................................... 406
POST Import Run.................................................................................................... 408
PUT Import Commit................................................................................................. 411
GET Import Run Submit Content File Content............................................................ 414
GET Import Run Result Content ............................................................................... 415
GET Import Run Error Content ................................................................................. 416
GET Requests ........................................................................................................ 417
GET Request .......................................................................................................... 426
POST Request Create ............................................................................................. 428
PUT Request Edit.................................................................................................... 430
DELETE Request .................................................................................................... 433
GET Request Items ................................................................................................. 435
GET Request Affected Item...................................................................................... 437
POST Request Item Add.......................................................................................... 438
PUT Request Item Edit ............................................................................................ 440
DELETE Request Item............................................................................................. 441
GET Request File View Associations ........................................................................ 442
GET Request Files View Association ........................................................................ 445
POST Request Files View Add Existing File .............................................................. 447
DELETE Request File View Association.................................................................... 449
GET Request File Markups ...................................................................................... 450
GET Request File Markup........................................................................................ 452
POST Request File Markup Create........................................................................... 454
DELETE Request File Markup.................................................................................. 456

Endpoints 33
GET Request Quality Processes .............................................................................. 457
GET All Changes Associated with a Request ............................................................. 459
GET All Changes Associated with a Request ............................................................. 461
GET Request Status Change Attributes .................................................................... 463
POST Requests Status Change (Unsubmitted to Submitted) ...................................... 465
POST Requests Status Change (Submitted to Promoted) .......................................... 467
POST Requests Status Change (Submitted to Deferred)............................................ 469
POST Requests Status Change (Submitted to Unsubmitted) ...................................... 470
POST Requests Status Change (Submitted to Closed) .............................................. 471
POST Requests Status Change (Promoted to Closed) ............................................... 473
POST Requests Status Change (Closed to Promoted) ............................................... 475
POST Requests Status Change (Deferred to Submitted)............................................ 477
POST Requests Status Change (Deferred to Unsubmitted) ........................................ 479
GET Changes ......................................................................................................... 480
GET Change........................................................................................................... 490
GET Change Affected Items..................................................................................... 496
GET Change Affected Item ...................................................................................... 501
GET Change Quality Processes ............................................................................... 505
POST Change Create.............................................................................................. 508
PUT Change Edit .................................................................................................... 516
DELETE Change..................................................................................................... 525
POST Change Affected Item Add ............................................................................. 526
PUT Change Affected Item Edit ................................................................................ 530
DELETE Change Affected Item ................................................................................ 534
POST Change Status (Lock/Unlock) ......................................................................... 535
POST Change Status (Submitting and Admin-Defined) .............................................. 537
POST Change Status (Submitting and Auto-Routing)................................................. 542
POST Change Status (Submitting and User-Defined)................................................. 545
GET Change Alerts ................................................................................................. 547
POST Change Status (Complete) ............................................................................. 549
POST Change Status (Complete With Implementation Status) ................................... 551
POST Change Status (Force Expire Deviations) ........................................................ 553
POST Change Status (Unmarking as Complete)........................................................ 554
POST Change Status (Reopen) ............................................................................... 556
POST Change Status (Cancel)................................................................................. 558
POST Change Status (Force Reject) ........................................................................ 559
POST Change Status (Force Approve) ..................................................................... 561
POST Change Status (Withdraw) ............................................................................. 563
GET Change Files View Associations ....................................................................... 565
GET Change Files View Association ......................................................................... 568
POST Change Files View Add Existing File ............................................................... 569
DELETE Change File View Association .................................................................... 571
GET Change Implementation Files View Associations................................................ 572
GET Change Implementation Files View Association ................................................. 576
POST Change Implementation Files View Add Existing File ....................................... 578
DELETE Change Implementation File View Association ............................................. 580
GET Change File Markups ....................................................................................... 581

34 Arena REST API Developer Guide

GET Change File Markup......................................................................................... 583
POST Change File Markup Create ........................................................................... 585
DELETE Change File Markup .................................................................................. 587
GET All Requests Associated with a Change ............................................................. 588
GET A Specific Request Associated with a Change.................................................... 589
POST Add a Request to a Change............................................................................ 591
DELETE Remove a Request from a Change ............................................................. 592
GET Change Implementation Tasks.......................................................................... 593
GET Change Implementation Task ........................................................................... 595
POST Change Implementation Task ......................................................................... 596
PUT Change Implementation Task............................................................................ 598
DELETE Change Implementation Task ..................................................................... 599
GET Change Implementation Task Notes .................................................................. 600
GET Change Implementation Task Note ................................................................... 602
POST Change Implementation Task Note ................................................................. 603
PUT Change Implementation Task Note.................................................................... 604
DELETE Change Implementation Task Note ............................................................. 606
GET Change Implementation Task Files.................................................................... 607
GET Change Implementation Task File ..................................................................... 608
POST Change Implementation Task File ................................................................... 610
DELETE Change Implementation Task File ............................................................... 611
GET Changes Ticket References.............................................................................. 612
GET Quality Processes Search ................................................................................ 614
GET Quality Process Summary ................................................................................ 620
POST Quality Process Create .................................................................................. 622
PUT Quality Process Update.................................................................................... 624
DELETE Quality Process ......................................................................................... 627
POST Quality Process Complete.............................................................................. 628
POST Quality Process Reopen ................................................................................ 630
GET Quality Process Step Affected Objects .............................................................. 632
GET Quality Process Step Affected Object ................................................................ 635
POST Quality Process Step Affected Object Add ....................................................... 636
PUT Quality Process Step Affected Object Update..................................................... 640
DELETE Quality Process Step Affected Object.......................................................... 642
GET Quality Process Steps...................................................................................... 643
GET Quality Process Step ....................................................................................... 648
GET Quality Process Step Decisions ........................................................................ 650
PUT Quality Process Step Update (User Assignee) ................................................... 654
PUT Quality Process Step Update (User Group Assignee) ......................................... 659
PUT Quality Process Step Update (Deprecated)........................................................ 663
POST Quality Process Step Add Decision Makers ..................................................... 666
PUT Quality Process Step Make Decision ................................................................. 668
POST Quality Process Step Complete ...................................................................... 670
POST Quality Process Step Reopen......................................................................... 672
GET Training Plan Record ....................................................................................... 674
GET Training Plan Records...................................................................................... 676
DELETE Training Plan Quality Process..................................................................... 679

Endpoints 35
POST Add Training Plan Quality Process .................................................................. 680
GET Training Plan Quality Process Reference........................................................... 681
GET Training Plan Quality Process References ......................................................... 683
DELETE Training Plan Item...................................................................................... 684
POST Add Training Plan Item ................................................................................... 685
GET Training Plan File............................................................................................. 687
GET Training Plan Files ........................................................................................... 688
POST Training Plans Files View Add Existing File...................................................... 691
DELETE Training Plans Remove File Association...................................................... 693
GET Training Plan Item............................................................................................ 694
GET Training Plan Items .......................................................................................... 695
DELETE Training Plan Users ................................................................................... 697
PUT Update Training Plan User................................................................................ 698
POST Add Training Plan Users................................................................................. 700
GET Training Plan User ........................................................................................... 701
GET Training Users ................................................................................................. 702
GET Training Manager ............................................................................................ 704
GET Training Managers........................................................................................... 705
GET Training Plan Number Sequences..................................................................... 706
GET Training Plan Number Sequence ...................................................................... 707
PUT Training Plan Edit............................................................................................. 709
POST Training Plans Status Change ........................................................................ 712
GET Training Plan ................................................................................................... 713
GET Training Plans (Search).................................................................................... 715
DELETE Training Plans ........................................................................................... 719
POST Training Plan Create ...................................................................................... 720
GET Tickets ............................................................................................................ 722
GET Ticket.............................................................................................................. 730
POST Ticket Create................................................................................................. 732
PUT Ticket Edit ....................................................................................................... 736
POST Ticket Status Change..................................................................................... 738
DELETE Ticket ....................................................................................................... 740
GET Ticket Files...................................................................................................... 741
POST Tickets Files View Add Existing File ................................................................ 745
DELETE Ticket Remove File Association .................................................................. 747
GET Ticket Changes ............................................................................................... 748
POST Tickets Add Change Reference ...................................................................... 749
DELETE Ticket Remove Change Association ............................................................ 751
GET Ticket Items..................................................................................................... 752
POST Tickets Add Item Reference ........................................................................... 753
DELETE Ticket Remove Item Association ................................................................. 755
GET Ticket Quality Processes .................................................................................. 756
POST Tickets Add Quality Process Reference........................................................... 758
DELETE Ticket Remove Quality Process Association ................................................ 759
GET Ticket Tickets .................................................................................................. 760
POST Tickets Add Ticket Reference ......................................................................... 762
DELETE Ticket Remove Ticket Association............................................................... 763

36 Arena REST API Developer Guide

GET Triggers .......................................................................................................... 765
GET Trigger ............................................................................................................ 770
GET Outbound-Events Integrations (Search)............................................................. 772
GET Outbound-Event Integrations ............................................................................ 775
GET Outbound-Event Integration Triggers................................................................. 777
GET Outbound-Event Integration Trigger .................................................................. 778
GET Integration Administrators ................................................................................ 780
GET Outbound-Events Integration Events ................................................................. 781
GET Outbound-Event Integration Event .................................................................... 786
GET Outbound-Event Integration Items Event ........................................................... 787
GET Outbound-Event Integration Requests Event ..................................................... 796
GET Outbound-Event Integration Changes Event ...................................................... 804
GET Outbound-Event Integration Quality Event ......................................................... 809
PUT Outbound-Event Event Item Reconcile .............................................................. 813
PUT Outbound-Event Event Requests Reconcile....................................................... 815
PUT Outbound-Event Event Change Reconcile ......................................................... 817
PUT Outbound-Event Event Quality Reconcile .......................................................... 819
GET Recent Activity - User Access ........................................................................... 821
GET Recent Activity - Exports .................................................................................. 823
GET Recent Activity - Report Runs ........................................................................... 825
GET Recent Activity - File Access............................................................................. 827
GET Item Attributes ................................................................................................. 829
GET BOM Attributes ................................................................................................ 837
GET Item Categories ............................................................................................... 841
GET Item Category Attributes................................................................................... 850
GET Item Category Attributes................................................................................... 853
GET Item Number Formats ...................................................................................... 858
GET Item Lifecycle Phases ...................................................................................... 862
GET Item Compliance Requirements ........................................................................ 864
GET Export Setting Attributes................................................................................... 866
GET Requests Categories ....................................................................................... 870
GET Request Attributes ........................................................................................... 873
GET Request Category Attributes............................................................................. 876
GET Request Item Attributes.................................................................................... 879
GET Request Number Prefixes ................................................................................ 882
GET Request Number Sequences............................................................................ 883
GET Request Administrators .................................................................................... 885
GET Request Evaluator Groups ............................................................................... 887
GET Change Administrators..................................................................................... 888
GET Change Administrator ...................................................................................... 890
GET Change Attributes............................................................................................ 891
GET Change Item Attributes .................................................................................... 894
GET Change Number Prefixes ................................................................................. 900
GET Change Category Attributes ............................................................................. 902
GET Change Categories.......................................................................................... 905
GET Change Category Routings .............................................................................. 908
GET Change Routings............................................................................................. 910

Endpoints 37
GET Change Implementation Statuses ..................................................................... 911
GET Change Implementation Task Templates ........................................................... 913
GET Change Implementation Task Template ............................................................. 914
GET Supplier Attributes ........................................................................................... 916
GET Supplier Item Attributes .................................................................................... 919
GET Supplier Item Compliance Requirements........................................................... 922
GET File Attributes .................................................................................................. 924
GET File Categories ................................................................................................ 928
GET Quality Process Templates ............................................................................... 932
GET Quality Process Number Formats ..................................................................... 947
GET Quality Process Attributes ................................................................................ 950
GET Quality Process Step Attributes......................................................................... 955
GET Quality Process Owners................................................................................... 958
GET Tickets Attributes ............................................................................................. 959
GET Tickets Number Sequence Prefixes................................................................... 962
GET Tickets Number Sequences.............................................................................. 963
GET Tickets Templates ............................................................................................ 965
GET Tickets Templates Attributes ............................................................................. 971
GET Users.............................................................................................................. 973
GET User Groups.................................................................................................... 977
GET User Group ..................................................................................................... 979
GET User Group Employees .................................................................................... 980
GET User Group Employee...................................................................................... 982
GET User Group Partners........................................................................................ 984
GET User Group Partner ......................................................................................... 985
GET User Group Machines ...................................................................................... 987
GET User Group Machine........................................................................................ 988
GET User Group Users............................................................................................ 990
GET User Group User ............................................................................................. 991
GET Suppliers ........................................................................................................ 993
GET Supplier (Profile).............................................................................................. 996
POST Supplier Create ............................................................................................. 999
PUT Supplier Update............................................................................................. 1003
DELETE Supplier .................................................................................................. 1009
GET Supplier Address ........................................................................................... 1010
GET Supplier Addresses........................................................................................ 1011
GET Supplier Profile Phone Numbers ..................................................................... 1013
GET Supplier Phone Number ................................................................................. 1015
POST Supplier Profile Address Create.................................................................... 1016
POST Supplier Phone Number Create .................................................................... 1018
PUT Supplier Profile Address Edit .......................................................................... 1019
PUT Supplier Phone Number Edit........................................................................... 1021
DELETE Supplier Address ..................................................................................... 1023
DELETE Supplier Phone Number ........................................................................... 1024
GET Supplier File Associations .............................................................................. 1025
GET Supplier File Association ................................................................................ 1027
POST Supplier File Add Existing ............................................................................ 1029

38 Arena REST API Developer Guide

DELETE Supplier File Association .......................................................................... 1031
DELETE Supplier File............................................................................................ 1032
GET Supplier Quality Processes............................................................................. 1033
GET Supplier Items ............................................................................................... 1035
GET Supplier Item Specs....................................................................................... 1040
POST Supplier Item Create.................................................................................... 1042
PUT Supplier Item Update ..................................................................................... 1046
GET Supplier Item Thumbnail Image Content .......................................................... 1051
POST Supplier Item Specs Thumbnail Image Create ............................................... 1053
POST Supplier Item Specs Thumbnail Image Create From Files View....................... 1054
DELETE Supplier Item Thumbnail Image ................................................................ 1056
DELETE Supplier Item........................................................................................... 1057
GET Supplier Item Compliance .............................................................................. 1058
GET Supplier Item Compliance Requirement .......................................................... 1060
PUT Supplier Item Compliance Update ................................................................... 1061
GET Supplier Item File Associations ....................................................................... 1064
GET Supplier Item File Association......................................................................... 1067
GET Supplier Item File Content .............................................................................. 1068
POST Supplier Item File Create.............................................................................. 1070
POST Supplier Item File Content Update ................................................................ 1073
POST Supplier Item File Add Existing .................................................................... 1075
PUT Supplier Item File Association Update ............................................................. 1077
DELETE Supplier Item File Association................................................................... 1079
POST Supplier Item Compliance ............................................................................ 1080
DELETE Supplier Item Compliance ........................................................................ 1082
GET Supplier Item Quality Processes ..................................................................... 1083
GET Supplier Item Source Relationships................................................................. 1085
GET Supplier Item Source Relationship .................................................................. 1088

Endpoints 39
Resource Actions Resource Actions
Access POST Log In on page 45 Item Files GET Item File
PUT Log Out on page 48 Associations on page 220
GET Item File
Data GET Extracts Search on Association on page 222
Extract page 49
GET Item File Content on
GET Extract on page 51 page 224
GET Extract Runs Search POST Item File Create on
on page 53 page 76
GET Extract Run on page POST Item File Add
57 Existing on page 228
GET Data Extract Latest POST Item File Content
on page 59 Update on page 231
GET Extract Run Files on PUT Item File
page 61 Association Update on
GET Extract Run File on page 234
page 64 DELETE Item File
GET Extract Run File Association on page 236
Content on page 66
Files GET Files Search on page Item POST Item Lifecycle
69 Lifecycle Phase Change on page
GET File Summary on
Phase 237
page 73 Change
Item GET Item Quality on page
GET File Content on page
74 Quality 240
Item GET Item Revisions on
POST File Create on page
Revisions page 242
76
PUT File Summary
Update on page 78POST
File Content Update on
page 83
DELETE File on page 84
File GET File Associations on Item GET Item Source
Associa- page Sourcing Relationships on page
tions 247
File GET File Editions on page GET Item Source
Editions 69 Relationship on page 251
POST File Edition Create
on page 69

40 Arena REST API Developer Guide

Resource Actions Resource Actions
POST Item Source
Relationship Create on
page 253
PUT Item Source
Relationship Update on
page 256
DELETE Item Source
Relationship on page 258
Item GET Items Search on Item Where GET Where Used on page
page 141 Used 263
GET Item Specs on page
Item GET Item Compliance
158 Compliance Requirements on page
215
POST Item Create on
page 162 GET Item Compliance
Requirement on page 217
POST Item Update on
page 171 PUT Item Compliance
Update on page 218
DELETE Item on page 184
Item BOM GET BOM on page 185 Change GET Changes on page
GET BOM Line on page 480
191 GET Change on page 490
GET BOM Settings on POST Change Create on
page 194 page 508
POST BOM Line Create PUT Change Edit on page
on page 195PUT BOM 516
Line Update on page 199
DELETE Change on page
PUT BOM Settings 525
Update on page 204
DELETE BOM Line on
page 205
Quality GET Quality Process Change GET Change Affected
Process Search on page 614 Affected Items on page 496
GET Quality Process Item GET Change Affected
Summary on page 620 Item on page 501
POST Quality Process POST Change Affected
Create on page 622PUT Item Add on page 526
Quality Process Update
PUT Change Affected
on page 624 Item Edit on page 530

Endpoints 41
Resource Actions Resource Actions
DELETE Quality Process DELETE Change Affected
on page 627 Item on page 534
Quality GET Quality Process Step Supplier GET Suppliers on page
Process Aff Objs on page 632 993
Affected GET Quality Process Step GET Supplier Profile on
Aff Obj on page 635 page 996
POST Quality Process POST Supplier Create on
Step Aff Obj Add on page 999
page 636 PUT Supplier Update on
PUT Quality Process Step page 1003
Aff Obj Update on page DELETE Supplier on page
640 1009
DELETE Quality Process
Step Aff Obj on page 642
Quality GET Quailty Process Supplier GET Supplier Quality
Process Steps on page 643 Quality Processes on page 1033
Steps GET Quality Process Step
on page 648
PUT Quality Process Step
Update on page 663
Recent GET Recent Activity _ Supplier GET Supplier Items on
Activity User Access on page 821 Item page 1035
GET Supplier Item on
GET Recent Activity _
Exports on page 823 page 1040
POST Supplier Item
GET Recent Activity _
Create on page 1042
Report Runs on page 825
PUT Supplier Item
GET Recent Activity _
Update on page 1046
File Access on page 827
DELETE Supplier Item on
page 1057
Settings GET Item Attributes on Supplier GET Supplier Item
page 829 Item Compliance on page 1058
GET BOM Attributes on Compliance GET Supplier Item
page 837 Compliance Requirement
GET Item Categories on
on page 1060
page 841 PUT Supplier Item
Compliance Update on
page 1061

42 Arena REST API Developer Guide

Resource Actions Resource Actions
GET Item Category
Supplier GET Supplier Item File
Attributes on page Item Files Associations on page
858GET Item Number 1064
Formats on page 185 GET Supplier Item File
GET Item Lifecycle Association on page 1067
Phases on page 862 GET Supplier Item File
GET Item Compliance Content on page 1068
Requirements on page POST Supplier Item File
864 Create on page 1070
GET Change Attributes POST Supplier Item File
on page 891 Content Update on page
GET Change Item 1073POST Supplier Item
Attributes on page File Add Existing on
page 1075PUT Supplier
GET Change Categories Item File Association
on page 905 Update on page 1077
GET Change Category DELETE Supplier Item
Attributes on page 902 File Association on page
GET Change Number 1079
Prefixes on page 900 Supplier GET Supplier Item

GET Change Routings on

Item Quality Processes on
page 910 Quality page 1083
Supplier GET Supplier Item Source
GET Supplier Attributes
on page 916 Item Relationships on page
Sourcing 1085
GET Supplier Item
Attributes on page 919
GET Supplier Item
Compliance
Requirements on page
922GET File Attributes
on page 924
GET File Categories on
page 928GET Quality
Process Templates on
page 932GET Quality
Process Number Formats
on page 947
GET Quality Process
Attributes on page
950GET Quality Process

Endpoints 43
Resource Actions Resource Actions
Step Attributes on page
955GET Quality Process
Owners on page 958
GET Users on page 973

44 Arena REST API Developer Guide

GET Arena Version
/settings/arena
This endpoint returns the current version of Arena. Please note that there is a
difference between the Arena version number and the Arena API version number.
The Arena version number is the current Arena release number.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the current Arena release number.
GET /settings/arena
{
arenaVersionId": "79.0.0"
}

POST Log In
/login

Endpoints 45
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

Standard login for Employees
{
"email":"user@[Link]",
"password":"xxxx",
"workspaceId":123456789
}
Machine User Login (email and password)
{
"email": "everyhome_machine_user@[Link]",
"password": "9ySBZ3E5D8tsbYk8dZ"
"workspaceId": 897691453
}
Machine User Login (web token)
{
"webtoken":
"0684pB2P7qFc2c9T53GLXYc9csK92ptNA2XvNYKMphyHUx31LU-
VaARm2tHKw1700692993452",

46 Arena REST API Developer Guide

 "workspaceId": 897691453
}

Note
If workspaceID is omitted, user will log into the last workspace visited.

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

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

/login
Employee or Partner response
{
"arena_session_id":"LABS-MXQKenjxWmyUIlJTKwQDfimkZksjpkO0|",
"workspaceId":123456789,
"workspaceName":"EveryRoad GPS",
"workspaceRequestLimit":1000
}
Machine User Login Response (for both passwords and webtoken logins)
{

Endpoints 47
 "arenaSessionId": "LABS-UYOYciSbex0xjaP6n5PMn7OstbAKSnez|",
"workspaceId": 897691453,
"workspaceName": "EveryScan - UM"
}
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."
}
]
}

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

48 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

/logout
no JSON response

GET Extracts Search

/extracts
Returns a collection of Extract on page 1114 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.

Endpoints 49
Searchable Attributes
Name Value Description
name string Data Extract name
[Link] 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

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

50 Arena REST API Developer Guide

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."
}
]
}

GET Extract
/extracts/<GUID>
Returns a single Extract on page 1114 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

Endpoints 51
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"
}
Request with invalid GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

52 Arena REST API Developer Guide

GET Extract Runs Search
/extracts/<GUID>/runs
Returns Extract Run on page 1114 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

Endpoints 53
Name Value Description
before this date and time
completionDateTime- string Include runs completed
From after this date and time
completionDateTimeTo string Include runs completed
before this date and time
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

54 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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":[
{
"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",

Endpoints 55
 "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"
}
]
}
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.
{

56 Arena REST API Developer Guide

 "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.

GET Extract Run

/extracts/<GUID>/runs/<GUID>
Returns an Extract Run on page 1114 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

Endpoints 57
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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,
"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":[

58 Arena REST API Developer Guide

 {
"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.

GET Data Extract Latest

/extracts/<GUID>/runs/latestCompleted
Returns a single Extract on page 1114 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

Endpoints 59
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the latest data extract, including file information
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."
}
]
}

60 Arena REST API Developer Guide

GET Extract Run Files
/extracts/<GUID>/runs/<GUID>/files
Returns Extract Run File Association on page 1115 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.

Endpoints 61
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.

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

62 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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
},
"guid":"3L5O2Z35GXG6P8R88MYW"
}
]
}
An error is returned if:
1. the GUID is not valid.
{
"status":400,
"errors":[

Endpoints 63
 {
"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.

GET Extract Run File

/extracts/<GUID>/runs/<GUID>/files/<GUID>
Returns an Extract Run File Association on page 1115 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

64 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",
"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":[

Endpoints 65
 {
"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.

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

66 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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,
"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.

Endpoints 67
POST Run DataExtract
/extracts/<GUID>/runs
Allows a user or a machine to run a DataExtract through Arena’s API. Creates an
Extract Run on page 1114 object for a run with a given GUID for an extract with a
given GUID.
API user must be an account administrator with a full license. Workspace must
have the DataExtract feature enabled.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Request Body
[No Submit Body]

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Execute a data extract run.
POST /extracts/<GUID>/runs
{

68 Arena REST API Developer Guide

 "completionDate":"2015-04-20T20:14:21Z",
"creationDateTime":null,
"creator":{
"fullName":"Extract Extraction"
},
"guid":"BTDWA7BDO5OFYH0J2L22",
"runDate":"2015-04-20T20:14:15Z",
"scheduledDate":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.
3. Error also occurs if this endpoint is executed at the same time as a scheduled
DataExtract run.

GET Files Search

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

Endpoints 69
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
[Link] 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.

70 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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":"[Link]",
"number":"FILE-000172",
"title":"500 board image for MPI"
},
{
"category":{
"guid":"M4O7QY5R7FY8RATAYXNX",
"name":"Design Drawing",
"path":"File\\Engineering\\Design Drawing"

Endpoints 71
 },
"checkedOut": false,
"creationDateTime":"2006-09-21T20:49:34Z",
"edition":"01",
"format":"pdf",
"guid":"J1L4NV2O4CVBUDW57LPY",
"name":"[Link]",
"number":"FILE-000145",
"title":"500 board footprint"
},
...
]
}

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":"[Link]",
"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":[

72 Arena REST API Developer Guide

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

GET File Summary

/files/<GUID>
Returns a File on page 1115 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
Get a file with a given GUID
GET <url>/files/<GUID>

Endpoints 73
{
"author":{
"fullName":"Heidi Walker"
},
"category":{
"guid":"M4O7QY5R7FY8RATAYXNX",
"name":"Design Drawing",
"path":"File\\Engineering\\Design Drawing"
},
"checkedOut": false,
"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":"[Link]",
"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."
}
]
}

GET File Content

/files/<GUID>/content
Returns file content belonging to a file with a given GUID.

74 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

Endpoints 75
POST File Create
/files
Creates a new File on page 1115 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:
[Link]: Heidi Walker
[Link]: 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"

76 Arena REST API Developer Guide

 },
"description":"500 board early spec",
"edition":"2",
"location":"[Link]/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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",

Endpoints 77
 "format":"PDF",
"guid":"GYI16WW251K0J2TITQ1O",
"hasMarkup":false,
"lastModifiedDateTime":"2014-02-24T22:41:19Z",
"latest":true,
"location":"[Link]/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."
}
]
}

PUT File Summary Update

/files/<GUID>
Updates a File on page 1115 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.

78 Arena REST API Developer Guide

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

Set Null
Name Value Description
setnull Append the URL with
setnull=true to set
description or format to
null. Attributes must be
included within the
request body and set to
null. Insert setnull after
the query string,
represented by a ?, after
the GUID.

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"
}

Endpoints 79
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",
"format":"url",
"location":"[Link]
"storageMethodName": "WEB",
"private":false,
"title":"Link to Assembly Instructions for 324-0263"
}

Sample Request Body - Set to Null

In this example, a File attribute is set to null.
PUT /files/<GUID>?setnull=true
{
"format":null
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

80 Arena REST API Developer Guide

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,
"name":"[Link]",
"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":"[Link]
"locked": false,
"mimeType": null,

Endpoints 81
 "name": null,
"number": "FILE-045893",
"private": false,
"size": 0,
"storageMethodName": "WEB",
"private":false,
"title":"Link to Assembly Instructions for 324-0263"
}
Sets a file attribute to null.
PUT /files/<GUID>?setnull=true
{
"author":{
"fullName":"John Parker"
},
"category":{
"guid":"EWGZDAEGR8R1K3J1LPP3"
},
"creationDateTime":"2013-03-14T23:19:28Z",
"description":"Assembly Instructions",
"edition":"B-1",
"format":null,
"guid":"GYI16WXX6DVYH0J2LEVZ ",
"hasMarkup":false,
"lastModifiedDateTime":"20170123132756",
"latest":true,
"location":null,
"locked":false,
"mimeType":null,
"name":"[Link]",
"number":"FILE-000544",
"private":false,
"size":125083,
"storageMethodName":"FILE",
"title":"Assembly Instructions for 324-0263"
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"EWGZDAEGR8R1K3J1LPP3\" is not
valid."
}
]
}

82 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
no JSON response
An error is returned if:
1. the GUID is not valid.

Endpoints 83
 {
"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."
}
]
}

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

84 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

GET File Editions

/files/<GUID>/editions
Returns a collection of File on page 1115 objects for a File with a given GUID.

Endpoints 85
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",
"description":"Assembly instructions",
"edition":"3",
"format":"pdf",
"guid":"9ASCVEMTFV3M2L4NWYCGO",
"hasMarkup":false,

86 Arena REST API Developer Guide

 "lastModifiedDateTime":"2016-02-01T22:28:10Z",
"latest":true,
"location":null,
"locked":true,
"mimeType":"text/plain",
"name":"[Link]",
"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."
}
]
}

GET File Corrections

/files/<GUID>/corrections
Returns a collection of corrected File on page 1115 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

Endpoints 87
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

{
"count": 5,
"results":[
{
"correctedDateTime": "2020-09-16-T14:26:45Z",
"correctedUser": {
"guid": "608R5268J0JZI1RPMHYM",
"fullName":"Helen Rodgers"
"email": "hrdogers@[Link]"
},
"file":{
"author":{
"fullName":"Heidi Walker"
},
"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":"[Link]",
"number":"FILE-000593",
"private":false,
"size":14081,
"storageMethodName":"FILE",

88 Arena REST API Developer Guide

 "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."
}
]
}

GET File Correction

/files/<GUID>/corrections/<guid>
Returns a correction of File on page 1115 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

Endpoints 89
Name Value Description
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

{
"correctedDateTime": "2020-09-16-T14:26:45Z",
"correctedUser": {
"guid": "608R5268J0JZI1RPMHYM",
"fullName":"Helen Rodgers"
"email": "hrdogers@[Link]"
},
"file":{
"author":{
"fullName":"Heidi Walker"
},
"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":"[Link]",
"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
{

90 Arena REST API Developer Guide

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

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:
[Link]: Heidi Walker
[Link]: WEYHMCDDMTCM5O08WPWY
description: Assembly Instructions
edition: 2
format: txt

Endpoints 91
private:false
storageMethodName: FILE
title: Assembly Instructions for 324-0263
File attribute:
content: [physical file]

Sample Request Body - no uploaded content

{
"file":{
"author":{
"fullName":"John Parker"
},
"category":{
"guid":"ZH0J2L4EXGS0NF91"
},
"description":"500 board early spec",
"edition":"2",
"format": "url",
"location":"[Link]/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

92 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",
"latest":true,
"location":"[Link]/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.
{

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

POST File Correct

/files/<guid>/corrections
Creates a corrected File on page 1115 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]

94 Arena REST API Developer Guide

Sample Request Body - no uploaded content
{
"comments": "Correcting typo in File Title.",
"storageMethodName":"WEB",
"removeOriginalContent": false,
"location": "[Link]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": "hrdogers@[Link]",
"fullName":"Helen Rodgers",
"guid": "938R5268J0JZI1RPMHYM"
},
"file":{
"author":{
"fullName":"John Parker"

Endpoints 95
 },
"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,
"location":"[Link]/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."
}
]
}

96 Arena REST API Developer Guide

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

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

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": "hwalker@[Link]",
"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 [Link]",
"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.

98 Arena REST API Developer Guide

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

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

Endpoints 99
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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 [Link]",
"number": "FILE-000867",
"private": false,
"size": 12326,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "USB CABLE A-A Datasheet"
}
}

100 Arena REST API Developer Guide

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.\""
}
]
}

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
[Link]: Heidi Walker
[Link]: 3L507K5WJM5FYHW334R7
[Link]: A design file
[Link]: 2
[Link]": pdf
[Link]: K2M501MD03M2L47YKQ5B
[Link]: false

Endpoints 101
[Link]: FILE
[Link]: New Design File
[Link]: [the physical file]

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

checkedOut: false
comment: check the file in
new edition: false
[Link]: Heidi Walker
[Link]: 3L507K5WJM5FYHW334R7
[Link]: A design file
[Link]: 2
[Link]": pdf
[Link]: 2K4N1Y24FWFVEXN0XFLX
[Link]: false
[Link]: FILE
[Link]: New Design File
[Link]: [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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
No JSON response.

102 Arena REST API Developer Guide

• 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."
}
]
}

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

Endpoints 103
Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": {
"guid": "0I2L4H2TGJ2CVET001OY"
},
"creationDateTime": "2011-07-25T22:38:18Z",
"format": "doc",
"guid": "1J3M5I3UHK3J2LN69BYY",
"lastModifiedDateTime": "2011-07-25T22:38:18Z",
"locked": true,
"mimeType": "application/msword",
"name": "[Link]",
"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"

104 Arena REST API Developer Guide

 },
"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
},
...
]
}
Returns an error if a parameter is not a valid search attribute.
{
"status":400,
"errors":[
{
"code":3019,
"message":"The attribute \"edition\" is not searchable."
}
]
}

GET File Markup

/files/<GUID>/markups/<GUID>
Returns a File Markup object with a given GUID. This is the latest edition of the
File.

Endpoints 105
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",
"format": "doc",
"guid": "1J3M5I3UHK3J2LN69BYY",
"lastModifiedDateTime": "2011-07-25T22:38:18Z",
"locked": true,
"mimeType": "application/msword",

106 Arena REST API Developer Guide

 "name": "[Link]",
"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."
}
]
}

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

Endpoints 107
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

POST File Markup Create

/files/<GUID>/markups
Creates a File Markup File on page 1115 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.

108 Arena REST API Developer Guide

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
[Link]:James Yan
[Link]:pdf
[Link]:Checkin Endpoint Test Update
[Link]:FILE
[Link]:0I2L4H2TGJ2CVET001OY
File attribute:
content: [physical file]

Sample Request Body - no uploaded content

{
"markup": {
"storageMethodName": "WEB",
"location":"[Link]/winter_tour_2021.com",
"title":"Winter 2021 Tour",
"format":"pdf",
"author": {
"fullName":"James Deckard"
}
},
"reserved": true
}

Response Codes
Code Description
201 Success
400 Failure

Endpoints 109
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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 [Link]",
"size": 15148,
"storageMethodName": "FILE",
"title": "Checkin Endpoint Test Update"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"reserved": true,
"reservedUser": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",

110 Arena REST API Developer Guide

 "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": "[Link]",
"locked": false,
"storageMethodName": "WEB",
"title": "Winter 2021 Tour"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"reserved": true,
"reservedUser": {
"email": "hwalker@[Link]",
"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.

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

Endpoints 111
 "code":3033,
"message":"The file content is missing."
}
]
}

PUT File Markup Update

/files/<GUID>/markups/<GUID>
Updates a File on page 1115 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

Set Null
Name Value Description
setnull Append the URL with
setnull=true to set
[Link] to null.
Attributes must be
included within the
request body and set to
null. Insert setnull after
the query string,
represented by a ?, after
the GUID.

112 Arena REST API Developer Guide

Sample Request Body

Note
This example shows all editable attributes.

[Link]: FILE
[Link]: <file stream>
[Link]: Q8SBPMQS3K3J2LC0SX84
[Link]: SmartWall 3000 Updated Drawing
[Link]: PDF
[Link]: 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":"[Link]/en_US/2021-update-file.
html",
"title":"Proposed 2021 Update",
"format":"pdf",
"author": {
"fullName":"Rachel Borger"
}
},
"reserved": false
}

Sample Request Body - Set [Link] to Null

In this example. the [Link] is set to null.
PUT /files/<GUID>/markups/<GUID>?setnull=true
[Link]: FILE
[Link]: <file stream>
[Link]: Q8SBPMQS3K3J2LC0SX84
[Link]: SmartWall 3000 Updated Drawing
[Link]: null
[Link]: John Sneath
reserved: false

Response Codes
Code Description
201 Success
400 Failure

Endpoints 113
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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.
{
"guid": "ASCVERC3QT7WFYOVDX3P",
"markup": {
"author": {
"fullName": "Rachel Borger"

114 Arena REST API Developer Guide

 },
"category": {
"guid": "2K4N6J4VIL4EXGV223PR"
},
"creationDateTime": "2021-01-22T03:22:20Z",
"format": "pdf",
"guid": "EWGZIVG7UXGWFYOVDX3G",
"lastModifiedDateTime": "2021-01-22T03:32:58Z",
"location":"[Link]/en_US/2021-update-file.
html",
"locked": false,
"storageMethodName": "WEB",
"title": "Proposed 2021 Update"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"reserved": false
}
Updates the file markup to null.
PUT /files/<GUID>/markups/<GUID>?setnull=true
{
"guid": "ASCVERC3QT7WFYOVDX3P",
"markup": {
"author": {
"fullName": "John Sneath"
},
"category": {
"guid": "Q8SBPMQS3K3J2LC0SX84"
},
"creationDateTime": "2021-01-22T03:22:20Z",
"format": null,
"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
}
Request with bad GUID
{

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

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

116 Arena REST API Developer Guide

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."
}
]
}

GET File Item Associations

/files/<GUID>/items
Returns a list of Item association GUIDs (and information about the associated
Items) 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

Endpoints 117
Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a collection of item associations for a specific file.
GET /files/<GUID>/items
{
"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
}
]
}
]
}

118 Arena REST API Developer Guide

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

GET File Item Association

/files/<GUID>/items/<GUID>
Returns a specific item association GUIDs 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 119
Sample Response Body
A specific file item association.
GET <url>/files/<GUID>/items/<GUID>
{
"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
}
]
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not
valid."
}
]
}

GET File Supplier Item Associations

/files/<GUID>/supplieritems
Returns a list of Supplier Item association GUIDs (and limited information about
the associated Supplier Item) for a File with a given GUID.

120 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a File's Supplier Item associations
GET <url>/files/<GUID>/supplieritems
{
"count":6,
"results":[
{
"guid":"O6Q9E455EL37Q95FRH30",
"supplierItem":{
"guid":"O6Q9E455EL49SBB1KF69",
"number":"AQW454A",
"supplier":{
"guid":"I0K38YZZ8FY4N6B122AL",
"name":"Aromat"
}
}
},
{

Endpoints 121
 "guid":"KEYH0DYPCFWFYH0JSIPD",
"supplierItem":{
"guid":"9J3M5I3UHK1M5O7Q9S0V",
"number":"CBDY454A",
"supplier":{
"guid":"QEYH0DYPCFWFYH0JSIPD",
"name":"Cyberdyne Industries"
}
}
},
{
"guid":"AO8RAN8ZMP6Q9SBUDTFF",
"supplierItem":{
"guid":"7P9SBO90NQ9H0F3XUEJR",
"number":"VAR454A",
"supplier":{
"guid":"VRX38YZZ8FY4N6B122AL",
"name":"Variance Inc"
}
}
},
...
]
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not
valid."
}
]
}

GET File Supplier Item Association

/files/<GUID>/supplieritems/<GUID>
Returns a supplier item association GUID 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

122 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

File Supplier Item association
GET <url>/files/<GUID>/supplieritems/<GUID>
{
"guid":"O6Q9E455EL37Q95FRH30",
"supplierItem":{
"guid":"O6Q9E455EL49SBB1KF69",
"number":"AQW454A",
"supplier":{
"guid":"I0K38YZZ8FY4N6B122AL",
"name":"Aromat"
}
}
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not
valid."
}
]
}

Endpoints 123
GET File Supplier Associations
/files/<GUID>/suppliers
Returns a list of Supplier association GUIDs (and limited information about the
associated Supplier) 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a File's Supplier associations
GET <url>/files/<GUID>/suppliers
{
"count":6,
"results":[
{
"guid":"5N7QVLMMV2JRATA2GJ6E",
"supplier":{
"guid":"UCWFKABBKRAGZINDEEM1",
"name":"Avnet"

124 Arena REST API Developer Guide

 }
},
{
"guid":"9V3Q9M7YLOZ3M5GLXZ0K",
"supplier":{
"guid":"YG0J2AJJGXGM5O7FOOG1",
"name":"Adaptive Circuit Boards"
}
},
{
"guid":":DB1K3G1SFITXGZBRWP1K",
"supplier":{
"guid":"UCWFY6FFCTCI1K3B82OC",
"name":"The Board Room"
}
},
...
]
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not
valid."
}
]
}

GET File Supplier Association

/files/<GUID>/suppliers/<GUID>
Returns a File Supplier association GUID 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

Endpoints 125
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

A specific File Suppliers Association
GET <url>/files/<GUID>/suppliers/<GUID>
{
"guid":"5N7QVLMMV2JRATA2GJ6E",
"supplier":{
"guid":"UCWFKABBKRAGZINDEEM1",
"name":"Avnet"
}
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not
valid."
}
]
}

GET File Change Associations

/files/<GUID>/changereferences

126 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Change Reference Associations
GET <url>/files/<GUID>/changereferences
{
"count": 3,
"results": [
{
"change": {
"guid": "5N7QVLNO10JM5N3XEDYU",
"number": "ECO-001442"
},
"guid": "1J3MRHJKXWDK3MH0VGMC"
},
{
"change": {

Endpoints 127
 "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."
}
]
}

GET File Change 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

128 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Change Reference Association
GET <url>/files/<GUID>/changereferences/<GUID>
{
"change": {
"guid": "CUEX2SUV87QTCUA2CVF8",
"number": "ECO-001452"
},
"guid": "I0K38Y01EDU1K3YHEUEL"
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not
valid."
}
]
}

GET File Change Implementation

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.

Endpoints 129
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Change Implementation Associations
GET <url>/files/<GUID>/changeimplementations
{
"count": 3,
"results": [
{
"change": {
"guid": "5N7QVLNO10JM5N36I97P",
"number": "ECO-000621"
},
"guid": "J1L49Z12FEV2L4G0BHZW"
},
{
"change": {
"guid": "CUEX2SUV87QTCUA2CVF8",
"number": "ECO-001452"
},
"guid": "VDXGLBDERQ7EXGSCNLHO"
},

130 Arena REST API Developer Guide

 {
"change": {
"guid": "O6Q9E467KJ25O6MG49QC",
"number": "ECO-001446"
},
"guid": "TBVEJ9BCPO5CVEQAM4SC"
}
]
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not
valid."
}
]
}

GET File Change Implementation

Association
/files/<GUID>/changeimplementations/<GUID>
Returns a Change File 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

Endpoints 131
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

File Change Implementation Association
GET <url>/files/<GUID>/changeimplementations/<GUID>
{
"change": {
"guid": "CUEX2SUV87QTCUA2CVF8",
"number": "ECO-001452"
},
"guid": "VDXGLBDERQ7EXGSCNLHO"
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not
valid."
}
]
}

GET File Request Associations

/files/<GUID>/requests
Returns a list of Requests association GUIDs (and limited information about the
associated Requests) for a File with a given GUID.

132 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Requests associations for a specific file
GET <url>/files/<GUID>/requests
{
"count":6,
"results":[
{
"guid":"4S1JM4YCFHIWJ45QNWJ0",
"request":{
"guid":"Z2M6BZX2ZJAYI06T6RCG",
"number":"ECR-000004"
}
},
{
"guid":"RTZ2LYJAX0JTCVAHHI66",
"request":{
"guid":"N5P8R4PG36PO7QXI618R",
"number":"ECR-000014"

Endpoints 133
 }
},
{
"guid":"9Z6P8L6XKN4L4N6P7X7E",
"request":{
"guid":"O6Q9S5QH47QP8RYJ729F",
"number":"ECR-000033"
}
},
...
]
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not
valid."
}
]
}

GET File Request Association

/files/<GUID>/requests/<GUID>
Returns a file request association GUID 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

134 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

A specific File Request association
GET <url>/files/<GUID>/requests/<GUID>
{
"guid":"4S1JM4YCFHIWJ45QNWJ0",
"request":{
"guid":"Z2M6BZX2ZJAYI06T6RCG",
"number":"ECR-000004"
}
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not
valid."
}
]
}

GET File Quality Process Associations

/files/<GUID>/qualityprocesses
Returns a list of Quality Process association GUIDs (and limited information
about the associated Quality Processes) for a File with a given GUID.

Endpoints 135
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a File's Quality Process associations
GET <url>/files/<GUID>/qualityprocesses
{
"count":6,
"results":[
{
"guid":"9RBUZPQQZ6N3M5O79TKC",
"qualityProcess":{
"guid":"4M6PUKLLU1KGZI1KYBRS",
"number":"NCMR-000002",
"step":{
"guid":"6O8RWMNNW3MI1K3M0DT2",
"name":"Action Taken"
}
}
},
{

136 Arena REST API Developer Guide

 "guid":"DFR16WXX6DUDWFYHPRY3",
"qualityProcess":{
"guid":"XFZINDEENUD9SBUDTFH4",
"number":"8D-000003",
"step":{
"guid":"YG0JOEFFOVEATCVEUGI5",
"name":"Action Taken"
}
}
},
{
"guid":"2UV4N6J4VIL40J2L4N0B3",
"qualityProcess":{
"guid":"K2M5O1MD03ML1K3MVZIC",
"number":"CAR-000003",
"step":{
"guid":"Q6Q9S5QH47QMFO7QZ3MG",
"name":"Immediate Containment"
}
}
},
...
]
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not
valid."
}
]
}

GET File Quality Process Association

/files/<GUID>/qualityprocesses/<GUID>
Returns a specific file's quality process association GUID for a file with a given
GUID.

Endpoints 137
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

A specific File Quality Process association
GET <url>/files/<GUID>/qualityprocesses/<GUID>
{
"guid":"9RBUZPQQZ6N3M5O79TKC",
"qualityProcess":{
"guid":"4M6PUKLLU1KGZI1KYBRS",
"number":"NCMR-000002",
"step":{
"guid":"6O8RWMNNW3MI1K3M0DT2",
"name":"Action Taken"
}
}
}
Request with bad GUID
{
"status":400,
"errors":[

138 Arena REST API Developer Guide

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

GET Training Plans Associated With A

File
files/<GUID>/trainingplans
Returns all the files associated within a specific Training Plan. In terms of the
browser-based application, this endpoint returns the Training Plans located within
the Associations view of 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 139
Sample Response Body
Get the Training Plans within the Associations view of a File.
GET files/<GUID>/trainingplans
{
"count": 2,
"results": [
{
"guid": "HZJ2LYJAX0DSBUDVA6PX",
"trainingplan": {
"guid": "1J3M5I3UHK1M5O7Q9S0V",
"number": "TRP-000002"
}
},
{
"guid": "4M6P8L6XKN0FYH0IXN99",
"trainingplan": {
"guid": "FXH0JWH8VYF0J2L4NZB8",
"number": "TRP-000004"
}
}
]
}

GET A Training Plan Associated With A

File
files/<GUID>/trainingplans/<GUID>
Returns a specific Training Plan associated within a specific File. Using the
browser-based application as a point of comparison, this endpoint returns a
specific Training Plan located within the Associations view of 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

140 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific Training Plan with a given GUID within the Associations view of a
File with a given GUID.
GET files/<GUID>/trainingplans/<GUID>
{
"guid": "4M6P8L6XKN0FYH0IXN99",
"trainingplan": {
"guid": "FXH0JWH8VYF0J2L4NZB8",
"number": "TRP-000004"
}
}

GET Items (Search)

/items
Returns a collection of Compact Item on page 1120 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

Endpoints 141
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.

142 Arena REST API Developer Guide

Name Value Description
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 on
page 150.
responseview string Allows users to customize
the scope and size of the
response data. Possible
values and definitions:
• minimum - returns
the GUID, item
number, and url.
• compact - returns the
commen set of data
that includes some
core attrinutes in
addition to the
attributes returned in
the minimum
response.
• full - returns the
complete set of data
including custom
attributes.

Endpoints 143
Searchable Attributes
Name Value Description
[additional attribute guid string This special search
value] permits searching for
strings in additional
attribute values. For
example GET /items?
VDXGZ7E0-
GO5N6P8PR55G=
*100pF where
VDXGZ7E0-
GO5N6P8PR55G 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 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:

144 Arena REST API Developer Guide

Name Value Description
GET /items?
4M6PUJNPNM3L4N25-
ZZ5F=2019-04-01
assemblyType String Possible values include:
TOP_LEVEL_
ASSEMBLY;
ASSEMBLY; NOT_AN_
ASSEMBLY
Top level assemblies are
items that contain
assemblies but
themselves are not
included as items in
another item's assembly.
[Link] string category unique ID
[Link] string the full name (first and
last) of the creator of the
item
[Link] string creator unique ID
name string item name
number string item number
revisionNumber string revision number
description string item description
[Link] 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)
[Link] string lifecyclePhase unique ID
modifiedBom true or false true indicates the BOM of
the item includes
modifications to the

Endpoints 145
Name Value Description
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

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.
For additional attribute field type MULTI_LINE_TEXT searches, different
values can be separated with an asterisk.
For additional attribute field types DROP_DOWN & FIXED_DROP_DOWN
searches, different values can be separated with a semi-colon.
When using a semi-colon to separate values in a FIXED_DROP_DOWN
search, note that the semi-colon will always act as an OR. This is relevant
when performing a Multi-Select search.
For example with FIXED_DROP_DOWN, multiselect = True: GET /Items?
J1L49Y281EVDWFUXRSCZ=Option 1;Option 2 will return all Items where
the FIXED_DROP_DOWN contains Option 1 OR Option 2 (or both). On the
other hand FIXED_DROP_DOWN, multiselect=False: GET /items?
J1L49Y281EVDWFUXRSCZ=Option 1;Option 2 will return all Items where
the FIXED_DROP_DOWN equals Option 1 OR Option 2.
Search in Zulu format is supported for custom attribute field type Date.
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.

146 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all items
GET /items
{
"count":20,
"results":[
{
"assemblyType": "ASSEMBLY",
"category":{
"guid":"5N6P8RAK3MY6UNTA"
},
"creationDateTime":"2011-06-02T19:23:31Z",
"guid":"VDXGLBCCLSBSBQMM0SJU",
"inAssembly": true,
"lifecyclePhase":{
"guid":"7G6P3WAD3MG6GNFD",
"name":"In Production"
},
"name":"PCBA, EveryRoad, Model 300",
"number":"830-00001",
"revisionNumber":"D",
"url": {
"api": "[Link]
VDXGLBCCLSBSBQMM0SJU",
"app": "[Link]
},
...

Endpoints 147
 ]
}
Get items with owner "James Deckard" and in category "Subassembly"
GET <url>/items?[Link]=James
Deckard&[Link]=UCWFKABBKRAK3MY6UNTU
{
"count":4,
"results":[
{
"assemblyType": "ASSEMBLY",
"category":{
"guid":"ZH1K3K3JFSBL4N6O1ZQS"
},
"creationDateTime":"2011-02-11T16:52:40Z",
"guid":"FXH0J0JZV8R8RASMLCR5",
"inAssembly": true,
"lifecyclePhase":{
"guid":"FXH0J0JZV8QTCVEXGZM5",
"name":"In Production"
},
"name":"Subassembly, EveryRoad, Front Bezel",
"number":"090-0001",
"revisionNumber":"A",
"url": {
"api": "[Link]
items/FXH0J0JZV8R8RASMLCR5",
"app": "[Link]
},
{
"assemblyType": "NOT_AN_ASSEMBLY",
"category":{
"guid":"ZH1K3K3JFSBL4N6O1ZQS"
},
"creationDateTime":"2011-02-11T16:52:40Z",
"guid":"VDXGZGZFBO7O7Q821S54",
"inAssembly": true,
"lifecyclePhase":{
"guid":"FXH0J0JZV8QTCVEXGZM5",
"name":"In Production"
},
"name":"Documentation Package, Everyroad Model 300/500",
"number":"090-0003",
"revisionNumber":"A",
"url": {
"api": "[Link]
items/VDXGZGZFBO7O7Q821S54",
"app": "[Link]
},
...

148 Arena REST API Developer Guide

 ]
}
Get effective revisions of items where the revisions were made effective between
4pm February 11, 2013 and 4pm March 11, 2013.
GET /items?effectiveDateTimeFrom=2013-02-
11T16:00:00Z&effectiveDateTimeTo=2013-03-11T16:00:00Z
{
"count":2,
"results":[
{
"assemblyType": "ASSEMBLY",
"category":{
"guid":"N5P8R8R73GZ9SBUCNG61"
},
"creationDateTime":"2011-02-11T16:52:40Z",
"guid":"GYI1K1K0W9S9SBSLE716",
"inAssembly": true,
"lifecyclePhase":{
"guid":"0I2L4L4KGTBEXGZI1H01",
"name":"Design Verification"
},
"name":"Circuit Board, EveryRoad, Model 500",
"number":"040-0002",
"revisionNumber":"2",
"url": {
"api": "[Link]
GYI1K1K0W9S9SBSLE716",
"app": "[Link]
},
{
"assemblyType": "ASSEMBLY",
"category":{
"guid":"ZH1K3K3JFSBL4N6O1ZQS"
},
"creationDateTime":"2011-02-11T16:52:40Z",
"guid":"1J3M5M5LHUDUDWE86ARW",
"inAssembly": true,
"lifecyclePhase":{
"guid":"EWGZIZIYU7PSBUDWFV6U",
"name":"Eng Verification"
},
"name":"Subassembly, Connector, Stormwatch",
"number":"090-0006",
"revisionNumber":"3",
"url": {
"api": "[Link]
1J3M5M5LHUDUDWE86ARW",
"app": "[Link]
}

Endpoints 149
 }
]
}
Request with an invalid search attribute.
GET /items?[Link]=*Walker
{
"status":400,
"errors":[
{
"code":3019,
"message":"The attribute \"[Link]\" is not
searchable."
}
]
}

GET Items (Search) Criteria Parameter

/items?criteria=<URL encoded criteria>
This article describes a special variation of the GET Items (Search) on page 141
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 on page 288 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 on page
285.
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.

150 Arena REST API Developer Guide

GET items?criteria=%5B%5B%20%20%7B%20%22attribute%22%3A%20%
22creationDateTime%22%2C%20%22value%22%3A%20%5B%222015-07-
12T10%3A00%3A01Z%22%20%2C%222020-07-12T20%3A23%3A59Z%22%
20%5D%2C%20%22operator%22%3A%20%22IS_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",
"inAssembly": true,
"lifecyclePhase": {
"guid": "DVFYHUF6TWEH0J2L4EYV",
"name": "In Production"
},
"name": "Policy, Quality",
"number": "001-00001",
"revisionNumber": "A",
"url": {
"api": "[Link]
1J3M5I3UHK3BU9XRO93Q",
"app": "[Link]
},
{
"category": {
"guid": "CUEXGTE5SVEO7Q29D8JI"
},
"creationDateTime": "2016-09-02T18:49:25Z",
"effectiveDateTime": "2016-09-02T19:20:10Z",
"guid": "6O8RAN8ZMP8GZE2WTE76",
"inAssembly": false,
"lifecyclePhase": {
"guid": "DVFYHUF6TWEH0J2L4EYV",
"name": "In Production"
},
"name": "Everyroad Employee Handbook",
"number": "010-00001",
"revisionNumber": "A",
"url": {
"api": "[Link]
6O8RAN8ZMP8GZE2WTE76",
"app": "[Link]
},
...

Endpoints 151
 ]
}
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":
"[Link]", "value": [
"9RBUDQB2PSADWFYH0AUY"], "operator": "IS_IN" } ] ]
Below is the url encoded criteria parameter search version that should be used.
GET /items?criteria=%5B%20%5B%20%7B%20%22attribute%22%3A%20%
[Link]%22%2C%20%22value%22%3A%20%5B%20%
229RBUDQB2PSADWFYH0AUY%22%5D%2C%20%22operator%22%3A%
20%22IS_IN%22%20%7D%20%5D%20%5D
Example Response
{
"count": 20,
"results": [
{
"assemblyType": "NOT_AN_ASSEMBLY",
"category": {
"guid": "J1L4N0LCZ2LVEXCJJK6K"
},
"creationDateTime": "2011-06-02T19:23:22Z",
"effectiveDateTime": "2011-07-19T16:28:45Z",
"guid": "DVFYHUF6TWFN6OYHTN2A",
"inAssembly": true,
"lifecyclePhase": {
"guid": "DVFYHUF6TWEH0J2L4EYV",
"name": "In Production"
},
"name": "Socket, Molex D50-L RA 20pin",
"number": "125-00006",
"revisionNumber": "A",
"url": {
"api": "[Link]
DVFYHUF6TWFN6OYHTN2A",
"app": "[Link]
},
{
"assemblyType": "NOT_AN_ASSEMBLY",
"category": {
"guid": "J1L4N0LCZ2LVEXCJJK6K"
},
"creationDateTime": "2011-06-02T19:23:25Z",
"effectiveDateTime": "2011-07-19T16:28:45Z",
"guid": "I0K3MZKBY1KSBT3MYS65",
"inAssembly": true,

152 Arena REST API Developer Guide

 "lifecyclePhase": {
"guid": "DVFYHUF6TWEH0J2L4EYV",
"name": "In Production"
},
"name": "Plug, Molex D50-L Straight, 20pin",
"number": "125-00007",
"revisionNumber": "A",
"url": {
"api": "[Link]
I0K3MZKBY1KSBT3MYS65",
"app": "[Link]
},
{
"category": {
"guid": "J1L4N0LCZ2LVEXCJJK6K"
},
"creationDateTime": "2011-06-02T19:23:27Z",
"effectiveDateTime": "2011-07-19T16:28:45Z",
"guid": "N5P8R4PG36PXGY8R3XAH",
"inAssembly": true,
"lifecyclePhase": {
"guid": "DVFYHUF6TWEH0J2L4EYV",
"name": "In Production"
},
"name": "Connector, Molex KK 3 cond straight",
"number": "125-00008",
"revisionNumber": "A",
"url": {
"api": "[Link]
N5P8R4PG36PXGY8R3XAH",
"app": "[Link]
},
...
]
}
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
hwalker@[Link].
Below is the non url encoded version. This should not be used but is included here
for instructional purposes.
GET /items?criteria=[ [ { "attribute": "[Link]",
"value": "WEYH0DYPCFWFYH0JSIPD", "operator": "IS_EQUAL_
TO" } ], "OR", [ { "attribute": "[Link]", "value":
"hwalker@[Link]", "operator": "CONTAINS" } ] ]
Below is the url encoded criteria parameter search version that should be used.

Endpoints 153
GET /items?criteria=%5B%20%5B%20%7B%20%22attribute%22%3A%20%
[Link]%22%2C%20%22value%22%3A%20%
22WEYH0DYPCFWFYH0JSIPD%22%2C%20%22operator%22%3A%20%
22IS_EQUAL_TO%22%20%7D%20%5D%2C%20%22OR%22%2C%20%5B%
20%7B%20%22attribute%22%3A%20%[Link]%22%2C%20%22value
%22%3A%20%22hwalker%[Link]%22%2C%20%22operator%
22%3A%20%22CONTAINS%22%20%7D%20%5D%20%5D
Example Response
{
"count": 20,
"results": [
{
"assemblyType": "NOT_AN_ASSEMBLY",
"category": {
"guid": "I0K3MZKBY1KUDWBIIJ49"
},
"creationDateTime": "2012-03-07T19:54:07Z",
"effectiveDateTime": "2012-03-07T19:56:04Z",
"guid": "2K4N6J4VIL4CVA8EYV18",
"inAssembly": true,
"lifecyclePhase": {
"guid": "EWGZIVG7UXFI1K3M5FZN",
"name": "In Design"
},
"name": "Voltage Regulator, Low-dropout, 5.0V, 90µA",
"number": "160-00007",
"revisionNumber": "1",
"url": {
"api": "[Link]
2K4N6J4VIL4CVA8EYV18",
"app": "[Link]
},
{
"assemblyType": "NOT_AN_ASSEMBLY",
"category": {
"guid": "5N7Q9M7YLO7H0JY556R1"
},
"creationDateTime": "2012-04-04T18:25:22Z",
"guid": "XFZI1EZQDGZ7Q535R6XM",
"inAssembly": true,
"lifecyclePhase": {
"guid": "9RBUDQB2PSADWFYH0AUY",
"name": "Unreleased"
},
"name": "Resistor, Surface Mount, 240ohm, 1/10W,
0603",
"number": "180-00013",
"revisionNumber": "01",
"url": {
"api": "[Link]

154 Arena REST API Developer Guide

 XFZI1EZQDGZ7Q535R6XM",
"app": "[Link]
},
{
"assemblyType": "TOP_LEVEL_ASSEMBLY",
"category": {
"guid": "WEYH0DYPCFY8RAPWWXIF"
},
"creationDateTime": "2011-08-09T22:19:25Z",
"effectiveDateTime": "2013-03-13T18:58:37Z",
"guid": "3L5O7K5WJM5DWB91YGJ7",
"inAssembly": false,
"lifecyclePhase": {
"guid": "EWGZIVG7UXFI1K3M5FZN",
"name": "In Design"
},
"name": "PCBA, EveryRoad, Model 500",
"number": "830-00002",
"revisionNumber": "3",
"url": {
"api": "[Link]
3L5O7K5WJM5DWB91YGJ7",
"app": "[Link]
},
...
]
}
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": "[Link]","value":
"CUEXGTE5SVEO7Q29D8JI","operator": "IS_EQUAL_TO"},"OR",
{"attribute": "[Link]","value": "BTDWFSD4RUDN6P18C7I6","operator":
"IS_EQUAL_TO"} ], "OR", [{"attribute": "[Link]","value":
"J1L4N0LCZ2LVEX9H2599","operator": "IS_EQUAL_TO"}], "OR",
[{"attribute": "[Link]","value":
"BTDWFSD4RUCFYH0J2CWA","operator": "IS_EQUAL_TO"}], "OR", [
{"attribute": "[Link]","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.

Endpoints 155
GET /items?criteria=%5B%20%5B%20%7B%22attribute%22%3A%20%
[Link]%22%2C%22value%22%3A%20%
22CUEXGTE5SVEO7Q29D8JI%22%2C%22operator%22%3A%20%22IS_
EQUAL_TO%22%7D%2C%22OR%22%2C%7B%22attribute%22%3A%20%
[Link]%22%2C%22value%22%3A%20%
22BTDWFSD4RUDN6P18C7I6%22%2C%22operator%22%3A%20%22IS_
EQUAL_TO%22%7D%20%5D%2C%20%20%22OR%22%2C%20%5B%7B%
22attribute%22%3A%20%[Link]%22%2C%22value%22%3A%20%
22J1L4N0LCZ2LVEX9H2599%22%2C%22operator%22%3A%20%22IS_
EQUAL_TO%22%7D%5D%2C%20%22OR%22%2C%20%5B%7B%22attribute
%22%3A%20%[Link]%22%2C%22value%22%3A%20%
22BTDWFSD4RUCFYH0J2CWA%22%2C%22operator%22%3A%20%22IS_
EQUAL_TO%22%7D%5D%2C%20%22OR%22%2C%20%5B%20%7B%
22attribute%22%3A%20%[Link]%22%2C%22value%22%3A%
20%22ASCVERC3QTBEXGZI1BVF%22%2C%22operator%22%3A%20%
22IS_EQUAL_TO%22%7D%2C%22OR%22%2C%7B%22attribute%22%3A%
20%22number%22%2C%22value%22%3A%20%228%22%2C%22operator%
22%3A%20%22STARTS_WITH%22%7D%20%5D%20%5D
Example Response
{
"count": 20,
"results": [
{
"assemblyType": "ASSEMBLY",
"category": {
"guid": "VDXGZCXOBEX7Q9OVVWHR"
},
"creationDateTime": "2011-06-02T19:23:30Z",
"effectiveDateTime": "2011-07-26T06:54:20Z",
"guid": "HZJ2LYJAX0JRAS1RLQS5",
"inAssembly": true,
"lifecyclePhase": {
"guid": "DVFYHUF6TWEH0J2L4EYV",
"name": "In Production"
},
"name": "Documentation Package, Everyroad Model 300/
500",
"number": "820-00003",
"revisionNumber": "A",
"url": {
"api": "[Link]
HZJ2LYJAX0JRAS1RLQS5",
"app": "[Link]
},
{
"assemblyType": "ASSEMBLY",
"category": {
"guid": "VDXGZCXOBEX7Q9OVVWHR"

156 Arena REST API Developer Guide

 },
"creationDateTime": "2011-06-02T19:23:31Z",
"effectiveDateTime": "2012-01-12T23:55:37Z",
"guid": "BTDWFSD4RUDL4MK9ZROI",
"inAssembly": true,
"lifecyclePhase": {
"guid": "DVFYHUF6TWEH0J2L4EYV",
"name": "In Production"
},
"name": "Subassembly, EveryRoad, Front Assembly",
"number": "820-00001",
"revisionNumber": "C",
"url": {
"api": "[Link]
BTDWFSD4RUDL4MK9ZROI",
"app": "[Link]
},
{
"assemblyType": "ASSEMBLY",
"category": {
"guid": "VDXGZCXOBEX7Q9OVVWHR"
},
"creationDateTime": "2011-06-02T19:23:31Z",
"effectiveDateTime": "2012-01-12T23:55:37Z",
"guid": "M4O7Q3OF25OWFWL0UWAS",
"inAssembly": true,
"lifecyclePhase": {
"guid": "DVFYHUF6TWEH0J2L4EYV",
"name": "In Production"
},
"name": "Subassembly, EveryRoad, Rear Assembly",
"number": "820-00002",
"revisionNumber": "F",
"url": {
"api": "[Link]
M4O7Q3OF25OWFWL0UWAS",
"app": "[Link]
},
{
"assemblyType": "ASSEMBLY",
"category": {
"guid": "FXH0JWH8VYHRAT8FFG2G"
},
"creationDateTime": "2011-06-02T19:23:30Z",
"effectiveDateTime": "2015-09-21T23:45:20Z",
"guid": "7P9SBO90NQ9H0H64Z4M0",
"inAssembly": true,
"lifecyclePhase": {
"guid": "DVFYHUF6TWEH0J2L4EYV",
"name": "In Production"
},

Endpoints 157
 "name": "Assembly, GPS, EveryRoad Car Navigation Unit
- Model 300",
"number": "810-00001",
"revisionNumber": "E",
"url": {
"api": "[Link]
7P9SBO90NQ9H0H64Z4M0",
"app": "[Link]
},
...
]
}

GET Item Specs

/items/<GUID>
Returns an Item on page 1118 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

158 Arena REST API Developer Guide

Parameters
Name Value Description
includeEmptyAdditiona- true or false If this is true, the
lAttributes response returns empty
additional attributes. The
default is false.
responseview string Allows users to customize
the scope and size of the
response data. Possible
values and definitions:
• minimum - returns
the GUID, item
number, and url.
• compact - returns the
commen set of data
that includes some
core attributes in
addition to the
attributes returned in
the minimum
response.
• full - returns the
complete set of data
including custom
attributes.

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

Endpoints 159
Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a single item (including empty additional attributes) with a full response
view..
GET /items/GUID?includeEmptyAdditionalAttributes=
true&responseview=true
{
"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"
]
}
],

160 Arena REST API Developer Guide

 "assemblyType": "ASSEMBLY",
"category":{
"guid":"P7RAT1AA7O7H0J2J7J83",
"name": "Assembly"
},
"creationDateTime":"2011-02-11T16:52:40Z",
"creator":{
"email":"hwalker@[Link]",
"fullName":"Heidi Walker"
"guid": "DVFY3SVCSJOJ2L4N38F
},
"description":"Circuit board for the EveryRoad product - Model
500",
"deviated":false,
"effectiveDateTime":"2018-04-06T22:33:27Z",
"guid":"L3N6PX663K3K3HOBOOT0",
"isAssembly": true,
"inAssembly": true.
"lifecyclePhase":{
"guid":"BTDWFNWWTASVEXGZIXDY",
"name":"In Design"
},
..."materialEffectivityDateTime": "2012-07-19T16:28:45Z",
"modifiedBom":false,
"modifiedFiles":true,
"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": "[Link]
L3N6PX663K3K3HOBOOT0",
"app": "[Link]
}
}

Endpoints 161
request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not
valid."
}
]
}

POST Item Create

/items
Creates a new Item on page 1118 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"

162 Arena REST API Developer Guide

 },
"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"
},
"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":[

Endpoints 163
 {
"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"
},
"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

164 Arena REST API Developer Guide

Name Value Description
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Create Item with no number
{
"additionalAttributes":[

],
"category":{
"guid":"1J3MRHIIRYHRAT5D1U08"
},
"creationDateTime":"2017-04-05T22:41:53Z",
"creator":{
"email":"hwalker@[Link]",
"fullName":"Heidi Walker"
},
"description":"New Part",
"deviated":false,
"effectiveDateTime":null,
"guid":"0I2L4L4KGTCTCQVZVP97",
"isAssembly":false,
"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,

Endpoints 165
 "supersededDateTime":null,
"targetCost":4.4,
"targetPrice":5.5,
"uom":"each",
"url": {
"api": "[Link]
0I2L4L4KGTCTCQVZVP97",
"app": "[Link]
}
Create Item with Autogenerating Number
{
"additionalAttributes":[

],
"category":{
"guid":"1J3MRHIIRYHRAT5D1U08"
},
"creationDateTime":"2017-04-05T22:41:53Z",
"creator":{
"email":"hwalker@[Link]",
"fullName":"Heidi Walker"
},
"description":"New Part",
"deviated":false,
"effectiveDateTime":null,
"guid":"0I2L4L4KGTCTCQVZVP97",
"isAssembly":false,
"lifecyclePhase":{
"guid":"BTDWFWFVR4MP8RATCVII",
"name":"Unreleased"
},
"modifiedBom":false,
"modifiedFiles":false,
"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,

166 Arena REST API Developer Guide

 "targetPrice":5.5,
"uom":"each",
"url": {
"api": "[Link]
0I2L4L4KGTCTCQVZVP97",
"app": "[Link]
}
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":"hwalker@[Link]",
"fullName":"Heidi Walker"
},
"description":"New PCBA",
"deviated":false,
"effectiveDateTime":null,
"guid":"9RBUDLUUR8RZIW11GB9L",
"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":{

Endpoints 167
 "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": "[Link]
9RBUDLUUR8RZIW11GB9L",
"app": "[Link]
}
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."
}
]
}
3. An option is not valid value for a fixed (non-user-editable) dropdown list.
{
"status":400,
"errors":[
{

168 Arena REST API Developer Guide

 "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."
}
]
}
7. A number format is invalid.

Endpoints 169
 "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\"."
}
]
}
11. The category is structural.

170 Arena REST API Developer Guide

 {
"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."
}
]
}

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

Endpoints 171
Set Null
Name Value Description
setnull Append the URL with
setnull=true to set
description,
revisionNumber,
standardCost, targetCost,
or targetPrice to null.
Attributes must be
included within the
request body and set to
null. Insert setnull after
the query string,
represented by a ?, after
the GUID.

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"

172 Arena REST API Developer Guide

 }
]
}
}
Set description of an Item to null.
PUT <url>/items/<GUID>?setnull=true
{
"description": null
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"

Endpoints 173
 },
{
"apiName":"YG0J2AJJGXEWFYHY0FSA",
"guid":"YG0J2AJJGXEWFYHY0FSA",
"multiSelect":true,
"name":"Affected Countries",
"fieldType":"FIXED_DROP_DOWN",
"value":[
"China",
"Latveria",
"USA"
]
},
{
"apiName":"I0K3MU330HYGZI1IKZSB",
"guid":"I0K3MU330HYGZI1IKZSB",
"name":"Warn when below",
"fieldType":"NUMBER",
"value":1000
}
],
"category":{
"guid":"P7RAT1AA7O7H0J2J7J83"
},
"creationDateTime":"2011-02-11T16:52:40Z",
"creator":{
"email":"hwalker@[Link]",
"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,

174 Arena REST API Developer Guide

 "revisionNumber":null,
"shared":false,
"standardCost":null,
"status":0,
"supersededDateTime":null,
"targetCost":null,
"targetPrice":null,
"uom":"each",
"url": {
"api": "[Link]
VDXGZ7GGDUDUDRWY7URV",
"app": "[Link]
}
Response if setnull=true with the appropriate request body.
PUT <url>/items/<GUID>?setnull=true
{
"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"
]
},
{
"apiName":"I0K3MU330HYGZI1IKZSB",
"guid":"I0K3MU330HYGZI1IKZSB",
"name":"Warn when below",
"fieldType":"NUMBER",
"value":1000
}

Endpoints 175
 ],
"category":{
"guid":"P7RAT1AA7O7H0J2J7J83"
},
"creationDateTime":"2011-02-11T16:52:40Z",
"creator":{
"email":"hwalker@[Link]",
"fullName":"Heidi Walker"
},
"description": null,
"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": "[Link]
VDXGZ7GGDUDUDRWY7URV",
"app": "[Link]
}
Requests return an error if:
1. An attribute included in the request is not recognizable.

{
"status":400,

176 Arena REST API Developer Guide

 "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.

Endpoints 177
 "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.

178 Arena REST API Developer Guide

 {
"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\"."
}
]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 179
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."
}
]
}
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.

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

180 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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.
{
"status":400,
"errors": [
{
"code": 3094,
"message": "The specified file is not a valid image."
}
]
}

Endpoints 181
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

182 Arena REST API Developer Guide

Sample Responses
If the File from the FIles view is successfully uploaded as the Specs Image this is
the response:
{
"guid":"YG0J2F0REH0GZI8FYY2C"
}

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)."
}
]
}

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

Endpoints 183
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

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

184 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

GET BOM
/items/<GUID>/bom
Returns an array of BOM Line on page 1121 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

Endpoints 185
Parameters
Name Value Description
includeAdditionalAttri- true or false If this is true, the
butes response includes
additional attributes for
each BOM Line. 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
ASCV0QRR07Q7Q511F8Z3",

186 Arena REST API Developer Guide

 "app": "[Link]
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": "[Link]
Q8SBG677GN6N6LHHVP7Y",
"app": "[Link]
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": "[Link]
VDXGLBCCLSBSBQMM0UZ1",
"app": "[Link]
VDXGLBCCLSBSBQMM0UZ1",
},
},
"lineNumber":3,
"notes":null,
"quantity":3,
"refDes":"C9,C13-14"
},
…
]

Endpoints 187
}
GET the BOM line of an Item with a specific GUID. Also get any BOM
Attributes (also known as Additional Attributes).
GET /items/6O8RWMQP21KSBQL/
bom?includeAdditionalAttributes=true
{
"count": 4,
"results": [
{
"additionalAttributes": [
{
"apiName": "GYI16WYZCBSATCVEXGP9",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "GYI16WYZCBSATCVEXGP9",
"name": "BOMATT",
"value": "Ultra Violet"
},
{
"apiName": "N5P8D356JIZH0J2L4N3H",
"fieldType": "DATE",
"guid": "N5P8D356JIZH0J2L4N3H",
"name": "DOCK DATE",
"value": "20220603235959"
}
],
"guid": "N5P8D356JI18RA3H96F9",
"item": {
"guid": "M4O7C245IH08R617NZJU",
"name": "Child Jamaica",
"number": "449-2020369",
"revisionNumber": "1",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
items/
M4O7C245IH08R617NZJU",
"app": "[Link]
M4O7C245IH08R617NZJU"
}
},
"lineNumber": 0,
"notes": null,
"quantity": 1,
"refDes": null
},
{
"additionalAttributes": [
{
"apiName": "GYI16WYZCBSATCVEXGP9",

188 Arena REST API Developer Guide

 "fieldType": "SINGLE_LINE_TEXT",
"guid": "GYI16WYZCBSATCVEXGP9",
"name": "BOMATT",
"value": "Infared"
},
{
"apiName": "N5P8D356JIZH0J2L4N3H",
"fieldType": "DATE",
"guid": "N5P8D356JIZH0J2L4N3H",
"name": "DOCK DATE",
"value": "20220603235959"
}
],
"guid": "TBVEJ9BCPO7EXG9PWXPC",
"item": {
"guid": "BTDW1RTU76PXGVQ6X798",
"name": "Child Queensbridge",
"number": "337-989656",
"revisionNumber": "1",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
items/
BTDW1RTU76PXGVQ6X798",
"app": "[Link]
BTDW1RTU76PXGVQ6X798"
}
},
"lineNumber": 0,
"notes": null,
"quantity": 1,
"refDes": null
},
{
"additionalAttributes": [
{
"apiName": "GYI16WYZCBSATCVEXGP9",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "GYI16WYZCBSATCVEXGP9",
"name": "BOMATT",
"value": "Cerulean"
},
{
"apiName": "N5P8D356JIZH0J2L4N3H",
"fieldType": "DATE",
"guid": "N5P8D356JIZH0J2L4N3H",
"name": "DOCK DATE",
"value": "20220603235959"
}
],
"guid": "UCWFKACDQP8FYHAQXYQQ",

Endpoints 189
 "item": {
"guid": "WEYHMCEFSRAI1GBRISTA",
"name": "Child Astoria",
"number": "989-2020369",
"revisionNumber": "1",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
items/
WEYHMCEFSRAI1GBRISTA",
"app": "[Link]
WEYHMCEFSRAI1GBRISTA"
}
},
"lineNumber": 1,
"notes": null,
"quantity": 1,
"refDes": null
},
{
"additionalAttributes": [
{
"apiName": "GYI16WYZCBSATCVEXGP9",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "GYI16WYZCBSATCVEXGP9",
"name": "BOMATT",
"value": "Azure"
},
{
"apiName": "N5P8D356JIZH0J2L4N3H",
"fieldType": "DATE",
"guid": "N5P8D356JIZH0J2L4N3H",
"name": "DOCK DATE",
"value": "20220603235959"
}
],
"guid": "8QATYOQR43MTCVO4BC4Q",
"item": {
"guid": "WEYHMCEFSRAI1GBL3Z90",
"name": "Five Points",
"number": "379-0369",
"revisionNumber": "2",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
items/
WEYHMCEFSRAI1GBL3Z90",
"app": "[Link]
WEYHMCEFSRAI1GBL3Z90"
}
},

190 Arena REST API Developer Guide

 "lineNumber": 0,
"notes": null,
"quantity": 1,
"refDes": null
}
]
}
Request with invalid GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"ASCVEMVVS9S9S6D0DDZ3\" is not
valid."
}
]
}

GET BOM Line

/items/<GUID>/bom/<GUID>
Returns a BOM Line on page 1121 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
includeEmptyAdditiona- true or false If this is true, the
lAttributes response returns empty
additional attributes. The
default is false.
includeBomSubstitutes true or false if this is true, the response
returns BOM Substitutes

Endpoints 191
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get BOM line (including empty additional attributes)
/items/ASCVEMVVS9S9S6D0DDZ5/bom/WEYH08HHEVEL4N6F52SC?
includeEmptyAdditionalAttributes=true
{
"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": "[Link]
K2M5OW552J2AT7E1EHJN",
"app": "[Link]
K2M5OW552J2AT7E1EHJN",
},

192 Arena REST API Developer Guide

 },
"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": "[Link]
I02QRAT1KZPMDPDW",
"app": "[Link]
I02QRAT1KZPMDPDW",
},
},
"lineNumber": 8,
"notes": "BOM notes",
"quantity": 1,
"refDes": "J1"
"additionalAttributes": [
{
"apiName": "2KMABUBTCVEXGZIF",
"fieldType": "NUMBER",
"guid": "2KMABUBTCVEXGZIF",
"name": "Classification",
"value": 1
},
...
],
"substitutes": [
{
"guid": "M4O7LIMOZGZ7Q5TUPZDB",
"item": {
"guid": "J1L4IFJLWDW3M5WM1UTZ",
"number": "T78-437-98442",
"revisionNumber": "A",
"name": "Capacitor, Tantalum, 10uF@24V, B pkg",
"revisionStatus" : "EFFECTIVE",
"url": {
"api": "[Link]
items/
I02QRAT1KZPMDPDW",

Endpoints 193
 "app": "[Link]
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."
}
]
}

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

194 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get BOM settings
/items/ASCVEMVVS9S9S6D0DDZ5/bom/settings
{
"automaticallyGenerateLineNumbers":true,
"checkReferenceDesignators":true
}
Request with bad GUID
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"ASCVEMVVS9S9S6D0DDZ51\" is not
valid."
}
]
}

POST BOM Line Create

/items/<GUID>/bom
Creates a new BOM Line on page 1121 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.

Endpoints 195
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

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

196 Arena REST API Developer Guide

Name Value Description
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": "[Link]
M4O7C228B7Q7Q50Y5C18",
"app": "[Link]
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,
"message": "Either you do not have privileges to access

Endpoints 197
 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,

198 Arena REST API Developer Guide

 "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)
{
"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."
}
]
}

PUT BOM Line Update

/items/<GUID>/bom/<GUID>
Updates an existing BOM Line on page 1121 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

Endpoints 199
Set Null
Name Value Description
setnull Append the URL with
setnull=true to set refdes
or notes to null. Attributes
must be included within
the request body and set
to null. Insert setnull after
the query string,
represented by a ?, after
the GUID

Sample Request Body

PUT /items/<GUID>/bom/<GUID>
{
"refDes":"u1",
"quantity":1,
"notes":"New chip"
}
Set a bom attribute to null.
PUT /items/<GUID>/bom/<GUID>?setnull=true
{
"refDes": null,
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

200 Arena REST API Developer Guide

Sample Response Body
Update a BOM line
/items/<GUID>/bom/<GUID>
{
"additionalAttributes":[
{
"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": "[Link]
M4O7C228B7Q7Q50Y5C18",
"app": "[Link]
M4O7C228B7Q7Q50Y5C18", },
},
"lineNumber":1,
"notes":"New chip",
"quantity":1,
"refDes":"u1"
}
Set a BOM attribute to null.
PUT /items/<GUID>/bom/<GUID>?setnull=true
{
"additionalAttributes":[
{
"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",

Endpoints 201
 "url": {
"api": "[Link]
M4O7C228B7Q7Q50Y5C18",
"app": "[Link]
M4O7C228B7Q7Q50Y5C18", },
},
"lineNumber":1,
"notes":"New chip",
"quantity":1,
"refDes":null
}
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": [
{
"code": 3036,
"message": "Invalid BOM Line: Invalid reference
descriptor: c."
}
]
}

202 Arena REST API Developer Guide

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."
}

Endpoints 203
 ]
}

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

204 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

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

Endpoints 205
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}
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

206 Arena REST API Developer Guide

 the requested data or it does not exist."
}
]
}

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
includeEmptyAdditiona- true or false If this is true, the
lAttributes 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

Endpoints 207
Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all the BOM Substitutes in within a BOM Line
/items/<GUID>/bom/<GUID>/substitutes
{
"count": 2,
"results": [
{
"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": [

208 Arena REST API Developer Guide

 {
"code": 3011,
"message": "The guid \"WEYH08HHEVEL4N6F52Sf\" is not valid."
}
]
}

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
includeEmptyAdditiona- true or false If this is true, the
lAttributes 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

Endpoints 209
Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",
"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."
}
]
}

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.

210 Arena REST API Developer Guide

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
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 211
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."
}
]
}

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.

212 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"

Endpoints 213
 },
"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."
}
]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

214 Arena REST API Developer Guide

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."
}
]
}

GET Item Compliance Requirements

/items/<GUID>/compliance
Returns all Compliance Requirement on page 1109 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

Endpoints 215
Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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":"jparker@[Link]",
"fullName":"John Parker"
},
"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":"hwalker@[Link]",
"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"

216 Arena REST API Developer Guide

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

GET Item Compliance Requirement

GET /items/<GUID>/compliance/<GUID>
Returns a Compliance Requirement on page 1109 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

Endpoints 217
Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a single item compliance requirement
GET /items/<GUID>/compliance/<GUID>
{
"evidenceType":"AML_AND_FILES",
"guid":"9RBUZPQQZ6OO7QV0DS6B",
"lastModifiedBy":{
"email":"jparker@[Link]",
"fullName":"John Parker"
},
"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"
}
Request with bad GUID
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

PUT Item Compliance Update

PUT /items/<GUID>/compliance/<GUID>
Updates a Compliance Requirement on page 1109 object with a given GUID for
an item with a given GUID.

218 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Update a compliance requirement for an Item
PUT /items/<GUID>/compliance/<GUID>
{
"evidenceType":"DIRECT_FILES",
"guid":"6O8RAIPBRZHH0J2J0ZY0",
"lastModifiedBy":{
"fullName":"Heidi Walker"
},
"lastModifiedDateTime":"2015-08-01T00:47:41Z",

Endpoints 219
 "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."
}
]
}

GET Item File Associations

/items/<GUID>/files
Returns a collection of File on page 1115 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

220 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

GET all files associated with an item
GET /items/VDXGZ7GGDUDUDRYLY132/files
{
"count":4,
"results":[
{
"file":{
"author":{
"fullName":"George Lewis"
},
"category":{
"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":"[Link]",
"number":"FILE-000825",
"private":false,
"size":463360,

Endpoints 221
 "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."
}
]
}

GET Item File Association

/items/<GUID>/files/<GUID>
Returns a File Association on page 1118 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

222 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"
},
"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 [Link]",
"number":"FILE-000059",
"private":false,
"size":416233,
"smartLink":"[Link]
p/ Q7Q6-P8RA-QO30-O53P-SCDY-CYF3",
"storageMethod":0,
"storageMethodName":"FILE",

Endpoints 223
 "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."
}
]
}

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

224 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}
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.

POST Item File Create

/items/<GUID>/files
Creates a new File Association on page 1118 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.

Endpoints 225
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:
[Link]: Heidi Walker
[Link]: WEYHMCDDMTCM5O08WPWY
[Link]: Assembly Instructions
[Link]: 1
[Link]: txt
[Link]:false
[Link]: FILE
[Link]: 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": "[Link]/files/300-traces.
pdf",
"category": {
"guid ": "ZH0J2L4EXGS0NF91"
},
"storageMethodName": "WEB",
"title": "traces for Everyroad 300 board",
"edition": "1",

226 Arena REST API Developer Guide

 "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- GUID string GUID for new file
ItemFileAssociation-Guid association - only when
including content
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",
"description":null,
"edition":"1",

Endpoints 227
 "format":"url",
"guid":"GYI16WW251K0J2TITQ1O",
"hasMarkup":false,
"lastModifiedDateTime":"2014-02-24T22:41:19Z",
"latest":true,
"location":"[Link]
"locked":false,
"mimeType":null,
"name":"[Link]",
"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 \"[Link]\" is required."
}
]
}

POST Item File Add Existing

/items/<GUID>/files
Associates an existing File Association on page 1118 object with an item with a
given GUID.

228 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
Associate an existing file with an item
/items/<GUID>/files
{
"file":{
"author":{
"fullName":"George Lewis"
},

Endpoints 229
 "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":"[Link]",
"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."
}
]
}

230 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
no JSON response
An error is returned if:
1. The GUID is not valid.
{
"status": 400,
"errors": [

Endpoints 231
 {
"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."
}
]
}

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:
[Link]: George Lewis
[Link]: 7P9S6379K1KUDWCUEIJG
description: Schematic Drawing
edition: 1
format: pdf

232 Arena REST API Developer Guide

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
X-Arena-File-GUID GUID string GUID for new file - only
when including content.
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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,

Endpoints 233
 "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."
}
]
}

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

234 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Update the details of a file associated with an item
/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":"[Link]",
"number":"FILE-000825",
"private":false,
"size":463360,
"storageMethod":0,
"storageMethodName":"FILE",
"title":"OrCAD Schematic File"
},
"guid":"J1L49Z009GZBUD95YPP0",
"latestEditionAssociation":true,
"primary":false

Endpoints 235
}
Returns an error if the GUID is not valid.
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

236 Arena REST API Developer Guide

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\"."
}
]
}

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.

Endpoints 237
 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"
}

238 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 239
Sample Responses
{
"effectiveRevItem":{
"guid":"M4O7QY5R7FYFYCHZ27X0",
"url": {
"api": "[Link]
M4O7QY5R7FYFYCHZ27X0",
"app": "[Link]
M4O7QY5R7FYFYCHZ27X0" }
},
"supersededRevItem":{
"guid":"CUEXGOVHX5O5O27PSXND",
"url": {
"api": "[Link]
CUEXGOVHX5O5O27PSXND",
"app": "[Link]
CUEXGOVHX5O5O27PSXND" }
},
"workingRevItem":{
"guid":"WEYH08F1HP8P8MR9CH77",
"url": {
"api": "[Link]
M4O7QY5R7FYFYCHZ27X0",
"app": "[Link]
M4O7QY5R7FYFYCHZ27X0" }
}
}
Returns an error if the item GUID is not valid
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

GET Item Quality Processes

GET /items/<GUID>/quality
GET /items/<GUID>/quality/<GUID>
Returns a collection of Quality Process on page 1135 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.

240 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",
"qualityProcess":{
"creationDateTime":null,
"guid":"SAUDI7O2P8RN6P8R57B7",
"name":"Quality Issue on 500 board",
"number":"8D-000002",
"step":{
"guid":"TBVEJ8P3Q9SO7Q9S68C4",
"name":"Form Team"
},

Endpoints 241
 "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."
}
]
}

GET Item Revisions

GET /items/<GUID>/revisions
Returns all Item Revision on page 1123 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

242 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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
},
"guid":"ASCVEMVVS9S9S6D0DDX3",
"lifecyclePhase":{
"guid":"ASCVEMVVS9RUDWFYHWC3",
"name":"In Production"
},
"notes":null,
"number":null,
"status":0,
"supersededDateTime":null,
"url": {
"api": "[Link]
ASCVEMVVS9S9S6D0DDX3",
"app": "[Link]
},
{

Endpoints 243
 "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": "[Link]
Q8SBU2BB8P8P8MTGTTHH",
"app": "[Link]
},
{
"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": "[Link]
items/5N7Q9HQQN4N4N18V8836",
"app": "[Link]
},
{
"change":{
"creationDateTime":"2011-02-11T16:52:39Z",
"deviated":false,
"effectiveDateTime":"2011-02-14T23:13:50Z",
"guid":null
},
"guid":"BTDWFNWWTATAT7E1EHR7",

244 Arena REST API Developer Guide

 "lifecyclePhase":{
"guid":"ASCVEMVVS9RUDWFYHWC3",
"name":"In Production"
},
"notes":null,
"number":"1",
"status":2,
"supersededDateTime":"2011-02-16T00:12:28Z",
"url": {
"api": "[Link]
BTDWFNWWTATAT7E1EHR7",
"app": "[Link]
}
]
}
Produces an error if the GUID is not valid.
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

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

Endpoints 245
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",
"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"

246 Arena REST API Developer Guide

 },
"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
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not
valid."
}
]
}

GET Item Source Relationships

/items/<GUID>/sourcing
Returns an array of Source Relationship on page 1143 objects for an item with a
given GUID.

Endpoints 247
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

248 Arena REST API Developer Guide

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"

Endpoints 249
 },
"notes":"Disapproved for repeated late delivery.",
"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": [

250 Arena REST API Developer Guide

 {
"code": 400,
"message": "The format of the request is not valid.
Please check the syntax."
}
]
}
2. the Item GUID is invalid:
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"6O8RAIPBRZIZIW2J7TL83\" is not valid."
}
]
}

GET Item Source Relationship

/items/<GUID>/sourcing/<GUID>
Returns a Source Relationship on page 1143 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

Endpoints 251
Name Value Description
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"
},
"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": [

252 Arena REST API Developer Guide

 {
"code": 3011,
"message": "The guid \"6O8RAIPBRZIZIW2J7TL83\" is not valid."
}
]
}

POST Item Source Relationship Create

/items/<GUID>/sourcing
Creates a new Source Relationship on page 1143 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":{

Endpoints 253
 "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,
"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

254 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
Create a new source relationship for a given item
/items/<GUID>/sourcing
{
"activeProduction":false,
"activePrototype":false,
"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,

Endpoints 255
 "errors": [
{
"code": 3040,
"message": "Conversion factor must be null if no vendor item or
is make myself."
}
]
}

PUT Item Source Relationship Update

/items/<GUID>/sourcing/<GUID>
Updates a Source Relationship on page 1143 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

Set Null
Name Value Description
setnull Append the URL with
setnull=true to set notes,
amlRank, or amlSplit to
null. Attributes must be
included within the
request body and set to
null. Insert setnull after
the query string,
represented by a ?, after
the GUID.

Sample Request Body

PUT /items/<GUID>/sourcing/<GUID>
{
"amlRank":2
}
PUT /items/<GUID>/sourcing/<GUID>?setnull=true

256 Arena REST API Developer Guide

{
"amlRank":null
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Update a source relationship for a given item
/items/<GUID>/sourcing/<GUID>
{
"activeProduction":false,
"activePrototype":false,
"amlRank":2,
"amlSplit":null,
"approved":true,
"guid":"I0K38YU3B6PTCVG5OV8P",
"makeItem":false,
"mfrItem":{
"guid":"ASCV0QMV3YHM5OOAA1AL"
},
"notes":"api-sourcing-relationship1",
"vendorItem":{
"guid":"3L5OTJFOWRAFYHH33U59"
},
"vendorItemConversionFactor":2
}
Set an Item Sourcing attribute to null

Endpoints 257
PUT /items/<GUID>/sourcing/<GUID>?setnull=true
{
"activeProduction":false,
"activePrototype":false,
"amlRank":null,
"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."
}
]
}

DELETE Item Source Relationship

/items/<GUID>/sourcing/<GUID>
Deletes a source relationship with a given GUID for an item with a given GUID.

258 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

POST Item Compliance

POST /items/<GUID>/compliance
Creates a Compliance Requirement on page 1109 object with a given GUID for an
item with a given GUID.

Endpoints 259
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

260 Arena REST API Developer Guide

Sample Response Body
Apply a compliance requirement to an Item
POST /items/<GUID>/compliance/<GUID>
{
"evidenceType":"AML_AND_FILES",
"guid":"9RBUZPQQZ6OO7QV0DS6B",
"lastModifiedBy":{
"email":"jparker@[Link]",
"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."
}
]
}

DELETE Item Compliance

DELETE /items/<GUID>/compliance/<GUID>
Deletes a Compliance Requirement on page 1109 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.

Endpoints 261
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

No JSON response.
Returns an error if the GUID is not valid.
{
"status":400,
"errors":[
{
"code":3082,
"message":"Invalid evidence type."
}
]
}

262 Arena REST API Developer Guide

GET Where Used
/items/<GUID>/whereused
Returns an array of Item on page 1118 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
Get where used results for an item
/items/<GUID>/whereused
{
"count":2,
"results":[
{
"guid":"I0K3MU1N3BU1K3MU8IT0",

Endpoints 263
 "item":{
"guid":"M4O7QY5R7FYFYCILCQJX"
"name": "Resistor, 43 Ohm",
"number": "248-00031",
"revisionNumber": "C",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
M4O7QY5R7FYFYCILCQJX",
"app": "[Link]
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": "[Link]
WEYH08F1HP8P8MSVM0T4",
"app": "[Link]
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."
}
]

264 Arena REST API Developer Guide

}

GET Training Plans Associated With An

Item
/items/<GUID>/trainingplans
Returns all the Training Plans that use a specific Item. Using the browser-based
application as a point of comparison, this endpoint returns the Training Plans
within the Training view, Training Plans subview of a specific Item.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the Training Plan records within the Training view, Training Plans subview of
an Item.
GET /items/<GUID>/trainingplans
{

Endpoints 265
 "count": 2,
"results": [
{
"guid": "DVFYHUF6TW2M5O7Q9S01",
"trainingplan": {
"guid": "1J3M5I3UHK1M5O7Q9S0V",
"number": "TRP-000002"
}
},
{
"guid": "R9TCV8TK7AG0J2L4NZBT",
"trainingplan": {
"guid": "FXH0JWH8VYF0J2L4NZB8",
"number": "TRP-000004"
}
}
]
}

GET A Training Plan Associated With An

Item
/items/<GUID>/trainingplans/<GUID>
Returns a specific Training Plan associated within a specific Item. Using the
browser-based application as a point of comparison, this endpoint returns a
specific Training Plan located within the Training view, Training Plans subview of
a specific Item.

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

266 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific Training Plan with a given GUID within the Training view, Training
Plans subview of an Item.
GET /items/<GUID>/trainingplans/<GUID>
{
"guid": "DVFYHUF6TW2M5O7Q9S01",
"trainingplan": {
"guid": "1J3M5I3UHK1M5O7Q9S0V",
"number": "TRP-000002"
}
}

GET Training Records Associated With

An Item
/items/<GUID>/trainingrecords
Returns a specific Item's training records across all the Training Plans it is
associated with. Using the browser-based application as a point of comparison,
this endpoint returns the training records of a specific Item within the Records
view of all Training Plans associated with that Item.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Endpoints 267
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
objects is 20. Can return
up 400.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the training records of an Item.
GET /items/<GUID>/trainingrecords
{
"count": 2,
"results": [
{

268 Arena REST API Developer Guide

 "guid": "DVFYHUF6TW2M5O7Q9S01",
"trainingplan": {
"guid": "1J3M5I3UHK1M5O7Q9S0V",
"number": "TRP-000002"
}
},
{
"guid": "R9TCV8TK7AG0J2L4NZBT",
"trainingplan": {
"guid": "FXH0JWH8VYF0J2L4NZB8",
"number": "TRP-000004"
}
}
]
}

GET A Training Record Associated With

An Item
/items/<GUID>/trainingrecords/<GUID>
Returns a specific Item's training record associated with a specific Training Plans.
Using the browser-based application as a point of comparison, this endpoint
returns a specific training record of a specific Item within the Records view of a
specific Training Plan.

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

Endpoints 269
Name Value Description
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific training record with a given GUID associated with an Item.
GET /items/<GUID>/trainingrecords/<GUID>
{
"dueDate": "2022-07-07T06:59:59Z",
"guid": "L3N6P2NE14K2L4N6D8E2",
"signedDateTime": "2022-04-29T06:42:37Z",
"trainingplan": {
"guid": "FXH0JWH8VYF0J2L4NZB8",
"number": "TRP-000004"
}
}

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

270 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
Get Item References for a given item
/items/<GUID>/items/
{
"count": 1,
"results": [
{
"guid": "TBVEXAVM9CTFYH0IXE17",
"item": {
"guid": "R9TCV8TK7AT1KZNA8V1W"
},
"note": "some note"
}
]
}
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,

Endpoints 271
 "errors": [
{
"code": 3011,
"message": "The guid \"X9TCV8TK7AT1KZNA8V1Q\" is not valid."
}
]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
Get an Item Reference for a given item
/items/<GUID>/items/<GUID>

272 Arena REST API Developer Guide

{
"guid": "0I2LQGHHQXGXGVRR5XND",
"item": {
"guid": "ASCV0QRR07Q7Q511F7V0",
},
"notes": "the 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."
}
]
}

POST Item-To-Item Reference Create

/items/<GUID>/items
Creates a new Item-to-Item reference on page 1143 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.

Endpoints 273
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
Create a new Item-to-Item reference.
/items/<GUID>/items
{
"guid": "TBVEXAVM9CTFYH0IXE17",
"item": {
"guid": "R9TCV8TK7AT1KZNA8V1W"
},
"note": "Item Reference Notes"

274 Arena REST API Developer Guide

}
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."
}
]
}

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

Endpoints 275
Set Null
Name Value Description
setnull Append the URL with
setnull=true to set notes
to null. Attributes must be
included within the
request body and set to
null. Insert setnull after
the query string,
represented by a ?, after
the GUID.

Sample Request Body

PUT /items/<GUID>/items/<GUID>
{
"note": "update notes"
}
PUT /items/<GUID>/items/<GUID>?setnull=true
{
"note": null
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

276 Arena REST API Developer Guide

Sample Responses
Update a given Item-To-Item Reference.
/items/<GUID>/items/<GUID>
{
"guid": "TBVEXAVM9CTFYH0IXE17",
"item": {
"guid": "R9TCV8TK7AT1KZNA8V1W"
},
"note": "update notes"
}
Set an Item to Item attribute to null
PUT /items/<GUID>/items/<GUID>?setnull=true
{
"guid": "TBVEXAVM9CTFYH0IXE17",
"item": {
"guid": "R9TCV8TK7AT1KZNA8V1W"
},
"note": null
}
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."
}
]
}

Endpoints 277
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

278 Arena REST API Developer Guide

GET Item Quality Processes
GET /items/<GUID>/quality
GET /items/<GUID>/quality/<GUID>
Returns a collection of Quality Process on page 1135 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
Get all quality processes that include a given item
GET /items/0I2LQGHHQXGXGVRR5XND/quality
{
"count":1,
"results":[
{
"guid":"L3N6B0HVI1IYH0J2B57U",

Endpoints 279
 "notes":"This is the related Quality process",
"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."
}
]
}

GET Item Ticket References

/items/<GUID>/tickets
/items/<GUID>/tickets/<GUID>

280 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",
"number": "REQ-000004"
}
},
{
"guid": "ZH1K3G1SFIZTCVEWBWQV",

Endpoints 281
 "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."
}
]
}

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.

282 Arena REST API Developer Guide

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.

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_ BOM Substitutes for all Items
SUBSTITUTES
SOURCING Sourcing relationships for all Items
FILES File Associations for all Items
FILES_FILE_ File summary for all Files on Item Files
SUMMARY
SOURCING_ Supplier Item Specs for all Supplier Items on Item sourcing
SUPPLIERITEM_
SPECS
SOURCING_ Supplier Profile for all Supplier Items on Item sourcing
SUPPLIERITEM_
SUPPLIER_
PROFILE
SOURCING_ Supplier Item File associations for all Supplier Items in
SUPPLIERITEM_ Sourcing
FILES
SOURCING_ File summary for all files on Supplier Items on Item
SUPPLIERITEM_ Sourcing
FILES_FILE_
SUMMARY
File Content determines if the actual Files associated with Items and Supplier
Items are included within the export. Assigning a value of PRIMARY to
fileContent is not supported for supplierItem.

Endpoints 283
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.

BOM Levels adds children Items on the BOM of matching Items to the results.

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

The Header option determines if custom attributes appear by their API name or
their actual name within the header of the exported CSV files.

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 Workspace
Settings of the graphic user interface.
Example: "Capacitance".

Item Revision Status

284 Arena REST API Developer Guide

revisionStatus Description
LATEST Returns the effective revision of the
items matching the criteria if the Item is
effective, otherwise returns 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.
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.

API Export Format

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.

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.

Endpoints 285
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
"criteria":[
[
{
"attribute":"number",
"operator":"STARTS_WITH",
"value":"20-"
},
"AND",
{

286 Arena REST API Developer Guide

 "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",
[
{
"attribute":"number",
"operator":"STARTS_WITH",
"value":"7"
},

Endpoints 287
 "AND",
{
"attribute":"effectiveDateTime",
"operator":"IS_AFTER"
"value":"2019-04-01T12:00:00Z"
}
]
}

Criteria: Attributes and Operators

Item Attributes that can be used in criteria.

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
[Link]* GUID IS_EQUAL_TO, IS_IN
[Link] FIXED_DROP_DOWN IS_EQUAL TO, IS_
(Single Select) NOT_EQUAL_TO,
CONTAINS, DOES_
NOT_CONTAIN,

288 Arena REST API Developer Guide

Supported Criteria Attributes and Their Supported Operators
(continued)
Attribute Field Type Operators
STARTS_WITH, DOES_
NOT_START_WITH
[Link] SINGLE_LINE_TEXT IS_EQUAL TO, IS_
NOT_EQUAL_TO,
CONTAINS, DOES_
NOT_CONTAIN,
STARTS_WITH, DOES_
NOT_START_WITH
[Link] GUID IS_EQUAL_TO
[Link] SINGLE_LINE_TEXT IS_EQUAL TO, IS_
NOT_EQUAL_TO,
CONTAINS, DOES_
NOT_CONTAIN,
STARTS_WITH, DOES_
NOT_START_WITH
[Link] SINGLE_LINE_TEXT IS_EQUAL TO, IS_
NOT_EQUAL_TO,
CONTAINS, DOES_
NOT_CONTAIN,
STARTS_WITH, DOES_
NOT_START_WITH
[Link] GUID IS_EQUAL_TO, IS_IN
[Link] FIXED_DROP_DOWN IS_EQUAL_TO, IS_
(Single Select) NOT_EQUAL_TO
[Link] FIXED_DROP_DOWN IS_EQUAL_TO, IS_
(Single Select) NOT_EQUAL_TO
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
[Link] SINGLE_LINE_TEXT IS_EQUAL TO, IS_
NOT_EQUAL_TO,

Endpoints 289
Supported Criteria Attributes and Their Supported Operators
(continued)
Attribute Field Type Operators
CONTAINS, DOES_
NOT_CONTAIN,
STARTS_WITH, DOES_
NOT_START_WITH
[Link] GUID IS_EQUAL_TO
[Link] SINGLE_LINE_TEXT IS_EQUAL TO, IS_
NOT_EQUAL_TO,
CONTAINS, DOES_
NOT_CONTAIN,
STARTS_WITH, DOES_
NOT_START_WITH
[Link] GUID IS_EQUAL_TO
Additional Attributes SINGLE_LINE_TEXT IS_EQUAL TO, IS_
(Various Types) NOT_EQUAL_TO,
CONTAINS, 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)

290 Arena REST API Developer Guide

Supported Criteria Attributes and Their Supported Operators
(continued)
Attribute Field Type Operators
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
Table of Criterion Operators organized by field type.

fieldType Operators Data Type

SINGLE_LINE_TEXT IS_EQUAL TO, IS_ String
NOT_EQUAL_TO,
CONTAINS, DOES_
NOT_CONTAIN,
STARTS_WITH, DOES_
NOT_START_WITH
GUID IS_IN Array of Strings
DATETIME IS_EQUAL_TO, IS_ String (Date)
BEFORE, IS_AFTER
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_ Array of Strings
NOT_EQUAL_TO
FIXED_DROP_DOWN, IS_EQUAL_TO, IS_ Array of Strings
multi-select NOT_EQUAL_TO
FIXED_DROP_DOWN, IS_EQUAL_TO, IS_ Array of Strings

Endpoints 291
fieldType Operators Data Type
single select NOT_EQUAL_TO
MULTI_LINE_TEXT IS_EQUAL_TO, IS_ String
LESS_THAN_OR
EQUAL_TO,
CONTAINS, DOES_
NOT_CONTAIN,
STARTS_WITH, DOES_
NOT_START_WITH
NUMBER IS_EQUAL_TO, IS_ Number
LESS_THAN_OR_
EQUAL_TO, IS_LESS_
THANK, IS_GREATER_
THAN_OR_EQUAL_
TO, IS_GREATER_
THAN
POSITIVE_DOUBLE IS_EQUAL_TO, IS_ Number
LESS_THAN_OR_
EQUAL_TO, IS_LESS_
THAN, IS_GREATER_
THAN_OR_EQUAL_TO

292 Arena REST API Developer Guide

 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 [Link] using the
GUID for uncategorized. The [Link] works for all other categorized
GUIDs. To run an export for uncategorized Items use the following
criteria: attribute is euqal to [Link], 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.

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.

Endpoints 293
 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",

294 Arena REST API Developer Guide

 "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.
"options":{
"exportViews": [
"SOURCING_SUPPLIERITEM_FILES"
],
"fileContent": {
"item": "NONE",
"supplierItem": "NONE"
}
"bomLevels":"FULL",
"revisionStatus":"WORKING",
"format":"json"
}

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.

Endpoints 295
7. Arena Export currently doesn't support export for [Link] using the
GUID for uncategorized. The [Link] works for all other categorized
GUIDs. To run an export for uncategorized Items use the following criteria:
attribute is euqal to [Link], 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 on page 283.
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 on page 293.

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
{
"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"

296 Arena REST API Developer Guide

 },
"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",
"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",

Endpoints 297
 "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":[
"SPECS",
"BOM",
"SOURCING",
"FILES",
"FILES_FILE_SUMMARY",
"SOURCING_SUPPLIERITEM_SPECS",
"SOURCING_SUPPLIERITEM_SPECS_PROFILE",
"SOURCING_SUPPLIERITEM_FILES",

298 Arena REST API Developer Guide

 "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

Endpoints 299
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Create Export Definition with no Criteria
{
"creationDateTime":"2020-03-01T14:32:25Z",
"creator":{
"email":"hwalker@[Link]",
"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"

300 Arena REST API Developer Guide

 },
"world":"ITEMS"
}
Create Export Definition with a single criterion
{
"creationDateTime":"2020-03-02T12:05:06Z",
"creator":{
"email":"hwalker@[Link]",
"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":{

Endpoints 301
 "email":"hwalker@[Link]",
"fullName":"Heidi Walker",
"guid":"4M6P3046HYFYH0J258QJ"
},
"criteria":[
[
{
"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"
}

302 Arena REST API Developer Guide

Create Export Definition with two Criterion groups separated by criterion gorup
logic
{
"creationDateTime":"2020-03-05T10:30:35Z",
"creator":{
"email":"hwalker@[Link]",
"fullName":"Heidi Walker",
"guid":"4M6P3046HYFYH0J258QJ"
},
"criteria":[
[
{
"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",

Endpoints 303
 "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"
}
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,

304 Arena REST API Developer Guide

 "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."
}
]
}

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

Endpoints 305
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
[Link] GUID The unique identifier for
the creator of the Export
Definition.
[Link] string The email address of the
user account that created
the Export Definition.
[Link] string The full name of the user
that created the Export
Definition.

306 Arena REST API Developer Guide

 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
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all export definitions
GET /exports
{
"count": 3,
"results":[
{
"creationDateTime": "2020-03-09T21:17:44Z"
"creator": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"criteria": [
[
{
"attribute": "number",

Endpoints 307
 "value": "900-00001",
"operator": "IS_EQUAL_TO"
}
]
],
"description": "March 9",
"guid": "L3N6P2NE14K3M5JYNZFB",
"name": "Model 300",
"number": 1,
"options": {
"bomLevels": "NONE",
"exportViews": [
"SPECS",
"BOM",
"FILES"
],
"header": "name",
"revisionStatus": "POTENTIAL",
"format": "csv"
},
"world": "ITEMS"
},
{
"creationDateTime": "2020-03-10T17:08:27Z"
"creator": {
"email": "hwalker@[Link]",
"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",

308 Arena REST API Developer Guide

 "format": "csv"
},
"world": "ITEMS"
},
{
"creationDateTime": "2020-03-10T17:30:17Z"
"creator": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"criteria": [
[
{
"attribute": "number",
"value": "800-000300",
"operator": "IS_EQUAL_TO"
}
]
],
"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": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},

Endpoints 309
 "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": {
"item": "PRIMARY",
"supplierItem": "NONE"
},
"header": "apiName",
"revisionStatus": "LATEST",
"format": "csv"
},
"world": "ITEMS"
},
{
"creationDateTime": "2020-03-10T21:18:54Z",
"creator": {
"email": "ecanard@[Link]",
"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": {

310 Arena REST API Developer Guide

 "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": "ecanard@[Link]",
"fullName": "Eleanor Canard",
"guid": "1J3M5I3UHK1K3M5OXNUV"
},
"criteria": [
[
{
"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"
},

Endpoints 311
 "world": "ITEMS"
}
]
}
Request with an invalid search attribute.
GET /export?[Link]=Heidi Walker
{
"status":400,
"errors":[
{
"code":3019,
"message":"The attribute \"[Link]\" is not
searchable."
}
]
}

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

312 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get an export definition.
GET /exports/GUID
{
"creationDateTime":"2020-03-02T12:05:06Z",
"creator":{
"email":"hwalker@[Link]",
"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"

Endpoints 313
 },
"world":"ITEMS"
}
request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not
valid."
}
]
}

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.
Exports runs can have the following six statuses.

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

314 Arena REST API Developer Guide

 Export Status Description
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 on page 293.

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"
}
]
• 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

Endpoints 315
Name Value Description
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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
{
"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

316 Arena REST API Developer Guide

 }
],
"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.

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

POST Export Run (Multiple Guids)

/exports/<GUID>/runs

Endpoints 317
By building a criteria that includes multiple GUIDS, users can use the POST
Export Run endpoint to export those specific items associated with the GUIDs
within the criteria. This variant of the POST Export Run endpoint can be useful in
integrations that return item GUIDs..

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Sample Request Body

• Run an Export were multiple Item GUIDs are specified in the Criteria.
{
"criteria": [
[
{
"attribute":"guid",
"operator":"IS_IN",
"value": ["CUEXB8CEPGHGZI18WDMU",
"M407LIMOZGZQ5TUP27F"]
}
[
]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

318 Arena REST API Developer Guide

Sample Response Body
Export Run is processing
{
"completionDateTime":null,
"creationDateTime":"2023-03-08T09:32:25Z",
"creator": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid":"ASCV96ACN4L4N6P6BG6H"
},
"criteria":[
{
"attribute":"guid",
"value": [
"CUEXB8CEPGHGZI18WDMU",
"M407LIMOZGZQ5TUP27F"
],
"operator":"IS_IN"
}
],
"criteriaResultsCount": 1,
"guid":"Z8SPLFQS3K0DTYB56MW",
"number":12,
"status":"RUNNING"
}
Export Run completed
{
"completionDateTime":"2023-03-08T09:40:00Z",
"creationDateTime":"2023-03-08T09:32:25Z",
"creator": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid":"ASCV96ACN4L4N6P6BG6H"
},
"criteria":[
{
"attribute":"guid",
"value": [
"CUEXB8CEPGHGZI18WDMU",
"M407LIMOZGZQ5TUP27F"
],
"operator":"IS_IN"
}
],
"criteriaResultsCount": 1,
"files": [
{
"guid": "1P7V0X13DKJWDKJPY982",
"title": null
}

Endpoints 319
 ],
"guid":"Z8SPLFQS3K0DTYB56MW",
"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.

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

GET Export Runs

/exports/<GUID>/runs
Returns the runs executed by an export definition with a given GUID.

320 Arena REST API Developer Guide

Export runs can have the following six statuses.

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
completionDateTime- Date-Formatted String The date and time (in
From 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.

Endpoints 321
Name Value Description
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

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFH0JS1PD"
},
"criteria": [
[

322 Arena REST API Developer Guide

 {
"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": {
"email": "hwalker@[Link]",
"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,

Endpoints 323
 "message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not
valid."
}
]
}

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

324 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get an export definition.
GET /exports/GUID
{
"creationDateTime":"2020-03-02T12:05:06Z",
"creator":{
"email":"hwalker@[Link]",
"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",
"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",

Endpoints 325
 "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":[
{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not
valid."
}
]
}

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.

326 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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,
"edition": null,
"format": null,
"guid": "VDXGZX0BEXDWF5CV9RE",
"hasMarkup": false,
"lastModifiedDateTime": "2020-03-09T21:18.46Z"
"latest": false,
"location": null,
"locked": true,
"mimeType": "application/zip",

Endpoints 327
 "name": "Model 300 Export [Link]",
"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."
}
]
}

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

328 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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.
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

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

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.

330 Arena REST API Developer Guide

 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.
GET calls that include Object numbers that include a percentage character, %,
must encode the percentage as %25 in order to return results.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"

Endpoints 331
 },
{
"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,
"status": "OUTBOUND_MANAGED",
"type": "UP_TO_DATE",
"transferType": "ITEM_REVISION"
}
]
}
Request with an invalid search attribute.
GET /outboundintegrations?transferType=Item Revision
{
"status":400,
"errors":[
{

332 Arena REST API Developer Guide

 "code":3003,
"message":"The value for the attribute \"transferType\"
is not valid."
}
]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific outbound integration.
GET /outboundintegrations/<GUID>
{

Endpoints 333
 "guid": "5N7Q9M7YLOZ6P8RATFCH",
"name": "ERP Integration",
"enabled": true,
"status": "UP_TO_DATE",
"type": "OUTBOUND_MANAGED",
"transferType": "ITEM_REVISION",
"creator": {
"email": "dcoronel@[Link]",
"fullName": "Dennis Coronel",
"guid": "FXH0JWH8VYFYH0J25014"
},
"creationDateTime": "2020-03-10T22:21:31Z",
"modifyUser": {
"email": "hwalker@[Link]",
"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."
}
]
}

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

334 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the integration administrators of a specific outbound integration.
GET /outboundintegrations/<GUID>/administrators
{
"count": 2,
"results": [
{
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
{
"email": "ecanard@[Link]",
"fullName": "Eleanor Canard",
"guid": "1J3M5I3UHK1K3M5OXNUV"
}
]
}
Request with an invalid GUID.
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"5D7Q9M7YL0Z6P8RATBDS\" is not
valid."

Endpoints 335
 }
]
}

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.

336 Arena REST API Developer Guide

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.
Search in Zulu format is supported for custom attribute field type Date.
GET calls that include Object numbers that include a percentage character, %,
must encode the percentage as %25 in order to return results.

Endpoints 337
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",

338 Arena REST API Developer Guide

 "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"
},
{
"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",

Endpoints 339
 "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",
"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
{

340 Arena REST API Developer Guide

 "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"
},
"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."
}
]
}

Endpoints 341
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",

342 Arena REST API Developer Guide

 "effectivityType": "PERMANENT",
"guid": "ZH1K3G1SFI14N5LLP1TU",
"number": "ECO-000023",
"title": "Critical Resistor Changes - Batch A"
},
"creationDateTime": "2020-03-13T22:47:36Z",
"creator": {
"email": "hwalker@[Link]",
"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": "hwalker@[Link]",
"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."
}
]
}

Endpoints 343
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

344 Arena REST API Developer Guide

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
{
"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":[
{

Endpoints 345
 "code":3011,
"message":"The guid \"4M6P8L6XKNY4N5LLP1T4\" is not
valid."
}
]
}

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

346 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": "hwalker@[Link]",
"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.
{

Endpoints 347
 "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": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"eventType": "CHANGE",
"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."
}
]
}

348 Arena REST API Developer Guide

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.

Endpoints 349
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
reconciledDateTime-
From/
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
reconciledDateTime-
From/

350 Arena REST API Developer Guide

Name Value Description
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",

Endpoints 351
 "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": "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"
}
}
},
{

352 Arena REST API Developer Guide

 "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": "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
}
]
}

Endpoints 353
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",
"guid": "DVFYHUF6TWEH0J2L4EYV"
},
"modifiedSpecs": false,
"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false
},
"guid": "R9TCV8TK7ALQ9SBMD74N",
"reconciled": true,
"reconciledDateTime": "2020-03-16T01:40:30Z",
"reconciledUser": {
"email": "hwalker@[Link]",
"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",

354 Arena REST API Developer Guide

 "stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
},
"modifiedSpecs": false,
"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false
},
"guid": "0I2L4H2TGJUZI1KVMGDQ",
"reconciled": true,
"reconciledDateTime": "2020-03-16T01:40:30Z",
"reconciledUser": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"supersededItemRevision": {
"guid": "2K4N6J4VIL4CVDN6IBY3",
"number": "180-00012",
"revisionNumber": "A",
"lifecyclePhase": {
"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
},

Endpoints 355
 "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"
},
"modifiedSpecs": false,
"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false
},
"guid": "R9TCV8TK7ALQ9SBMD74N",
"reconciled": true,
"reconciledDateTime": "2020-03-16T01:40:30Z",
"reconciledUser": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"supersededItemRevision": {
"guid": "8QATCPA1ORAI1JTCOHK9",
"number": "180-00009",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
}
}
},
{
"effectiveItemRevision": {
"guid": "XFZI1EZQDGZ7Q8I1D56A",

356 Arena REST API Developer Guide

 "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,
"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false
},
"guid": "XFZI1EZQDGRWFYHSJDAA",
"reconciled": false,
"supersededItemRevision": {
"guid": "7P9SBO90NQ9H0ISBNGAO",
"number": "180-00011",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",
"stage": "PRODUCTION",

Endpoints 357
 "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": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"supersededItemRevision": {
"guid": "2K4N6J4VIL4CVDN6IBY3",
"number": "180-00012",
"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"

358 Arena REST API Developer Guide

 },
"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",
"reconciled": true,
"reconciledDateTime": "2020-12-17T01:40:30Z",
"reconciledUser": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"supersededItemRevision": {
"guid": "9DHWTE1ORAI1JTCOHK9",
"number": "180-00019",
"revisionNumber": "A",
"lifecyclePhase": {
"name": "In Production",

Endpoints 359
 "stage": "PRODUCTION",
"guid": "DVFYHUF6TWEH0J2L4EYV"
}
}
},
...
}
]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get an Item from an integration event.

360 Arena REST API Developer Guide

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"
},
"modifiedSpecs": false,
"modifiedBom": false,
"modifiedSourcing": false,
"modifiedFiles": false
},
"guid": "R9TCV8TK7ALQ9SBMD74N",
"reconciled": true,
"reconciledDateTime": "2020-03-16T01:40:30Z",
"reconciledUser": {
"email": "hwalker@[Link]",
"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."
}
]
}

Endpoints 361
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

362 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": "hwalker@[Link]",
"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.

Endpoints 363
/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": 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": [
{

364 Arena REST API Developer Guide

 "code": 3011,
"message": "The guid \"X9TCV8TK7AT1KZNA8V1Q\" is not valid."
}
]
}

About the Import Engine

Along with the Event Engine and Export Engine (initially introduced as API
Export), the Import Engine is the third installment of the Integration Engine,
whose goal is to allow integrations to seamlessly obtain and load data to and from
Arena while notifying external systems about events within an Arena workspace.
The Import Engine is ONLY available in workspaces with Access Policies enabled.
As the counterpart to the Export Engine, the Import Engine supports the loading
of data through Arena’s API.
The Import Engine consists of two components.
1. The Import Definition configures the import. Once created, it can be used
again in future imports.
2. The Import Run is an endpoint that executes an import according to the
Definition with different source content identifying the data to be imported.
Resources
Resources are Arena objects or Arena object-views that are the focus of an import.
Currently, Item Specs, Item BOM, Item Files, and File Summary are supported.
One resource is managed within one import definition. (If you’re creating a Bill of
Materials with new Items, you’d have to create them first through an import run
citing an Item Specs import definition, and then create a Bill of Materials with a
separate import run Item BOM import definition. A notable exception to this is an
Item Files import, which can create Files (File Summary) and Item File
associations in a single import run.
Key Attributes
Existing resources are identified either by their API guid or by ‘key attributes.”
The guid or Key Attribute can be used for editing or deleting purposes.
Resource Key Attributes
ITEM_SPECS Number
ITEM_BOM Parent Item number/Child Item number
ITEM_FILES Item number/File Number
FILE_SUMMARY File Number

Modes
The Import Engine supports modes. Modes identify how the import is executed.

Endpoints 365
Mode Description
Create Creates new resources. Error message if
resource already exists.
Edit Edits existing resources. Error message
if resource doesn’t exist.
Overwrite Edit resource if it exists, otherwise
creates the source.
Replace Applicable to the Item BOM resource.
Deletes all existing resources within
specified parent, then creates resources.
Delete Deletes resources. An error message if
it does not exist.

Import Engine: Best Practices Overview

Create the Import Definition
The first step is to create an import definition that suits the specifics of your
integration. By design, the import definition cannot be edited do that a specific
integration is guaranteed to have a static definition.
It may be necessary to create multiple definitions depending on the integration.
For example, an integration may wish to import items (item specs) and the BOM
Name: An arbitrary name of the import definition.
Description: The description allows the user to add additional details on how the
import definition is used.
Resource: A specific Arena world or the specific view of an Arena wold.
Mode: The mode to use for the import. If unsure use Overwrite.
Options: The import engine allows various configurations that dictate the behavior
of the import.
• Match Duplicates: Defines behavior when editing resources where duplicates
exist (e.g., two items with number 1000–02).
• Create Duplicates: Defines behavior when replacing resources when
duplicates exist.
• Match Duplicate Parents: Defines behavior when replacing resources where
duplicate parents exist.
• File Edition Edit: Configure to edit a file edition or create a new edition.
• File Edition Delete: Configure to delete a file edition or delete the entire file.
• Additional options are available within the Import Options article.

366 Arena REST API Developer Guide

• Guid: The auto-generated unique identifier of the definition required to run the
import.
• Number: An automatically incrementing unique numberidentifying the
definition which may be easier to use than the Guid.
Run the Import
After creating an import definition, the user can create an import run.
Guid (Definition): The Guid of the import definition that you’d like to run.
Submit Content: Specifies the source data file to be imported.
Submit Worksheet Name: The Excel worksheet name. (Used when the submit
content file is an XLSX file).
File Content: Physical files (e.g., drawings, pdfs) to import for to the File world.
Status: The status of the run.
Warnings: Import warnings that do not affect the import.
Commit: True to commit the import, false for testing for errors.
Total Count: The total number of resources to be imported.
Success Count: The number of resources successfully imported.
Error Count: The number of resources that failed to import.
Result Content: A CSV file of the results, including details of successful and
failed imports.
Guid: The auto-generated unique identifier of the run.
Number: An automatically incrementing unique number identifying the
definition’s run.
Determine when the data is ready.
The import is completed when its status is “COMPLETE”. This can take time
depending on the amount of data that is being imported.
Check the results
Imports can be previewed by setting the “commit” to false. The response will
return the run’s Total, Success, and Error counts. Details of the errors can be
obtained in two CSV files (named Result Contents or Error Contents
respectively). Columns within the CSV files with rows failed and why.
Commit the Import
If satisfied with the results, the run cab be committed by setting the “commit” to
true. Committing the import run, imports the data to Arena.

Endpoints 367
Import Engine Best Practices: Create the
Import Definition
Create the Import Definition
POST /imports

Request Body

{
"name": "Item Master CAD Integration for System Y",
"description": "Used to import CAD Item data from System Y
into Arena.",
...."resource": "ITEM_SPECS",
"mode": "OVERWRITE",
"options": {
"matchDuplicates": "ERROR",
"mapping": [
{
"resource": "ITEM_SPECS",
"apiName": "name",
"sourceName: "Name"
},
{
"resource": "ITEM_SPECS",
"apiName": "number",
"sourceName: "Number"
},
{
"resource": "ITEM_SPECS",
"apiName": "description",
"sourceName": "Description"
{
]
}
}

Response
• In the response below matchDuplicates is set to ERROR to generate an error if
the import leads to duplicate items in the workspace.
• Although not listed below, the value APPLY_TO_ALL can be used to import
to all matching items in the workspace.
• The removeValue sets a value to null.
• multiSelectDelimiter specifies a delimiter for multi-select list values.
• useCategoryNumberFormat is used to specify the number format specified
within the resource’s category.

368 Arena REST API Developer Guide

• stripWhiteSpace is used to remove leading and trailing white spaces.
• numberingFreeTextHeader specifies using free text for item numbers.
• For additional attributes (also referred to as custom attributes), additional
mapping can be used.
○ apiName refers to the Arena attribute name.
○ sourceName refers to the name as it appears in the source file.
○ inResponse can be set to true to include this attribute in the response.
• number is the sequential definition number.
• The Guid at the end of the response is the unique identifier of the import
definition.
{
"name": "Item Master CAD Integration for System Y",
"description": "Used to import CAD Item data from System Y
into Arena.",
"resource": "ITEM_SPECS",
"mode": "OVERWRITE",
"options": {
"matchDuplicates": "ERROR",
"removeValue": "[Remove Value]",
"multiSelectDelimiter": ";",
"useCategoryNumberFormat": "[Use Category Number Format]",
"stripWhiteSpace": "STRIP",
"numberingFreeTextHeader": "Numbering Free Text",
"mapping": [
{
"resource": "ITEM_SPECS",
"apiName": "name",
"sourceName": "Name",
"inResponse": true
},
{
"resource": "ITEM_SPECS",
"apiName": "number",
"sourceName": "Number",
"inResponse": true
},
{
"resource": "ITEM_SPECS",
"apiName": "description",
"sourceName": "Description",
"inResponse": true
}
]
},
"number": 17,
"creationDateTime": "2023-06-23T04:32:54Z",

Endpoints 369
"creator": {
"fullName": "Heidi Walker",
"email": "hwalker@[Link]",
"guid": "7P9SXNOOX4L4N6P8BG6R"
},
"guid": "XFZINDEENUUXGZI1K3W"
}

Import Engine Best Practices: Run the

Import
Run the Import
POST /imports/XFZINDEENUUXGZI1K3KW/runs
The import run endpoint url utilizes a Guid from an existing import definition.

Request Body
The request body in the import run endpoint is a URL encoded form.
commit: false
submitWorksheetName: Item Master
submitContent: source_file_xlsx

Response
{
"number": 1,
"creator": {
"fullName": "Heidi Walker",
"email": "hwalker@[Link]",
"guid": "7P9SXNOOX4L4N6P8BG6R"
},
"submitFileType": "EXCEL_WORKSHEET",
"submitWorksheetName": :Item Master",
"status": "CREATED",
"warnings": {...},
"commit": false,
"totalCount": 9,
"successCount": 0,
"errorCount": 0,
"guid": "YG0JOEFFOVVXGZI1K3I1"
}

Import Engine Best Practices: Check if

the data is ready
Determine if the data is ready

370 Arena REST API Developer Guide

GET /imports/XFZINDEENUUXGZI1K3KW/runs/
YG0JOEFFOVVXGZI1K3I1
The above is the GET Import Run endpoint. It’s used to determine the status of an
import run.
When the import process is completed, the status will have a value of
COMPLETE. COMPLETE indicates that the run is completed and is independent
of the success or failure of each row in the source file.

Response
Within the response body, the ‘status’ attribute reports on the state of the import
run. Below are the possible values and what they mean.
• CREATED: the import run is created. (The import is in queue, but not
officially in progress.)
• RUNNING: the import run is in progress.
• COMPLETE: the import run is completed.
• ERROR: the import run failed. (Import run failure is not related to the source
file content.)
A ‘commit’ value of false means that the imported data is not yet officially
committed to the Arena workspace. This allows the user to check for errors. After
reviewing and perhaps resolving errors, the user can then run a PUT Import
Commit endpoint to complete the import process to the workspace.
totalCount refers to the total number of resources.
successCount refers to the number of resources successfully imported (or will be
successfully imported if commit is set to false).
errorCount refers to the number of resources that failed to import.
{
"number": 1,
"creationDateTime": "2023-06-23T04:47:43Z",
"completionDateTime": "2023-06-23T04:47:45Z",
"creator": {
"fullName": "Heidi Walker",
"email": "hwalker@[Link]",
"guid": "7P9SXNOOX4L4N6P8BG6R"
},
"submitFileType": "EXCEL_WORKSHEET",
"submitWorksheetName": "ITEM_SPECS CREATE",
"status": "COMPLETE",
"warnings": "{...}",
"commit": false,
"totalCount": 9,
"successCount": 8,
"errorCount": 1,
"guid"" YG0JOEFFOVVXGZI1K3I1

Endpoints 371
}

Check the results

GET /imports/XFZINDEENUUXGZI1K3KW/runs/
YG0JOEFFOVVXGZI1K3I1/errorContent
Above is the GET Import Run Error Content. It returns the a file that lists errors
within the import run.

Response
Below is a table that represents a row within a possible CSV error file returned
after using the GET Import Run Error Content endpoint.
Row De- error-
Num- Num- scrip- error- Mes-
ber Name ber Rev tion status Code sage
4 120– A Capaci- Error 8012 Name is
003–21 tor, required.
Tanta-
lum,
4.7u-
F@4V,
A plg

The user can fix the error by providing a name for the attribute in the error content
CSV file and submit within another import run.

Import Engine Best Practices: Commit the

Import
Commit the Import
PUT /imports/XFZINDEENUUXGZI1K3KW/runs/
YG0JOEFFOVVXGZI1K3I1
The PUT Import Commit endpoint commits successfully imported resources into
an Arena workspace.

Request Body
{
"commit": true
}

Response
{
"number": 1,

372 Arena REST API Developer Guide

"creationDateTime": "2023-06-23T04:50:43",
"completionDateTime": "2023-06-23T04:51:00
"creator": {
"fullName": "Heidi Walker",
"email": "hwalker@[Link]",
"guid": "7P9SXNOOX4L4N6P8BG6R"
},
"submitFileType": "EXCEL_WORKSHEET",
"submitWorksheetName": :ITEM_SPECS CREATE",
"status": "RUNNING",
"warnings": {...},
"commit": true,
"totalCount": 9,
"successCount": 8,
"errorCount": 1,
"guid": "DZ0JODKSOSPWGZI1K3I1"
}

Import Engine: File Associations and File

Creation
File Associations with File Creation
The Import Engine allows users to create a file and associate that file to an Arena
object in a single import.
In Create, Overwrite (if no existing resource), or Replace modes, the specified file
and an item-file association to that newly created file will be created.

CREATE
If [Link] or [Link] are provided, the import will create an association to the
existinf files. File attributes cannot be edited with ITEM_FILES imports.
Using the FILE_SUMMARY with the CREATE mode (and the specified file
attributes) creates an association to the new file.

EDIT
This mode edits the association attributes only and does not edit the file summary
attributes.

OVERWRITE
If the [Link] or [Link] are provided the file association will be modified in
a similar manner to the EDIT mode.
If no [Link] or [Link] is absent, a new file and a new item-file association
is created similar to the CREATE mode.

Endpoints 373
REPLACE
If [Link] or [Link] are provided and an existing file association exists, then
the association is modified similar to an EDIT mode import. (File summary
attributes cannot be edited.)
If [Link] or [Link] are provided but no existing file association exists, a
new file association is created to the existing file.
In the absence of [Link] or [Link], a new file and association is created
similar to a CREATE mode import.

Import Engine Modes

The table below lists the Import Engine Modes, the supported options for each
mode, and a brief description of the mode.
Supported Import
Import Engine Mode Options Description
CREATE createDuplicates Import definitions with
multiSelectDelimiter the CREATE mode are
checkRefDes intended to create new
resources that currently
timeZone do not exist. Required
addToChange attributes must either be
stripWhiteSpace provided in the source file
or have default values.
numberingFreeTextHead-
er
EDIT matchDuplicates EDIT mode imports are
matchDuplicateParents intended to edit an
removeValue existing resource. If the
GUID is present in the
multiSelectDelimiter source file, it is used first.
checkRefDes If the GUID is not
timeZone present, key attributes are
required.
addToChange
stripWhiteSpace
numberingFreeTextHead-
er
OVERWRITE matchDuplicates OVERWRITE mode edits
removeValue existing resources and
multiSelectDelimiter creates new resources if
the resource within the
checkRefDes

374 Arena REST API Developer Guide

 Supported Import
Import Engine Mode Options Description
timeZone source file does not exist.

addToChange
stripWhiteSpace
numberingFreeTextHead-
er
REPLACE matchDuplicateParents REPLACE mode replaces
multiSelectDelimiter the entire view of the
checkRefDes parent resource with the
contents of the source
timeZone file. Currently this can
addToChange only be used with the
stripWhiteSpace ITEM_BOM resource.
DELETE matchDuplicates DELETE mode deletes
stripWhiteSpace the existing data.

Import Options (Item Specs and Item

BOM)
The table below lists import options (for Item Specs and Item BOM imports) with
the modes they are supported. Supported values (when applicable) are listed in
capitol letters. Empty cells indicate that the import option is not supported within
that mode.
Import Option Mode and Function
createDuplicates Create
• ALLOW permits duplicates to be
created if permitted by settings.
• ERROR returns an error indicating
that there are duplicate resources.
Errors are returned even if duplicate
resources are permitted by the
workspace settings.. Default value
if not specified.
matchDuplicates Edit
• APPLY_TO_ALL applies the edit
to all resources matching the key
attributes

Endpoints 375
Import Option Mode and Function
• ERROR returns an error indicating
that there are duplicates (default if
not specified)
Overwrite
• APPLY_TO_ALL applies the edit
to all resources matching the key
attributes
• ERROR returns an error indicating
that there are duplicates (default if
not specified)
Delete
• APPLY_TO_ALL applies the
delete to all resources matching the
key attributes.
• ERROR returns an error indicating
there are duplicates.
matchDuplicateParents Replace
• ALLOW replaces view resources
for all matching parent resources.
• ERROR returns an error indicating
that there are duplicate parent
resources. (Default).
removeValue Edit
When editing attributes, an empty value
in the source file typically indicates that
the value should not change. In order to
change the value to be empty, the string
represented by the option
“removeValue” can be used. When this
value appears in the source file, values
entered in that attribute will be
removed. The default value for
“removeValue” is “[Remove Value]”. If
the attribute is required, then an error
shall be returned, and the default value
shall not be used.
Overwrite

376 Arena REST API Developer Guide

Import Option Mode and Function
When editing attributes, an empty value
in the source file typically indicates that
the value should not change. In order to
change the value to be empty, the string
represented by the option
“removeValue” can be used. When this
value appears in the source file, values
entered in that attribute will be
removed. The default value for
“removeValue” is “[Remove Value]”. If
the attribute is required, then an error
shall be returned, and the default value
shall not be used.
multiSelectDelimiter Create
Multiselect lists are submitted with
multiple values in a text field. The
values are delimited with the value in
option “multiSelectDelimiter”. The
default value is a semicolon (\;) if not
specified.
Edit
Multiselect lists are submitted with
multiple values in a text field. The
values are delimited with the value in
option “multiSelectDelimiter”. The
default value is a semicolon (\;) if not
specified.
Overwrite
Multiselect lists are submitted with
multiple values in a text field. The
values are delimited with the value in
option “multiSelectDelimiter”. The
default value is a semicolon (\;) if not
specified.
Replace
Multiselect lists are submitted with
multiple values in a text field. The
values are delimited with the value in
option “multiSelectDelimiter”. The
default value is a semicolon (\;) if not
specified.

Endpoints 377
Import Option Mode and Function
checkRefDes Create
• CHECK runs a check on the
reference designators for every
created and edited BOM Line.
(Default).
• DO_NOT_CHECK value prevents
a reference designator check.
Edit
• CHECK runs a check on the
reference designators for every
created and edited BOM Line.
(Default).
• DO_NOT_CHECK value prevents
a reference designator check.
Overwrite
• CHECK runs a check on the
reference designators for every
created and edited BOM Line.
(Default).
• DO_NOT_CHECK value prevents
a reference designator check.
Replace
• CHECK runs a check on the
reference designators for every
created and edited BOM Line.
(Default).
• DO_NOT_CHECK value prevents
a reference designator check
timeZone Create
DateTime values must be specified
using ISO-8601 which must include
time and optionally time zone. If time
zone information is not included, the
option “timeZone” can be specified for
the import to set the time zone
accordingly. The timeZone option is set
to UTC by default.
Edit

378 Arena REST API Developer Guide

Import Option Mode and Function
DateTime values must be specified
using ISO-8601 which must include
time and optionally time zone. If time
zone information is not included, the
option “timeZone” can be specified for
the import to set the time zone
accordingly. The timeZone option is set
to UTC by default.
Overwrite
DateTime values must be specified
using ISO-8601 which must include
time and optionally time zone. If time
zone information is not included, the
option “timeZone” can be specified for
the import to set the time zone
accordingly. The timeZone option is set
to UTC by default.
Replace
DateTime values must be specified
using ISO-8601 which must include
time and optionally time zone. If time
zone information is not included, the
option “timeZone” can be specified for
the import to set the time zone
accordingly. The timeZone option is set
to UTC by default.
addToChange Create
Adds imported items to a change.
Supported values:
• An existing and valid change
GUID
• An existing and valid change
number.
• A valid POST CHANGES request
body.
Edit
Adds imported items to a change.
Supported values:
• An existing and valid change

Endpoints 379
Import Option Mode and Function
GUID
• An existing and valid change
number.
• A valid POST CHANGES request
body.
Overwrite
Adds imported items to a change.
Supported values:
• An existing and valid change
GUID
• An existing and valid change
number.
• A valid POST CHANGES request
body.
Replace
Adds imported items to a change.
Supported values:
• An existing and valid change
GUID
• An existing and valid change
number.
• A valid POST CHANGES request
body.
stripWhiteSpace Create
• STRIP strips white space from the
source for all atrributes. Default.
• RETAIN does not strip white space
from the source file.
Edit
• STRIP strips white space from the
source for all atrributes. Default.
• RETAIN does not strip white space
from the source file.
Overwrite
• STRIP strips white space from the

380 Arena REST API Developer Guide

Import Option Mode and Function
source for all atrributes. Default.
• RETAIN does not strip white space
from the source file.
Replace
• STRIP strips white space from the
source for all atrributes. Default.
• RETAIN does not strip white space
from the source file.
Delete
• STRIP strips white space from the
source for all atrributes. Default.
• RETAIN does not strip white space
from the source file.
numberingFreeTextHeader Create
A single Free Text field shall be
supported for item numbers using a
numbering sequence. The free text
content shall be taken from a dedicated
column in the import source file. The
column header shall be named as
specified in the option
"numberingFreeTextHeader". This shall
default to "Numbering Free Text" if not
supplied. When an item number is
generated using item numbering and
the item numbering has a single Free
Text field:
• If the numberingFreeTextHeader
column is supplied, and there is a
value for the item, this value shall
be used in the free text.
• If the numberingFreeTextHeader
column is supplied, and there is NO
value for the item, the default value
for the free text field shall be used.
If there is not default value, then
there shall be an error.
• If the numberingFreeTextHeader
column is not supplied, then the

Endpoints 381
Import Option Mode and Function
default value for the free text field
shall be used. If there is not default
value, then there shall be an error.
Edit
A single Free Text field shall be
supported for item numbers using a
numbering sequence. The free text
content shall be taken from a dedicated
column in the import source file. The
column header shall be named as
specified in the option
"numberingFreeTextHeader". This shall
default to "Numbering Free Text" if not
supplied. When an item number is
generated using item numbering and
the item numbering has a single Free
Text field:
• If the numberingFreeTextHeader
column is supplied, and there is a
value for the item, this value shall
be used in the free text.
• If the numberingFreeTextHeader
column is supplied, and there is NO
value for the item, the default value
for the free text field shall be used.
If there is not default value, then
there shall be an error.
• If the numberingFreeTextHeader
column is not supplied, then the
default value for the free text field
shall be used. If there is not default
value, then there shall be an error.
Overwrite
A single Free Text field shall be
supported for item numbers using a
numbering sequence. The free text
content shall be taken from a dedicated
column in the import source file. The
column header shall be named as
specified in the option

382 Arena REST API Developer Guide

Import Option Mode and Function
"numberingFreeTextHeader". This shall
default to "Numbering Free Text" if not
supplied. When an item number is
generated using item numbering and
the item numbering has a single Free
Text field:
• If the numberingFreeTextHeader
column is supplied, and there is a
value for the item, this value shall
be used in the free text.
• If the numberingFreeTextHeader
column is supplied, and there is NO
value for the item, the default value
for the free text field shall be used.
If there is not default value, then
there shall be an error.
• If the numberingFreeTextHeader
column is not supplied, then the
default value for the free text field
shall be used. If there is not default
value, then there shall be an error.

Import Mapping: Items Specs

ITEM_SPECS
The table below lists the API names when importing Item Specs (Item_Specs)
resources.
Item_Specs imports create and modify individual items.
The Source Names are examples. While users can use their own terminology, our
examples closely match the apiName since it can be helpful to use the same terms
if the source file originates from Arena’s Export Engine.
The last four columns lists the modes were the attribute can be used (e.g., TRUE
indicates that attribute is supported within that mode).
source-
Name
api- (exam- inRes- CRE- OVER- RE- DE-
Name ple) ponse ATE EDIT WRITE PLACE LETE
guid guid TRUE TRUE TRUE TRUE
number Number TRUE TRUE TRUE TRUE TRUE

Endpoints 383
 source-
Name
api- (exam- inRes- CRE- OVER- RE- DE-
Name ple) ponse ATE EDIT WRITE PLACE LETE
revision- revision- TRUE TRUE TRUE TRUE
Number Number
name name TRUE TRUE TRUE TRUE
category. category. TRUE TRUE TRUE TRUE
guid guid
category. category. TRUE TRUE TRUE TRUE
name name
category. category. TRUE TRUE TRUE TRUE
path path
descrip- descrip- TRUE TRUE TRUE TRUE
tion tion
uom uom TRUE TRUE TRUE TRUE
procure- procure- TRUE TRUE TRUE TRUE
ment- ment-
Type Type
owner. owner. TRUE TRUE TRUE TRUE
full- full-
Name Name
shared shared TRUE TRUE TRUE TRUE
Custom Custom TRUE TRUE TRUE TRUE
Attribute Attribute

Import Mapping: Item BOM

ITEM_BOM
The table below lists the API names when importing Item BOM (Item_BOM)
resources.
Item_BOM imports create or modify the Bill of Materials view of an Item..
The Source Names are examples. While users can use their own terminology, our
examples closely match the apiName since it can be helpful to use the same terms
if the source file originates from Arena’s Export Engine.
The last four columns lists the modes were the attribute can be used (e.g., TRUE
indicates that attribute is supported within that mode).

384 Arena REST API Developer Guide

 source-
Name
api- (exam- inRes- CRE- OVER- RE- DE-
Name ple) ponse ATE EDIT WRITE PLACE LETE
guid guid TRUE TRUE TRUE TRUE TRUE
parent. parent. TRUE TRUE TRUE TRUE TRUE TRUE
guid guid
parent. parent. TRUE TRUE TRUE TRUE TRUE TRUE
Number Number
item. item. TRUE TRUE TRUE TRUE TRUE TRUE
guid guid
item. item. TRUE TRUE TRUE TRUE TRUE TRUE
number number
lineN- lineN- TRUE TRUE TRUE TRUE TRUE
umber umber
quantity quantity TRUE TRUE TRUE TRUE TRUE
refDes refDes TRUE TRUE TRUE TRUE TRUE
notes notes TRUE TRUE TRUE TRUE TRUE
Custom Custom TRUE TRUE TRUE TRUE TRUE
Attribute Attribute

Import Mapping: Item Files

ITEM_FILES
Item Files only has two editable attributes:
• primary: If multiple file associations are set to primary, an error shall be
returned for all the rows for that item file.
• latestEditionAssociation: If set from false to true, then the file association will
change to the latest file edition. If set from true to false, then the file
association will change to the specific for the latest edition. It is not possible to
change the file association to a file edition that is not the latest edition using
import directly. The file association will need to be removed, then recreated.
Item Files Mapping Table
The table below lists the API names when importing Item Files (ITEM_FILES)
resources.
ITEM_FILES imports add or modify Item-File associations within the Files view
of an Item.
The Source Names are examples. While users can use their own terminology, our
examples closely match the apiName since it can be helpful to use the same terms
if the source file originates from Arena’s Export Engine.

Endpoints 385
The last four columns lists the modes were the attribute can be used (e.g., TRUE
indicates that attribute is supported within that mode).
source-
Name
api- (exam- inRes- CRE- OVER- RE- DE-
Name ple) ponse ATE EDIT WRITE PLACE LETE
guid guid TRUE TRUE TRUE TRUE TRUE
parent. parent. TRUE TRUE TRUE TRUE TRUE TRUE
guid guid
parent. parent. TRUE TRUE TRUE TRUE TRUE TRUE
number number
[Link] [Link] TRUE TRUE TRUE TRUE TRUE TRUE
file. file. TRUE TRUE TRUE TRUE TRUE TRUE
number number
latestE- latestE- TRUE TRUE TRUE TRUE TRUE
ditio- ditio-
nAssoci- nAssoci-
ation ation
primary primary TRUE TRUE TRUE TRUE TRUE
file. file. TRUE TRUE TRUE TRUE
location location
file. file. TRUE TRUE TRUE TRUE
edition edition
[Link] [Link] TRUE TRUE TRUE TRUE
file. file. TRUE TRUE TRUE TRUE
storage- storage-
Method- Method-
Name Name
file. file. TRUE TRUE TRUE TRUE
category. category.
guid guid
file. file. TRUE TRUE TRUE TRUE
category. category.
name name
file. file. TRUE TRUE TRUE TRUE
category. category.
path path
file. file. TRUE TRUE TRUE TRUE
descrip- descrip-
tion tion
file. file. TRUE TRUE TRUE TRUE

386 Arena REST API Developer Guide

 source-
Name
api- (exam- inRes- CRE- OVER- RE- DE-
Name ple) ponse ATE EDIT WRITE PLACE LETE
author. author.
full- full-
Name Name
file. file. TRUE TRUE TRUE TRUE
format format
file. file. TRUE TRUE TRUE TRUE
private private
file. file. TRUE TRUE TRUE TRUE
content- content-
Path Path
file. file. TRUE TRUE TRUE TRUE
com- com-
ment ment

Import Mapping: File Summary

FILE_SUMMARY
For File Summary resources, the number attribute is not case sensitive.
Files are automatically numbered during creation. Therefore file numbers cannot
be specified during creation.
EDIT and OVERWRITE Behavior
When running an import in edit or overwrite, the latest edition will be modified.
If the guid is specified in the source file, then the import will automatically the
latest edition. This is true even if the guid specifies a previous edition.
When running import in edit or overwrite mode, the files and item files, the
fileEditionEdit option can be used.
• EDIT_LATEST_EDITION overwrites the existing file edition.
• CREATE_NEW_EDITION creates a new edition.
When updating or creating a new edition the file edition ([Link]) can be set. If
not set, it will default to the File Edition Update and Check In within the Files
section within the Workspace > Summary > Settings subview.
DELETE Behavior
Files and individual file editions can be deleted with the FILE_SUMMARY
resoure. The behavior depends on the fileEditionDelete option.

Endpoints 387
• DELETE_ALL_EDITIONS deletes all editions of the file.
• DELETE_SINGLE_EDITION deletes the specified edition of the file.
If the file guid is specified with DELETE_SINGLE_EDITION, then that edition is
deleted.
If the file number (and not the guid) is specified with DELETE_SINGLE_
EDITION, then the latest edition is deleted.
If the file guid is specified with DELETE_ALL_EDITIONS, then all file editions
are deleted.
If the file number (and not the guid) is specified with DELETE_ALL_EDITIONS,
then all file editions are deleted.
Note that these delete behaviors are specific for FILE_SUMMARY. Delete in
ITEM_FILES simply deletes the Item to File association.
File Summary Mapping Table
The table below lists the API names when importing File Summary(FILE_
SUMMARY) resources.
FILE_SUMMARY imports create or modify Files.
The Source Names are examples. While users can use their own terminology, our
examples closely match the apiName since it can be helpful to use the same terms
if the source file originates from Arena’s Export Engine.
The last four columns lists the modes were the attribute can be used (e.g., TRUE
indicates that attribute is supported within that mode).
source-
Name
api- (exam- inRes- CRE- OVER- RE- DE-
Name ple) ponse ATE EDIT WRITE PLACE LETE
guid guid TRUE TRUE TRUE TRUE
number Number TRUE TRUE TRUE TRUE
location location TRUE TRUE TRUE TRUE
edition edition TRUE TRUE TRUE TRUE
title title TRUE TRUE TRUE TRUE
storage- storage- TRUE TRUE TRUE TRUE
Method- Method-
Name Name
category. category. TRUE TRUE TRUE TRUE
guid guid
category. category. TRUE TRUE TRUE TRUE
name name
category. category. TRUE TRUE TRUE TRUE
path path

388 Arena REST API Developer Guide

 source-
Name
api- (exam- inRes- CRE- OVER- RE- DE-
Name ple) ponse ATE EDIT WRITE PLACE LETE
descrip- descrip- TRUE TRUE TRUE TRUE
tion tion
author. author. TRUE TRUE TRUE TRUE
full- full-
Name Name
format format TRUE TRUE TRUE TRUE
private private TRUE TRUE TRUE TRUE
content- content- TRUE TRUE TRUE TRUE
Path Path
com- com- TRUE TRUE TRUE TRUE
ment ment
Custom Custom TRUE TRUE TRUE TRUE
Attribute Attribute

Import Engine Source File

The Import Engine supports a single resource per import run. The source file
contains data for that resource.
The following source file formats are supported:
• Microsoft 2007 Excel XLSX worksheet
• Comma Separated Values (CSV) adhering to RFC-4180 encoded in UTF-8.
Each column within the source file represent an attribute.
Each row within the source file represents a resource.

Note
As of our Spring 2023 release, the Import Engine supports two resources:
ITEM_SPECS and ITEM_BOM. These two resources are equivalent to the
Specs view and BOM view of an Item respectively.

GET Import Definitions (Search)

/imports?query_string
Returns a collection of Import Definition on page 1110 objects matching the given
search criteria..

Endpoints 389
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 import
definitions where results
should begin. All import
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 import definition. 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 import
definition
[Link] GUID The unique identifier for
the creator of the Export
Definition.
[Link] string The email address of the
user account that created

390 Arena REST API Developer Guide

Name Value Description
the import Definition.
[Link] string The full name of the user
that created the Import
Definition.
mode string The Mode of the import.
The mode dictates the
function of the import.

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
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all import definitions that use Item Specs as a resource.
GET /imports?resource=ITEM_SPECS
{
"count": 6,
"results": [

Endpoints 391
 {
"name": "General Import Items",
"description": "Item_Speces_create",
"resource": "ITEM_SPECS",
"mode": "CREATE",
"options": {
"createDuplicates": "ERROR",
"multiSelectDelimiter": ";",
"useCategoryNumberFormat": "[Use Category Number
Format]",
"stripWhiteSpace": "STRIP",
"numberingFreeTextHeader": "Numbering Free Text",
"mapping": [
{
"resource": "ITEM_SPECS",
"apiName": "revisionNumber",
"sourceName": "revision",
"inResponse": true
},
{
"resource": "ITEM_SPECS",
"apiName": "number",
"sourceName": "item number",
"inResponse": true
},
{
"resource": "ITEM_SPECS",
"apiName": "[Link]",
"sourceName": "item category",
"inResponse": true
},
{
"resource": "ITEM_SPECS",
"apiName": "uom",
"sourceName": "unit of measure",
"inResponse": true
},
{
"resource": "ITEM_SPECS",
"apiName": "owner",
"sourceName": "owner",
"inResponse": true
}
]
},
"number": 2,
"creationDateTime": "2023-04-26T06:01:49Z",
"creator": {
"fullName": "Heidi Walker",
"email": "hwalker@[Link]",
"guid": "9RBUZOR8OFWFYH0JSIPJ"

392 Arena REST API Developer Guide

 },
"guid": "Q8SBG58P5WWZI1K3M4U1"
},
{
"name": "General Import Items",
"description": "Item_Speces_create",
"resource": "ITEM_SPECS",
"mode": "CREATE",
"options": {
"createDuplicates": "ERROR",
"multiSelectDelimiter": ";",
"useCategoryNumberFormat": "[Use Category Number
Format]",
"stripWhiteSpace": "STRIP",
"numberingFreeTextHeader": "Numbering Free Text",
"mapping": [
{
"resource": "ITEM_SPECS",
"apiName": "revisionNumber",
"sourceName": "revision",
"inResponse": true
},
{
"resource": "ITEM_SPECS",
"apiName": "number",
"sourceName": "item number",
"inResponse": true
},
{
"resource": "ITEM_SPECS",
"apiName": "name",
"sourceName": "item name",
"inResponse": true
},
{
"resource": "ITEM_SPECS",
"apiName": "procurementType",
"sourceName": "procurement type",
"inResponse": true
},
{
"resource": "ITEM_SPECS",
"apiName": "[Link]",
"sourceName": "item category",
"inResponse": true
},
{
"resource": "ITEM_SPECS",
"apiName": "uom",
"sourceName": "unit of measure",
"inResponse": true

Endpoints 393
 },
{
"resource": "ITEM_SPECS",
"apiName": "owner",
"sourceName": "owner",
"inResponse": true
}
]
},
"number": 3,
"creationDateTime": "2023-04-26T06:20:03Z",
"creator": {
"fullName": "Heidi Walker",
"email": "hwalker@[Link]",
"guid": "9RBUZOR8OFWFYH0JSIPJ"
},
"guid": "SAUDI7AR7YY1K3M5O6WN"
},
{
"name": "General Import Items",
"description": "Item_Speces_create",
"resource": "ITEM_SPECS",
"mode": "CREATE",
"options": {
"createDuplicates": "ERROR",
"multiSelectDelimiter": ";",
"useCategoryNumberFormat": "[Use Category Number
Format]",
"stripWhiteSpace": "STRIP",
"numberingFreeTextHeader": "Numbering Free Text",
"mapping": [
{
"resource": "ITEM_SPECS",
"apiName": "revisionNumber",
"sourceName": "revision",
"inResponse": true
},
{
"resource": "ITEM_SPECS",
"apiName": "number",
"sourceName": "item number",
"inResponse": true
},
{
"resource": "ITEM_SPECS",
"apiName": "name",
"sourceName": "item name",
"inResponse": true
},
{
"resource": "ITEM_SPECS",

394 Arena REST API Developer Guide

 "apiName": "procurementType",
"sourceName": "procurement type",
"inResponse": true
},
{
"resource": "ITEM_SPECS",
"apiName": "[Link]",
"sourceName": "item category",
"inResponse": true
},
{
"resource": "ITEM_SPECS",
"apiName": "uom",
"sourceName": "unit of measure",
"inResponse": true
},
{
"resource": "ITEM_SPECS",
"apiName": "owner",
"sourceName": "owner",
"inResponse": true
}
]
},
"number": 4,
"creationDateTime": "2023-04-26T06:51:55Z",
"creator": {
"fullName": "Heidi Walker",
"email": "hwalker@[Link]",
"guid": "9RBUZOR8OFWFYH0JSIPJ"
},
"guid": "WEYHMBEVB225O7Q9SA09"
},
...
]
}
Get import definitions use REPLACE mode.
GET <url>/imports?mode=REPLACE
{
"count": 1,
"results": [
{
"name": "Item_BOM_Replace",
"description": "Item_BOM_Replace",
"resource": "ITEM_BOM",
"mode": "REPLACE",
"options": {
"matchDuplicateParents": "ERROR",
"removeValue": "[Remove Value]",
"multiSelectDelimiter": ";",

Endpoints 395
 "checkRefDes": "CHECK",
"stripWhiteSpace": "STRIP"
},
"number": 9,
"creationDateTime": "2023-05-03T18:53:29Z",
"creator": {
"fullName": "Heidi Walker",
"email": "hwalker@[Link]",
"guid": "9RBUZOR8OFWFYH0JSIPJ"
},
"guid": "9RBUZOR8OFFI1K3M5N94"
}
]
}
Request with an invalid search attribute.
GET /imports?[Link]=Heidi Walker
{
"status":400,
"errors":[
{
"code":3019,
"message":"The attribute \"[Link]\" is not
searchable."
}
]
}

GET Import Definition

/imports/<GUID>
Returns an Import Definition on page 1110with 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

396 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific import definition.
GET /imports/GUID
{
"guid": "5N7Q4157IZGYH0HMVRLM",
"number": 14,
"creationDateTime": "2021-09-15T00:00:00Z",
"creator": {
"email": "rjohannas@[Link]",
"fullName": "Roy Arena",
"guid": "4M6P3046HYFYH0J258QJ"
},
"name": "CAD Import",
"description": "Used for OnShape",
"resource": "ITEM_SPECS",
"mode": "OVERWRITE",
"options": {
"createDuplicates": "ERROR",
"matchDuplicates": "ERROR",
"matchDuplicateParents": "ERROR",
"fileEdition": "CREATE_EDITION",
"removeValue": "[Remove Value]",
"multiSelectDelimiter": ";",
"useCategoryNumberFormat": "[Use Category Number Format]",
"checkRefDes": "CHECK",
"mapping": [
{
"resource": "ITEM_SPECS",
"apiName": "revisionNumber",
"sourceName": "Rev"
},
...
],

Endpoints 397
 "addToChange": {
"effectivityType": "PERMANENT_ON_APPROVAL",
"category": {
"guid": "L3N6KHLNYFY8RAQ8SWYT"
},
"numberSequencePrefix": {
"value": "ECO-"
},
"title": "New CAD Release",
"routings": [
{
"guid": "7P9S6379K1IL4N6P4QFB"
}
]
}
}
}
request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not
valid."
}
]
}

POST Item Definition

/imports
Creates a new Import Definition on page 1110 object. Note that all Import Engine
endpoints are only supported in Access Policies workspaces..

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Sample Request Body

• Import Definition for creating Items and adding them to a change. Includes
custom mapping.
{

398 Arena REST API Developer Guide

 "name": "Item_Specs_Create_0331",
"description": "Item_Specs_Create_0331",
"resource": "item_specs",
"mode": "create",
"options": {
"createDuplicates": "ALLOW",
"mapping": [
{
"resource": "item_specs",
"apiName": "revisionNumber",
"sourceName": "Revd"
},
{
"resource": "item_specs",
"apiName": "procurementType",
"sourceName": "procurementType"
}
{
"resource": "item_specs",
"apiName": "Date Zero",
"sourceName": "Date Zero"
},
{
"resource": "import",
"apiName": "errormessage",
"sourceName": "error messages"
}
],
"addToChange": {
"effectivityType": "PERMANENT_ON_APPROVAL",
"category": {
"guid": "L3N6KHLNYFY8RAQ8SWYT"
},
"numberSequencePrefix": {
"value": "ECO-"
},
"title": "New CAD Release",
"routings": [
{
"guid": "7P9S6379K1IL4N6P4QFB"
}
]
}
}
}
• Import Definition BOM replacement. Uses default mapping.
{
"name": "Item_BOM_Replace",
"description": "Item_BOM_Replace",
"resource": "ITEM_BOM",

Endpoints 399
 "mode": "Replace",
"options": {
"createDuplicates": "ERROR",
"matchDuplicates": "ERROR",
"matchDuplicateParents": "ERROR",
"removeValue": "[Remove Value]",
"multiSelectDelimiter": ";",
"useCategoryNumberFormat": "[Use Category Number
Format]"
}
}
• Create an import definition that can be used to create Item File associations.
{
"name": "item_1_0904",
"description": "create item file associations",
"resource": "item_files",
"mode": "create"
"options": {
"mapping": [
{
"resource": "ITEM_FILES",
"apiName": "[Link]",
"sourceName": "[Link]",
"inResponse": true
},
{
"resource": "ITEM_FILES",
"apiName": "[Link]",
"sourceName": "[Link]",
"inResponse": true
},
{ "resource": "ITEM_FILES",
"apiName": "[Link]",
"sourceName": "[Link]",
"inResponse": true
},
{
"resource": "ITEM_FILES",
"apiName": "[Link]",
"sourceName": "[Link]",
"inResponse": true
},
...
]
}

400 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Import Definition for creating Items and adding them to a change. Includes
custom mapping.
{
"name": "Item_Specs_Create_0331",
"description": "Item_Specs_Create_0331",
"resource": "item_specs",
"mode": "create",
"options": {
"createDuplicates": "ALLOW",
"mapping": [
{
"resource": "item_specs",
"apiName": "revisioNNUMBER",
"sourceName": "Revd"
},
{
"resource": "item_specs",
"apiName": "procurementType",
"sourceName": "procurementType"
}
{
"resource": "item_specs",
"apiName": "Date Zero",
"sourceName": "Date Zero"
},
{

Endpoints 401
 "resource": "import",
"apiName": "errormessage",
"sourceName": "error messages"
}
],
"addToChange": {
"effectivityType": "PERMANENT_ON_APPROVAL",
"category": {
"guid": "L3N6KHLNYFY8RAQ8SWYT"
},
"numberSequencePrefix": {
"value": "ECO-"
},
"title": "New CAD Release",
"routings": [
{
"guid": "7P9S6379K1IL4N6P4QFB"
}
]
}
"number": 9,
"creationDateTime": "2023-05-03T18:53:29Z",
"creator": {
"fullName": "Heidi Walker",
"email": "hwalker@[Link]",
"guid": "9RBUZOR8OFWFYH0JSIPJ"
},
"guid": "9RBUZOR8OFFI1K3M5N94"
}
Import Definition BOM replacement. Uses default mapping.
{
"name": "Item_BOM_Replace",
"description": "Item_BOM_Replace",
"resource": "ITEM_BOM",
"mode": "REPLACE",
"options": {
"matchDuplicateParents": "ERROR",
"removeValue": "[Remove Value]",
"multiSelectDelimiter": ";",
"checkRefDes": "CHECK",
"stripWhiteSpace": "STRIP"
},
"number": 9,
"creationDateTime": "2023-05-03T18:53:29Z",
"creator": {
"fullName": "Heidi Walker",
"email": "hwalker@[Link]",
"guid": "9RBUZOR8OFWFYH0JSIPJ"
},
"guid": "9RBUZOR8OFFI1K3M5N94"

402 Arena REST API Developer Guide

}
Create an import definition that can be used to create Item File associations
response.

{
"name": "item_1_0904",
"description": "create item file associations",
"resource": "item_files",
"mode": "create"
"options": {
"mapping": [
{
"resource": "ITEM_FILES",
"apiName": "[Link]",
"sourceName": "[Link]",
"inResponse": true
},
{
"resource": "ITEM_FILES",
"apiName": "[Link]",
"sourceName": "[Link]",
"inResponse": true
},
{ "resource": "ITEM_FILES",
"apiName": "[Link]",
"sourceName": "[Link]",
"inResponse": true
},
{
"resource": "ITEM_FILES",
"apiName": "[Link]",
"sourceName": "[Link]",
"inResponse": true
},
...
]
},
"number": 1,
"creationDateTime": "2023-11-22T03:46:09Z",
"creator": {
"fullName": "Heidi Walker",
"email": "hwalker@[Link]",
"guid": "9RBUZOR8OFWFYH0JSIPJ"
},
"guid": "K2M5AZ2JZQQTCVEXGUI7" }

1. A field is not creatable.

{
"status":400,

Endpoints 403
 "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."
}
]
}

PUT Import Definition Edit

/imports/<GUID>
Edits the Import Definition on page 1110 name and description. Import Engine
endpoints are only supported in Access Policies workspaces.

404 Arena REST API Developer Guide

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Sample Request Body

• Edit the name or description of an import definition.
{
"name": "Joe B's Personal Import Definition",
"description": "Tailored Import for Sr. Developer J.
Branson for the Skunkworks Project"
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Edit the name or description of an import definition
{
"name": "Joe B's Personal Import Definition",
"description": "Tailored Import for Sr. Developer J. Branson
for the Skunkworks Project",
"resource": "ITEM_BOM",
"mode": "REPLACE",
"options": {
"matchDuplicateParents": "ERROR",

Endpoints 405
 "removeValue": "[Remove Value]",
"multiSelectDelimiter": ";",
"checkRefDes": "CHECK",
"stripWhiteSpace": "STRIP"
},
"number": 9,
"creationDateTime": "2023-05-03T18:53:29Z",
"creator": {
"fullName": "Heidi Walker",
"email": "hwalker@[Link]",
"guid": "9RBUZOR8OFWFYH0JSIPJ"
},
"guid": "9RBUZOR8OFFI1K3M5N94"
}

GET Import Run

/imports/<GUID>/runs/<GUID>
Returns anImport Runs on page 1112 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

406 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific prrevious import engine run.
GET /imports/<GUID>/runs/<GUID>
{
"guid": "R9TCQNRT4L47Q9VQWUF3",
"number": 14,
"creationDateTime": "2021-09-15T00:00:00Z",
"creator": {
"email": "rjones@[Link]",
"fullName": "Roy Arena",
"guid": "4M6P3046HYFYH0J258QJ"
},
"submitFileType": "EXCEL_WORKSHEET",
"submitWorksheetName": "Item Master",
"completionDateTime": "2021-09-16T00:00:00Z",
"status": "COMPLETE",
"warnings": {
"count": 12,
"results": [
{
"code": 331,
"message": "Column 'Descrptn' ignored."
},
...
]
},
"commit": false,
"totalCount": 134881,
"successCount": 134862,
"errorCount": 19,
"options": {
"timeZone": "???",
"addToChange": {
"number": "ECO-002114"
}
},
"changes": [
{
"category": {
"guid": "L3N6KHLNYFY8RAQ8SWYT",
"name": "Engineering Change Order",

Endpoints 407
 "path": "Change\\Change Order\\Engineering Change
Order"
},
"creationDateTime": "2021-09-14T23:58:41Z",
"creator": {
"email": "integration@[Link]",
"fullName": "Mr. Integration",
"guid": "J1L4IFJLWDUDWFYHPRYT"
},
"effectiveDateTime": null,
"guid": "J1L4IFJLWDWZI0GL6I34",
"lifecycleDateTime": "2021-09-14T23:58:41Z",
"lifecycleStatus": {
"type": "OPEN_AND_UNLOCKED"
},
"number": "ECO-002114",
"submissionDateTime": null,
"title": "From an integration!"
},
...
]
}
request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not
valid."
}
]
}

POST Import Run

/imports/<GUID>/runs
Initiates an Import run based using an import source file in conjunection with an
existing Import Definition. Creates an Import Run on page 1112 object. Each case
is shown below.
NOTES:
1. The import run endpoint executes an import definition.
2. Import results are saved in Arena and expire after 60 days. Once expired, the
results files are deleted in Arena and are no longer available.
3. Import Limits: COMING SOON.
4.

408 Arena REST API Developer Guide

 Import runs can have the following six statuses.

Import Status Description

CREATED The import run has been created and
is queued for processing.
RUNNING The import run is processing.
COMPLETE The import file is completed and is
ready to be downloaded.
ERROR The import file has errors.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type multipart/form-data

Sample Request Body

• Run Import Definition with an Excel worksheet. Do not commit data to
workspace.
submitContent:everyscan_spring2023_project_revA.xlsx
submitFileType: EXCEL_WORKSHEET
submitWorsheetName:everyscanBOM
commit: false
• Run Import Definition with a CSV file. Commit data to workspace (assuming
there are no errors).
submitContent:updated_parts_for_winter_23_fan.csv
submitFileType: CSV
commit: true
• Run an Item Files creation Definition with an Excel worksheet. Do not
commit data to workspace.
submitContent: Item_File_001.xlsx
submitWorksheetName: Item_File_create
commit: false
fileContent: new_item_file_associations.zip

Response Codes
Code Description
201 Success
400 Failure

Endpoints 409
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Run Import Definition with an Excel worksheet. Do not commit data to
workspace.
{
"number": 2,
"creator": {
"fullName": "Heidi Walker",
"email": "hwalker@[Link]",
"guid": "9RBUZOR8OFWFYH0JSIPJ"
},
"submitFileType": "EXCEL_WORKSHEET",
"submitWorksheetName": everyscanBOM,
"status": "CREATED",
"commit": false,
"totalCount": 3,
"successCount": 3,
"errorCount": 0,
"guid": "GYI16VYFVMMO7Q9SBN3Q"
}
Run Import Definition with a CSV file. Commit data to workspace (assuming
there are no errors).
{
"number": 2,
"creator": {
"fullName": "Heidi Walker",
"email": "hwalker@[Link]",
"guid": "9RBUZOR8OFWFYH0JSIPJ"
},
"submitFileType": "CSV",
"status": "CREATED",
"commit": true,
"totalCount": 3,
"successCount": 3,

410 Arena REST API Developer Guide

 "errorCount": 0,
"guid": "FE67A3D57DAF4293A1FF"
}
Response to an import run with an Item Files creation Definition with an Excel
worksheet.
{
"number": 1,
"creator": {
"fullName": "Heidi Walker",
"email": "hwalker@[Link]",
"guid": "9RBUZOR8OFWFYH0JSIPJ"
},
"submitFileType": "EXCEL_WORKSHEET",
"submitWorksheetName": "Item_Create_001",
"status": "CREATED",
"commit": false,
"totalCount": 1,
"successCount": 1,
"errorCount": 0,
"guid": "8QATYNQ7NEEGZI1K3GF2"
}
The request is validated to make sure it doesn’t violate any business rules. Any
violation will result in an error response:
1. A value in the import definition is invalid.
{
"status":400,
"errors":[
{
"code":3011,
"message":"The specified value \"Changes\" is not a
valid option for the attribute \"world\"."
}
]
}

PUT Import Commit

/imports/<GUID>/runs/<GUID>
When performing a POST import run endpoint, users can set the commit value to
false. The import then can use information within the response and GET import
run error content or GET import run results content to find any errors within an
import run. This allows users to double check for any import errors without
committing it to the workspace.
Once the user has completed troubleshooting the errors, they can then use this
PUT Import commit endpoint to commit the import to the workspace.

Endpoints 411
Please note that this endpoint is uni-directional. Once the import commit has been
set to true, it cannot be returned to a value of false. Response returns a Import
Runs on page 1112 object.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Sample Request Body

• Commit and "finish" an import run. Once set to true, the import run commit
attribute cannot be set back to false.
{
"commit": 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Import Run has successfully been commited to the workspace.
{
"guid": "R9TCQNRT4L47Q9VQWUF3",
"number": 14,
"creationDateTime": "2021-09-15T00:00:00Z",

412 Arena REST API Developer Guide

 "creator": {
"email": "rjones@[Link]",
"fullName": "Roy Arena",
"guid": "4M6P3046HYFYH0J258QJ"
},
"submitFileType": "EXCEL_WORKSHEET",
"submitWorksheetName": "Item Master",
"completionDateTime": "2021-09-16T00:00:00Z",
"status": "COMPLETE",
"warnings": {
"count": 12,
"results": [
{
"code": 331,
"message": "Column 'Descrptn' ignored."
},
...
]
},
"commit": true,
"totalCount": 134881,
"successCount": 134862,
"errorCount": 19,
"options": {
"addToChange": {
"number": "ECO-002114"
}
},
"changes": [
{
"category": {
"guid": "L3N6KHLNYFY8RAQ8SWYT",
"name": "Engineering Change Order",
"path": "Change\\Change Order\\Engineering
Change Order"
},
"creationDateTime": "2021-09-14T23:58:41Z",
"creator": {
"email": "integration@[Link]",
"fullName": "Mr. Integration",
"guid": "J1L4IFJLWDUDWFYHPRYT"
},
"effectiveDateTime": null,
"guid": "J1L4IFJLWDWZI0GL6I34",
"lifecycleDateTime": "2021-09-14T23:58:41Z",
"lifecycleStatus": {
"type": "OPEN_AND_UNLOCKED"
},
"number": "ECO-002114",
"submissionDateTime": null,
"title": "From an integration!"

Endpoints 413
 },
The request is validated to make sure it doesn’t violate any business rules. Any
violation will result in an error response:
1. A value in the import definition is invalid.
{
"status":400,
"errors":[
{
"code":3011,
"message":"The specified value \"Changes\" is not a
valid option for the attribute \"world\"."
}
]
}

GET Import Run Submit Content File

Content
/imports/<GUID>/runs/<GUID>/submitContent
Streams the content of the submitContent file (also called the source file) of a
specific import run.

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

414 Arena REST API Developer Guide

Name Value Description
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Downloads the import source file.
GET /imports/<GUID>/runs/<GUID>/submitContent
<file stream of submitContent file>
request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not
valid."
}
]
}

GET Import Run Result Content

/imports/<GUID>/runs/<GUID>/resultContent
Streams the content of the resultContent file (also called the source file) of an
import run.
The results content file contains both the successes and errors of an import run.

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

Endpoints 415
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Downloads the results content file of an import.
GET /imports/<GUID>/runs/<GUID>/resultContent
<file stream of submitContent file>
request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not
valid."
}
]
}

GET Import Run Error Content

/imports/<GUID>/runs/<GUID>/errorContent
Streams the content of the errorContent file of an import run. Unlike the results
content file, this file only contains errors.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

416 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Downloads the error content file.
GET /imports/<GUID>/runs/<GUID>/errorContent
<file stream of submitContent file>
request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"L3N6PX663K3K3HOBOOT0 \" is not
valid."
}
]
}

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.

Endpoints 417
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.

418 Arena REST API Developer Guide

Searchable Attributes
Name Value Description
[additional attribute guid string This special search
value] permits searching for
strings in additional
attribute values. For
example GET /items?
VDXGZ7E0-
GO5N6P8PR55G=
*100pF where
VDXGZ7E0-
GO5N6P8PR55G 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 example,
the user is using the
following to search for a
date field type custom
attribute with a value of
April 1, 2019:

Endpoints 419
Name Value Description
GET /requests?
4M6PUJNPNM3L4N25-
ZZ5F=2019-04-01
[Link] string category unique ID
[Link] string creator user unique ID
deferralCode string Denotes the nature of a
deferred Request. Values
can be customized within
Workspace Settings.
[Link] 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.
submissionDateTime- Date-Formatted String the date and time (in Zulu
From 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.

420 Arena REST API Developer Guide

 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.
For additional attribute field type MULTI_LINE_TEXT searches, different
values can be separated with an asterisk.
For additional attribute field types DROP_DOWN & FIXED_DROP_DOWN
searches, different values can be separated with a semi-colon.
When using a semi-colon to separate values in a FIXED_DROP_DOWN
search, note that the semi-colon will always act as an OR. This is relevant
when performing a Multi-Select search.
For example with FIXED_DROP_DOWN, multiselect = True: GET /Items?
J1L49Y281EVDWFUXRSCZ=Option 1;Option 2 will return all Items where
the FIXED_DROP_DOWN contains Option 1 OR Option 2 (or both). On the
other hand FIXED_DROP_DOWN, multiselect=False: GET /items?
J1L49Y281EVDWFUXRSCZ=Option 1;Option 2 will return all Items where
the FIXED_DROP_DOWN equals Option 1 OR Option 2.
Search in Zulu format is supported for custom attribute field type Date.
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
400 Failure

Response Header
Name Value Description
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions

Endpoints 421
Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": "ykeller@[Link]",
"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.",
"resolutionCode": null,
"submissionDateTime": null,

422 Arena REST API Developer Guide

 "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": "ykeller@[Link]",
"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": "jparker@[Link]",
"fullName": "John Parker",
"guid": "XFZI1EZQDGXGZI1KTJQ2"
},
"title": "EveryRoad Model 300 Case Melting"
},
{
"category": {
"guid": "I0K3MZKBY1KUDWBIIJ7C",
"name": "Manufacturing Change Request"
},
"creationDateTime": "2011-07-11T20:01:22Z",

Endpoints 423
 "creator": {
"email": "ykeller@[Link]",
"fullName": "Yvette Keller",
"guid": "VDXGZCXOBEVEXGZIWZJK"
},
"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?[Link]=
PROMOTED&[Link]=HZJ2LYJAX0JTCVAHHI66
{
"count": 2,
"results": [
{
"category": {
"guid": "HZJ2LYJAX0JTCVAHHI66",
"name": "Engineering Change Request"
},
"creationDateTime": "2011-07-11T23:28:57Z",
"creator": {
"email": "ykeller@[Link]",
"fullName": "Yvette Keller",
"guid": "VDXGZCXOBEVEXGZIWZJK"
},
"deferDeadlineDateTime": null,
"deferralCode": null,
"evaluatorGroup": {

424 Arena REST API Developer Guide

 "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": "jparker@[Link]",
"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": "ykeller@[Link]",
"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",

Endpoints 425
 "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": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"title": "Alternate Mounting Solution for EveryRoad
GPS"
}
]
}

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

426 Arena REST API Developer Guide

Name Value Description
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": "ykeller@[Link]",
"fullName": "Yvette Keller",
"guid": "VDXGZCXOBEVEXGZIWZJK"
},
"deferDeadlineDateTime": null,
"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": {

Endpoints 427
 "email": "hwalker@[Link]",
"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"
}
]
}

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

428 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Create Request.
POST /requests
Request
{
"category": {
"guid": "HZJ2LYJAX0JTCVAHHI66"
},
"creatorParticipation": false,
"evaluatorGroup": {
"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": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},

Endpoints 429
 "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"
}

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

430 Arena REST API Developer Guide

Set Null
Name Description
setnull Append the URL with
setnull=true to set
problem or
requestedAction to null.
Attributes must be
included within the
request body and set to
null. Insert setnull after
the query string,
represented by a ?, after
the GUID.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Edit a Request.
/requests/<GUID>
Request
{
"category": {
"guid": "GYI1KXI9WZISBU9GGH53"
},
"title": "Melted Bezels on Model 400",

Endpoints 431
 "problem": "Unit PCB is overheating",
"requestCode": "Performance"
}
Response
{
"category": {
"guid": "GYI1KXI9WZISBU9GGH53",
"name": "Document Change Request"
},
"creationDateTime": "2021-09-06T05:36:54Z",
"creator": {
"email": "hwalker@[Link]",
"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"
}
Sets a Request attribute to null.
PUT /requests/<GUID>?setnull=true
Request
{
"category": {
"guid": "GYI1KXI9WZISBU9GGH53"
},
"title": "Melted Bezels on Model 400",
"problem": null,
"requestCode": "Performance"
}
Response

432 Arena REST API Developer Guide

{
"category": {
"guid": "GYI1KXI9WZISBU9GGH53",
"name": "Document Change Request"
},
"creationDateTime": "2021-09-06T05:36:54Z",
"creator": {
"email": "hwalker@[Link]",
"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": null,
"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"
}
]
}

DELETE Request
/requests/<GUID>

Endpoints 433
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

434 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": {

Endpoints 435
 "api": "[Link]
items/3L5O7K5WJM5DWEO7JBIR",
"app": "[Link]
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": "[Link]
items/UCWFYBWNADQP8R0GGESV",
"app": "[Link]
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": "[Link]
items/HZJ2LYJAX0JRAS1RLQU7",
"app": "[Link]
HZJ2LYJAX0JRAS1RLQU7"
}
},
"notes": "Self-tapping Pan head screw with Phillips
drive style"
},
]
}
Request with invalid GUID
{
"status":400,

436 Arena REST API Developer Guide

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

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific item included in a request
GET /requests/<GUID>/items/<GUID>
{
"guid": "TBVEXAVM9CPO7QZFFDRY",

Endpoints 437
 "item": {
"guid": "3L5O7K5WJM5DWEO7JBIR",
"name": "Screw, M3 x 6, ST, Torx",
"number": "472-00001",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
3L5O7K5WJM5DWEO7JBIR",
"app": "[Link]
}
},
"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."
}
]
}

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."
}

438 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

{
"guid": "DVFYHUF6TW98RAB185YV",
"item": {
"guid": "1J3M5I3UHK3BUCLB5AED",
"name": "Manual, Everyroad Model 300/500",
"number": "770-00001",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
3L5O7K5WJM5DWEO7JBIR",
"app": "[Link]
}
},
"notes": "This is overheating the forward unit."
}
Request with invalid GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

Endpoints 439
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Update the notes information for an item on a request
/requests/<GUID>/items/<GUID>
{
"guid": "CUEXGTE5SV87Q9A3DB9W",
"item": {

440 Arena REST API Developer Guide

 "guid": "R9TCV8TK7AT1KZNA8V5I",
"name": "Gasket, 3.75 in",
"number": "437-00002",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
R9TCV8TK7AT1KZNA8V5I",
"app": "[Link]
}
},
"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."
}
]
}

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

Endpoints 441
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

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

442 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Request Files View Associations
GET <url>/requests/<GUID>/files
{
"count": 5,
"results": [
{
"file": {
"author": {
"fullName": "Kathy Davies"
},
"category": {
"guid": "CUEXGTE5SVEO7Q5CCD07",
"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 [Link]",
"number": "FILE-000875",
"private": false,
"size": 74607,

Endpoints 443
 "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, [Link]",
"number": "FILE-000948",
"private": false,
"size": 8690,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "EveryRoad GPS Car Navigation Unit -
Model 300, Rendering"
},
"guid": "4M6P8L6XKN4ATCBFZ1YG"
},
{
"file": {
"author": {
"fullName": "Heidi Walker"
},
"category": {
"guid": "2K4N6J4VIL4EXGV223PR",
"name": "-uncategorized-"
},

444 Arena REST API Developer Guide

 "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 [Link]",
"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."
}
]
}

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.

Endpoints 445
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Request Files View Association
GET <url>/requests/<GUID>/files/<GUID>
{
"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",

446 Arena REST API Developer Guide

 "guid": "ASCVERC3QTCSBUVTA0U1",
"hasMarkup": false,
"lastModifiedDateTime": "2011-08-31T18:11:23Z",
"latest": true,
"location": null,
"locked": false,
"mimeType": "application/pdf",
"name": "MPI, ERGPS 300 [Link]",
"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."
}
]
}

POST Request Files View Add Existing

File
/requests/<GUID>/files
Associates an existing File Association on page 1118 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

Endpoints 447
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
Associate an existing file with a Request
/requests/<GUID>/files
{
"file": {
"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",

448 Arena REST API Developer Guide

 "guid": "XFZI1EZQDGZFYHKBX3JI",
"hasMarkup": false,
"lastModifiedDateTime": "2011-06-02T19:30:28Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "image/jpeg",
"name": "[Link]",
"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."
}
]
}

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

Endpoints 449
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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\"."
}
]
}

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

450 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": {
"guid": "0I2L4H2TGJ2CVET001OY"
},
"creationDateTime": "2021-01-22T19:51:01Z",
"format": "333",
"guid": "Q8SBU7SJ69S8RA07P9F9",
"lastModifiedDateTime": "2021-01-22T19:59:08Z",
"locked": false,
"mimeType": "application/pdf",
"name": "[Link]",
"size": 260178,
"storageMethodName": "FILE",
"title": "1004"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"reserved": true,
"reservedUser": {

Endpoints 451
 "email": "hwalker@[Link]",
"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": "[Link]/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."
}
]
}

GET Request File Markup

/requests/<GUID>/markupfiles/<GUID>

452 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",
"format": "Web",
"guid": "FXH0JWH8VYHXGZPWEY43",

Endpoints 453
 "lastModifiedDateTime": "2021-01-22T03:31:04Z",
"location": "[Link]/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."
}
]
}

POST Request File Markup Create

/requests/<GUID>/markupfiles
Creates a Request File Markup File on page 1115 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"
}
}

454 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
• When associating a File Markup to a Request:
{
"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": "[Link]",
"size": 27136,
"storageMethodName": "FILE",
"title": "mount-instructions-07-25-2011"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",

Endpoints 455
 "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."
}
]
}

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

456 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

GET Request Quality Processes

GET /requests/<GUID>/quality
GET /requests/<GUID>/quality/<GUID>
Returns a collection of Quality Process on page 1135 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

Endpoints 457
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
Get all quality processes that include a given request
GET /requests/0I2LQGHHQXGXGVRR5XND/quality
{
"count": 2,
"results": [
{
"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
}
},
{
"guid": "5N7Q9M7YLO6H0J2KYGR1",
"notes": null,
"qualityProcess": {
"guid": "TBVEXAVM9CVRATCVO1X4",
"name": "Everyroad bezels melted/burned",
"number": "CAR-000008",
"step": {
"guid": "UCWFYBWNADWSBUDWP2Y8",
"name": "Problem Description"
},
"type": null
}

458 Arena REST API Developer Guide

 }
]
}
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,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

GET All Changes Associated with a

Request
/requests/<GUID>/changes
Returns all the changes associated with a specific request. Users must have a Read
Request Summary and Edit Request Changes rule. Additionally users must have a
Read Change Summary rule for the referenced changes.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Endpoints 459
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all changes associated with a request.
GET /requests/<GUID>/changes
{
"count": 4,
"results": [
{
"change": {
"guid": "YG0J2J2IERADWEXIMLIS",
"number": "ECO-000033"
},
"guid": "FXH0J0JZV8QEXGZ7AQVD"
},
{
"change": {
"guid": "DVFYHYHXT6PSBTCX10WY",
"number": "DEV-000003"
},
"guid": "O6Q9S9S84HZN6P8GJBI8"
},
{
"change": {
"guid": "UCWFYFYEAN69SATEIHDS",
"number": "ECO-000044"
},
"guid": "N5P8R8R73GYM5O7FIAHU"
},
{
"change": {

460 Arena REST API Developer Guide

 "guid": "CUEXGXGWS5ORASBW0ZVR",
"number": "ECO-000041"
},
"guid": "P7RATAT95I0O7Q9HKCJT"
}
]
}
Request with invalid GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

GET All Changes Associated with a

Request
/requests/<GUID>/changes
Returns all the changes associated with a specific request. Users must have a Read
Request Summary and Edit Request Changes rule. Additionally users must have a
Read Change Summary rule for the referenced changes.

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

Endpoints 461
Name Value Description
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all changes associated with a request.
GET /requests/<GUID>/changes
{
"count": 4,
"results": [
{
"change": {
"guid": "YG0J2J2IERADWEXIMLIS",
"number": "ECO-000033"
},
"guid": "FXH0J0JZV8QEXGZ7AQVD"
},
{
"change": {
"guid": "DVFYHYHXT6PSBTCX10WY",
"number": "DEV-000003"
},
"guid": "O6Q9S9S84HZN6P8GJBI8"
},
{
"change": {
"guid": "UCWFYFYEAN69SATEIHDS",
"number": "ECO-000044"
},
"guid": "N5P8R8R73GYM5O7FIAHU"
},
{
"change": {
"guid": "CUEXGXGWS5ORASBW0ZVR",
"number": "ECO-000041"
},
"guid": "P7RATAT95I0O7Q9HKCJT"
}
]
}
Request with invalid GUID
{
"status":400,
"errors":[

462 Arena REST API Developer Guide

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

GET Request Status Change Attributes

settings/requests/statuschangeattributes
This endpoint returns attributes used when modifying the status of a Request.
These attributes can be utilized in the POST requests/statuschanges endpoints.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the Requests Status Change Attributes.
GET settings/requests/statuschangeattributes

Endpoints 463
{
"count": 7,
"results": [
{
"allowsExplicitNullValue": false,
"apiName": "resolutionNotes",
"creatable": true,
"custom": false,
"editable": false,
"fieldType": "SINGLE_LINE_TEXT",
"searchable": false
},
{
"allowsExplicitNullValue": false,
"apiName": "deferralCode",
"creatable": true,
"custom": false,
"editable": false,
"fieldType": "FIXED_DROP_DOWN",
"multiSelect": false,
"possibleValues": [
"Next Version",
"Future Project",
"Low Priority",
"Resources Unavailable"
],
"searchable": false
},
{
"allowsExplicitNullValue": false,
"apiName": "status",
"creatable": true,
"custom": false,
"editable": false,
"fieldType": "FIXED_DROP_DOWN",
"possibleValues": [
"UNSUBMITTED",
"SUBMITTED",
"PROMOTED",
"CLOSED",
"DEFERRED"
],
"searchable": false
},
{
"allowsExplicitNullValue": false,
"apiName": "resolutionCode",
"creatable": true,
"custom": false,
"defaultValue": "Approved [Immediate]",
"editable": false,

464 Arena REST API Developer Guide

 "fieldType": "FIXED_DROP_DOWN",
"multiSelect": false,
"possibleValues": [
"Approved [Immediate]",
"Approved [Future]",
"Rejected",
"As Designed",
"Duplicate"
],
"searchable": false
},
{
"allowsExplicitNullValue": false,
"apiName": "deferDeadlineDateTime",
"creatable": true,
"custom": false,
"editable": false,
"fieldType": "DATETIME",
"searchable": false
},
{
"allowsExplicitNullValue": false,
"apiName": "request",
"creatable": true,
"custom": false,
"editable": false,
"fieldType": "OBJECT",
"searchable": false
},
{
"allowsExplicitNullValue": false,
"apiName": "comment",
"creatable": true,
"custom": false,
"editable": false,
"fieldType": "SINGLE_LINE_TEXT",
"searchable": false
}
]
}

POST Requests Status Change

(Unsubmitted to Submitted)
/requests/statuschanges
This example of this endpoint demonstrates how to change the status of a Request
from Unsubmitted to Submitted. This endpoint example is equivalent to
submitting a Request within the browser-based application.

Endpoints 465
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Upgrade the status of a Request from UNSUBMITTED to SUBMITTED.
POST /requests/statuschanges
Request
{
"request": {
"guid": "K2M5O1MD03ML4NJ32ZN1"
},
"comment":"Let's move this Request from Unsubmitted to
Submitted",
"status": "SUBMITTED"
}
Response
{
"comment": "Let's move this Request from Unsubmitted to
Submitted",
"request": {

466 Arena REST API Developer Guide

 "guid": "K2M5O1MD03ML4NJ32ZN1",
"number": "ECR-000009"
},
"status": "SUBMITTED"
}

POST Requests Status Change

(Submitted to Promoted)
/requests/statuschanges
This example of this endpoint demonstrates how to change the status of a Request
from Submitted to Promoted. This endpoint example is equivalent to promoting a
submitted Request within the browser-based application.
Note that Requests created by supplier users contain an additional property,
labeled resolutionNotes, within their responses when promoted.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 467
Sample Requests and Responses
Upgrade the status of a Request from SUBMITTED to PROMOTED.
POST /requests/statuschanges
Request
{
"request": {
"guid": "K2M5O1MD03ML4NJ32ZN1"
},
"comment": "From Submitted to Promoted",
"status": "PROMOTED",
"resolutionCode": "Approved [Immediate]"
}
Response
{
"comment": "From Submitted to Promoted",
"request": {
"guid": "K2M5O1MD03ML4NJ32ZN1",
"number": "ECR-000009"
},
"resolutionCode": "Approved [Immediate]",
"status": "PROMOTED"
}
Upgrade the status of a Request created by a Supplier user (with access to
Requests) from SUBMITTED to PROMOTED. When a Request created by a
Supplier user is promoted, it contains an additional attribute, labeled Resolution
Notes, in the response.
POST /requests/statuschanges
Request
{
"request": {
"guid": "VDXGURVX8P7BUD7GLYB8"
},
"comment": "Request from our manufacturer. Moving from
Submitted to Promoted",
"status": "PROMOTED",
"resolutionCode": "Approved [Immediate]",
"resolutionNotes": "Please notifify Digi-Key we're promiting
their ECR-000045"
}
Response
{
"comment": "From Submitted to Promoted",
"request": {
"guid": "VDXGURVX8P7BUD7GLYB8",
"number": "ECR-000045"
},

468 Arena REST API Developer Guide

 "resolutionCode": "Approved [Immediate]",
"status": "PROMOTED",
"resolutionNotes": "Please notifify Digi-Key we're promiting
their ECR-000045"
}

POST Requests Status Change

(Submitted to Deferred)
/requests/statuschanges
This example of this endpoint demonstrates how to change the status of a Request
from Submitted to Deferred. This endpoint example is equivalent to deferring a
submitted Request within the browser-based application.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Upgrade the status of a Request from SUBMITTED to DEFERRED.

Endpoints 469
POST /requests/statuschanges
Request
{
"request": {
"guid": "K2M5O1MD03ML4NJ32ZN1"
},
"comment": "Deferring to a future release.",
"status": "DEFERRED",
"deferralCode": "Next Version",
"deferDeadlineDateTime": "2023-03-17T09:00:00Z"
}
Response
{
"comment": "Deferring to a future release.",
"deferDeadlineDateTime": "2023-03-17T07:00:00Z",
"deferralCode": "Next Version",
"request": {
"guid": "K2M5O1MD03ML4NJ32ZN1",
"number": "ECR-000009"
},
"status": "DEFERRED"
}

POST Requests Status Change

(Submitted to Unsubmitted)
/requests/statuschanges
This example of this endpoint demonstrates how to change the status of a Request
from Submitted to Unsubmitted. This endpoint example is equivalent to
withdrawing a submitted Request within the browser-based application.

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

470 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Upgrade the status of a Request from SUBMITTED to UNSUBMITTED.
POST /requests/statuschanges
Request
{
"request": {
"guid": "K2M5O1MD03ML4NJ32ZN1"
},
"comment": "From Submitted to Unsubmitted",
"status": "UNSUBMITTED"
}
Response
{
"comment": "From Submitted to Unsubmitted",
"request": {
"guid": "K2M5O1MD03ML4NJ32ZN1",
"number": "ECR-000009"
},
"status": "UNSUBMITTED"
}

POST Requests Status Change

(Submitted to Closed)
/requests/statuschanges
This example of this endpoint demonstrates how to change the status of a Request
from Submitted to Closed. This endpoint example is equivalent to closing a
submitted Request within the browser-based application.

Endpoints 471
Note that Requests created by supplier users contain an additional property,
labeled resolutionNotes, within their responses when closed.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Upgrade the status of a Request from SUBMITTED to CLOSED.
POST /requests/statuschanges
Request
{
"request": {
"guid": "L3N6P2NE14NM5OK430OS"
},
"comment": "From Submitted to Closed",
"status": "CLOSED",
"resolutionCode": "As Designed"
}
Response
{

472 Arena REST API Developer Guide

 "comment": "From Submitted to Closed",
"request": {
"guid": "L3N6P2NE14NM5OK430OS",
"number": "ECR-000010"
},
"resolutionCode": "As Designed",
"status": "CLOSED"
}
Upgrade the status of a Request created by a Supplier user (with access to
Requests) from SUBMITTED to CLOSED. When a Request created by a Supplier
user is promoted, it contains an additional attribute, labeled Resolution Notes, in
the response.
POST /requests/statuschanges
Request
{
"request": {
"guid": "GYI1FCGITARL4N6PFGI0"
},
"comment": "Request from our manufacturer. Moving from
SUBMITTED to Closed",
"status": "CLOSED",
"resolutionCode": "As Designed",
"resolutionNotes": "Please notifify Digi-Key we're closing
their ECR-000045"
}
Response
{
"comment": "From Submitted to Promoted",
"request": {
"guid": "GYI1FCGITARL4N6PFGI0",
"number": "ECR-000045"
},
"resolutionCode": "As Designed",
"status": "CLOSED",
"resolutionNotes": "Please notifify Digi-Key we're closing
their ECR-000045"
}

POST Requests Status Change

(Promoted to Closed)
/requests/statuschanges
This example of this endpoint demonstrates how to change the status of a Request
from Promoted to Closed. This endpoint example is equivalent to promoting a
submitted Request within the browser-based application.

Endpoints 473
Note that Requests created by supplier users contain an additional property,
labeled resolutionNotes, within their responses when closed.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Upgrade the status of a Request from PROMOTED to CLOSED.
POST /requests/statuschanges
Request
{
"request": {
"guid": "K2M5O1MD03ML4NJ32ZN1"
},
"comment": "From Submitted to Promoted",
"status": "PROMOTED",
"resolutionCode": "Approved [Immediate]"
}
Response
{

474 Arena REST API Developer Guide

 "comment": "From Submitted to Promoted",
"request": {
"guid": "K2M5O1MD03ML4NJ32ZN1",
"number": "ECR-000009"
},
"resolutionCode": "Approved [Immediate]",
"status": "PROMOTED"
}
Upgrade the status of a Request created by a Supplier user (with access to
Requests) from PROMOTED to CLOSED. When a Request created by a Supplier
user is promoted, it contains an additional attribute, labeled Resolution Notes, in
the response.
POST /requests/statuschanges
Request
{
"request": {
"guid": "3L5O2Z35GXEXGZI11H6B"
},
"comment": "Request from our manufacturer. Moving from
Promoted to Closed",
"status": "CLOSED",
"resolutionCode": "Approved [Immediate]",
"resolutionNotes": "Please notifify Digi-Key we're closing
their ECR-000045"
}
Response
{
"comment": "From Submitted to Promoted",
"request": {
"guid": "3L5O2Z35GXEXGZI11H6B",
"number": "ECR-000045"
},
"resolutionCode": "Approved [Immediate]",
"status": "CLOSED",
"resolutionNotes": "Please notifify Digi-Key we're closing
their ECR-000045"
}

POST Requests Status Change (Closed to

Promoted)
/requests/statuschanges
This example of this endpoint demonstrates how to change the status of a Request
from Closed to Promoted. This endpoint example is equivalent to closed Request
within the browser-based application.

Endpoints 475
Note that Requests created by supplier users contain an additional property,
labeled resolutionNotes, within their responses when promoted.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Upgrade the status of a Request from CLOSED to PROMOTED.
POST /requests/statuschanges
Request
{
"request": {
"guid": "L3N6P2NE14NM5OK430OS"
},
"comment": "Reopening for further evaluation.",
"status": "PROMOTED",
"resolutionCode": "Approved [Future]"
}
Response
{

476 Arena REST API Developer Guide

 "comment": "Reopening for further evaluation.",
"request": {
"guid": "L3N6P2NE14NM5OK430OS",
"number": "ECR-000010"
},
"resolutionCode": "Approved [Future]",
"status": "PROMOTED"
}
Upgrade the status of a Request created by a Supplier user (with access to
Requests) from CLOSED to PROMOTED. When a Request created by a Supplier
user is promoted, it contains an additional attribute, labeled Resolution Notes, in
the response.
POST /requests/statuschanges
Request
{
"request": {
"guid": "DVFYC9DFQ7QYHV3DCJV6"
},
"comment": "Request from our manufacturer. Moving from
Submitted to Promoted",
"status": "PROMOTED",
"resolutionCode": "Approved [Immediate]",
"resolutionNotes": "Please notifify Digi-Key we're promoting
their request after reconsidering"
}
Response
{
"comment": "From Submitted to Promoted",
"request": {
"guid": "DVFYC9DFQ7QYHV3DCJV6",
"number": "ECR-000047"
},
"resolutionCode": "Approved [Immediate]",
"status": "PROMOTED",
"resolutionNotes": "Please notifify Digi-Key we're promoting
their request after reconsidering"
}

POST Requests Status Change (Deferred

to Submitted)
/requests/statuschanges
This example of this endpoint demonstrates how to change the status of a Request
from Deferred to Submitted. This endpoint example is equivalent to clickin the
Resubmit button on a deferred Request within the browser-based application.

Endpoints 477
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Upgrade the status of a Request from DEFERRED to SUBMITTED.
POST /requests/statuschanges
Request
{
"request": {
"guid": "M4O7Q3OF25ON6PL541PG"
},
"comment": "From Deferred to Submitted",
"status": "SUBMITTED"
}
Response
{
"comment": "From Deferred to Submitted",
"deferralCode": "Next Version",
"request": {
"guid": "K2M5O1MD03ML4NJ32ZN1",

478 Arena REST API Developer Guide

 "number": "ECR-000009"
},
"status": "SUBMITTED"
}

POST Requests Status Change (Deferred

to Unsubmitted)
/requests/statuschanges
This example of this endpoint demonstrates how to change the status of a Request
from Deferred to Unsubmitted. This endpoint example is equivalent to
withdrawing a deferred Request within the browser-based application.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Upgrade the status of a Request from DEFERRED to UNSUBMITTED.

Endpoints 479
POST /requests/statuschanges
Request
{
"request": {
"guid": "M4O7Q3OF25ON6PL541PG"
},
"comment": "From Deferred to Unsubmitted",
"status": "UNSUBMITTED"
}
Response
{
"comment": "From Deferred to Unsubmitted",
"deferralCode": "Next Version",
"request": {
"guid": "M4O7Q3OF25ON6PL541PG",
"number": "MCR-000004"
},
"status": "UNSUBMITTED"
}

GET Changes
/changes
Returns a collection of Change on page 1103 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

480 Arena REST API Developer Guide

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.

Endpoints 481
Searchable Attributes
Name Value Description
[additional attribute guid string This special search
value] permits searching for
strings in additional
attribute values. For
example GET /items?
VDXGZ7E0-
GO5N6P8PR55G=
*100pF where
VDXGZ7E0-
GO5N6P8PR55G 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 example,
the user is using the
following to search for a
date field type custom
attribute with a value of
April 1, 2019:

482 Arena REST API Developer Guide

Name Value Description
GET /changes?
9QU24KGN-
KOUGD1Z0RM3X=
2019-04-01
[Link] string category unique ID
[Link] 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.
[Link] 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.

Endpoints 483
Name Value Description
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.
For additional attribute field type MULTI_LINE_TEXT searches, different
values can be separated with an asterisk.
For additional attribute field types DROP_DOWN & FIXED_DROP_DOWN
searches, different values can be separated with a semi-colon.
When using a semi-colon to separate values in a FIXED_DROP_DOWN
search, note that the semi-colon will always act as an OR. This is relevant
when performing a Multi-Select search.
For example with FIXED_DROP_DOWN, multiselect = True: GET /Items?
J1L49Y281EVDWFUXRSCZ=Option 1;Option 2 will return all Items where
the FIXED_DROP_DOWN contains Option 1 OR Option 2 (or both). On the
other hand FIXED_DROP_DOWN, multiselect=False: GET /items?
J1L49Y281EVDWFUXRSCZ=Option 1;Option 2 will return all Items where
the FIXED_DROP_DOWN equals Option 1 OR Option 2.
Search in Zulu format is supported for custom attribute field type Date.
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
400 Failure

Response Header
Name Value Description
Content-Type application/json content type of response
Date date today's date and time

484 Arena REST API Developer Guide

Name Value Description
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all changes
GET /changes
{
"count":25,
"results":[
{
"category":{
"guid":"ASCVERC3QTCM5O3AABZF"
},
"creationDateTime":"2013-12-11T19:33:12Z",
"creator":{
"email":"hwalker@[Link]",
"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",
"url": {
"api": "[Link]
VDXGLBCCLSBSBQMM0SJU",
"app": "[Link]
}
},
{
"category":{
"guid":"4M6P8L6XKN6GZIX445T6"
},
"creationDateTime":"2018-03-07T00:53:59Z",
"creator":{
"email":"hwalker@[Link]",
"fullName":"Heidi Walker",

Endpoints 485
 "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",
"url": {
"api": "[Link]
657EAC4C55AB453AQW",
"app": "[Link]
},
},
{
"category":{
"guid":"7P9SBO90NQ9J2L0778WO"
},
"creationDateTime":"2015-02-18T21:56:44Z",
"creator":{
"email":"hwalker@[Link]",
"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",
"url": {
"api": "[Link]
B42041B334DD0310DS",
"app": "[Link]
},
},
{
"category":{
"guid":"ASCVERC3QTCM5O3AABZF"
},
"creationDateTime":"2012-01-11T19:14:23Z",

486 Arena REST API Developer Guide

 "creator":{
"email":"hwalker@[Link]",
"fullName":"Heidi Walker",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"effectiveDateTime":"2012-01-11T19:16:35Z",
"guid":"L3N6P2NE14NQ9SEDI1DJ",
"implementationStatus":"NOT_STARTED",
"lifecycleDateTime":"2012-01-11T19:16:35Z",
"lifecycleStatus":{
"type":"EFFECTIVE"
},
"number":"DCO-000002",
"submissionDateTime":"2012-01-11T19:14:46Z",
"title":"BOM correction - Docs only",
"url": {
"api": "[Link]
890B4D40D1B74E84CV",
"app": "[Link]
},
},
{
"category":{
"guid":"BTDWFSD4RUDN6P4BBC0T"
},
"creationDateTime":"2012-04-27T22:34:15Z",
"creator":{
"email":"hwalker@[Link]",
"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",
"url": {
"api": "[Link]
9B712FD146DE9444WW",
"app": "[Link]
},
},
{
"category":{
"guid":"7P9SBO90NQ9J2L0778WO"
},

Endpoints 487
 "creationDateTime":"2018-03-07T01:17:44Z",
"creator":{
"email":"hwalker@[Link]",
"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",
"url": {
"api": "[Link]
3E0C3E8E869A42CFXZ",
"app": "[Link]
},
},
{
"category":{
"guid":"BTDWFSD4RUDN6P4BBC0T"
},
"creationDateTime":"2012-01-11T00:49:46Z",
"creator":{
"email":"hwalker@[Link]",
"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",
"url": {
"api": "[Link]
884B4C71EF639C43LP",
"app": "[Link]
},
},
...
]

488 Arena REST API Developer Guide

}
Get effective changes in category ECO
GET <url>/changes?[Link]=
effective&[Link]=L3N6PX663K3DWFYF3F6C
{
"count":5,
"results":[
{
"category":{
"guid":"L3N6PX663K3DWFYF3F6C"
},
"creationDateTime":"2011-02-14T23:38:11Z",
"creator":{
"email":"rborger@[Link]",
"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",
"url": {
"api": "[Link]
39D31D3F0B464B83LD",
"app": "[Link]
},
},
{
"category":{
"guid":"L3N6PX663K3DWFYF3F6C"
},
"creationDateTime":"2011-02-15T01:33:35Z",
"creator":{
"email":"tmakamuri@[Link]",
"fullName":"Toshiro Makamuri",
"guid":"CUEXGOXXUBSBUDWFYURL"
},
"effectiveDateTime":"2011-02-15T21:22:57Z",
"guid":"L3N6PX663K36P7QBSH62",
"implementationStatus":"IN_PROGRESS",
"lifecycleDateTime":"2011-02-15T21:22:57Z",
"lifecycleStatus":{

Endpoints 489
 "type":"EFFECTIVE"
},
"number":"ECO-000005",
"submissionDateTime":"2011-02-15T19:30:12Z",
"title":"Production Release of Everyroad GPS Custom
Mechanical Parts",
"url": {
"api": "[Link]
39D31D3F0B464B83LD",
"app": "[Link]
},
},
...
]
}

GET Change
/changes/<GUID>
Returns a Change on page 1103 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

490 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"
},
{
"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":"hwalker@[Link]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},

Endpoints 491
 "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": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
],
"routings":[
{
"guid":"J1L4NV441IZ2L4N6P3EZ",
"name":"Approval Routing"
}
],
"submissionDateTime":"2014-07-16T23:43:54Z",
"submitter":{
"email":"hwalker@[Link]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"title":"Replace at-risk components in EveryRoad PCBA",
"url": {
"api": "[Link]
96CF9D9AD470728CRW",
"app": "[Link]
},
"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",

492 Arena REST API Developer Guide

 "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":"hwalker@[Link]",
"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",
"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": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
],

Endpoints 493
 "routings":[
{
"guid":"I0K3MZKBY1IL4N6P5RSG",
"name":"Component Librarian"
},
{
"guid":"2K4N6J4VIL25O7Q9PBCD",
"name":"CTO Review"
}
],
"submissionDateTime":"2014-07-16T23:43:54Z",
"submitter":{
"email":"hwalker@[Link]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"title":"New Fabrication for Everyroad Rear Panel,
"url": {
"api": "[Link]
7B7A029742744C2FDF",
"app": "[Link]
},
}
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
}
],
"approvalDeadlineDateTime":"2018-06-01T06:59:59Z",
"category":{
"guid":"O6Q9S0996N6GZI1I6I94",
"name":"Deviation",
"path":"Change\\Deviation"
},
"creationDateTime":"2018-05-23T23:08:20Z",

494 Arena REST API Developer Guide

 "creator":{
"email":"hwalker@[Link]",
"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": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
],
"routings":[
{
"guid":"J1L4NV441IZ2L4N6P3EZ",
"name":"Approval Routing"
}
],
"submissionDateTime":"2018-05-23T23:09:44Z",
"submitter":{
"email":"hwalker@[Link]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"title":"Use Existing Stock for EveryRoad Bezel",
"url": {
"api": "[Link]
8ADD63B4E2BDCA59RT",
"app": "[Link]
},
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,

Endpoints 495
 "message":"The guid \"ASCVERC3QTCFYGPWW1WCS\" is not
valid"
}
]
}

GET Change Affected Items

/changes/<GUID>/items
Returns all Change Affected Items on page 1106 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all items included in a change
GET /changes/<GUID>/items
{
"count":4,

496 Arena REST API Developer Guide

 "results":[
{
"affectedItemRevision":{
"effectiveDateTime": "2011-07-26T06:54:20Z",
"guid":"Q8SBU2BB8P8P8MTGTWBE",
"name": "Yellow, Side Fastener",
"number":"072-0003",
"revisionNumber":"A",
"revisionStatus": "SUPERSEDED",
"url": {
"api": "[Link]
Q8SBU2BB8P8P8MTGTWBE",
"app": "[Link]
}
},
"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

Endpoints 497
 }
],
"filesView":{
"includedInThisChange":false,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":false,
"notes":null
},
"guid":"J1L4NV441I0TCVENB6LQ",
"materialEffectivityDateTime":null,
"newItemRevision":{
"effectiveDateTime": "2011-11-18T22:04:06Z",
"guid":"L3N6PX663K3K3HOBOO3A",
"name": "Yellow, Side Fastener",
"number":"072-0003",
"revisionNumber":"B",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
L3N6PX663K3K3HOBOO3A",
"app": "[Link]
}
},
"newLifecyclePhase":{
"guid":"ASCVEMVVS9RUDWFYHWC3",
"name":"In Production"
},
"newRevisionNumber": "B",
"retrainingRequired": true,
"retraining": "AFTER_EFFECTIVE",
"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",

498 Arena REST API Developer Guide

 "url": {
"api": "[Link]
6O8RAIRRO5O5O29W9CHJ",
"app": "[Link]
}
},
"bomView":{
"includedInThisChange":false,
"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",

Endpoints 499
 "materialEffectivityDateTime":null,
"newItemRevision":{
"effectiveDateTime": "2011-12-25T22:04:06Z",
"guid":"5N7Q9HQQN4N4N18V889C",
"name": "Blue, Side Fastener",
"number":"072-0005",
"revisionNumber":"B",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
5N7Q9HQQN4N4N18V889C",
"app": "[Link]
}
},
"newLifecyclePhase":{
"guid":"9RBUDLUUR8QTCVEXGVB9",
"name":"Abandoned"
},
"newRevisionNumber": "2",
"retrainingRequired": true,
"retraining": "AFTER_EFFECTIVE",
"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."
}
]
}

500 Arena REST API Developer Guide

GET Change Affected Item
/changes/<GUID>/items/<GUID>
Returns a Change Affected Item on page 1106 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.

Endpoints 501
 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.
d. After the Deviation, the temporary Change expires, the
502 Arena REST API Developer Guide
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": "[Link]
6O8RAIRRO5O5O29W9CHJ",
"app": "[Link]
}
},
"bomView":{
"includedInThisChange":false,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":false,

Endpoints 503
 "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": {

504 Arena REST API Developer Guide

 "api": "[Link]
5N7Q9HQQN4N4N18V889C",
"app": "[Link]
}
},
"newLifecyclePhase":{
"guid":"9RBUDLUUR8QTCVEXGVB9",
"name":"Abandoned"
},
"newRevisionNumber": "A",
"retrainingRequired": true,
"retraining": "AFTER_APPROVED",
"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."
}
]
}

GET Change Quality Processes

GET /changes/<GUID>/quality
GET /changes/<GUID>/quality/<GUID>
Returns a collection of Quality Process on page 1135 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.

Endpoints 505
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
Get all quality processes that include a given change
GET /changes/0I2LQGHHQXGXGVRR5XND/quality
{
"count": 2,
"results": [
{
"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

506 Arena REST API Developer Guide

 }
},
{
"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,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

Endpoints 507
POST Change Create
/changes
Creates a new Change on page 1103 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 on page 29

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

508 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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

Endpoints 509
{
"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-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":"hwalker@[Link]",
"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"

510 Arena REST API Developer Guide

 }
],
"submissionDateTime":null,
"title":"EveryRoad Model 300 Case Melting",
"url": {
"api": "[Link]
96003C3DB703EDPIJK",
"app": "[Link]

}
}
Change with permanent-on-date effectivity
POST /changes
Request
{
"category":{
"guid":"7P9SBO90NQ9J2L0778WO"
},
"numberSequencePrefix":{
"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"
}
]
}

Endpoints 511
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"
},
"creationDateTime":"2018-02-21T21:43:30Z",
"creator":{
"email":"hwalker@[Link]",
"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",

512 Arena REST API Developer Guide

 "name": "CTO Review"
}
],
"submissionDateTime":null,
"title":"New Fabrication for Everyroad Rear Panel",
"url": {
"api": "[Link]
40089E611AA751DKPA",
"app": "[Link]

}
}
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"
}
],
"effectivityType":"TEMPORARY",
"expirationDateTime":"2018-10-15T07:59:59Z",
"additionalAttributes":[
{
"guid":"TBVEXAVM9CUH0J05D4RE",
"value":"< $5000"
},
{
"guid":"6O8RAN8ZMP7UDWDIQH5T",
"value":"High-Medium"
},
{
"guid":"9QU24KGNKOUGD1Z0RM3X",
"value":"2"
}
]
}

Endpoints 513
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":"hwalker@[Link]",
"fullName":"Heidi Walker",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"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":[
{

514 Arena REST API Developer Guide

 "guid":"I0K3MZKBY1IL4N6P5RSG",
"name":"Component Librarian"
}
],
"submissionDateTime":null,
"title":"Temporarily use gray enclosure while black enclosure
is unavailable.",
"url": {
"api": "[Link]
AF27027AB8B84AE59A",
"app": "[Link]

}
}
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,
"message":"The GUID 07SFVKE79SLLW285LF8S is invalid."
}
]

Endpoints 515
}

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; category; title; category; title;
description; description; description;
approvalDeadline; approvalDeadline; approvalDeadline;
effectivityType*; effectivityType*; enforceApprovalDead-
enforceApprovalDead- enforceApprovalDead- line; expirationDateTime;
line; line; implementationStatus;
implementationStatus; implementationStatus; Additional Attribute
Additional Attribute Additional Attribute values
values 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 on page 29

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

516 Arena REST API Developer Guide

Set Null
Name Value Description
setnull Append the URL with
setnull=true to set
implementationStatus,
approvalDeadlineDate-
Time, title, and
description to null.
Attributes must be
included within the
request body and set to
null. Insert setnull after
the query string,
represented by a ?, after
the GUID

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Edit a Change with permanent-on-approval effectivity
/changes/<GUID>
Request
{
"category":{

Endpoints 517
 "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":{
"email":"hwalker@[Link]",
"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",

518 Arena REST API Developer Guide

 "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",
"url": {
"api": "[Link]
A5AFCAA4D4804D7BBA",
"app": "[Link]
},
}
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
{
"additionalAttributes":[
{
"apiName":"custom2361807",
"fieldType":"FIXED_DROP_DOWN",

Endpoints 519
 "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": "hwalker@[Link]",
"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": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"title": "New Fabrication for Everyroad Rear Panel",
"url": {
"api": "[Link]
6E5732F4E3FA4733BF",

520 Arena REST API Developer Guide

 "app": "[Link]
},
"withdrawnDateTime": "2018-03-07T18:52:06Z"
}
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":"hwalker@[Link]",
"fullName":"Heidi Walker",
"guid":"WEYH0DYPCFWFYH0JSIPD"

Endpoints 521
 },
"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",
"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",
"url": {
"api": "[Link]
A71F7F3C92C360FD",
"app": "[Link]
},
}
Set a change attribute to null.
PUT /changes/<GUID>?setnull=true
Request
{
"implementationStatus": null
}
Response
{
"additionalAttributes":[
{
"apiName":"custom2361807",
"fieldType":"FIXED_DROP_DOWN",
"guid":"6O8RAN8ZMP7UDWDIQH5T",
"name":"Urgency",

522 Arena REST API Developer Guide

 "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":"hwalker@[Link]",
"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",
"enforceApprovalDeadline":false,
"expirationDateTime":"2018-03-28T07:00:00Z",
"guid":"3L5O7K5WJM58R9PPUQJC",
"implementationStatus":null,
"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",
"url": {
"api": "[Link]
1195453472824E318A",
"app": "[Link]
},

Endpoints 523
}

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,
"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."
}

524 Arena REST API Developer Guide

 ]
}
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"
}
]
}

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.

Endpoints 525
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

POST Change Affected Item Add

/changes/<GUID>/items
Adds an item to a change with a specific GUID.
NOTES:

526 Arena REST API Developer Guide

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":{
"guid":"TBVEXAVM9CVCVDN6IAA5"
},
"newRevisionNumber":"B",

Endpoints 527
 "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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": "[Link]
8QATCPA1ORARAS2LXQC0",
"app": "[Link]
}
},

528 Arena REST API Developer Guide

 "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",

Endpoints 529
 "revisionNumber":"B",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
TBVEXAVM9CVCVDN6IAA5",
"app": "[Link]
}
},
"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."
}
]
}

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.

530 Arena REST API Developer Guide

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"
}
]

Endpoints 531
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": "[Link]
YG0J2J2IERARATB537OW",
"app": "[Link]
}
},
"bomView":{
"includedInThisChange":true,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":true,
"notes":"modifications at lines 17 and 34"
},
"dispositionAttributes":[

532 Arena REST API Developer Guide

 {
"guid":"Q8SBUBUA6J0I1K3MH6FR",
"name":"On Order",
"notes":null,
"value":null
},
{
"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": "[Link]
3L5O7O7NJWFWFYGA8CTT",
"app": "[Link]
}
},
"newLifecyclePhase":{

Endpoints 533
 "guid":"O6Q9S07T9HZ2L4N6P38C",
"name":"In Production"
},
"newRevisionNumber":"C",
"sourcingView":{
"includedInThisChange":false
},
"specsView":{
"includedInThisChange":true,
"lockedByAnotherChange":false,
"modifiedOnWorkingRev":false,
"notes":"note new owner"
}
}
Request with bad GUID
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

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

534 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}
Request with invalid GUID (item not included in change)
{
"status":400,
"errors":[
{
"code":3012,
"message":"The requested object with guid
\"UCWFYFYEAN5YH0JSFPEP\" is not found."
}
]
}

POST Change Status (Lock/Unlock)

/changes/statuschanges
This endpoint can be used to change the status of a Change on page 1103 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.

Endpoints 535
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Locks a Change. The Change must have an initial status of OPEN_AND_
UNLOCKED.
POST /changes/statuschanges
Request
{
"change": {
"guid": "Q8SBU7SJ69SVEWCEKLBO"
},
"comment": "Locking change.",
"status": "OPEN_AND_LOCKED"
}
Response
{

536 Arena REST API Developer Guide

 "change": {
"guid": "Q8SBU7SJ69SVEWCEKLBO",
"number": "ECO-000020"
},
"comment": "Locking change.",
"status": "OPEN_AND_LOCKED",
"url": {
"api": "[Link]
6B52B6D575A269HDKE",
"app": "[Link]

}
}
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",
"url": {
"api": "[Link]
62E11329239730KJNM",
"app": "[Link]

}
}

POST Change Status (Submitting and

Admin-Defined)
/changes/statuschanges

Endpoints 537
This endpoint can be used to change the status of a Change on page 1103 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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.

538 Arena REST API Developer Guide

POST /changes/statuschanges
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": "hwalker@[Link]"
"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",
"url": {
"api": "[Link]
A3FE5DD85583420B83",
"app": "[Link]

}
}
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": [

Endpoints 539
 {
"email": "tmakamuri@[Link]"
"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"
}
Response
{
"administrators": [
{
"email": "tmakamuri@[Link]"
"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",
"url": {
"api": "[Link]
FF1DF627041A4CDLPD",
"app": "[Link]

}
}
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": {

540 Arena REST API Developer Guide

 "guid": "P7RAT6RI58RUDVBBE2ZP"
},
"comment": "Submitting Change for Approval. The user
performing this call is the Change Administrator",
"status": "SUBMITTED"
}
Response
{
"administrators": [
{
"email": "tmakamuri@[Link]"
"number": "Toshiro Makamuri"
"guid": "J1L4N0LCZ2J2L4N6F6ZL",
},
],
"change": {
"guid": "P7RAT6RI58RUDVBBE2ZP",
"number": "ECO-000027"
},
"comment": "Submitting Change for Approval. The user
performing this call is the Change Administrator",
"status": "SUBMITTED_FOR_APPROVAL",
"url": {
"api": "[Link]
23A808129C5E4A009F",
"app": "[Link]

}
}
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"

Endpoints 541
}
Response
{
"status": 400,
"errors": [
{
"code": 3145,
"message": "This specific change lifecycle transition
does not support the inclusion of a change administrator."
}
]
}

POST Change Status (Submitting and

Auto-Routing)
/changes/statuschanges
This endpoint can be used to change the status of a Change on page 1103 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

542 Arena REST API Developer Guide

Name Value Description
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"
},
"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",
"url": {
"api": "[Link]
9E97F4657967ECPDMS",
"app": "[Link]

}
}
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": {

Endpoints 543
 "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",
"url": {
"api": "[Link]
BC715466F5504BF1BD",
"app": "[Link]

}
}
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": {
{
"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."
}

544 Arena REST API Developer Guide

 ]
}

POST Change Status (Submitting and

User-Defined)
/changes/statuschanges
This endpoint can be used to change the status of a Change on page 1103 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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.

Endpoints 545
POST /changes/statuschanges
Request
{
"change": {
"guid": "R9TCV8TK7ATWFXDDG41X"
},
"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",
"url": {
"api": "[Link]
2CCFA0FDBA554619B8",
"app": "[Link]

}
}
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."

546 Arena REST API Developer Guide

 },
{
"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."
}
]
}

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.

Endpoints 547
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the Change Alerts of a Change.
GET /changes/<GUID>/alerts
{
"count": 54,
"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

548 Arena REST API Developer Guide

 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.

POST Change Status (Complete)

/changes/statuschanges
This endpoint can be used to change the status of a Change on page 1103 object.
This version of the POST Change Status endpoint demonstates how to complete a
Change without updating the implementation status. Only Change Administators
can perform this version of the endpoint.
For changes that have reached a status of EFFECTIVE, a Change administrator
can complete the Change by inputting a status of COMPLETED.
In addition to effective changes with permanent effectivity, this endpoint can be
used on expired changes with temporary effectivity which are also known as
deviations.

Endpoints 549
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

For Change administrators, inputting a status of COMPLETED in an effective
Change updates the Change status to COMPLETED.
POST /changes/statuschanges
Request
{
"change": {
"guid": "O6Q9S5QH47QTCUAADB0E"
},
"comment": "Completing this effective Change without inputting
an implementation status.",
"status": "COMPLETED"
}
Response
{
"change": {
"guid": "O6Q9S5QH47QTCUAADB0E",

550 Arena REST API Developer Guide

 "number": "ECO-000022"
},
"comment": "Completing this effective Change without inputting
an implementation status.",
"status": "COMPLETED",
"url": {
"api": "[Link]
6EE9DB6EBD3F488F99",
"app": "[Link]

}
}

POST Change Status (Complete With

Implementation Status)
/changes/statuschanges
This endpoint can be used to change the status of a Change on page 1103 object.
This version of the POST Change Status endpoint demonstates how to complete a
Change while updating its implementation status. Only Change Administators can
perform this version of the endpoint.
For changes that have reached a status of EFFECTIVE, a Change administrator
can complete the Change while updating the implementation status by inputting a
status of COMPLETED and inputting a valid value for implementationStatus.
Supported values for implementationStatus can be found by executing the GET
Change Implementation Statuses endpoint.
In addition to effective changes with permanent effectivity, this endpoint can be
used on expired changes with temporary effectivity which are also known as
deviations.

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

Endpoints 551
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

For Change administrators, inputting a status of COMPLETED and an
implementationStatus in an effective Change updates the implementation status to
the specified value and updates the Change status to COMPLETED.
POST /changes/statuschanges
Request
{
"change": {
"guid": "O6Q9S5QH47QTCUAADB0E"
},
"comment": "Change completed and impelentation is done.",
"implementationStatus": {
"value": "DONE"
},
"status": "COMPLETED"
}
Response
{
"change": {
"guid": "O6Q9S5QH47QTCUAADB0E",
"number": "ECO-000022"
},
"comment": "Change completed and impelentation is done.",
"implementationStatus": {
"value": "DONE"
},
"status": "COMPLETED",
"url": {
"api": "[Link]
52517F9A48748AVBDC",
"app": "[Link]

552 Arena REST API Developer Guide

 }
}

POST Change Status (Force Expire

Deviations)
/changes/statuschanges
This endpoint can be used to change the status of a Change on page 1103 object.
This version of the POST Change Status endpoint demonstates how to force the
expiration of a Change with temporary effectivity (also known as a Deviation).
Only Change Administators can perform this version of the endpoint.
For changes with temporary effectivity that have reached a status of EFFECTIVE,
a Change administrator can remove the temporary effectivity of the change before
its scheduled expiration date by inputting a value of EXPIRED for the attribute
status within the request body of the POST Change Status endpoint.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 553
Sample Requests and Responses
For Change administrators, inputting a status of EXPIRED in an effective Change
with temporary effectivity forces the deviation to expire before its scheduled date.
POST /changes/statuschanges
Request
{
"change": {
"guid": "SAUDW9UL8BUXGYEEHF43"
},
"comment": "Per management, we're forcing the expiration of
DEV-000026.",
"status": "EXPIRED"
}
Response
{
"administrators": [
{
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
],
"change": {
"guid": "SAUDW9UL8BUXGYEEHF43",
"number": "ECO-000026"
},
"comment": "Per management, we're forcing the expiration of
DEV-000026.",
"status": "EXPIRED",
"url": {
"api": "[Link]
6FED7D50362782JFBC",
"app": "[Link]

}
}

POST Change Status (Unmarking as

Complete)
/changes/statuschanges
This endpoint can be used to change the status of a Change on page 1103 object.
This version of the POST Change Status endpoint demonstates how to unmark the
completion of a completed Change. Only Change Administators can perform this
version of the endpoint.

554 Arena REST API Developer Guide

For changes that have reached a status of COMPLETED, a Change administrator
can remove the COMPLETED status of the change by inputting a value of
EFFECTIVE for the attribute status within the request body of the POST Change
Status endpoint.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

For Change administrators, inputting a status of EFFECTIVE in a Change that has
a status of COMPLETED removes the COMPLETED status of the change.
POST /changes/statuschanges
Request
{
"change": {
"guid": "O6Q9S5QH47QTCUAADB0E"
},
"comment": "Implementation task 7 has not been completed
properly. Reopening change to address this..",
"implementationStatus": {

Endpoints 555
 "value": "NEEDS_ATTN"
},
"status": "EFFECTIVE"
}
Response
{
"change": {
"guid": "O6Q9S5QH47QTCUAADB0E",
"number": "ECO-000022"
},
"comment": "Implementation task 7 has not been completed
properly. Reopening change to address this..",
"implementationStatus": {
"value": "NEEDS_ATTN"
},
"status": "EFFECTIVE",
"url": {
"api": "[Link]
1A7731B47BCBDBKLJN",
"app": "[Link]

}
}

POST Change Status (Reopen)

/changes/statuschanges
This endpoint can be used to change the status of a Change on page 1103 object.
This version of the POST Change Status endpoint demonstates how to reopen a
rejected Change. Only Change Administators can perform this version of the
endpoint.
For changes that have reached a status of REJECTED, a Change administrator can
reopen the change by inputting a value of OPEN_AND_UNLOCKED for the
attribute status within the request body of the POST Change Status endpoint.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

556 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

For Change administrators, inputting a status of OPEN_AND_UNLOCKED in a
Change that has a status of REJECTED reopens the change.
POST /changes/statuschanges
Request
{
"change": {
"guid": "TBVEXAVM9CVYHZFFIG5K"
},
"comment": "In light of our new circumstances, we are re-
opening the rejected change.",
"status": "OPEN_AND_UNLOCKED"
}
Response
{
"change": {
"guid": "TBVEXAVM9CVYHZFFIG5K",
"number": "ECO-000027"
},
"comment": "In light of our new circumstances, we are re-
opening the rejected change.",
"status": "OPEN_AND_UNLOCKED",
"url": {
"api": "[Link]
16BD9134D5A24BDF9C",

Endpoints 557
 "app": "[Link]

}
}

POST Change Status (Cancel)

/changes/statuschanges
This endpoint can be used to change the status of a Change on page 1103 object.
This version of the POST Change Status endpoint demonstates how to cancel a
Change. Only Change Administators can perform this version of the endpoint.
For changes that have reached a status of OPEN_AND_UNLOCKED or
REJECTED, a Change administrator can cancel the change by inputting a value of
CANCELED for the attribute status within the request body of the POST Change
Status endpoint.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

558 Arena REST API Developer Guide

Sample Requests and Responses
For Change administrators, inputting a status of CANCELED in a Change that has
a status of OPEN_AND_UNLOCKED or REJECTED cancels the change.
POST /changes/statuschanges
Request
{
"change": {
"guid": "P7RAT6RI58RUDVBBEC1H"
},
"comment": "As discussed in the Monday triage meeting, we are
canceling this Change.",
"status": "CANCELED"
}
Response
{
"administrators": [
{
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
],
"change": {
"guid": "P7RAT6RI58RUDVBBEC1H",
"number": "ECO-000023"
},
"comment": "As discussed in the Monday triage meeting, we are
canceling this Change.",
"status": "CANCELED",
"url": {
"api": "[Link]
6B52B6D575A269HDKE",
"app": "[Link]

}
}

POST Change Status (Force Reject)

/changes/statuschanges
This endpoint can be used to change the status of a Change on page 1103 object.
This version of the POST Change Status endpoint demonstates how to force reject
a Change. Only Change Administators can perform this version of the endpoint.

Endpoints 559
For changes that have reached a status of SUBMITTED_FOR_APPROVAL, a
Change administrator can force reject the change by inputting a value of
REJECTED for the attribute status within the request body of the POST Change
Status endpoint.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

For Change administrators, inputting a status of REJECTED in a Change that has
a status of SUBMITTED_FOR_APPROVAL force rejects the change.
POST /changes/statuschanges
Request
{
"change": {
"guid": "P7RAT6RI58RUDVBBEC1H"
},
"comment": "Per the Executive Escalation meeting, we are
unilaterally rejecting the Change.",
"status": "REJECTED"

560 Arena REST API Developer Guide

}
Response
{
"administrators": [
{
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
],
"change": {
"guid": "P7RAT6RI58RUDVBBEC1H",
"number": "ECO-000023"
},
"comment": "Per the Executive Escalation meeting, we are
unilaterally rejecting the Change.",
"status": "REJECTED",
"url": {
"api": "[Link]
C11E57AC03C94831BD",
"app": "[Link]

}
}

POST Change Status (Force Approve)

/changes/statuschanges
This endpoint can be used to change the status of a Change on page 1103 object.
This version of the POST Change Status endpoint demonstates how to force
approve a Change. Only Change Administators can perform this version of this
endpoint.
For changes that have reached a status of SUBMITTED_FOR_APPROVAL, a
Change administrator can force approve the change by inputting a value of
APPROVED for the status attribute within the request body of the POST Change
Status endpoint.
In an API Force Approval, the request body inputs a value of APPROVED, yet
the response body returns a status of EFFECTIVE. This reflects a unique behavior
within Arena's Change lifecycle: Once a Change is approved, it automatically
becomes effective in an automated step.

Endpoints 561
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

For Change administrators, inputting a status of APPROVED in a Change that has
a status of SUBMITTED_FOR_APPROVAL force approves the change.
POST /changes/statuschanges
Request
{
"change": {
"guid": "O6Q9S5QH47QTCUAADB0E"
},
"comment": "ECO-000022 is Submitted for Approval. Force
Approving by Executive authority.",
"status": "APPROVED"
}
Response
{
"administrators": [
{

562 Arena REST API Developer Guide

 "email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
],
"change": {
"guid": "O6Q9S5QH47QTCUAADB0E",
"number": "ECO-000022"
},
"comment": "ECO-000022 is Submitted for Approval. Force
Approving by Executive authority.",
"status": "EFFECTIVE",
"url": {
"api": "[Link]
DD1402A0F92949BB9B",
"app": "[Link]

}
}

POST Change Status (Withdraw)

/changes/statuschanges
This endpoint can be used to change the status of a Change on page 1103 object.
Changes that have a status of SUBMITTED_FOR_ROUTING or SUBMITTED_
FOR_APPROVAL can be withrawn by inputting a value of OPEN_AND_
UNLOCKED for 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

Endpoints 563
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Inputting a status of OPEN_AND_UNLOCKED to withdraw a submitted Change.
POST /changes/statuschanges
Request
{
"change": {
"guid": "Q8SBU7SJ69SVEWCCFD2V"
},
"comment": "ECO-000024 does not have the required criteria for
submission. Withdrawing. Please resubmit once errors are
corrected.",
"status": "OPEN_AND_UNLOCKED"
}
Response
{
"change": {
"guid": "Q8SBU7SJ69SVEWCCFD2V",
"number": "ECO-000024"
},
"comment": "ECO-000024 does not have the required criteria for
submission. Withdrawing. Please resubmit once errors are
corrected.",
"status": "OPEN_AND_UNLOCKED",
"url": {
"api": "[Link]
AE496C8A7C0E2CSJNB",
"app": "[Link]

}
}

564 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Change File Associations
GET <url>/changes/<GUID>/files
{
"count": 3,
"results": [
{
"file": {
"author": {
"fullName": "George C Lewis"
},
"category": {
"guid": "CUEXGTE5SVEO7Q5CCD07"

Endpoints 565
 },
"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": "[Link]",
"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": "[Link]",
"number": "FILE-000864",
"private": false,
"size": 4480,
"storageMethod": 0,
"storageMethodName": "FILE",

566 Arena REST API Developer Guide

 "title": "USB to Car Power Adapter image"
},
"guid": "HZJ2LYJAX0HO7QM65MEH"
},
{
"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 [Link]",
"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."
}
]
}

Endpoints 567
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Change Files View Association
GET <url>/changes/<GUID>/files/<GUID>
{
"file": {
"author": {
"fullName": "George C Lewis"
},
"category": {
"guid": "3L5O7K5WJM5FYHW334R7"
},

568 Arena REST API Developer Guide

 "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 [Link]",
"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."
}
]
}

POST Change Files View Add Existing

File
/changes/<GUID>/files
Associates an existing File Association on page 1118 object with the Files view of
a Change with a given GUID.

Endpoints 569
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
Associate an existing file with a Change
/changes/<GUID>/files
{
"file": {
"author": {
"fullName": "Bret D Lobree"
},
"category": {
"guid": "3L5O7K5WJM5FYHW334R7"

570 Arena REST API Developer Guide

 },
"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": "[Link]",
"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."
}
]
}

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

Endpoints 571
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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\"."
}
]
}

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.

572 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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,
"creationDateTime": "2011-06-02T19:30:28Z",
"description": null,
"edition": "1",
"format": "pdf",

Endpoints 573
 "guid": "9RBUDQB2PSBRATWN9FV3",
"hasMarkup": false,
"lastModifiedDateTime": "2011-06-02T19:30:28Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/pdf",
"name": "[Link]",
"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 - [Link]",
"number": "FILE-000911",
"private": false,
"size": 251396,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "NEC - TouchLCD-NL4864HL11-01B"
},
"guid": "EWGZIVG7UXBZI1DXDRO2"
},
{
"file": {

574 Arena REST API Developer Guide

 "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": "[Link]
[Link]",
"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,

Endpoints 575
 "locked": true,
"mimeType": "application/pdf",
"name": "NRC06J474TR_NICCS01262-[Link]",
"number": "FILE-000873",
"private": false,
"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."
}
]
}

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

576 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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,
"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 - [Link]",
"number": "FILE-000911",
"private": false,
"size": 251396,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "NEC - TouchLCD-NL4864HL11-01B"
},

Endpoints 577
 "guid": "EWGZIVG7UXBZI1DXDRO2"
}

Request with bad GUID

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

POST Change Implementation Files View

Add Existing File
/changes/<GUID>/implementationfiles
Associates an existing File Association on page 1118 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"
}
}

578 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
Associate an existing file with the Implementation Files view of a specific
Change.
/changes/<GUID>/implementationfiles
{
"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": "[Link]",
"number": "FILE-000861",
"private": false,
"size": 120052,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "ZIP-PWR-AC"
},

Endpoints 579
 "guid": "I0K3MZKBY1F3M5H1HVS5"
}
An error is returned if the GUID is not valid.
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

580 Arena REST API Developer Guide

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\"."
}
]
}

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

Endpoints 581
Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": {
"guid": "0I2L4H2TGJ2CVET001OY"
},
"creationDateTime": "2021-01-22T19:51:01Z",
"format": "333",
"guid": "Q8SBU7SJ69S8RA07P9F9",
"lastModifiedDateTime": "2021-01-22T19:59:08Z",
"locked": false,
"mimeType": "application/pdf",
"name": "[Link]",
"size": 260178,
"storageMethodName": "FILE",
"title": "1004"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},
"reserved": true,
"reservedUser": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
},
{
"guid": "4M6P8L6XKN1O7QM65LS5",
"markup": {
"author": {

582 Arena REST API Developer Guide

 "fullName": "Jamie Smith"
},
"category": {
"guid": "2K4N6J4VIL4EXGV223PR"
},
"creationDateTime": "2021-01-22T03:31:04Z",
"format": "Web",
"guid": "FXH0JWH8VYHXGZPWEY43",
"lastModifiedDateTime": "2021-01-22T03:31:04Z",
"location": "[Link]/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."
}
]
}

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

Endpoints 583
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",
"format": "Web",
"guid": "FXH0JWH8VYHXGZPWEY43",
"lastModifiedDateTime": "2021-01-22T03:31:04Z",
"location": "[Link]/Spring2021",
"locked": false,
"size": 0,
"storageMethodName": "WEB",
"title": "ftp001"
},
"markupOf": {
"edition": "1",
"guid": "UCWFYBWNADWCVEGZ24RC",
"number": "FILE-000944"
},

584 Arena REST API Developer Guide

 "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."
}
]
}

POST Change File Markup Create

/changes/<GUID>/markupfiles
Creates a Change File Markup File on page 1115 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

Endpoints 585
Name Value Description
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
• When associating a File Markup to a Change:
{
"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": "[Link]",
"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,

586 Arena REST API Developer Guide

 "message":"The attribute \"edition\" is required."
}
]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

No JSON response.
Request with bad GUID
{

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

GET All Requests Associated with a

Change
/changes/<GUID>/requests
Returns all the requests associated with a specific change. Users must have a Read
Change Summary and Edit Change Requests rule for the Change. Additionally
users must have a Read Request Summary rule for the request being added.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

588 Arena REST API Developer Guide

Sample Response Body
Get all requests associated with a change
GET /changes/<GUID>/requests
{
"count": 3,
"results": [
{
"guid": "J1L4N4N3ZCUI1K3BE6EB",
"request": {
"guid": "N5P8R8R73GZYH0J024AP",
"number": "ECR-000001"
}
},
{
"guid": "K2M5O5O40DVJ2L4CF7F5",
"request": {
"guid": "Q8SBUBUA6J21K3M357DB",
"number": "FFR-000001"
}
},
{
"guid": "L3N6P6P51EWK3M5DG8G4",
"request": {
"guid": "R9TCVCVB7K32L4N468E1",
"number": "ECR-000002"
}
}
]
}
Request with invalid GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

GET A Specific Request Associated with

a Change
/changes/<GUID>/requests/<GUID>

Endpoints 589
Returns a specific request associated with a specific change. Users must have a
Read Change Summary and Edit Change Requests rule for the Change.
Additionally, users must have a Read Request Summary rule for the request being
added.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific request associated with a change
GET /changes/<GUID>/requests/<GUID>
{
"guid": "J1L4N4N3ZCUI1K3BE6EB",
"request": {
"guid": "N5P8R8R73GZYH0J024AP",
"number": "ECR-000001"
}
}
Request with invalid GUID
{
"status":400,
"errors":[
{

590 Arena REST API Developer Guide

 "code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

POST Add a Request to a Change

/changes/<GUID>/requests
Adds a Request to a Change. Users must have a Read Change Summary and Edit
Change Requests rule for the Change. Additionally users must have a Read
Request Summary rule for the request being added.
The Change must have a lifecycle status of OPEN_AND_UNLOCKED. The
Request being added must have a lifecycle status of PROMOTED.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Sample Request Body

Add a Request with a GUID of N5P8R8R73GZYH0J024AP to a Change with a
GUID specified in the URL.
{
"request": {
"guid": "N5P8R8R73GZYH0J024AP"
}
}

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

Endpoints 591
Name Value Description
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

A request is added to a change. A new change-request associatiion GUID is
created.
{
"guid": "J1L4N4N3ZCUI1K3BE6EB",
"request": {
"guid": "N5P8R8R73GZYH0J024AP",
"number": "ECR-000001"
}
}

DELETE Remove a Request from a

Change
changes/<GUID>/requests/<GUID>
Removes an request with a given GUID from 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

592 Arena REST API Developer Guide

Name Value Description
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

GET Change Implementation Tasks

/changes/<GUID>/implementationtasks
Returns the implementation tasks for a specific change category. Note that
Implementation Task Management must be enabled for the category. If it is not
enabled, the endpoints shall return an error indicating it is not enabled.

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

Endpoints 593
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the implementation tasks of a specific change.
GET /changes/<GUID>/implementationtasks
{
"count": 5,
"results": [
{
"guid": "J1L4IFJLWDWZI0G8FQA8",
"name": "Check Supplier",
"assignee": {
"userGroup": {
"guid": "VDXGURVX8OUH0J2L4HEJ",
"name": "EveryHome Engineering USA"
}
},
"dueDate": "2022-03-07T08:00:00Z",
"status": "NOT_STARTED"
},
{
"guid": "J1L4IFJLWDWZI0G8FQA8",
"name": "Verify Final Tooling",
"assignee": { },
"supplier": {
"guid": "4M6P3046HXGM5OTJK65R",
"name": "Onward Technology Corp"
},
},
"dueDate": "2022-03-07T08:00:00Z",
"status": "NOT_STARTED"
},
...
]
}
Request with invalid GUID
{

594 Arena REST API Developer Guide

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

GET Change Implementation Task

/changes/<GUID>/implementationtasks/<GUID>
Returns an implementation task for a specific change category. Note that
Implementation Task Management must be enabled for the category. If it is not
enabled, the endpoints shall return an error indicating it is not enabled.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific implementation task.
GET /changes/<GUID>/implementationtasks/<GUID>

Endpoints 595
{
"guid": "J1L4IFJLWDWZI0G8FQA8",
"name": "Commit changes to archive",
"assignee": {
"userGroup": {
"guid": "VDXGURVX8OUH0J2L4HEJ",
"name": "EveryHome Engineering USA"
}
},
"dueDate": "2022-03-07T08:00:00Z",
"status": "DONE"
]
Request with invalid GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

POST Change Implementation Task

/changes/<GUID>/implementationtasks
Creates an implementation tasks for a specific change. Note that Implementation
Task Management and Object Level Override must be enabled for the category. If
it is not enabled, the endpoints shall return an error indicating it is not enabled.
Not supported for Canceled, Completed or Uncategorized changes.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Sample Request Body

Adds an implementation task to a change that supports implementation tasks.
{
"name": "Commit changes to archive",
"assignee": {
"userGroup": {
"guid": "VDXGURVX8OUH0J2L4HEJ",
"name": "EveryHome Engineering USA"

596 Arena REST API Developer Guide

 }
},
"dueDate": "2022-03-07T08:00:00Z",
"status": "NOT_STARTED"
]

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Adds a specific implementation tasks of a specific change.
POST /changes/<GUID>/implementationtasks
{
"guid": "J1L4IFJLWDWZI0G8FQA8",
"name": "Commit changes to archive",
"assignee": {
"userGroup": {
"guid": "VDXGURVX8OUH0J2L4HEJ",
"name": "EveryHome Engineering USA"
}
},
"dueDate": "2022-03-07T08:00:00Z",
"status": "NOT_STARTED"
]
Request with invalid GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."

Endpoints 597
 }
]
}

PUT Change Implementation Task

/changes/<GUID>/implementationtasks/<GUID>
Edits an implementation task for a specific change. Note that Implementation Task
Management and Object Level Override must be enabled for the category. If it is
not enabled, the endpoints shall return an error indicating it is not enabled. Not
supported for Canceled, Completed or Uncategorized changes. User must be a
change administrator, creator of the change, or the current task assginee to
perform this endpoint.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Sample Request Body

Edits an implementation task to a change that supports implementation tasks
{
"name": "Check Packaging",
"assignee": {
"userGroup": {
"guid": "VDXGURVX8OUH0J2L4HEJ",
},
},
"dueDate": "2022-03-07T08:00:00Z",
"status": "NOT_STARTED"
}

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

598 Arena REST API Developer Guide

Name Value Description
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Edits a specific implementation task of a specific change.
PUT /changes/<GUID>/implementationtasks/<GUID>
{
"name": "Check Packaging",
"assignee": {
"userGroup": {
"guid": "VDXGURVX8OUH0J2L4HEJ",
name": "EveryHome Engineering USA"
}
},
"dueDate": "2022-03-07T08:00:00Z",
"status": "DONE"
}
Request with invalid GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

DELETE Change Implementation Task

/changes/<GUID>/implementationtasks/<GUID>
Deletes a Change Implementation Task from a Change. Implementation Task
Management and Object Level Override should be enabled. Change status cannot
be canceled or completed. Endpoint can only be performed by the change
administrator or the change creator.

Endpoints 599
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

GET Change Implementation Task Notes

/changes/<GUID>/implementationtasks/<GUID/notes

600 Arena REST API Developer Guide

Returns the notes in a specific implementation task within a specific change. Only
supported in categories that have Implementation Task Management enabled.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the notes of a specific change implementation task.
GET /changes/<GUID>/implementationtasks/<GUID>/notes
{
"count": 20,
"results": [
{
"guid": "I0K3HEIKVCT8RATCV2DU",
"note" "This was done early to help schedule.",
"private": True,
"label": "Cost Impact"
},
{
"guid": "5N7Q4157IZGZI1K33VOE",
"note" "Done per the request of our Validation team.",
"private": True,
"label": "Quality Control"
},

Endpoints 601
 ...
]
}
Request with invalid GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

GET Change Implementation Task Note

/changes/<GUID>/implementationtasks/<GUID>/notes/<GUID>
Returns a specific note in a specific implementation task of a specific change.
Only supported in categories that have Implementation Task Management
enabled.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

602 Arena REST API Developer Guide

Sample Response Body
Get a specific implementation task note.
GET /changes/<GUID>/implementationtasks/<GUID>/notes/
<GUID>
{
"guid": "I0K3HEIKVCT8RATCV2DU",
"note" "This was done early to help schedule.",
"private": True,
"label": "Cost Impact"
}
Request with invalid GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

POST Change Implementation Task Note

/changes/<GUID>/implementationtasks/<GUID>/notes
Adds a note to a change implementation task. Implementation Task Management
must be enabled to execute this endpoint. Not supported for Canceled or
Completed Changes.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Sample Request Body

Adds a note to an implementation task.
{
"note" "This was done early to help schedule.",
"private": True,
"label": "Cost Impact"
}

Endpoints 603
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Adds a specific change implementation task note.
POST /changes/<GUID>/implementationtasks/<GUID>/notes
{
"guide": I0K3HEIKVCT8RATCV2DU,
"note" "This was done early to help schedule.",
"private": True,
"label": "Cost Impact"
}
Request with invalid GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

PUT Change Implementation Task Note

/changes/<GUID>/implementationtasks/<GUID>/notes
Edits an implementation task note for an implementation task. Implementation
Task Management must be enabled to execute this endpoint. Not supported for
Canceled or Completed Changes.

604 Arena REST API Developer Guide

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Sample Request Body

Edits an implementation task note.
{
"note" "This was done early to help schedule.",
"private": False,
"label": "Cost Impact"
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Edits a specific change implementation task note.
PUT /changes/<GUID>/implementationtasks/<GUID>/notes
{
"guide": I0K3HEIKVCT8RATCV2DU,
"note" "This was done early to help schedule.",
"private": False,
"label": "Cost Impact"
}
Request with invalid GUID
{
"status":400,

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

DELETE Change Implementation Task

Note
/changes/<GUID>/implementationtasks/<GUID>/notes
Deletes a specific note from a specific implementation task within a Change.
Implementation Task Management needs to be enabled for this change category.
Not supported for Canceled or Completed changes..

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

606 Arena REST API Developer Guide

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."
}
]
}

GET Change Implementation Task Files

/changes/<GUID>/implementationtasks/<GUID>/files
Retrieves the files associated with a change implementation task. Implementation
Task Management must be enabled within the specific change category.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 607
Sample Response Body
Get all files of an implementation task of a specific change.
GET /changes/<GUID>/implementationtasks/<GUID>/files
{
"count": 20,
"results": [
{
"guid": "I0K3HEIKVCT8RATCV2DU",
"file": {
"guid": "GYI1FCGITAT9SB0IJX9M",
"number": "FILE-046012",
"edition": "1",
"name": "implementation [Link]",
"storageMethodName": "FILE",
"title": "Implementation Plan"
},
{
"guid": "XFZI1EZQDGY9SBUCQ8JJ",
"file": {
"guid": "M4O7Q3OF25OK3M5OHUQ2",
"number": "FILE-046017",
"edition": "1",
"location": "[Link] # for WEB
"storageMethodName": "WEB",
"title": "Implementation Plan"
},
...
]
}
Request with invalid GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

GET Change Implementation Task File

/changes/<GUID>/implementationtasks/<GUID>/files/<GUID>
Retrieves a specific file associated with a change implementation task.
Implementation Task Management must be enabled within the specific change
category.

608 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all the files of an implementation task of a specific change.
GET /changes/<GUID>/implementationtasks/<GUID>/files
{
"guid": "I0K3HEIKVCT8RATCV2DU",
"file": {
"guid": "GYI1FCGITAT9SB0IJX9M",
"number": "FILE-046012",
"edition": "1",
"name": "implementation [Link]",
"storageMethodName": "FILE",
"title": "Implementation Plan"
}
Request with invalid GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."

Endpoints 609
 }
]
}

POST Change Implementation Task File

/changes/<GUID>/implementationtasks/<GUID>/files
Adds a specific, already existing in the workspace, File to a specific
implementation task. Implementation Task Management must be enabled to
execute this endpoint. Not supported for Canceled or Completed Changes.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Sample Request Body

Adds an existing file to an existing implementation task.
{
"file": {
"guid": "GYI1FCGITAT9SB0IJX9M"
}
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

610 Arena REST API Developer Guide

Sample Response Body
Adds a specific change implementation task file.
POST /changes/<GUID>/implementationtasks/<GUID>
{
"guid": "I0K3HEIKVCT8RATCV2DU",
"file": {
"guid": "GYI1FCGITAT9SB0IJX9M",
"number": "FILE-046012",
"edition": "1",
"name": "implementation [Link]",
"storageMethodName": "FILE",
"title": "Implementation Plan"
}
Request with invalid GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

DELETE Change Implementation Task

File
/changes/<GUID>/implementationtasks/<GUID>/files
Returns the implementation tasks for a specific change category. Note that
Implementation Task Management and Object Level Override must be enabled for
the category. If it is not enabled, the endpoints shall return an error indicating it is
not enabled. Not supported for Canceled, Completed or Uncategorized changes.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Endpoints 611
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

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.

612 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",
"number": "DEF-000002"
}
},
{
"guid": "HZJ2LYJAX0HBUDWETE84",
"ticket": {
"guid": "5N7Q9M7YLO5K3M5O7PAS",
"number": "REQ-000004"

Endpoints 613
 }
}
]
}
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."
}
]
}

GET Quality Processes Search

/qualityprocesses
Returns a collection of Quality Process on page 1135 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

614 Arena REST API Developer Guide

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.

Endpoints 615
Searchable Attributes
Name Value Description
[additional attribute guid string This special search
value] permits searching for
strings in additional
attribute values. For
example GET /items?
VDXGZ7E0-
GO5N6P8PR55G=
*100pF where
VDXGZ7E0-
GO5N6P8PR55G 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 example,
the user is using the
following to search for a
date field type custom
attribute with a value of
April 1, 2019:

616 Arena REST API Developer Guide

Name Value Description
GET /qualityprocesses?
GYI16WXX6DUDW-
FYHPRY3=2019-04-01
description string Quality process
description
number string quality process number
name string quality process name
[Link] string template unique identifier
type string quality process type
[Link] string owner full name (first and
last)
[Link] 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
[Link] string creator full name (first
and last)
[Link] string creator unique ID

Endpoints 617
 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.
Uncompleted Quality Processes can be queried by using the search attribute
status equal to !Completed. Example URL: .../qualityprocesses?status=!
COMPLETED
For additional attribute field type MULTI_LINE_TEXT searches, different
values can be separated with an asterisk.
For additional attribute field types DROP_DOWN & FIXED_DROP_DOWN
searches, different values can be separated with a semi-colon.
When using a semi-colon to separate values in a FIXED_DROP_DOWN
search, note that the semi-colon will always act as an OR. This is relevant
when performing a Multi-Select search.
For example with FIXED_DROP_DOWN, multiselect = True: GET /Items?
J1L49Y281EVDWFUXRSCZ=Option 1;Option 2 will return all Items where
the FIXED_DROP_DOWN contains Option 1 OR Option 2 (or both). On the
other hand FIXED_DROP_DOWN, multiselect=False: GET /items?
J1L49Y281EVDWFUXRSCZ=Option 1;Option 2 will return all Items where
the FIXED_DROP_DOWN equals Option 1 OR Option 2.
Search in Zulu format is supported for custom attribute field type Date.
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
400 Failure

Response Header
Name Value Description
Content-Length number number of characters in
response
Content-Type application/json content type of response

618 Arena REST API Developer Guide

Name Value Description
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"
},
...
]
}

Endpoints 619
Returns an error if a parameter is not a valid search attribute.
{
"status": 400,
"errors": [
{
"code": 3019,
"message": "The attribute \"a\" is not searchable."
}
]
}

GET Quality Process Summary

/qualityprocesses/<GUID>
Returns a Quality Process on page 1135 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

620 Arena REST API Developer Guide

Name Value Description
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a single quality process
/settings/qualityprocesses/<GUID>
{
"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,

Endpoints 621
 "message": "The guid \"CUB5FVEN6P8RAQI\" is not valid."
}
]
}

POST Quality Process Create

/qualityprocesses
Creates a new Quality Process on page 1135 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 on
page 958 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"
}

622 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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":{

Endpoints 623
 "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,
"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."
}
]
}

PUT Quality Process Update

/qualityprocesses/<GUID>
Updates the metadata of a Quality Process on page 1135 object with a given
GUID.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

624 Arena REST API Developer Guide

Set Null
Name Value Description
setnull Append the URL with
setnull=true to set
description,
targetCompletionDate, or
type to null. Attributes
must be included within
the request body and set
to null. Insert setnull after
the query string,
represented by a ?, after
the GUID.

Sample Request Body

PUT /qualityprocesses/<GUID>
{
"description":"Quality Process with updated name",
"name":"New Process Introduction",
"type":"Manufacturing"
}
PUT /qualityprocesses/<GUID>?setnull=true
{
"description":"Quality Process with updated name",
"name":"New Process Introduction",
"type":null
}

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

Endpoints 625
Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Update the details of a quality process
/qualityprocesses/<GUID>
{
"completedDateTime":null,
"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"
}
Set Quality Process Step attribute to null.
PUT /qualityprocesses/<GUID>?setnull=true
{
"completedDateTime":null,
"creationDateTime":"2016-04-26T16:48:47Z",
"creator":{
"fullName":"Roy S",
"guid":"7P9SXNOOX4L4N6P8BG6R"

626 Arena REST API Developer Guide

 },
"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."
}
]
}

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.

Endpoints 627
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

POST Quality Process Complete

/qualityprocesses/statuschanges
Completes a Quality Process on page 1135 object.

628 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Complete a quality process
/qualityprocesses/statuschanges

Endpoints 629
{
"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."
}
]
}

POST Quality Process Reopen

/qualityprocesses/statuschanges
Completes a Quality Process on page 1135 object.

630 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Reopen a quality process
/qualityprocesses/statuschanges

Endpoints 631
{
"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."
}
]
}

GET Quality Process Step Affected

Objects
/qualityprocesses/<GUID>/steps/<GUID>/affected
Returns a collection of Affected Objects on page 1139 for a step with a given
GUID in a Quality Process with a given GUID.

632 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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":"[Link]",
"type":"URL"
},
"guid":"5N7Q9HOAQYHDWFYH0YMJ",
"notes":"Flextronics home page"
},
{
"affected":{

Endpoints 633
 "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."
}
]
}

634 Arena REST API Developer Guide

GET Quality Process Step Affected Object
/qualityprocesses/<GUID>/steps/<GUID>/affected/<GUID>
Returns an Affected Object on page 1139 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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":"[Link]",
"type":"URL"
},
"guid":"5N7Q9HOAQYHDWFYH0YMJ",

Endpoints 635
 "notes":"Flex page"
}
Returns an error if the GUID is not valid
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

POST Quality Process Step Affected

Object Add
/qualityprocesses/<GUID>/steps/<GUID>/affected
Adds an Affected Object on page 1139 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"
}
}

636 Arena REST API Developer Guide

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
{
"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":"[Link]",
"display":"Flextronics home page",
"description":"Supplier info"
}
}

Endpoints 637
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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
{

638 Arena REST API Developer Guide

 "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": {
"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",

Endpoints 639
 "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",
"link":"[Link]",
"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."
}
]
}

PUT Quality Process Step Affected Object

Update
/qualityprocesses/<GUID>/steps/<GUID>/affected/<GUID>
Updates an existing Affected Object on page 1139 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

640 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Update an affected object in a quality process step
/qualityprocesses/<GUID>/steps/<step_GUID>/affected/
<GUID>
{
"affected":{
"description":"Supplier info",
"display":"Flextronics home page",
"link":"[Link]",
"type":"URL"
},
"guid":"7P9SBJQCS0JFYH0J20O3",
"notes":"look at this!"
}
Returns an error if a GUID is not valid
{
"status": 400,
"errors": [
{
"code": 3011,

Endpoints 641
 "message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Returns an error if the GUID is not valid
{
"status": 400,
"errors": [
{

642 Arena REST API Developer Guide

 "code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

GET Quality Process Steps

/qualityprocesses/<GUID>/steps
Returns a collection of Quality Process Step on page 1136 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get steps for a given quality process
/qualityprocesses/<GUID>/steps
{

Endpoints 643
 "count":6,
"results":[
{
"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":[
{
"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"

644 Arena REST API Developer Guide

 },
{
"fullName":"Caroline Goff ",
"guid":"5N7Q9M7YL0507Q9SY0E7"
},
{
"fullName":"Peter Yeh",
"guid":"0I2L4H2TGJ0J2L4NWMTA"
}
]

}
],
"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",

Endpoints 645
 "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"
},
{
"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

646 Arena REST API Developer Guide

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,
"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."
}
]
}

Endpoints 647
GET Quality Process Step
/qualityprocesses/<GUID>/steps/<GUID>
Returns a Quality Process Step on page 1136 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

Parameters
Name Value Description
includeEmptyAdditiona- true or false If this is true, the
lAttributes 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a single step for a given quality process

648 Arena REST API Developer Guide

/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":[
{
"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",

Endpoints 649
 "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"
}
Produces an error if the step GUID is not valid.
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"CUB5FVEN6P8RAQI\" is not valid."
}
]
}

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.

650 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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,
"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",

Endpoints 651
 "user": {
"email": "rhatcher@[Link]",
"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": "rborger@[Link]",
"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": "ecanard@[Link]",
"fullName": "Eleanor Canard",
"guid": "1J3M5I3UHK1K3M5OXNUV"
}
},
{
"comments": null,
"decision": "APPROVED",
"decisionDateTime": "2021-11-28T10:07:13Z",
"decisionType": "ALL_REQUIRED",
"group": {
"guid": "DVFYHUF6TW2P8RATCFGK",
"name": "Quality Process Approval Group"
},
"guid": "5N7Q9M7YLOUFYH0JSIP0",
"user": {
"email": "hwalker@[Link]",

652 Arena REST API Developer Guide

 "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": "ecanard@[Link]",
"fullName": "Eleanor Canard",
"guid": "1J3M5I3UHK1K3M5OXNUV"
}
},
{
"comments": null,
"decision": "APPROVED",
"decisionDateTime": "2021-11-28T09:49:01Z",
"decisionType": "ONE_REQUIRED",
"guid": "5N7Q9M7YLOUFYH0JSIP0",
"user": {
"email": "hwalker@[Link]",
"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 this issue will come up
again.",
"decision": "REJECTED",
"decisionDateTime": "2021-11-28T10:14:20Z",
"decisionType": "ALL_REQUIRED",

Endpoints 653
 "guid": "5N7Q9M7YLOUFYH0JSIP0",
"user": {
"email": "hwalker@[Link]",
"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."
}
]
}

PUT Quality Process Step Update (User

Assignee)
/qualityprocesses/<GUID>/steps/<GUID>
Updates an existing Step on page 1136 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

654 Arena REST API Developer Guide

Set Null
Name Value Description
setnull Append the URL with
setnull=true to set
dueDateTime to null.
Attribute must be
included within the
request body and set to
null. Insert setnull after
the query string,
represented by a ?, after
the GUID.

Sample Request Body

PUT /qualityprocesses/<GUID>/steps/<GUID>
{
"assignees": {
"users": [
{
"guid": "2K4N6EL7NVCVEXGZI8QJ"
}
]
},
"attributes": [
{
"guid": "6O8RAIPBRZIEXGZI1HZ1",
"value": "Send notification email"
}
],
"dueDateTime": "2021-08-08T15:00:00Z"
}
PUT /qualityprocesses/<GUID>/steps/<GUID>?setnull=true
{
"assignees": {
"users": [
{
"guid": "2K4N6EL7NVCVEXGZI8QJ"
}
]
},
"attributes": [
{
"guid": "6O8RAIPBRZIEXGZI1HZ1",
"value": "Send notification email"
}
],
"dueDateTime": null

Endpoints 655
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"

656 Arena REST API Developer Guide

 },
{
"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":"2021-08-08T15:00:00Z",
"guid":"DVFYHPWIY6PL4N6P82C8",
"name":"Immediate Containment",
"order":3,
"status":"OPEN",
"type":"REGULAR"
}
Updates dueDateTime to null.
PUT /qualityprocesses/<GUID>/steps/<GUID>?setnull=true
{
"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"
}

Endpoints 657
 ]
},
"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":null,
"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."
}
]
}

658 Arena REST API Developer Guide

PUT Quality Process Step Update (User
Group Assignee)
/qualityprocesses/<GUID>/steps/<GUID>
Updates an existing Step on page 1136 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

Set Null
Name Value Description
setnull Append the URL with
setnull=true to set
dueDateTime to null.
Attribute must be
included within the
request body and set to
null. Insert setnull after
the query string,
represented by a ?, after
the GUID.

Sample Request Body

PUT /qualityprocesses/<GUID>/steps/<GUID>
{
"assignees": {
"userGroups": [
{

Endpoints 659
 "guid": "GYI1KSSHLGWDWFYH0D3Z"
}
]
},
"attributes": [
{
"guid": "6O8RAIPBRZIEXGZI1HZ1",
"value": "Send notification email"
}
],
"dueDateTime": "2026-08-08T15:00:00Z"
}
PUT /qualityprocesses/<GUID>/steps/<GUID>?setnull=true
{
"assignees": {
"userGroups": [
{
"guid": "GYI1KSSHLGWDWFYH0D3Z"
}
]
},
"attributes": [
{
"guid": "6O8RAIPBRZIEXGZI1HZ1",
"value": "Send notification email"
}
],
"dueDateTime": null
}

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

660 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",
"name":"Supplier Containment actions required"
},

Endpoints 661
 {
"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"
}
Updates dueDateTime to null.
PUT /qualityprocesses/<GUID>/steps/<GUID>?setnull=true
{
"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?",

662 Arena REST API Developer Guide

 "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":null,
"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."
}
]
}

PUT Quality Process Step Update

(Deprecated)
/qualityprocesses/<GUID>/steps/<GUID>
Updates an existing Step on page 1136 object with a given GUID in a Quality
Process with a given GUID.

Endpoints 663
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

664 Arena REST API Developer Guide

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,

Endpoints 665
 "dueDateTime":"2016-11-20T07:59:59Z",
"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."
}
]
}

POST Quality Process Step Add Decision

Makers
/qualityprocesses/<GUID>/steps/<GUID>/decisions
Adds decision makers on an existing Step on page 1136 object with a given GUID
in a Quality Process with a given GUID.

Request Header
This endpoint supports the addition of an individual user or a user group (access
policies only). Possible values for decisionType include: ALL_REQUIRED,
ONE_REQUIRED, OPTIONAL, and COMMENTS_ONLY.

Sample Request Body

Adding a user group as a decision maker to a quality process step.
{
"decisionType": "ALL_REQUIRED",
"group": { "guid": "SAUDROSU5LREXGZIZBJ3" }
}
Adding a user as a decision maker to a quality process step.
{
"decisionType": "ALL_REQUIRED",
"user": { "guid": "K2M5JGKMXDUDWFYHPRYG" }
}

666 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Add a user group as a decision maker to a quality process step.
/qualityprocesses/<GUID>/steps/<GUID>/decisions
{
"count": 6,
"results": [
{
"comments": null,
"decision": null,
"decisionDateTime": null,
"decisionType": "ALL_REQUIRED",
"guid": "SAUDROSU5MSDWFYHPRYG",
"user": {
"email": "roger@[Link]",
"fullName": "Roger Every",
"guid": "J1L4IFJLWDUDWFYHPRYT"
}
},
{
"comments": null,
"decision": null,
"decisionDateTime": null,
"decisionType": "ALL_REQUIRED",
"guid": "CUEXB8CEP6CXGZI11H62",
"user": {
"email": "jjuy@[Link]",
"fullName": "Janet Joy",

Endpoints 667
 "guid": "3L5O2Z35GXEXGZI11H6B"
}
},
...
]
}
Add a user as an approver to a quality process sign-off step..
/qualityprocesses/<GUID>/steps/<GUID>/decisions
{
"comments": null,
"decision": null,
"decisionDateTime": null,
"decisionType": "ALL_REQUIRED",
"guid": "CUEXB8CEP6CXGZI11H62",
"user": {
"email": "jjuy@[Link]",
"fullName": "Janet Joy",
"guid": "3L5O2Z35GXEXGZI11H6B"
}
}
Returns an error if the GUID is not valid:
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"CUB5FVEN6P8RAQI\" is not valid."
}
]
}

PUT Quality Process Step Make Decision

/qualityprocesses/<GUID>/steps/<GUID>/decisions/<GUID>
Makes a decision on an existing Step on page 1136 object with a given GUID in a
Quality Process with a given GUID. Decisions can only be made within a quality
process sign-off step.

Request Header
This endpoint supports the following values for decisions: “APPROVED”.
“REJECTED”, and “COMMENT”,

Sample Request Body

{
"decision": "APPROVED",

668 Arena REST API Developer Guide

"comments": "My comment"
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Make a decision on a quality process sign-off step.
/qualityprocesses/<GUID>/steps/<GUID>
{
"comments": null,
"decision": "APPROVED",
"decisionDateTime": "2021-11-28T09:49:01Z",
"decisionType": "ONE_REQUIRED",
"guid": "5N7Q9M7YLOUFYH0JSIP0",
"user": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
Returns an error if the GUID is not valid:
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"CUB5FVEN6P8RAQI\" is not valid."
}

Endpoints 669
 ]
}

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

670 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Complete a quality process step
/qualityprocesses/statuschanges
{
"qualityProcess":{
"completedDateTime":"2019-07-05T21:57:22Z",
"creationDateTime":"2017-01-20T19:35:37Z",
"creator":{
"email": "hwalker@[Link]",
"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":{
"email": "hwalker@[Link]",
"fullName":"Heidi W",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"status":"COMPLETED",
"statusMode":"AUTOMATIC",
"targetCompletionDateTime":"2017-02-04T07:59:59Z",
"template":{
"active":null,
"guid":"2KN4N6J4VIL40J2L4N0B3"
},

Endpoints 671
 "type": NULL
"complete": true,
"comment": "Problem Description fields have been entered."
}
Returns an error if the Quality Process step is already completed.
{
"status": 400,
"errors": [
{
"code": 3089,
"message": "The quality process step is already completed."
}
]
}

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",

672 Arena REST API Developer Guide

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

Sample Response Body

Reopens a quality process step
/qualityprocesses/statuschanges
{
"qualityProcess":{
"completedDateTime":"2019-07-25T13:51:25Z",
"creationDateTime":"2017-01-20T19:35:37Z",
"creator":{
"email": "hwalker@[Link]",
"fullName":"Heidi W",
"guid":"WEYH0DYPCFWFYH0JSIPD"
},
"currentStep":{
"approvals":null,
"attributes":null,
"guid":"Q6Q9S5QH47QMFO7QZ3MG"
},

Endpoints 673
 "description":"Products have been melting at high temps.",
"guid":"K2M5O1MD03ML1K3MVZIC",
"name":"Everyroad bezels melted/burned.",
"number":"CAR-000003",
"owner":{
"email": "hwalker@[Link]",
"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,
"errors": [
{
"code": 3089,
"message": "The quality process is already open."
}
]
}

GET Training Plan Record

/trainingplans/<GUID>/records/<GUID>
Returns a specific training record associated within a specific Training Plan.
Using the browser-based application as a point of comparison, this endpoint
returns a specific record located within the Records view of a specific Training
Plan.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

674 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific training record with a given GUID within the Records view of a
Training Plan with a given GUID.
GET /trainingplans/<GUID>/records/<GUID>
{
"dueDate": "2016-09-18T06:59:59Z",
"guid": "N5P8R4PG36M4N6P8Q0RJ",
"item": {
"guid": "7P9SBO90NQ9H0F3XUEJR",
"name": "SOP, Production and Process Management",
"number": "020-00008",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
7P9SBO90NQ9H0F3XUEJR",
"app": "[Link]
}
},
"signedDateTime": "2017-03-17T22:56:08Z",
"user": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
}

Endpoints 675
GET Training Plan Records
/trainingplans/<GUID>/records
Returns all the training records for a specific Training Plan. Using the browser-
based application as a point of comparison, this endpoint returns the training
records data within the Records view of a specific Training Plan.

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
objects is 20. Can return
up 400.

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

676 Arena REST API Developer Guide

Name Value Description
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the Training Plan records within the Records view of a Training Plan.
GET /trainingplans/<GUID>/records
{
"count": 11,
"results": [
{
"dueDate": "2016-09-18T06:59:59Z",
"guid": "ZH1K3G1SFIYGZI1K2C5X",
"item": {
"guid": "L3N6P2NE14NVETHB8TF2",
"name": "SOP, Building Evacuation and Safety",
"number": "020-00004",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
items/L3N6P2NE14NVETHB8TF2",
"app": "[Link]
L3N6P2NE14NVETHB8TF2"
}
},
"signedDateTime": "2016-09-07T23:09:49Z",
"user": {
"email": "jdeckard@[Link]",
"fullName": "James Deckard",
"guid": "YG0J2F0REHYH0J2LUKR9"
}
},
{
"dueDate": "2016-09-18T06:59:59Z",
"guid": "3L5O7K5WJM2K3M5O6G9M",
"item": {
"guid": "7P9SBO90NQ9H0F3XUEJR",
"name": "SOP, Production and Process Management",
"number": "020-00008",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {

Endpoints 677
 "api": "[Link]
items/7P9SBO90NQ9H0F3XUEJR",
"app": "[Link]
7P9SBO90NQ9H0F3XUEJR"
}
},
"signedDateTime": "2016-09-07T23:10:19Z",
"user": {
"email": "jdeckard@[Link]",
"fullName": "James Deckard",
"guid": "YG0J2F0REHYH0J2LUKR9"
}
},
{
"dueDate": "2016-09-18T06:59:59Z",
"guid": "YG0J2F0REHXFYH0J1B4F",
"item": {
"guid": "R9TCV8TK7AT1KZNHEY9O",
"name": "SOP, Inspection and Test",
"number": "020-00005",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
items/R9TCV8TK7AT1KZNHEY9O",
"app": "[Link]
R9TCV8TK7AT1KZNHEY9O"
}
},
"signedDateTime": "2016-09-07T23:09:58Z",
"user": {
"email": "jdeckard@[Link]",
"fullName": "James Deckard",
"guid": "YG0J2F0REHYH0J2LUKR9"
}
},
{
"dueDate": "2016-09-18T06:59:59Z",
"guid": "J1L4N0LCZ2I0J2L4MWNG",
"item": {
"guid": "L3N6P2NE14NVETHB8TF2",
"name": "SOP, Building Evacuation and Safety",
"number": "020-00004",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
items/L3N6P2NE14NVETHB8TF2",
"app": "[Link]
L3N6P2NE14NVETHB8TF2"
}

678 Arena REST API Developer Guide

 },
"signedDateTime": "2017-03-17T22:55:40Z",
"user": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
},
...
}
]
}

DELETE Training Plan Quality Process

/trainingplans/<GUID>/quality/<GUID>
Removes an Quality Process from a Training Plan. In order to remove a user from
a Training Plan, the user must be the assigned Training Manager of the Training
Plan.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 679
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."
}
]
}

POST Add Training Plan Quality Process

/trainingplans/<GUID>/quality
This endpoint adds a Quality Process (with a specified step) as a reference to a
Training Plan. Using the browser-based application as a point of comparison, this
endpoint adds a specific Quality Process to the Reference view of a specific
Training Plan.

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

680 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Add a Quality Process (with a specified step) to a Training Plan.
POST /trainingplans/<GUID>/quality
Request
{
"quality": {
"guid": "M4O7Q3OF25OK3M5O7KU3",
"step": {
"guid": "N5P8R4PG36PL4N6P8LVG"
}
}
}
Response
{
"guid": "WEYH0DYPCFWQ9SBT8YJG",
"quality": {
"guid": "M4O7Q3OF25OK3M5O7KU3",
"number": "NCMR-000001",
"step": {
"guid": "N5P8R4PG36PL4N6P8LVG",
"name": "Nonconformance Description"
}
}
}

GET Training Plan Quality Process

Reference
/trainingplans/<GUID>/quality/<GUID>
Returns a specific Quality Process associated within a specific Training Plan.
Using the browser-based application as a point of comparison, this endpoint
returns a specific Quality Process located within the Reference view of a specific
Training Plan.

Endpoints 681
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific Quality Process with a given GUID within the Reference view of a
Training Plan with a given GUID.
GET /trainingplans/<GUID>/quality/<GUID>
{
"guid": "P7RAT6RI58PJ2L4M1RDH",
"quality": {
"guid": "M4O7Q3OF25OK3M5O7KU3",
"number": "NCMR-000001",
"step": {
"guid": "N5P8R4PG36PL4N6P8LVG",
"name": "Nonconformance Description"
}
}
}

682 Arena REST API Developer Guide

GET Training Plan Quality Process
References
/trainingplans/<GUID>/quality
Returns all the Quality Processes and the specific step associated within a specific
Training Plan. Using the browser-based application as a point of comparison, this
endpoint returns the Quality Process (and the specified step) located within the
References view of a specific Training Plan.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the Quality Processes (and their respective steps) within the Reference view
of a Training Plan.
GET /trainingplans/<GUID>/quality
{
"count": 2,
"results": [

Endpoints 683
 {
"guid": "P7RAT6RI58PJ2L4M1RDH",
"quality": {
"guid": "M4O7Q3OF25OK3M5O7KU3",
"number": "NCMR-000001",
"step": {
"guid": "N5P8R4PG36PL4N6P8LVG",
"name": "Nonconformance Description"
}
}
},
{
"guid": "UCWFYBWNADUO7Q9R6WHK",
"quality": {
"guid": "K2M5O1MD03MI1K3MVZIC",
"number": "CAR-000003",
"step": {
"guid": "P7RAT6RI58RN6P8R04NA",
"name": "Corrective Action"
}
}
}
]
}

DELETE Training Plan Item

/trainingplans/<GUID>/items/<GUID>
Removes an item from a Training Plan. In order to remove a user from a Training
Plan, the user must be the assigned Training Manager of the Training Plan.

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

684 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

POST Add Training Plan Item

/trainingplans/<GUID>/items
This endpoint adds an Item to a Training Plan. In order to add a user to a Training
Plan, the user account executing the endpoint must be the Training Plan Manager.
Using the browser-based application as a point of comparison, this endpoint adds
a specific item to the Items view of a specific Training Plan.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Endpoints 685
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Add an item to a Training Plan.
POST /trainingplans/<GUID>/items
Request
{
"item": {
"guid": "L3N6P2NE14NVETHB8TF2"
}
}
Response
{
"guid": "K2M5O1MD03K4N6P8Q09D",
"item": {
"guid": "L3N6P2NE14NVETHB8TF2",
"name": "SOP, Building Evacuation and Safety",
"number": "020-00004",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
L3N6P2NE14NVETHB8TF2",
"app": "[Link]
}
}
}

686 Arena REST API Developer Guide

GET Training Plan File
/trainingplans/<GUID>/files/<GUID>
Returns a specific file associated within a specific Training Plan. Using the
browser-based application as a point of comparison, this endpoint returns a
specific file located within the Files view of a specific Training Plan.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific file with a given GUID within the Files of a Training Plan with a
given GUID.
GET /trainingplans/<GUID>/files/<GUID>
{
"file": {
"author": {
"fullName": "Heidi Walker"
},
"category": {

Endpoints 687
 "guid": "2K4N6J4VIL4EXGV223PR",
"name": "-uncategorized-"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2016-09-02T19:02:08Z",
"description": null,
"edition": "1",
"format": "docx",
"guid": "4M6P8L6XKN6M5OEUH99C",
"hasMarkup": false,
"lastModifiedDateTime": "2016-09-02T19:02:08Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/[Link]-
[Link]",
"name": "020-00003 SOP, Control of [Link]",
"number": "FILE-000966",
"private": true,
"size": 35450,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "020-00003 SOP, Control of Records"
},
"guid": "J1L4N0LCZ2FUDWFXC8RA"
}

GET Training Plan Files

/trainingplans/<GUID>/files
Returns all the files associated within a specific Training Plan. Using the browser-
based application as a point of comparison, this endpoint returns the files located
within the Files view of a specific Training Plan.

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

688 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the files within the Files view of a Training Plan.
GET /trainingplans/<GUID>/files
{
"count": 3,
"results": [
{
"file": {
"author": {
"fullName": "Heidi Walker"
},
"category": {
"guid": "2K4N6J4VIL4EXGV223PR",
"name": "-uncategorized-"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2016-09-02T19:00:27Z",
"description": null,
"edition": "1",
"format": "pdf",
"guid": "L3N6P2NE14N3M5VBYQQ3",
"hasMarkup": false,
"lastModifiedDateTime": "2016-09-02T19:00:27Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/pdf",
"name": "020-00001 SOP, Document Control
[Link]",
"number": "FILE-000961",
"private": true,
"size": 92146,

Endpoints 689
 "storageMethod": 0,
"storageMethodName": "FILE",
"title": "020-00001 SOP, Document Control
Management"
},
"guid": "HZJ2LYJAX0DSBUDVA6PX"
},
{
"file": {
"author": {
"fullName": "Heidi Walker"
},
"category": {
"guid": "2K4N6J4VIL4EXGV223PR",
"name": "-uncategorized-"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2016-09-02T19:01:26Z",
"description": null,
"edition": "1",
"format": "docx",
"guid": "WEYH0DYPCFYEXG6M911I",
"hasMarkup": false,
"lastModifiedDateTime": "2016-09-02T19:01:26Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/[Link]-
[Link]",
"name": "020-00002 SOP, Change [Link]",
"number": "FILE-000964",
"private": true,
"size": 35440,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "020-00002 SOP, Change Control"
},
"guid": "I0K3MZKBY1ETCVEWB7QK"
},
{
"file": {
"author": {
"fullName": "Heidi Walker"
},
"category": {
"guid": "2K4N6J4VIL4EXGV223PR",
"name": "-uncategorized-"
},
"checkedOut": false,
"corrected": false,

690 Arena REST API Developer Guide

 "creationDateTime": "2016-09-02T19:02:08Z",
"description": null,
"edition": "1",
"format": "docx",
"guid": "4M6P8L6XKN6M5OEUH99C",
"hasMarkup": false,
"lastModifiedDateTime": "2016-09-02T19:02:08Z",
"latest": true,
"location": null,
"locked": true,
"mimeType": "application/[Link]-
[Link]",
"name": "020-00003 SOP, Control of [Link]",
"number": "FILE-000966",
"private": true,
"size": 35450,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "020-00003 SOP, Control of Records"
},
"guid": "J1L4N0LCZ2FUDWFXC8RA"
}
]
}

POST Training Plans Files View Add

Existing File
/trainingplans/<GUID>/files
Associates an existing file to the Files view of a Training Plan.

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

Sample Request Body

{

Endpoints 691
 "file": {
"guid": "UCTQE5NGZI1AXZ3W"
}
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Training Plans Files View Association
POST <url>/trainingplans/<GUID>/files
{
"guid": "UCTQE5NGZI1AXZ3W",
"latestEditionAssociation": true,
"file": {
"author": {
"fullName": "Roy Stafford"
},
"category": {
"guid": "EWGZDAEGR8R1K3J1LPP3",
"name": "-uncategorized-"
},
"checkedOut": false,
"corrected": false,
"creationDateTime": "2016-12-21T19:00:26Z",
"description": null,
"edition": "1",
"format": "txt",
"guid": "4M6P3046HYHXGZP3HMLL",
"hasMarkup": false,
"lastModifiedDateTime": "2016-12-21T19:00:26Z",
"latest": false,
"location": null,
"locked": true,
"mimeType": null,
"name": "[Link]",

692 Arena REST API Developer Guide

 "number": "FILE-007674",
"private": false,
"size": 631,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "[Link]"
}
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not
valid."
}
]
}

DELETE Training Plans Remove File

Association
/trainingplans/<GUID>/files/<GUID>
Removes a File with a specific GUID from associating with a Training Plans 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

Endpoints 693
Name Value Description
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

GET Training Plan Item

/trainingplans/<GUID>/items/<GUID>
Returns a specific item associated within a specific Training Plan. In terms of the
browser-based application, this endpoint returns a specific item located within the
Files view of a specific Training Plan.

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

694 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific item with a given GUID within the Items view of a Training Plan
with a given GUID.
GET /trainingplans/<GUID>/items/<GUID>
{
"guid": "CUEXGTE5SVCWFYH0JZKJ",
"item": {
"guid": "R9TCV8TK7AT1KZNHEY9O",
"name": "SOP, Inspection and Test",
"number": "020-00005",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
R9TCV8TK7AT1KZNHEY9O",
"app": "[Link]
}
}
}

GET Training Plan Items

/trainingplans/<GUID>/items
Returns all the items associated within a specific Training Plan. In terms of the
browser-based application, this endpoint returns the items located within the Items
view of a specific Training Plan.

Endpoints 695
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the items within the Items view of a Training Plan.
GET /trainingplans/<GUID>/items
{
"count": 6,
"results": [
{
"guid": "6O8RAN8ZMP6Q9SBUDTFF",
"item": {
"guid": "7P9SBO90NQ9H0F3XUEJR",
"name": "SOP, Production and Process Management",
"number": "020-00008",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
items/7P9SBO90NQ9H0F3XUEJR",

696 Arena REST API Developer Guide

 "app": "[Link]
7P9SBO90NQ9H0F3XUEJR"
}
}
},
{
"guid": "7P9SBO90NQ7RATCVEUGZ",
"item": {
"guid": "WEYH0DYPCFY6P4SMJ3DL",
"name": "SOP, Risk Management",
"number": "020-00006",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
items/WEYH0DYPCFY6P4SMJ3DL",
"app": "[Link]
WEYH0DYPCFY6P4SMJ3DL"
}
}
},
{
"guid": "9RBUDQB2PS9TCVEXGWHX",
"item": {
"guid": "1J3M5I3UHK3BU9XRO8B3",
"name": "SOP, Control of Nonconforming Material",
"number": "020-00010",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE",
"url": {
"api": "[Link]
items/1J3M5I3UHK3BU9XRO8B3",
"app": "[Link]
1J3M5I3UHK3BU9XRO8B3"
}
}
},
...
]
}

DELETE Training Plan Users

/trainingplans/<GUID>/users/<GUID>
Removes a user from a Training Plan. In order to remove a user from a Training
Plan, the user must be the assigned Training Manager of the Training Plan.

Endpoints 697
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

PUT Update Training Plan User

/trainingplans/<GUID>/users/<GUID>

698 Arena REST API Developer Guide

In order to modify a user in a Training Plan, the user must be a Training Plan
Manager within the workspace. Currently, the only modification to a user in a
Training Plan supported is the ability to change due date of a user's training
assignments..

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Edit the due date of a user's training assignment in a specific Training Plan.
/trainingplans/<GUID>/users/<GUID>
Request
{
"dueDate": "2023-01-30"
}
Response
{
"dueDate": "2023-01-30T07:59:59Z",
"guid": "K2M5O1MD03J2L4N6F6Z5",
"user": {

Endpoints 699
 "email": "tmakamuri@[Link]",
"fullName": "Toshiro Makamuri",
"guid": "J1L4N0LCZ2J2L4N6F6ZL"
}
}
User, who is not the Training Manager of the specificied Training Plan, attempts
to modify a user's training assignment due date.
{
"status": 400,
"errors": [
{
"code": 4217,
"message": "Only the assigned training manager for
this training plan can perform this action."
}
]
}

POST Add Training Plan Users

/trainingplans/<GUID>/users
This endpoint adds a user to a Training Plan. In order to add a user to a Training
Plan, the user account executing the endpoint must be the Training Plan Manager.

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

700 Arena REST API Developer Guide

Name Value Description
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Add users to a Training Plan.
POST /trainingplans/<GUID>/users
Request
{
"user": {
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"dueDate":"2022-11-28"
}
Response
{
"dueDate": "2022-11-28T07:59:59Z",
"guid": "XFZI1EZQDGWFYH0JSIPU",
"user": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
}

GET Training Plan User

/trainingplans/<GUID>/users/<GUID>
If the GET Training Plan Users endpoint is appended with a valid guid, it returns
the information of a specific user in a Training Plan.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Endpoints 701
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific Training Plan user with a given GUID.
GET /trainingplans/<GUID>/users/<GUID>
{
"dueDate": null,
"guid": "ZH1K3G1SFIYH0J2LUKR1",
"user": {
"email": "jdeckard@[Link]",
"fullName": "James Deckard",
"guid": "YG0J2F0REHYH0J2LUKR9"
}
}

GET Training Users

/trainingplans/<GUID>/users
Returns all the users (trainees) included within a Training Plan.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

702 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the Training Plan Users of a Training Plan.
GET /trainingplans/<GUID>/users
{
"count": 14,
"results": [
{
"dueDate": "2016-12-21T07:59:59Z",
"guid": "2K4N6J4VIL1K3M5OXNUH",
"user": {
"email": "ecanard@[Link]",
"fullName": "Eleanor Canard",
"guid": "1J3M5I3UHK1K3M5OXNUV"
}
},
{
"dueDate": null,
"guid": "ZH1K3G1SFIYH0J2LUKR1",
"user": {
"email": "jdeckard@[Link]",
"fullName": "James Deckard",
"guid": "YG0J2F0REHYH0J2LUKR9"
}
},
{
"dueDate": "2017-04-14T06:59:59Z",
"guid": "M4O7Q3OF25L4N6P8ADFD",

Endpoints 703
 "user": {
"email": "test987789notreal@[Link]",
"fullName": ";laksdf slakdf",
"guid": "L3N6P2NE14L4N6P8ADFJ"
}
},
...
]
}

GET Training Manager

/settings/trainingplans/managers/<GUID>
If the GET Training Managers endpoint is appended with a valid guid, it returns
the information of a specific Training Plan Manager.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

704 Arena REST API Developer Guide

Sample Response Body
Get a specific Training Plan Manager with a given GUID.
GET /settings/trainingplans/managers/WEYHODYPCFWFYHOJSIPD
{
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}

GET Training Managers

/settings/trainingplans/managers
Returns all the Training Plan managers of a 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
response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the Training Plan Managers of a workspace.

Endpoints 705
GET /settings/trainingplans/managers
{
"count": 2,
"results": [
{
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
{
"email": "tmakamuri@[Link]",
"fullName": "Toshiro Makamuri",
"guid": "J1L4N0LCZ2J2L4N6F6ZL"
}
]
}

GET Training Plan Number Sequences

/settings/trainingplans/numbersequences
This first url returns all Training Plan number sequences available in the
workspace. .
Training 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

706 Arena REST API Developer Guide

Name Value Description
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all Training number sequences defined for the workspace
/settings/trainingplans/numbersequences
{
"count": 2,
"results": [
{
"creationDateTime": "2022-04-19T06:22:03Z",
"guid": "R9TCV8TK7AQN6P8RAID3",
"lastUsed": "000000",
"name": "Standard Operating Procedures",
"nextValue": "000001",
"prefixes": [
{
"guid": "0I2L4H2TGJZVEXGZIQI8",
"value": "SOP"
}
]
},
{
"creationDateTime": "2016-06-26T15:20:47Z",
"guid": "2K4N6J4VIL1YH0J2L3CX",
"lastUsed": "000003",
"name": "TRP",
"nextValue": "000004",
"prefixes": [
{
"guid": "3L5O7K5WJM2YH0J2L3C7",
"value": "TRP-"
}
]
}
]
}

GET Training Plan Number Sequence

/settings/trainingplans/numbersequences/<GUID>

Endpoints 707
Appending a GUID to the URL returns the number format with that GUID.
Training Plan Number Sequence endpoint consist of a prefix 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific Training number sequences with a specific GUID
/settings/trainingplans/numbersequences/
2K4N6J4VIL1YH0J2L3CX
{
"creationDateTime": "2016-06-26T15:20:47Z",
"guid": "2K4N6J4VIL1YH0J2L3CX",
"lastUsed": "000003",
"name": "TRP",
"nextValue": "000004",
"prefixes": [
{
"guid": "3L5O7K5WJM2YH0J2L3C7",
"value": "TRP-"

708 Arena REST API Developer Guide

 }
]
}

PUT Training Plan Edit

/trainingplans/<GUID>
In order to edit a Training Plan, the user must be a Training Plan Manager within
the workspace. If the user is a Training Plan Manager within the workspace but
not the Training Plan Manager of this specific Training Plan, they can only use
this endpoint to modify the Training Manager.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Set Null
Name Value Description
setnull Append the URL with
setnull=true to set
description to null.
Attribute must be
included within the
request body and set to
null. Insert setnull after
the query string,
represented by a ?, after
the GUID

Response Codes
Code Description
200 Success
400 Failure

Endpoints 709
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Edit a Training Plan.
/trainingplans/<GUID>
Request
{
"name": "EveryHome Green Efficiency Initiative 2022 - North
America Line",
"description": "All employees must review Green 2022
Initiative. Please contact your manager or HR if you have any
questions.",
"manager": {
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"daysToComplete": 36
}
Response
{
"creationDateTime": "2022-04-25T22:38:35Z",
"creator": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"daysToComplete": 36,
"description": "All employees must review Green 2022
Initiative. Please contact your manager or HR if you have any
questions.",
"guid": "FXH0JWH8VYF0J2L4NZB8",
"manager": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"

710 Arena REST API Developer Guide

 },
"name": "EveryHome Green Efficiency Initiative 2022 - North
America Line",
"number": "TRP-000004",
"status": "OPEN"
}
Request
Set description to null.
PUT /trainingplans/<GUID>?setnull=true
{
"name": "EveryHome Green Efficiency Initiative 2022 - North
America Line",
"description": null,
"manager": {
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"daysToComplete": 36
}
Response
{
"creationDateTime": "2022-04-25T22:38:35Z",
"creator": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"daysToComplete": 36,
"description":null,
"guid": "FXH0JWH8VYF0J2L4NZB8",
"manager": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "EveryHome Green Efficiency Initiative 2022 - North
America Line",
"number": "TRP-000004",
"status": "OPEN"
}
User, who is a Training Manager but not the Training Manager of the specificied
Training Plan, attempts to modify an attribute of the Training Plan other than the
Training Manager attribute.
{
"status": 400,
"errors": [
{
"code": 4217,

Endpoints 711
 "message": "Only the assigned training manager for
this training plan can perform this action."
}
]
}

POST Training Plans Status Change

/trainingplans/statuschanges
The Training Plan Manager can change the status of their Training Plan through
this endpoint. Supported statuses: CLOSED and OPEN.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Upgrade the status of a Training Plan from OPEN to CLOSED.
POST /trainingplans/statuschanges
Request

712 Arena REST API Developer Guide

{
"trainingplan": {
"guid": "FXH0JWH8VYF0J2L4NZB8"
},
"status": "CLOSED",
"comment": "This initiative is being dropped. Closing Training
Plan."
}
Response
{
"creationDateTime": "2022-04-25T22:38:35Z",
"creator": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"daysToComplete": 30,
"description": "All employees must review Green 2022
Initiative. Please contact your manager or HR if you have any
questions.",
"guid": "FXH0JWH8VYF0J2L4NZB8",
"manager": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "EveryHome Green Efficiency Initiative 2022 - North
America Line",
"number": "TRP-000004",
"status": "CLOSED"
}

GET Training Plan

/trainingplans/<GUID>
Returns a Training Plan object with a given GUID.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Endpoints 713
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a Training Plan with a unique GUID
GET /trainingplans/<GUID>
{
"creationDateTime": "2016-09-07T22:43:04Z",
"creator": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"daysToComplete": 30,
"description": "This Training Plan must be completed by all
new Everyroad employees within 10 days of hire",
"guid": "1J3M5I3UHK1M5O7Q9S0V",
"manager": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "Everyroad Employee Training",
"number": "TRP-000002",
"status": "OPEN"
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,

714 Arena REST API Developer Guide

 "message":"The guid \"ASCVERC3QTCFYGPWW1WCS\" is not
valid"
}
]
}

GET Training Plans (Search)

/trainingplans
Returns a collection of Training Plan 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
number string Training Plan number
name string Training Plan name
status string Status of the Training
Plan. Possible values:
"OPEN" or "CLOSED".

Endpoints 715
Name Value Description
[Link] string The unique user id for the
Training Manager. User
unique ids can be
obtained by the GET
Users endpoint.
[Link] string The first and last name of
the Training Plan
manager.
[Link] string The unique user id for the
users listed as trainees
within the Training Plan.

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.
For additional attribute field type MULTI_LINE_TEXT searches, different
values can be separated with an asterisk.
For additional attribute field types DROP_DOWN & FIXED_DROP_DOWN
searches, different values can be separated with a semi-colon.
When using a semi-colon to separate values in a FIXED_DROP_DOWN
search, note that the semi-colon will always act as an OR. This is relevant
when performing a Multi-Select search.
For example with FIXED_DROP_DOWN, multiselect = True: GET /Items?
J1L49Y281EVDWFUXRSCZ=Option 1;Option 2 will return all Items where
the FIXED_DROP_DOWN contains Option 1 OR Option 2 (or both). On the
other hand FIXED_DROP_DOWN, multiselect=False: GET /items?
J1L49Y281EVDWFUXRSCZ=Option 1;Option 2 will return all Items where
the FIXED_DROP_DOWN equals Option 1 OR Option 2.
Search in Zulu format is supported for custom attribute field type Date.
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.

716 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all Training Plans
GET /trainingplans
{
"count": 2,
"results": [
{
"creationDateTime": "2016-09-07T22:43:04Z",
"creator": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"daysToComplete": 30,
"description": "This Training Plan must be completed
by all new Everyroad employees within 10 days of hire",
"guid": "1J3M5I3UHK1M5O7Q9S0V",
"manager": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "Everyroad Employee Training",
"number": "TRP-000002",
"status": "OPEN"
},
{
"creationDateTime": "2016-09-07T23:46:58Z",
"creator": {

Endpoints 717
 "email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"daysToComplete": 30,
"description": "This training plan is to be completed
by all Everyroad Document Control staff within 30 days of hire",
"guid": "2K4N6J4VIL2N6P8RAT1F",
"manager": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "Document Control Training",
"number": "TRP-000003",
"status": "OPEN"
}
]
}
Get the Training Plan with a number of TRP-000002.
GET <url>/trainingplans?number=TRP-000002
{
"count": 1,
"results": [
{
"creationDateTime": "2016-09-07T22:43:04Z",
"creator": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"daysToComplete": 30,
"description": "This Training Plan must be completed
by all new Everyroad employees within 10 days of hire",
"guid": "1J3M5I3UHK1M5O7Q9S0V",
"manager": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "Everyroad Employee Training",
"number": "TRP-000002",
"status": "OPEN"
}
]
}
Get all Training Plans with a status of CLOSED.
GET <url>/trainingplans?status=CLOSED

718 Arena REST API Developer Guide

{
"count": 1,
"results": [
{
"creationDateTime": "2022-04-25T22:38:35Z",
"creator": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"daysToComplete": 69,
"description": "All employees must review Green 2022
Initiative. Please contact your manager or HR if you have any
questions.",
"guid": "FXH0JWH8VYF0J2L4NZB8",
"manager": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "EveryHome Green Efficiency Initiative 2022 -
North America Line",
"number": "TRP-000004",
"status": "CLOSED"
}
]
}

DELETE Training Plans

/trainingplans/<GUID>
Deletes a Training Plan with a given GUID. In order to delete a Training Plan, the
user must be the assigned Training Manager of the Training Plan. For Access
Policies workspaces, users need a Delete Training rule in order in order to delete a
Training Plan.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Endpoints 719
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

POST Training Plan Create

/trainingplans
This endpoint creates a Training Plan. In order to create a Training Plan, the user
must be a Training Plan Manager. For Access Policies workspaces, user must also
contain a policy that includes an Edit Training Summary rule.

720 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Create a Training Plan.
POST /trainingplans
Request
{
"numberSequencePrefix": {
"value": "TRP-"
},
"name": "EveryHome Green Efficiency Initiative 2022",
"description": "All employees must review Green 2022
Initiative",
"manager": {
"guid": "J1L4N0LCZ2J2L4N6F6ZL"
},
"daysToComplete": 30
}
Response

Endpoints 721
{
"creationDateTime": "2022-04-25T22:38:35Z",
"creator": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"daysToComplete": 30,
"description": "All employees must review Green 2022
Initiative",
"guid": "FXH0JWH8VYF0J2L4NZB8",
"manager": {
"email": "tmakamuri@[Link]",
"fullName": "Toshiro Makamuri",
"guid": "J1L4N0LCZ2J2L4N6F6ZL"
},
"name": "EveryHome Green Efficiency Initiative 2022",
"number": "TRP-000004",
"status": "OPEN"
}

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

722 Arena REST API Developer Guide

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.

Endpoints 723
Searchable Attributes
Name Value Description
[additional attribute guid string This special search
value] permits searching for
strings in additional
attribute values. For
example GET /tickets?
VDXGZ7E0-
GO5N6P8PR55G=
*100pF where
VDXGZ7E0-
GO5N6P8PR55G 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 example,
the user is using the
following to search for a
date field type custom
attribute with a value of
April 1, 2019:

724 Arena REST API Developer Guide

Name Value Description
GET /tickets?
4M6PUJNPNM3L4N25-
ZZ5F=2019-04-01
[Link] 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.
For additional attribute field type MULTI_LINE_TEXT searches, different
values can be separated with an asterisk.
For additional attribute field types DROP_DOWN & FIXED_DROP_DOWN
searches, different values can be separated with a semi-colon.
When using a semi-colon to separate values in a FIXED_DROP_DOWN
search, note that the semi-colon will always act as an OR. This is relevant
when performing a Multi-Select search.
For example with FIXED_DROP_DOWN, multiselect = True: GET /Items?
J1L49Y281EVDWFUXRSCZ=Option 1;Option 2 will return all Items where
the FIXED_DROP_DOWN contains Option 1 OR Option 2 (or both). On the
other hand FIXED_DROP_DOWN, multiselect=False: GET /items?
J1L49Y281EVDWFUXRSCZ=Option 1;Option 2 will return all Items where
the FIXED_DROP_DOWN equals Option 1 OR Option 2.
Search in Zulu format is supported for custom attribute field type Date.
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.

Endpoints 725
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all tickets
GET /tickets
{
"count": 6,
"results": [
{
"additionalAttributes": [
{
"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

726 Arena REST API Developer Guide

 },
{
"apiName": "5N7Q9M7YLO5N6P8RATF6",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "5N7Q9M7YLO5N6P8RATF6",
"name": "Labels",
"value": null
}
],
"assignee": null,
"creationDateTime": "2017-03-17T22:27:02Z",
"creator": {
"email": "hwalker@[Link]",
"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": [
{
"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": "jparker@[Link]",

Endpoints 727
 "fullName": "John Parker",
"guid": "XFZI1EZQDGXGZI1KTJQ2"
},
"creationDateTime": "2017-03-17T22:48:02Z",
"creator": {
"email": "hwalker@[Link]",
"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",
"guid": "6O8RAN8ZMP6O7Q9SBUGT",
"name": "Components",
"value": "Model 600"
}
],
"assignee": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"creationDateTime": "2021-09-06T23:47:26Z",

728 Arena REST API Developer Guide

 "creator": {
"email": "hwalker@[Link]",
"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&[Link]=
8QATCPA1OR83M5O7Q967
{
"count": 1,
"results": [
{
"additionalAttributes": [
{
"apiName": "6O8RAN8ZMP6O7Q9SBUGT",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "6O8RAN8ZMP6O7Q9SBUGT",
"name": "Components",
"value": null
},
{
"apiName": "5N7Q9M7YLO5N6P8RATF6",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "5N7Q9M7YLO5N6P8RATF6",
"name": "Labels",
"value": null

Endpoints 729
 }
],
"assignee": {
"email": "jparker@[Link]",
"fullName": "John Parker",
"guid": "XFZI1EZQDGXGZI1KTJQ2"
},
"creationDateTime": "2017-03-17T22:48:02Z",
"creator": {
"email": "hwalker@[Link]",
"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"
}
}
]
}

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

730 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",
"guid": "5N7Q9M7YLO5N6P8RATF6",
"name": "Labels",
"value": null
}
],
"assignee": {
"email": "jparker@[Link]",
"fullName": "John Parker",
"guid": "XFZI1EZQDGXGZI1KTJQ2"
},
"creationDateTime": "2017-03-17T22:48:02Z",
"creator": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",

Endpoints 731
 "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"
}
]
}

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.

732 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Create Ticket. Specify numberSequencePrefix.
POST /tickets
Request
{
"additionalAttributes": [
{
"guid": "6O8RAN8ZMP6O7Q9SBUGT",
"value": "Model 20000"
}
],
"template": {
"guid": "8QATCPA1OR83M5O7Q967"
},
"numberSequencePrefix": {
"value": "DEF-"
},
"title": "Paint chipping on new Model 20000",

Endpoints 733
 "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": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"creationDateTime": "2021-09-07T05:24:08Z",
"creator": {
"email": "hwalker@[Link]",
"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",
"value": "Not Started"
},
"template": {
"guid": "8QATCPA1OR83M5O7Q967",
"name": "Defects"
}
}
Create Ticket. Specify entire ticket number.
POST /tickets

734 Arena REST API Developer Guide

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": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"creationDateTime": "2021-09-07T05:25:10Z",
"creator": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"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",

Endpoints 735
 "status": {
"guid": "Q8SBU7SJ69QM5O7Q9SCG",
"value": "Not Started"
},
"template": {
"guid": "8QATCPA1OR83M5O7Q967",
"name": "Defects"
}
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Requests and Responses

Edit a Ticket.

736 Arena REST API Developer Guide

PUT /requests/<GUID>
Request
{
"additionalAttributes": [
{
"guid": "6O8RAN8ZMP6O7Q9SBUGT",
"value": "Model 3000"
}
],
"title": "Paint chipping on new Model 3000",
"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": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"creationDateTime": "2021-09-07T05:24:08Z",
"creator": {
"email": "hwalker@[Link]",
"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"

Endpoints 737
 },
"template": {
"guid": "8QATCPA1OR83M5O7Q967",
"name": "Defects"
}
}
Request with invalid GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"ASCVERC3QTCFYGPWW1WCS\" is not
valid"
}
]
}

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

738 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"
}
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": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"creationDateTime": "2021-09-07T05:24:08Z",
"creator": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "",

Endpoints 739
 "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"
}
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

740 Arena REST API Developer Guide

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."
}
]
}

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

Endpoints 741
Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all files associated with a ticket
GET /tickets/<GUID>/files
{
"count": 3,
"results": [
{
"file": {
"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 [Link]",
"number": "FILE-000971",
"private": true,
"size": 92123,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "020-00006 SOP, Risk Management"
},
"guid": "N5P8R4PG36JO7Q9R58BB",
"latestEditionAssociation": true
},
{
"file": {
"author": {

742 Arena REST API Developer Guide

 "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
[Link]",
"number": "FILE-000973",
"private": true,
"size": 92171,
"storageMethod": 0,
"storageMethodName": "FILE",
"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,

Endpoints 743
 "location": null,
"locked": true,
"mimeType": "application/pdf",
"name": "020-00008 SOP, Production and Process
[Link]",
"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,
"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 [Link]",
"number": "FILE-000971",
"private": true,
"size": 92123,
"storageMethod": 0,
"storageMethodName": "FILE",
"title": "020-00006 SOP, Risk Management"
},

744 Arena REST API Developer Guide

 "guid": "N5P8R4PG36JO7Q9R58BB",
"latestEditionAssociation": true
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 745
Sample Response Body
Tickets Files View Association
POST <url>/tickets/<GUID>/files
{
"file": {
"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 [Link]",
"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."
}
]
}

746 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

Endpoints 747
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"

748 Arena REST API Developer Guide

 },
{
"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"
}

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

Endpoints 749
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Adds a Change as a reference to a ticket.
POST <url>/tickets/<GUID>/changes
{
"change": {
"guid": "CUEXGOODHCVYHZI360DQ",
"number": "DCO-000001"
},
"guid": "O6Q9S5QH47OI1K3HK2JR"
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not
valid."
}
]
}

750 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]

Endpoints 751
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all items added as references to a ticket
GET /tickets/<GUID>/items
{
"count": 3,
"results": [
{
"guid": "UCWFYBWNADUO7Q9R58AA",
"item": {

752 Arena REST API Developer Guide

 "guid": "WEYH0DYPCFY6P4SMJ3DL",
"name": "SOP, Risk Management",
"number": "020-00006",
"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"
}
}

POST Tickets Add Item Reference

/tickets/<GUID>/items
Adds an item as a reference to a ticket.

Endpoints 753
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Adds an item as a reference to a ticket.
POST <url>/tickets/<GUID>/items
{
"guid": "UCWFYBWNADUO7Q9R58AA",
"item": {
"guid": "WEYH0DYPCFY6P4SMJ3DL",
"name": "SOP, Risk Management",
"number": "020-00006",
"revision": "A",

754 Arena REST API Developer Guide

 "revisionStatus": "EFFECTIVE"
}
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not
valid."
}
]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 755
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."
}
]
}

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

756 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": {
"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"
}
}
}
]
}

Endpoints 757
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"
}
}
}

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"
}
}
}

758 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Adds a quality process as a reference to a ticket.
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."
}
]
}

DELETE Ticket Remove Quality Process

Association
/tickets/<GUID>/quality/<GUID>

Endpoints 759
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

GET Ticket Tickets

/tickets/<GUID>/tickets

760 Arena REST API Developer Guide

/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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"
}
},
{
"guid": "5N7Q9M7YLO5ZI1K2GJIL",
"ticket": {

Endpoints 761
 "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"
}
}

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": {

762 Arena REST API Developer Guide

 "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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Adds a ticket as a reference to a ticket.
POST <url>/tickets/<GUID>/tickets
{
"guid": "7P9SBO90NQ71K3M4ILKN",
"ticket": {
"guid": "GYI1KXI9WZGVEXGZI0K9",
"number": "DEF-000002"
}
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"M4O7QY5R7FY8RATAYXNX\" is not
valid."
}
]
}

DELETE Ticket Remove Ticket

Association
/tickets/<GUID>/tickets/<GUID>

Endpoints 763
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

764 Arena REST API Developer Guide

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.

Endpoints 765
Searchable Attributes
Name Value Description
name string The name of the Trigger.
resource string The resource of the
Trigger. Currently
supported resources:
ITEM
REQUEST
CHANGE
QUALITY
action string The action of the Trigger.
Supported actions:
CREATE
EDIT
WORKFLOW

766 Arena REST API Developer Guide

 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.
For additional attribute field type MULTI_LINE_TEXT searches, different
values can be separated with an asterisk.
For additional attribute field types DROP_DOWN & FIXED_DROP_DOWN
searches, different values can be separated with a semi-colon.
When using a semi-colon to separate values in a FIXED_DROP_DOWN
search, note that the semi-colon will always act as an OR. This is relevant
when performing a Multi-Select search.
For example with FIXED_DROP_DOWN, multiselect = True: GET /Items?
J1L49Y281EVDWFUXRSCZ=Option 1;Option 2 will return all Items where
the FIXED_DROP_DOWN contains Option 1 OR Option 2 (or both). On the
other hand FIXED_DROP_DOWN, multiselect=False: GET /items?
J1L49Y281EVDWFUXRSCZ=Option 1;Option 2 will return all Items where
the FIXED_DROP_DOWN equals Option 1 OR Option 2.
Search in Zulu format is supported for custom attribute field type Date.
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
400 Failure

Response Header
Name Value Description
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions

Endpoints 767
Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",
"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"
},

768 Arena REST API Developer Guide

 "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",
"resource": "ITEM"
},
{
"action": "CREATE",
"creationDatetime": "2023-01-26T03:43:21Z",
"creator": {
"email": null,
"fullName": "Heidi Walker",
"guid": "9RBUZOR8OFWFYH0JSIPJ"

Endpoints 769
 },
"description": null,
"guid": "R9TCH69Q6X85O7Q9SBT0",
"lastModifiedDateTime": null,
"modifyUser": null,
"name": "Create Requests",
"resource": "REQUEST"
}
]
}
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"
}
]
}

GET Trigger
/settings/integrations/triggers/<GUID>
Returns a Trigger with a given GUID.

770 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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 Reports transitioning from the Corrective
Action
Plan Approved? step to the Corrective Action step.",
"guid": "L3N6P2NE14FCVEXGZIIQ",
"lastModifiedDateTime": null,
"modifyUser": null,

Endpoints 771
 "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"
}
]
}

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.

772 Arena REST API Developer Guide

 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.
GET calls that include Object numbers that include a percentage character, %,
must encode the percentage as %25 in order to return results.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all outbound event integrations
GET /outboundevents
{
"count": 3,
"results": [
{
"creationDateTime": "2021-07-29T23:00:02Z",
"creator": {
"email": "cstone@[Link]",
"fullName": "Craig Stone",
"guid": "FXH0JWH8VYFYH0J25014"
},

Endpoints 773
 "enabled": false,
"guid": "5D2V6J4VILWUDWFYH3FBG",
"lastModifiedDateTime": "2021-08-01T21:41:31Z",
"modifyUser": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "EveryHome Outbound Event Integration Clovex",
"status": "NEEDS_ATTENTION"
},
{
"creationDateTime": "2021-07-20T23:32:02Z",
"creator": {
"email": "cstone@[Link]",
"fullName": "Craig Stone",
"guid": "FXH0JWH8VYFYH0J25014"
},
"enabled": true,
"guid": "2K4N6J4VILWUDWFYH3YT",
"lastModifiedDateTime": "2021-08-06T21:41:31Z",
"modifyUser": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "EveryHome Outbound Event Integration",
"status": "NEEDS_ATTENTION"
},
{
"creationDateTime": "2021-07-28T12:32:02Z",
"creator": {
"email": "cstone@[Link]",
"fullName": "Craig Stone",
"guid": "FXH0JWH8VYFYH0J25014"
},
"enabled": false,
"guid": "M4O7QY5R7FY8RATAYXNX",
"lastModifiedDateTime": "2021-08-12T21:41:31Z",
"modifyUser": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "EveryHome Outbound Event Gamma Integration",
"status": "NEEDS_ATTENTION"
}
]
}
Get outbound events integrations that are enabled

774 Arena REST API Developer Guide

GET <url>/outboundevents?enabled=true
{
"count": 1,
"results": [
{
"creationDateTime": "2021-07-20T23:32:02Z",
"creator": {
"email": "cstone@[Link]",
"fullName": "Craig Stone",
"guid": "FXH0JWH8VYFYH0J25014"
},
"enabled": true,
"guid": "2K4N6J4VILWUDWFYH3YT",
"lastModifiedDateTime": "2021-08-06T21:41:31Z",
"modifyUser": {
"email": "hwalker@[Link]",
"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 \"transferType\"
is not valid."
}
]
}

GET Outbound-Event Integrations

/outboundevents/<guid>
Returns a specific outbound event integration matching the given GUID.

Endpoints 775
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific outbound event integration.
GET /outboundevents/<GUID>
{
"creationDateTime": "2021-07-20T23:32:02Z",
"creator": {
"email": "cstone@[Link]",
"fullName": "Craig Stone",
"guid": "FXH0JWH8VYFYH0J25014"
},
"enabled": true,
"guid": "2K4N6J4VILWUDWFYH3YT",
"lastModifiedDateTime": "2021-08-06T21:41:31Z",
"modifyUser": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},

776 Arena REST API Developer Guide

 "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."
}
]
}

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

Endpoints 777
Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"
},
{
"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"
}
]
}

GET Outbound-Event Integration Trigger

/outboundevents/<GUID>/triggers/<GUID>

778 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"
}
Request with an invalid GUID.
{
"status":400,

Endpoints 779
 "errors":[
{
"code":3011,
"message":"The guid \"5N7Q9M7YL0Z6P8RATFCI\" is not
valid."
}
]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the integration administrators of a specific outbound events integration.

780 Arena REST API Developer Guide

GET /outboundevents/<GUID>/administrators
{
"count": 3,
"results": [
{
"email": "rborger@[Link]",
"fullName": "Rachael Borger",
"guid": "VDXGZCXOBEVEXGZIRHOJ"
},
{
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
{
"email": "ecanard@[Link]",
"fullName": "Eleanor Canard",
"guid": "1J3M5I3UHK1K3M5OXNUV"
}
]
}
Request with an invalid GUID.
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"5D7Q9M7YL0Z6P8RATBDS\" is not
valid."
}
]
}

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

Endpoints 781
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

782 Arena REST API Developer Guide

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": "hwalker@[Link]",
"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": "hwalker@[Link]",
"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",

Endpoints 783
 "name": "Corrective Action Report: Plan Step
Approval",
"resource": "QUALITY"
}
]
},
{
"creationDateTime": "2021-08-26T22:28:58Z",
"creator": {
"email": "hwalker@[Link]",
"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": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"eventType": "OUTBOUND_EVENT",
"guid": "4M6P8L6XKNYYH0J2L10Y",
"resourcesReconciled": true,

784 Arena REST API Developer Guide

 "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"
}
]
},
{
"creationDateTime": "2021-08-18T18:22:56Z",
"creator": {
"email": "hwalker@[Link]",
"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": "hwalker@[Link]",
"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

Endpoints 785
 lifecycle status of Submitted or Approved to Effective.",
"guid": "M4O7Q3OF25GDWFYH0JPT",
"name": "Manufacturing Change Order Release",
"resource": "CHANGE"
}
]
}
]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific outbound-event integration event.

786 Arena REST API Developer Guide

GET /outboundevents/<GUID>/events/<GUID>
{
"creationDateTime": "2021-08-26T22:28:58Z",
"creator": {
"email": "hwalker@[Link]",
"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"
}
]
}
Request with an invalid GUID.
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"5N7Q9M7YL0Z6P8RATFCI\" is not
valid."
}
]
}

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.

Endpoints 787
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get item-events from a specific event from a specific outbound-event integration.

788 Arena REST API Developer Guide

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": "6O8RAN8ZMP0ZI1KQT6D7",
"item": {
"guid": "DVFYHUF6TWFN6KA8FX5O"
},
"postEvents": [
{
"guid": "DVFYHUF6TWFN6KA8FX5O"
}
],
"preEvents": [],
"reconciled": false
},
{
"guid": "7P9SBO90NQ10J2LRU7EI",
"item": {
"guid": "N5P8R4PG36PXGUKIP7FL"
},
"postEvents": [
{
"guid": "N5P8R4PG36PXGUKIP7FL"
}
],
"preEvents": [],
"reconciled": false
},
{
"guid": "8QATCPA1OR21K3MSV8FZ",
"item": {
"guid": "YG0J2F0REH08R5VT0IPU"
},
"postEvents": [
{
"guid": "YG0J2F0REH08R5VT0IPU"
}
],
"preEvents": [],
"reconciled": false
},
{
"guid": "9RBUDQB2PS32L4NTW9GN",
"item": {
"guid": "8QATCPA1ORAI1F53ASZV"

Endpoints 789
 },
"postEvents": [
{
"guid": "8QATCPA1ORAI1F53ASZV"
}
],
"preEvents": [],
"reconciled": false
},
{
"guid": "5N7Q9M7YLOZYH0JPS5C1",
"item": {
"guid": "3L5O7K5WJM5DWA0Y5NV6"
},
"postEvents": [
{
"guid": "3L5O7K5WJM5DWA0Y5NV6"
}
],
"preEvents": [],
"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": "6O8RAN8ZMP0ZI1KQT6D7",
"item": {
"guid": "DVFYHUF6TWFN6KA8FX5O"
},
"postEvents": [
{
"guid": "DVFYHUF6TWFN6KA8FX5O"
}
],
"preEvents": [],
"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

790 Arena REST API Developer Guide

{
"count": 5,
"results": [
{
"guid": "L3N6P2NE14FEXGZ58LRG",
"item": {
"guid": "8QATCPA1ORAI1F53ASVR"
},
"postEvents": [
{
"category": {
"guid": "N5P8R4PG36PZI1GNNOAT"
}
}
],
"preEvents": [
{
"category": {
"guid": "R9TCV8TK7AT3M5KRRSDZ"
}
}
],
"reconciled": false
},
{
"guid": "M4O7Q3OF25GFYH069MSP",
"item": {
"guid": "3L5O7K5WJM5DWA0Y5NPU"
},
"postEvents": [
{
"category": {
"guid": "N5P8R4PG36PZI1GNNOAT"
}
}
],
"preEvents": [
{
"category": {
"guid": "R9TCV8TK7AT3M5KRRSDZ"
}
}
],
"reconciled": false
},
{
"guid": "N5P8R4PG36HGZI17ANTX",
"item": {
"guid": "DVFYHUF6TWFN6KA8FXZI"
},
"postEvents": [

Endpoints 791
 {
"category": {
"guid": "N5P8R4PG36PZI1GNNOAT"
}
}
],
"preEvents": [
{
"category": {
"guid": "R9TCV8TK7AT3M5KRRSDZ"
}
}
],
"reconciled": false
},
{
"guid": "O6Q9S5QH47IH0J28BOUD",
"item": {
"guid": "SAUDW9UL8BU2LZPNUCFO"
},
"postEvents": [
{
"category": {
"guid": "N5P8R4PG36PZI1GNNOAT"
}
}
],
"preEvents": [
{
"category": {
"guid": "R9TCV8TK7AT3M5KRRSDZ"
}
}
],
"reconciled": false
},
{
"guid": "P7RAT6RI58JI1K39CPVA",
"item": {
"guid": "I0K3MZKBY1KSBPFDK25Z"
},
"postEvents": [
{
"category": {
"guid": "N5P8R4PG36PZI1GNNOAT"
}
}
],
"preEvents": [
{
"category": {

792 Arena REST API Developer Guide

 "guid": "R9TCV8TK7AT3M5KRRSDZ"
}
}
],
"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.
GET /outboundevents/<GUID>/events/<GUID>/items/<GUID>
{
"guid": "P7RAT6RI58JI1K39CPVA",
"item": {
"guid": "I0K3MZKBY1KSBPFDK25Z"
},
"postEvents": [
{
"category": {
"guid": "N5P8R4PG36PZI1GNNOAT"
}
}
],
"preEvents": [
{
"category": {
"guid": "R9TCV8TK7AT3M5KRRSDZ"
}
}
],
"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.
GET /outboundevents/<GUID>/events/<GUID>/
items?reconciled=false
{
"count": 5,
"results": [
{
"guid": "GYI1KXI9WZA9SBU03GM5",
"item": {
"guid": "3L5O7K5WJM5DWA0Y5NV6"
},

Endpoints 793
 "postEvents": [
{
"lifecyclePhase": {
"guid": "4M6P8L6XKN58RATCU9I6",
"name": "Concept"
}
}
],
"preEvents": [
{
"lifecyclePhase": {
"guid": "9RBUDQB2PSADWFYH0AUY",
"name": "Unreleased"
}
}
],
"reconciled": false
},
{
"guid": "HZJ2LYJAX0BATCV14HNN",
"item": {
"guid": "DVFYHUF6TWFN6KA8FX5O"
},
"postEvents": [
{
"lifecyclePhase": {
"guid": "4M6P8L6XKN58RATCU9I6",
"name": "Concept"
}
}
],
"preEvents": [
{
"lifecyclePhase": {
"guid": "9RBUDQB2PSADWFYH0AUY",
"name": "Unreleased"
}
}
],
"reconciled": false
},
{
"guid": "I0K3MZKBY1CBUDW25IOZ",
"item": {
"guid": "N5P8R4PG36PXGUKIP7FL"
},
"postEvents": [
{
"lifecyclePhase": {
"guid": "4M6P8L6XKN58RATCU9I6",
"name": "Concept"

794 Arena REST API Developer Guide

 }
}
],
"preEvents": [
{
"lifecyclePhase": {
"guid": "9RBUDQB2PSADWFYH0AUY",
"name": "Unreleased"
}
}
],
"reconciled": false
},
{
"guid": "J1L4N0LCZ2DCVEX36JPA",
"item": {
"guid": "YG0J2F0REH08R5VT0IPU"
},
"postEvents": [
{
"lifecyclePhase": {
"guid": "4M6P8L6XKN58RATCU9I6",
"name": "Concept"
}
}
],
"preEvents": [
{
"lifecyclePhase": {
"guid": "9RBUDQB2PSADWFYH0AUY",
"name": "Unreleased"
}
}
],
"reconciled": false
},
{
"guid": "K2M5O1MD03EDWFY47KQJ",
"item": {
"guid": "8QATCPA1ORAI1F53ASZV"
},
"postEvents": [
{
"lifecyclePhase": {
"guid": "4M6P8L6XKN58RATCU9I6",
"name": "Concept"
}
}
],
"preEvents": [
{

Endpoints 795
 "lifecyclePhase": {
"guid": "9RBUDQB2PSADWFYH0AUY",
"name": "Unreleased"
}
}
],
"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": "K2M5O1MD03EDWFY47KQJ",
"item": {
"guid": "8QATCPA1ORAI1F53ASZV"
},
"postEvents": [
{
"lifecyclePhase": {
"guid": "4M6P8L6XKN58RATCU9I6",
"name": "Concept"
}
}
],
"preEvents": [
{
"lifecyclePhase": {
"guid": "9RBUDQB2PSADWFYH0AUY",
"name": "Unreleased"
}
}
],
"reconciled": false
}

GET Outbound-Event Integration

Requests Event
/outboundevents/<GUID>/events/<GUID>/requests
/outboundevents/<GUID>/events/<GUID>/requests/<GUID>

796 Arena REST API Developer Guide

Returns requests results from a specific event specified by triggers from an
outbound-event integration.
Appending a GUID to the URL returns the specific request result guid from that
event.
The examples below will display responses for events generated by triggers that
contain Requests 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 797
Sample Response Body
Get request-events from a specific event from a specific outbound-event
integration.
The results are generated by a trigger with Requests as a resource and Edit as an
action. In the lone event, specific request attributes were edited.
GET /outboundevents/<GUID>/events/<GUID>/
requests?reconciled=false
{
"count": 1,
"results": [
{
"guid": "3L5OTIL2I9KJ2L4F5NZE",
"postEvents": [
{
"category": {
"guid": "SAUDI7AR7YHRAT5C5MA6"
},
"requestCode": "Performance",
"title": "Metal Chrome is tarnishing in model
400 Q Series"
}
],
"preEvents": [
{
"category": {
"guid": "TBVEJ8BS8ZISBU6D6NBD"
},
"requestCode": "Manufacturability",
"title": "Metal Chrome is tarnishing in model
400"
}
],
"reconciled": false
}
]
}
Get general request-events from a specific outbound-event integration.
The results below are generated by a trigger with Request as a resource and Edit
as an action. In the lone event below, eight items were added to the Request.
GET /outboundevents/<GUID>/events/<GUID>/requests
{
"count": 1,
"results": [
{
"guid": "8QATYNQ7NEPO7Q9KAS4H",
"postEvents": [
{

798 Arena REST API Developer Guide

 "guid": "8QATYNQ7NERQ9STMWPOS",
"item": {
"guid": "Q8SBG58P5WFN6K27H9VN",
"name": "Resistor, 10K Ohm, 1/16W, 5%,
0402, SMD",
"number": "180-00001",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE"
},
"notes": "For the Winter release"
},
{
"guid": "9RBUZOR8OFSRATUNXQPV",
"item": {
"guid": "0I2LQFIZF6PXGUCHRJ37",
"name": "Resistor, 1K Ohm, 1/16W, 5%,
0402, SMD",
"number": "180-00002",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE"
},
"notes": "Prototype for 2024"
},
{
"guid": "ASCV0PS9PGTSBUVOYRQ2",
"item": {
"guid": "GYI16VYFVM5DWASX7YF6",
"name": "Resistor, 100 Ohm, 1/10W, 5%,
0603, SMD",
"number": "180-00003",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE"
},
"notes": null
},
{
"guid": "BTDW1QTAQHUTCVWPZSRR",
"item": {
"guid": "GYI16VYFVM5DWASX7YD4",
"name": "Resistor, 51K Ohm, 1/10W, 5%,
0603, SMD",
"number": "180-00004",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE"
},
"notes": null
},
{
"guid": "CUEX2RUBRIVUDWXQ0TSI",
"item": {
"guid": "GYI16VYFVM5DWASX7YB2",

Endpoints 799
 "name": "Resistor, 470k, Thick Film, 0.1W,
5%, 0603, SMD",
"number": "180-00005",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE"
},
"notes": null
},
{
"guid": "DVFY3SVCSJWVEXYR1UTV",
"item": {
"guid": "GYI16VYFVM5DWASX7Y7W",
"name": "Resistor, 470 Ohm, 1/10W, 5%,
0603, SMD",
"number": "180-00006",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE"
},
"notes": null
},
{
"guid": "EWGZ4TWDTKXWFYZS2VUV",
"item": {
"guid": "BTDW1QTAQH08R5NS2TV5",
"name": "Resistor, 220k, Thick Film, 0.1W,
5%, 0603, SMD",
"number": "180-00007",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE"
},
"notes": null
},
{
"guid": "FXH05UXEULYXGZ0T3WVK",
"item": {
"guid": "GYI16VYFVM5DWASX7YZO",
"name": "Resistor, 1M Ohm, 1/16W, 5%,
0402, SMD",
"number": "180-00008",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE"
},
"notes": null
}
],
"preEvents": [],
"reconciled": false
}
]
}

800 Arena REST API Developer Guide

Get a specific request event from a specific outbound-event integration.
The results from the specific event are generated by a trigger with Requests as a
resource and edit as an action. The specific event below details the editing of core
attributes and custom attributes (additional attributes) within the Request.
GET /outboundevents/<GUID>/events/<GUID>/requests/
<GUID>
{
"guid": "N5P8D25M2T43M5OZP7I8",
"postEvents": [
{
"additionalAttributes": [
{
"apiName": "O6Q9E36N3UBTCVCZLWDP",
"fieldType": "FIXED_DROP_DOWN",
"guid": "O6Q9E36N3UBTCVCZLWDP",
"name": "Urgency",
"value": "Critical"
},
{
"apiName": "P7RAF47O4VCUDWD0MXE8",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "P7RAF47O4VCUDWD0MXE8",
"name": "Expected Completion Date",
"value": "31/10/2024"
}
],
"category": {
"guid": "SAUDI7AR7YHRAT5C5MA6"
},
"problem": "We need to reproduce the Ferrite Cores
used
in the Project 9708",
"requestedAction": "Use The Artemis notes to relayer
the fibers
based on the 1874 Archives."
}
],
"preEvents": [
{
"additionalAttributes": [
{
"apiName": "O6Q9E36N3UBTCVCZLWDP",
"fieldType": "FIXED_DROP_DOWN",
"guid": "O6Q9E36N3UBTCVCZLWDP",
"name": "Urgency",
"value": null
},
{
"apiName": "P7RAF47O4VCUDWD0MXE8",

Endpoints 801
 "fieldType": "SINGLE_LINE_TEXT",
"guid": "P7RAF47O4VCUDWD0MXE8",
"name": "Expected Completion Date",
"value": null
}
],
"category": {
"guid": "1J3MRGJ0G7Q0J2ELEVIF"
},
"problem": "We need to reproduce the Ferrite Cores
used
in the Apollo Program",
"requestedAction": "Use The Artemis notes to relayer
the fibers"
}
],
"reconciled": false
}
Get a specific request-event from a specific event from a specific outbound-event
integration.
The specific result from the event below is generated by a trigger with Requests as
a resource and edit as an action. In the specific event below details the addition of
five items with a category of capacitor to a Request.
GET /outboundevents/<GUID>/events/<GUID>/requests/
<GUID>
{
"guid": "CUEX2RUBRITSBUDOEW82",
"postEvents": [
{
"guid": "GYI16VYFVMZYH01U4XW3",
"item": {
"guid": "5N7QVKN4KBU2LZHMWMFM",
"name": "Capacitor, Ceramic Chip, 0.1uF",
"number": "120-00001",
"revisionNumber": "B",
"revisionStatus": "EFFECTIVE"
},
"notes": null
},
{
"guid": "HZJ27WZGWN0ZI12V5YXG",
"item": {
"guid": "6O8RWLO5LCV3M0INXO7N",
"name": "Capacitor, Ceramic Chip, 1.0uF, 1206",
"number": "120-00002",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE"
},
"notes": null

802 Arena REST API Developer Guide

 },
{
"guid": "I0K38X0HXO10J23W6ZY5",
"item": {
"guid": "Q8SBG58P5WFN6K27H8F2",
"name": "Capacitor, Tantalum, 10uF@16V, B pkg",
"number": "120-00003",
"revisionNumber": "A",
"revisionStatus": "EFFECTIVE"
},
"notes": null
},
{
"guid": "J1L49Y1IYP21K34X70ZW",
"item": {
"guid": "ASCV0PS9PGZ7Q4MR1RFC",
"name": "Capacitor, Tantalum, 4.7uF@4V, A pkg",
"number": "120-00004",
"revisionNumber": "B",
"revisionStatus": "EFFECTIVE"
},
"notes": null
},
{
"guid": "K2M5AZ2JZQ32L45Y810O",
"item": {
"guid": "VDXGLADUA1KSBP7CMC5H",
"name": "Capacitor, Ceramic Chip, 0.01uF, 0603",
"number": "120-00005",
"revisionNumber": "B",
"revisionStatus": "EFFECTIVE"
},
"notes": null
}
],
"preEvents": [],
"reconciled": false
}
Get a specific request-event from a specific outbound-event integration.
The results from the specific event below are generated by a trigger with Requests
as a resource and Create as an action. In the event below, a Request is created.
GET /outboundevents/<GUID>/events/<GUID>/requests/
<GUID>
{
"guid": "2K4NSHK1H8JI1K3E4MYD",
"postEvents": [
{
"guid": "0I2LQFIZF6PO7QM64M84"
}

Endpoints 803
 ],
"preEvents": [],
"reconciled": false
}
Get a specific request-event from a specific event from a specific outbound-event
integration.
The specific request event below is generated by a trigger with Requests as a
resource and workflow as an action. In the specific event below, the Request is
moved from the SUBMITTED to PROMOTED lifecycle status.
GET /outboundevents/<GUID>/events/<GUID>/requests/
<GUID>
{
"guid": "4M6PUJM3JALK3M5G6PVS",
"postEvents": [
{
"lifecycleStatus": {
"type": "SUBMITTED" }
}
],
"preEvents": [
{
"lifecycleStatus": {
"type": "PROMOTED"
}
}
],
"reconciled": false
}

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.

804 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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.

Endpoints 805
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
}
]
}

806 Arena REST API Developer Guide

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
}

Endpoints 807
Get change-events from a specific event from a specific outbound-event
integration.
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
}

808 Arena REST API Developer Guide

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

Endpoints 809
Name Value Description
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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
}

810 Arena REST API Developer Guide

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": {
"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": {

Endpoints 811
 "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",
"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"
}

812 Arena REST API Developer Guide

 },
"preEvent": {
"currentStep": {
"guid": "YG0J2F0REH0WFYH0TJ56",
"name": "Corrective Action Plan Approved?"
}
},
"reconciled": false
}

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

Endpoints 813
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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>
{
"guid": "I0K3MZKBY1KSBP7DYNR7",
"postEvent": {
"guid": "I0K3MZKBY1KSBP7DYNR7"
},
"preEvent": null,
"reconciled": true,
"reconciledDatetime": "2021-09-10T23:58:21Z",
"reconciledUser": {
"email": "hwalker@[Link]",
"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
}

814 Arena REST API Developer Guide

PUT Outbound-Event Event Requests
Reconcile
/outboundevents/<GUID>/events/<GUID>/requests/<GUID>
Marks a request 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 reconciled set to true marks a Request 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 815
Sample Responses
Marks as reconciled the specific request within an a specific event of a specific
outbound-event integration.
/outboundevents/<GUID>/events/<GUID>/requests/<GUID>
{
"guid": "N5P8D25M2T43M5OZP7I8",
"postEvents": [
{
"additionalAttributes": [
{
"apiName": "O6Q9E36N3UBTCVCZLWDP",
"fieldType": "FIXED_DROP_DOWN",
"guid": "O6Q9E36N3UBTCVCZLWDP",
"name": "Urgency",
"value": "Critical"
},
{
"apiName": "P7RAF47O4VCUDWD0MXE8",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "P7RAF47O4VCUDWD0MXE8",
"name": "Expected Completion Date",
"value": "31/10/2024"
}
],
"category": {
"guid": "SAUDI7AR7YHRAT5C5MA6"
},
"problem": "We need to reproduce the Ferrite Cores
used
in the Project 9708",
"requestedAction": "Use The Artemis notes to relayer
the fibers
based on the 1874 Archives."
}
],
"preEvents": [
{
"additionalAttributes": [
{
"apiName": "O6Q9E36N3UBTCVCZLWDP",
"fieldType": "FIXED_DROP_DOWN",
"guid": "O6Q9E36N3UBTCVCZLWDP",
"name": "Urgency",
"value": null
},
{
"apiName": "P7RAF47O4VCUDWD0MXE8",
"fieldType": "SINGLE_LINE_TEXT",
"guid": "P7RAF47O4VCUDWD0MXE8",

816 Arena REST API Developer Guide

 "name": "Expected Completion Date",
"value": null
}
],
"category": {
"guid": "1J3MRGJ0G7Q0J2ELEVIF"
},
"problem": "We need to reproduce the Ferrite Cores
used
in the Apollo Program",
"requestedAction": "Use The Artemis notes to relayer
the fibers"
}
],
"reconciled": true,
"reconciledDatetime": "2022-11-24T08:46:45Z",
"reconciledUser": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "9RBUZOR8OFWFYH0JSIPJ"
}
}
If the request body has a reconciled value of false, the response would resemble
below.
{
"guid": "4M6PUJM3JALK3M5G6PVS",
"postEvents": [
{
"lifecycleStatus": {
"type": "SUBMITTED"
}
}
],
"preEvents": [
{
"lifecycleStatus": {
"type": "PROMOTED"
}
}
],
"reconciled": false
}

PUT Outbound-Event Event Change

Reconcile
/outboundevents/<GUID>/events/<GUID>/changes/<GUID>

Endpoints 817
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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>

818 Arena REST API Developer Guide

{
"guid": "SAUDW9UL8BUXGYEEGQCB",
"postEvent": {
"lifecycleStatus": {
"type": "APPROVED"
}
},
"preEvent": {
"lifecycleStatus": {
"type": "SUBMITTED_FOR_APPROVAL"
}
},
"reconciled": true,
"reconciledDatetime": "2021-09-11T01:02:18Z",
"reconciledUser": {
"email": "hwalker@[Link]",
"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
}

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.

Endpoints 819
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
Marks as reconciled the specific quality process within an a specific event of a
specific outbound-event integration.
/outboundevents/<GUID>/events/<GUID>/qualityprocesses/
<GUID>
{
"guid": "UCWFYBWNADWSBUDWPF1I",
"postEvent": {
"currentStep": {
"guid": "ZH1K3G1SFI1XGZI1UK6H",

820 Arena REST API Developer Guide

 "name": "Corrective Action"
}
},
"preEvent": {
"currentStep": {
"guid": "YG0J2F0REH0WFYH0TJ56",
"name": "Corrective Action Plan Approved?"
}
},
"reconciled": true,
"reconciledDatetime": "2021-09-11T01:06:50Z",
"reconciledUser": {
"email": "hwalker@[Link]",
"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
}

GET Recent Activity - User Access

/settings/recentactivities/useraccesses
Returns an array of Login on page 1134 objects.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Endpoints 821
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
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

822 Arena REST API Developer Guide

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":"[Link]",
"duration":265,
"loginDateTime":"2016-09-03T22:57:02Z",
"logoutDateTime":"2016-09-03T22:59:12Z",
"originatingIp":"[Link]",
"user":{
"email":"hwalker@[Link]",
"fullName":"Heidi Walker",
"guid":"7P9S6379K1KUDW8FUIY9"
}
},
…
]
}

GET Recent Activity - Exports

/settings/recentactivities/exports
Returns an array of Export Event on page 1113 objects.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Endpoints 823
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
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

824 Arena REST API Developer Guide

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":"hwalker@[Link]",
"fullName":"Heidi Walker",
"guid":"7P9S6379K1KUDW8FUIY9"
}
},
…
]
}

GET Recent Activity - Report Runs

/settings/recentactivities/reportruns
Returns an array of Report Run on page 1142 objects.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Endpoints 825
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
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

826 Arena REST API Developer Guide

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":"hwalker@[Link]",
"fullName":"Heidi Walker",
"guid":"7P9S6379K1KUDW8FUIY9"
}
},
…
]
}

GET Recent Activity - File Access

/settings/recentactivities/fileaccesses
Returns an array of File Access Event on page 1117 objects.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Endpoints 827
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
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

828 Arena REST API Developer Guide

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":"hwalker@[Link]",
"guid":"7P9S6379K1KUDW8FUIY9",
"fullName":"Heidi Walker"
}
}
},
…
]
}

GET Item Attributes

/settings/items/attributes
/settings/items/attributes/<GUID>
Returns Attributes on page 1095 available for Items. By adding a valid Item
Attribute GUID at the end of the URL, the endpoint returns a single unique Item
attribute.

Endpoints 829
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.
If this is set to false, it
returns only non-creatable
sattributes.
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

830 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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,

Endpoints 831
 "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":"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",

832 Arena REST API Developer Guide

 "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,
"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
},

Endpoints 833
 {
"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,
"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

834 Arena REST API Developer Guide

 },
{
"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,
"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",

Endpoints 835
 "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,
"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
}

836 Arena REST API Developer Guide

GET BOM Attributes
/settings/items/bom/attributes
Returns Attributes on page 1095 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.
creatableOnly true or false If this is set to true, it
returns only creatable
attributes, which are
settable during creation of
a BOM.
If this is set to false, it
returns only non-creatable
attributes.

Endpoints 837
Name Value Description
editableOnly true or false If this is set to true, it
returns only editable
attributes, which are
settable during update of
a BOM. 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
BOMs.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all BOM attributes with possible values included
GET /settings/items/bom/
attributes?includePossibleValues=true
{
"count":7,
"results":[
{
"active":true,
"allowsExplicitNullValue":true,
"apiName":"4M6P8GPPM3K2L4N6P8I6",

838 Arena REST API Developer Guide

 "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,
"required":false,
"searchable":false
},

Endpoints 839
 {
"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
}
]
}

840 Arena REST API Developer Guide

GET Item Categories
/settings/items/categories
/settings/items/categories/<GUID>
This returns Category on page 1099 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

Endpoints 841
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
[Link]
[Link]/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

842 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": "hwalker@[Link]",
"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",

Endpoints 843
 "mark":"dd Compliance Mark 2",
"rationale":"dd Rationale 2",
"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": "hwalker@[Link]",
"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": "hwalker@[Link]",
"fullName":"Heidi Walker",
"guid": "4M6P8GPPM3K3M507QMJ9"
},
"description":null,
"guid":"I0K38Y01EDW6P8KSGNS2",
"level":3,
"name":"Artwork - SmartHOME",
"numberFormat":{
"guid":"P7Q9SBU3M5LMFGCG"
},

844 Arena REST API Developer Guide

 "path":"Item\Document\Artwork",
"parentCategory": {
"guid": "ADT9879H3W6182WND"
},
"requirements":[],
"structural": false,
"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": "hwalker@[Link]",
"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",

Endpoints 845
 "name":"RoHS (2002/95/EC)"
},
"status":"UNKNOWN"
}
],
"structural": false,
"systemDefined": true
},
{
"activated":true,
"assignable":true,
"creationDateTime":"2008-03-05T13:26:37Z",
"creator":{
"email": "hwalker@[Link]",
"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": "hwalker@[Link]",
"fullName":"Heidi Walker",
"guid": "4M6P8GPPM3K3M507QMJ9"
},
"description":null,
"guid":"I0K38Y01EDW6P8KSGNS2",
"level":3,
"name":"Artwork - SmartHOME",
"numberFormat":{
"guid":"P7Q9SBU3M5LMFGCG"
},
"path":"Item\Document\Artwork",
"parentCategory": {
"guid": "ADT9879H3W6182WND"
},

846 Arena REST API Developer Guide

 "requirements":[],
"structural": false,
"systemDefined": false
},
{
"activated":true,
"assignable":false,
"creationDateTime":"2008-03-05T13:27:31Z",
"creator":{
"email": "hwalker@[Link]",
"fullName":"Heidi Walker",
"guid": "4M6P8GPPM3K3M507QMJ9"
},
"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": "hwalker@[Link]",
"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":[],

Endpoints 847
 "structural": false,
"systemDefined": false
},
...
]
}
Get all item categories that begin with A
GET settings/items/categories?path=item\A
{
"count":6,
"results":[
{
"activated":true,
"assignable":false,
"creationDateTime":"2011-02-05T01:05:49Z",
"creator":{
"email": "hwalker@[Link]",
"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": "hwalker@[Link]",
"fullName":"Heidi Walker",
"guid": "4M6P8GPPM3K3M507QMJ9"
},
"description":"Shippable ERGPS Product Assemblies",
"guid":"0I2L4CLLIZISBUDUIUI5",
"level":3,
"name":"Finished Good",
"numberFormat":{
"guid":"VDXGZ7GGDUDM5O7OL7R3"

848 Arena REST API Developer Guide

 },
"path":"Item\Assembly\Finished Good",
"parentCategory": {
"guid": "EWGZ4UWXA9S2L4G0CJNL"
},
"requirements":[],
"structural": false,
"systemDefined":false
},
...
]
}
Get a single item category
GET /settings/items/categories/UCWFKABBKRAK3MY6UNTU
{
"activated":true,
"assignable":true,
"creationDateTime":"2008-03-04T22:56:04Z",
"creator":{
"email": "hwalker@[Link]",
"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

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

GET Item Category Attributes

/settings/items/categories/<GUID>/attributes
This returns Attributes on page 1095 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.
creatableOnly true or false If this is set to true, it
returns only creatable
attributes, which are
settable during creation of
an item.
If this is set to false, it
returns only non-creatable
attributes.

850 Arena REST API Developer Guide

Name Value Description
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 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

GET all attributes for a given category with possible values included
/settings/items/categories/<GUID>/
attributes?includePossibleValues=true
{
"count": 31,
"results": [
{
"active": true,
"allowsExplicitNullValue": true,
"apiName": "M4O7Q3OF25M4N6NM8LYP",

Endpoints 851
 "creatable": true,
"custom": true,
"deleted": false,
"editable": true,
"fieldType": "SINGLE_LINE_TEXT",
"global": false,
"guid": "M4O7Q3OF25M4N6NM8LYP",
"maxLength": 1000,
"name": "Material",
"origin": {
"guid": "5N7Q9M7YLO7H0JY556SY",
"name": "Fabricated Plastic"
},
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": false
},
{
"active": true,
"allowsExplicitNullValue": true,
"apiName": "ZH1K3G1SFIZH0JY14JDN",
"creatable": true,
"custom": true,
"defaultValue": "No",
"deleted": false,
"editable": true,
"example": "Yes/No",
"fieldType": "FIXED_DROP_DOWN",
"global": true,
"guid": "ZH1K3G1SFIZH0JY14JDN",
"multiSelect": false,
"name": "Orderable",
"origin": {
"guid": "2K4N6J4VIL4EXGV223NP",
"name": "-uncategorized-"
},
"possibleValues": [
"Yes",
"No",
"N/A"
],
"required": false,
"revisionControlled": true,
"searchable": true,
"visibleWhenBlank": false
},
{
"allowsExplicitNullValue": false,
"apiName": "category",
"creatable": true,

852 Arena REST API Developer Guide

 "custom": false,
"developerNotes": "Defaults to -uncategorized- if no
default is set",
"editable": true,
"fieldType": "OBJECT",
"global": true,
"guid": "7P9SBO90NQ8VEXGZI1KH",
"inViews": [
"ITEM_SPECS"
],
"name": "Category",
"origin": {
"guid": "2K4N6J4VIL4EXGV223NP",
"name": "-uncategorized-"
},
"required": false,
"searchable": true
},
...
}
]
}
Request with bad GUID
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

GET Item Category Attributes

/settings/items/categories/<GUID>/attributes
This returns Attributes on page 1095 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.

Endpoints 853
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

GET all attributes for a given category with possible values included
/settings/items/categories/<GUID>/
attributes?includePossibleValues=true
{
"count": 32,
"results": [
{

854 Arena REST API Developer Guide

 "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,
"searchable": true
},

Endpoints 855
 {
"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,

856 Arena REST API Developer Guide

 "fieldType": "DATETIME",
"global": true,
"inViews": [
"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",

Endpoints 857
 "global": true,
"inViews": [
"ITEM_SPECS"
],
"searchable": false
},
{
"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."
}
]
}

GET Item Number Formats

/settings/items/numberformats
/settings/items/numberformats/<GUID>
This returns Compact Item Number Formats on page 1123. Appending a GUID to
the URL returns an Item Number Format on page 1122 (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)

858 Arena REST API Developer Guide

• 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"
},

Endpoints 859
 {
"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
/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":[

860 Arena REST API Developer Guide

 {
"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":[

],
"type":"AUTO_SEQUENCE",
"value":null
}
],
"guid":"YG0J2AJJGXGP8RAROAUE",
"name":"Electrical"
}

Endpoints 861
Request with bad GUID
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

GET Item Lifecycle Phases

/settings/items/lifecyclephases
This returns all Item Lifecycle Phases on page 1122 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

862 Arena REST API Developer Guide

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
},
{
"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",

Endpoints 863
 "shortName":"Obs",
"stage":"PRODUCTION",
"used":false
},
{
"active":true,
"guid":"6O8RAIRRO5NQ9SBUDS87",
"name":"Unreleased",
"shortName":"Unrel",
"stage":"PRELIMINARY",
"used":true
}
]
}

GET Item Compliance Requirements

/settings/items/requirements
/settings/items/requirements/<GUID>
Returns Compliance Requirements on page 1109 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

864 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all compliance requirements for items in the workspace
GET /settings/items/requirements
{
"count":5,
"results":[
{
"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",

Endpoints 865
 "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)",
"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."
}
]
}

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.

866 Arena REST API Developer Guide

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

Endpoints 867
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": [

868 Arena REST API Developer Guide

 "EXPORT_SUMMARY"
],
"required": false,
"searchable": false
},
{
"allowsExplicitNullValue": false,
"apiName": "description",
"creatable": true,
"editable": false,
"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"
],

Endpoints 869
 "searchable": true
},
{
"allowsExplicitNullValue": false,
"apiName": "options",
"creatable": true,
"editable": false,
"fieldType": "OBJECT",
"inViews": [
"EXPORT_SUMMARY"
],
"required": false,
"searchable": false
},
{
"allowsExplicitNullValue": false,
"apiName": "world",
"creatable": true,
"editable": false,
"fieldType": "FIXED_DROP_DOWN",
"inViews": [
"EXPORT_SUMMARY"
],
"possibleValues": [
"ITEMS"
],
"required": true,
"searchable": false
}
]
}

GET Requests Categories

/settings/requests/categories
/settings/requests/categories/<GUID>
Returns Categories on page 1099 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

870 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": "[Link]@mzeroofhn@[Link]",
"fullName": "Eprn )Amviz( Nzeroofh",
"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"
},

Endpoints 871
 "path": "Request\\Change Request\\Compliance Change
Request",
"structural": false,
"systemDefined": false
},
{
"activated": true,
"assignable": true,
"creationDateTime": "2008-03-07T19:05:17Z",
"creator": {
"email": "[Link]@mzeroofhn@[Link]",
"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": "[Link]@mzeroofhn@[Link]",
"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": {

872 Arena REST API Developer Guide

 "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": "[Link]@mzeroofhn@[Link]",
"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
}

GET Request Attributes

/settings/requests/attributes
Returns Attributes on page 1095 available for Requests.

Endpoints 873
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 request.
If this is set to false, it
returns only non-creatable
attributes.
editableOnly true or false If this is set to true, it
returns only editable
attributes, which are
settable during update of
a request. 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
requests.

Response Codes
Code Description
200 Success
400 Failure

874 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all request attributes with possible values included
GET /settings/requests/
attributes?includePossibleValues=true

{
"count": 22,
"results": [
{
"allowsExplicitNullValue": false,
"apiName": "category",
"creatable": true,
"custom": false,
"description": "Engineering Change Requests should
have
this assigned category.",
"developerNotes": "Defaults to -uncategorized- if no
default is set",
"editable": true,
"example": "E.g., Engineering Change Requests",
"fieldType": "OBJECT",
"global": true,
"guid": "XFZI1I1HDQ8VEXGZI1EQ",
"inViews": [
"REQUEST_SUMMARY"
],
"name": "Category",
"required": true,
"searchable": true
},
{
"allowsExplicitNullValue": false,
"apiName": "creationDateTime",
"creatable": false,
"custom": false,

Endpoints 875
 "editable": false,
"fieldType": "DATETIME",
"global": true,
"inViews": [
"REQUEST_SUMMARY"
],
"name": "Creation Date",
"searchable": false
},
{
"allowsExplicitNullValue": false,
"apiName": "creator",
"creatable": false,
"custom": false,
"editable": false,
"fieldType": "OBJECT",
"global": true,
"inViews": [
"REQUEST_SUMMARY"
],
"name": "Creator",
"searchable": true
},
...
]
}

GET Request Category Attributes

/settings/requests/categories/<GUID>/attributes
Returns Attributes on page 1095 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

876 Arena REST API Developer Guide

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 request.
If this is set to false, it
returns only non-creatable
attributes.
editableOnly true or false If this is set to true, it
returns only editable
attributes, which are
settable during update of
a request. 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
requests.

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

Endpoints 877
Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all attributes available for a request category with a given GUID
GET /settings/requests/categories/GUID/attributes

{
"count": 19,
"results": [
{
"active": true,
"allowsExplicitNullValue": false,
"apiName": "R9TCVCVB7K1J2L4NMPZV",
"creatable": true,
"custom": true,
"deleted": false,
"editable": true,
"fieldType": "FIXED_DROP_DOWN",
"global": false,
"guid": "R9TCVCVB7K1J2L4NMPZV",
"multiSelect": false,
"name": "Urgency",
"origin": {
"guid": "UCWFYFYEAN6GZI1JVQS0",
"name": "Compliance Change Request"
},
"possibleValues": [
"Critical",
"High",
"Medium",
"Low"
],
"required": true,
"searchable": true
},
{
"allowsExplicitNullValue": false,
"apiName": "category",
"creatable": true,
"custom": false,
"description": "Engineering Change Requests should
have
this assigned category.",

878 Arena REST API Developer Guide

 "developerNotes": "Defaults to -uncategorized- if no
default is set",
"editable": true,
"example": "E.g., Engineering Change Requests",
"fieldType": "OBJECT",
"global": true,
"guid": "XFZI1I1HDQ8VEXGZI1EQ",
"inViews": [
"REQUEST_SUMMARY"
],
"name": "Category",
"origin": {
"guid": "R9TCVCVB7K3DWFYH1HJ5",
"name": "-uncategorized-"
},
"required": true,
"searchable": true
},
{
"allowsExplicitNullValue": false,
"apiName": "creationDateTime",
"creatable": false,
"custom": false,
"editable": false,
"fieldType": "DATETIME",
"global": true,
"inViews": [
"REQUEST_SUMMARY"
],
"name": "Creation Date",
"origin": {
"guid": "R9TCVCVB7K3DWFYH1HJ5",
"name": "-uncategorized-"
},
"searchable": false
},
...
]
}

GET Request Item Attributes

/settings/requests/items/attributes
Returns Attributes on page 1095 available for Requests.

Endpoints 879
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 the
addition of an item to a
request.
If this is set to false, it
returns only non-creatable
attributes.
editableOnly true or false If this is set to true, it
returns only editable
attributes, which are
settable during the update
of a request-item
relationship. 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
requests-item
associations.

Response Codes
Code Description
200 Success
400 Failure

880 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all modified item attributes, showing all possible values
GET /settings/requests/items/
attributes?includePossibleValues=true
{
"count": 3,
"results": [
{
"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",

Endpoints 881
 "creatable": true,
"editable": true,
"fieldType": "MULTI_LINE_TEXT",
"inViews": [
"REQUEST_ITEMS"
],
"maxLength": 4000,
"searchable": false
}
]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

882 Arena REST API Developer Guide

Sample Response Body
Get all requests number prefixes
GET /settings/requests/numbersequenceprefixes
{
"count": 13,
"results": [
{
"guid": "8QATCPA1OR73M5NPBWL9",
"value": "DCR-"
},
{
"guid": "ASCVERC3QT95O7PRDYND",
"value": "ECR-"
},
{
"guid": "CUEXGTE5SVB7Q9RTF0P8",
"value": "MCR-"
},
...
]
}

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

Endpoints 883
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all Request number formats defined for the workspace
/settings/requests/numbersequences
{
"count": 13,
"results": [
{
"creationDateTime": "2008-03-07T18:40:23Z",
"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-"
}
]
},
{

884 Arena REST API Developer Guide

 "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-"
}
]
}

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

Endpoints 885
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the Request administrators of a workspace.
GET /settings/requests/administrators
{
"count": 3,
"results": [
{
"email": "tmakamuri@[Link]",
"fullName": "Toshiro Makamuri",
"guid": "J1L4N0LCZ2J2L4N6F6ZL"
},
{
"email": "jparker@[Link]",
"fullName": "John Parker",
"guid": "XFZI1EZQDGXGZI1KTJQ2"
},
{
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
]
}
Get a specific Request Administrator with a given GUID.
GET /settings/requests/administrators/WEYHODYPCFWFYHOJSIPD

886 Arena REST API Developer Guide

{
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all request evaluator groups
GET /settings/requests/evaluatorgroups
{
"count": 6,

Endpoints 887
 "results": [
{
"guid": "4M6P8L6XKN4L4N6P7X7E",
"name": "Engineering plus Board Supplier"
},
{
"guid": "3L5O7K5WJM3K3M5O5JDC",
"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"
}

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

888 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the Change Administrators of a workspace.
GET /settings/changes/administrators
{
"count": 3,
"results": [
{
"email": "tmakamuri@[Link]",
"fullName": "Toshiro Makamuri",
"guid": "J1L4N0LCZ2J2L4N6F6ZL"
},
{
"email": "jparker@[Link]",
"fullName": "John Parker",
"guid": "XFZI1EZQDGXGZI1KTJQ2"
},
{
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}
]
}
Get a specific Change Administrator with a given GUID.
GET /settings/changes/administrators/WEYHODYPCFWFYHOJSIPD
{
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
}

Endpoints 889
GET Change Administrator
/settings/changes/administrators/<GUID>
If the GET Change Administrators endpoint is appended with a valid guid, it
returns the information of a 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific Change Administrator of a workspace.
GET /settings/changes/administrators/<GUID>
{
"email": "tmakamuri@[Link]",
"fullName": "Toshiro Makamuri",
"guid": "J1L4N0LCZ2J2L4N6F6ZL"
}

890 Arena REST API Developer Guide

GET Change Attributes
/settings/changes/attributes
Returns Attributes on page 1095 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
a change.
If this is set to false, it
returns only non-creatable
attributes.
editableOnly true or false If this is set to true, it
returns only editable
attributes, which are
settable during update of
a change. 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
changes.

Endpoints 891
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",

892 Arena REST API Developer Guide

 "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",
"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",

Endpoints 893
 "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
},
{
"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
},
...
]
}

GET Change Item Attributes

/settings/changes/items/attributes

894 Arena REST API Developer Guide

Returns Attributes on page 1095 (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.
creatableOnly true or false If this is set to true, it
returns only creatable
attributes, which are
settable during the
addition of an item to a
change.
If this is set to false, it
returns only non-creatable
attributes.
editableOnly true or false If this is set to true, it
returns only editable
attributes, which are
settable during updates to
a change-item
relationship. 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
changes-item
associations.

Endpoints 895
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all modified item attributes, showing all possible values
GET /settings/changes/items/
attributes?includePossibleValues=true
{
"count":14,
"results":[
{
"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",

896 Arena REST API Developer Guide

 "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"
],
"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"

Endpoints 897
 ],
"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"
],
"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"

898 Arena REST API Developer Guide

 ],
"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
},
{
"allowsExplicitNullValue":false,
"apiName":"newItemRevision",
"creatable":false,
"custom":false,
"developerNotes":"Item Revision to be made effective",
"editable":false,
"fieldType":"OBJECT",
"inViews":[
"CHANGE_ITEMS"

Endpoints 899
 ],
"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
}
]
}

GET Change Number Prefixes

/settings/changes/numbersequenceprefixes
This returns all Change Number Prefixes on page 1109 available for the
workspace.

900 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all change number prefixes
GET /settings/changes/numbersequenceprefixes
{
"count":7,
"results":[
{
"guid":"QCCLWNGXUH1VAQZSV6XB",
"value":"CCO-"
}
{
"guid":"F54NB3G08DIVT5DZS3FD",
"value":"DEV-"
}
{

Endpoints 901
 "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."
}
]
}

GET Change Category Attributes

/settings/changes/categories/<GUID>/attributes
Returns Attributes on page 1095 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

902 Arena REST API Developer Guide

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 change.
If this is set to false, it
returns only non-creatable
attributes.
editableOnly true or false If this is set to true, it
returns only editable
attributes, which are
settable during update of
an change. 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
changes.

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

Endpoints 903
Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all attributes available for a change category with a given GUID
GET /settings/changes/categories/GUID/attributes
{
"count": 23,
"results": [
{
"allowsExplicitNullValue": true,
"apiName": "approvalDeadlineDateTime",
"creatable": true,
"custom": false,
"editable": true,
"fieldType": "DATETIME",
"global": true,
"inViews": [
"CHANGE_SUMMARY"
],
"name": "Approval Deadline",
"origin": {
"guid": "CUEXGTE5SVEO7Q5CCD1T",
"name": "-uncategorized-"
},
"required": false,
"searchable": false
},
{
"allowsExplicitNullValue": false,
"apiName": "canceledDateTime",
"creatable": false,
"custom": false,
"editable": false,
"fieldType": "DATETIME",
"global": true,
"inViews": [
"CHANGE_SUMMARY"
],
"name": "Canceled On",
"origin": {
"guid": "CUEXGTE5SVEO7Q5CCD1T",
"name": "-uncategorized-"
},
"searchable": false

904 Arena REST API Developer Guide

 },
{
"allowsExplicitNullValue": false,
"apiName": "category",
"creatable": true,
"custom": false,
"developerNotes": "Defaults to -uncategorized- if no
default is set",
"editable": true,
"fieldType": "OBJECT",
"global": true,
"guid": "I0K3MZKBY1J6P8RATCV5",
"inViews": [
"CHANGE_SUMMARY"
],
"name": "Category",
"origin": {
"guid": "CUEXGTE5SVEO7Q5CCD1T",
"name": "-uncategorized-"
},
"required": false,
"searchable": true
},
...
]
}

GET Change Categories

/settings/changes/categories
/settings/changes/categories/<GUID>
Returns Categories on page 1099 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

Endpoints 905
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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":{
"email":"cvickery@[Link]",
"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":{

906 Arena REST API Developer Guide

 "email":"hwalker@[Link]",
"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":"hwalker@[Link]",
"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
},
...
]
}
Get a Change category with a specific GUID
GET /settings/changes/categories/guid
{
"activated":true,
"allowDuplicateRevisions":true,

Endpoints 907
 "allowManualRevisionEntry":true,
"assignable":true,
"creationDateTime":"2011-02-08T22:09:30Z",
"creator":{
"email":"hwalker@[Link]",
"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
}

GET Change Category Routings

/settings/changes/categories/<GUID>/routings
Returns routing object available for within a specific Change category.

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

908 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all routings for a change category
GET /settings/changes/categories/<GUID>/routings
{
"count": 4,
"results": [
{
"description": "This Routing approves releases to
Design.",
"guid": "Q8SBG58P5WDGZI1KYQMP",
"name": "Design Phase Changes"
},
{
"description": "To be used for updating sourcing
information on parts. Also responsible for part obsolescence.",
"guid": "P7RAF47O4VCFYH0JXPLK",
"name": "Component Librarian"
},
{
"description": "Use this routing when financial impact
exceeds capital investment of $10k",
"guid": "TBVEJ8BS8ZGJ2L4N1TP5",
"name": "Executive Approval"
},
{
"description": "This Routing approves releases to
Production.",
"guid": "R9TCH69Q6XEH0J2LZRN7",
"name": "Production Phase Changes"
}
]
}

Endpoints 909
GET Change Routings
/settings/changes/routings
/settings/changes/routings/<GUID>
Returns Routings on page 1109 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"

910 Arena REST API Developer Guide

 },
{
"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"
}

GET Change Implementation Statuses

settings/changes/implementationstatuses
The GET Change Implementation Statuses endpoint returns all the
implementation statuses for a Change in a workspaace. Change Administrators
use the implementation statuses to set the implementation status when moving a
Change from the EFFECTIVE to the COMPLETED lifecycle status or when
moving a Change from the COMPLETED to the EFFECTIVE lifecycle status.
Implementation statuses can also be used when moving a Change from the
EXPIRED to the COMPLETED lifecycle status. For examples using the
implementationStatus property, see POST Change Status (Completed) or POST
Change Status (Unmark as Complete).

Endpoints 911
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get the Implementation Statuses for Changes in a workspace.
GET /settings/changes/implementationstatuses
{
"count": 5,
"results": [
{
"guid": "EWGZIVG7UXATCVEXGZIT",
"name": "NOT_STARTED"
},
{
"guid": "FXH0JWH8VYBUDWFYH0JM",
"name": "IN_PROGRESS"
},
{
"guid": "GYI1KXI9WZCVEXGZI1KC",
"name": "NEEDS_ATTN"
},

912 Arena REST API Developer Guide

 {
"guid": "HZJ2LYJAX0DWFYH0J2LC",
"name": "DONE"
},
{
"guid": "I0K3MZKBY1EXGZI1K3M9",
"name": "BLANK"
}
]
}

GET Change Implementation Task

Templates
/settings/changes/categories/<GUID>/
implementationtemplates
Returns the implementation tasks template for a change. Implementation Task
Management needs to be enabled for the category.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 913
Sample Response Body
Get the implementation task templates of a specific change category.
GET /settings/changes/categories/<GUID>/
implementationtemplates
{
"count": 7,
"results": [
{
"guid": "L3N6KHLNYFY8RAQ8SWYT",
"name": "Check Supplier",
"defaultAssignee": {
"user": {
"email": "rolu@[Link]",
"fullName": "Rocky Lu",
"guid": "5N7Q4157IZGZI1K33VOE"
},
}
},
{
"guid": "L3N6KHLNYFY8RAQ8SWYT",
"name": "Check Supplier",
"defaultAssignee": {
"userGroup": {
"guid": "VDXGURVX8OUH0J2L4HEJ",
"name": "Supplier & Supplier Item Manager"
}
}
},
...
]
}
Request with invalid GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

GET Change Implementation Task

Template
/settings/changes/categories/<GUID>/
implementationtemplates/<GUID>

914 Arena REST API Developer Guide

Returns the implementation tasks template for a change. Implementation Task
Management needs to be enabled for the category.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific implementation task template of a specific change category.
GET /settings/changes/categories/<GUID>/
implementationtemplates/<GUID>
{
"guid": "L3N6KHLNYFY8RAQ8SWYT",
"name": "Check Supplier",
"defaultAssignee": {
"user": {
"email": "rolu@[Link]",
"fullName": "Rocky Lu",
"guid": "5N7Q4157IZGZI1K33VOE"
},
}
}
Request with invalid GUID
{

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

GET Supplier Attributes

/settings/suppliers/attributes
Returns Attributes on page 1095 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.
If this is set to false, it
returns only non-creatable
attributes.

916 Arena REST API Developer Guide

Name Value Description
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",

Endpoints 917
 "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",
"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

918 Arena REST API Developer Guide

 },
{
"allowsExplicitNullValue":false,
"apiName":"addresses",
"creatable":true,
"custom":false,
"editable":true,
"fieldType":"OBJECT",
"inViews":[
"SUPPLIER_PROFILE"
],
"required":false,
"searchable":false
},
...
]
}

GET Supplier Item Attributes

/settings/supplieritems/attributes
Returns Attributes on page 1095 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
the supplier item.
If this is set to false, it
returns only non-creatable

Endpoints 919
Name Value Description
attributes
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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,

920 Arena REST API Developer Guide

 "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",
"creatable":false,
"custom":false,
"editable":false,
"fieldType":"DATETIME",
"inViews":[
"SI_SPECS"
],
"searchable":false
},
{
"allowsExplicitNullValue":false,
"apiName":"creator",
"creatable":false,
"custom":false,
"editable":false,

Endpoints 921
 "fieldType":"OBJECT",
"inViews":[
"SI_SPECS"
],
"required":false,
"searchable":false
},
...
]
}

GET Supplier Item Compliance

Requirements
/settings/supplieritems/requirements
/settings/supplieritems/requirements/<GUID>
Returns all supplier item Compliance Requirement on page 1109 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

922 Arena REST API Developer Guide

Name Value Description
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all compliance requirements for supplier items in the workspace
GET /settings/supplieritems/requirements
{
"count":3,
"results":[
{
"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

Endpoints 923
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
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

GET File Attributes

/settings/files/attributes
Returns Attributes on page 1095 available for Files.

924 Arena REST API Developer Guide

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 file.
If this is set to false, it
returns only non-creatable
attributes.
editableOnly true or false If this is set to true, it
returns only editable
attributes, which are
settable during update of
a file. 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
files.

Response Codes
Code Description
200 Success
400 Failure

Endpoints 925
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all file attributes with possible values included
GET /settings/files/attributes?includePossibleValues=
true
{
"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,

926 Arena REST API Developer Guide

 "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"
],
"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",

Endpoints 927
 "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",
"inViews":[
"ITEM_FILES",
"FILE_SUMMARY",
"SI_FILES"
],
"required":true,
"searchable":false
},
…
]
}

GET File Categories

/settings/files/categories
/settings/files/categories/<GUID>
This returns Categories on page 1099 available for Files. Appending a GUID to
the URL returns the category with that GUID.

928 Arena REST API Developer Guide

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
[Link]
[Link]/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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 929
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":"hwalker@[Link]",
"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":"hwalker@[Link]",
"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":"hwalker@[Link]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"description":null,

930 Arena REST API Developer Guide

 "guid":"SAUDW4DDARAK3M5MAMCT",
"level":3,
"name":"Artwork",
"path":"File\\Internal File\\Artwork",
"requirements":[],
"systemDefined":false
},
{
"activated":true,
"assignable":true,
"creationDateTime":"2011-02-08T22:29:55Z",
"creator":{
"email":"hwalker@[Link]",
"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":"hwalker@[Link]",
"fullName":"Heidi Walker",
"guid":"4M6P8GPPM3K3M5O7QMJ9"
},
"description":null,
"guid":"8F8ALDIEN3QDGOWI7V7G",
"level":2,
"name":"Confidential File",
"objectType":"FILE",
"path":"File\Confidential File",
"requirements":[],
"systemDefined":false
}

Endpoints 931
 ]
}
Get a single file category
GET settings/files/categories/9RBUZPQQZ6PZI1DL92A2
{
"activated":true,
"assignable":null,
"creationDateTime":"2008-03-05T13:56:22Z",
"creator":{
"email":"hwalker@[Link]",
"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."
}
]
}

GET Quality Process Templates

/settings/qualityprocesses/templates
/settings/qualityprocesses/templates/<GUID>
This returns Quality Process Templates on page 1138 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.

932 Arena REST API Developer Guide

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Searchable Attributes (for GET /settings/qualityprocesses/templates

only)
Name Value Description
name string Quality Process template
name
active true or false true indicates template is
active
false indicates template is
inactive

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all Quality Process Templates defined for the workspace
GET /settings/qualityprocesses/templates
{
"count":3,
"results":[
{
"active":true,

Endpoints 933
 "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"

934 Arena REST API Developer Guide

 },
{
"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":[

Endpoints 935
 {
"fullName":"Dhana Prakash"
},
{
"fullName":"Heidi Walker"
}
],
"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"
}
],

936 Arena REST API Developer Guide

 "guid":"SAUDW42IRUD9SBUDWUK3",
"name":"Closure and Team Celebration",
"order":9,
"type":"REGULAR"
}
]
},
...
],
}
Get all active Quality Process templates
GET /settings/qualityprocesses/templates?active=true
{
"count": 2,
"results": [
{
"active": true,
"creationDateTime": "2014-08-12T22:30:52Z",
"creator": {
"email": "cagustin@[Link]",
"fullName": "Cole Agustin",
"guid": "L3N6B03K0R8RATCVDVBM"
},
"defaultNumberFormat": null,
"defaultOwner": null,
"description": null,
"guid": "J1L49Y1IYP84N6P821H4",
"name": "Corrective Action Report (CAR) Template",
"numberFormats": null,
"shortName": "CAR",
"steps": [
{
"attributes": [
{
"apiName": "VDXGLADUA1I0J2L4J87T",
"fieldType": null,
"guid": "VDXGLADUA1I0J2L4J87T",
"name": "Problem Description",
"value": null
}
],
"defaultAssignees": null,
"description": null,
"guid": "K2M5AZ2JZQ95O7Q932IH",
"name": "Problem Description",
"order": 1,
"type": "REGULAR"
},
{
"attributes": [

Endpoints 937
 {
"apiName": "WEYHMBEVB2J1K3M5K982",
"fieldType": null,
"guid": "WEYHMBEVB2J1K3M5K982",
"name": "Serial Number(s) of
Nonconforming Parts",
"value": null
},
{
"apiName": "XFZINCFWC3K2L4N6LA92",
"fieldType": null,
"guid": "XFZINCFWC3K2L4N6LA92",
"name": "Inventory Impact?",
"value": null
},
{
"apiName": "YG0JODGXD4L3M5O7MBA5",
"fieldType": null,
"guid": "YG0JODGXD4L3M5O7MBA5",
"name": "Inventory Impact
description",
"value": null
},
{
"apiName": "ZH1KPEHYE5M4N6P8NCB2",
"fieldType": null,
"guid": "ZH1KPEHYE5M4N6P8NCB2",
"name": "Supplier Containment actions
required",
"value": null
},
{
"apiName": "0I2LQFIZF6N5O7Q9ODCI",
"fieldType": null,
"guid": "0I2LQFIZF6N5O7Q9ODCI",
"name": "Internal Containment actions
required",
"value": null
},
{
"apiName": "1J3MRGJ0G7O6P8RAPEDI",
"fieldType": null,
"guid": "1J3MRGJ0G7O6P8RAPEDI",
"name": "Customer Containment actions
required",
"value": null
}
],
"defaultAssignees": null,
"description": null,
"guid": "L3N6B03K0RA6P8RA43J8",

938 Arena REST API Developer Guide

 "name": "Immediate Containment",
"order": 2,
"type": "REGULAR"
},
{
"attributes": [
{
"apiName": "2K4NSHK1H8P7Q9SBQFEG",
"fieldType": null,
"guid": "2K4NSHK1H8P7Q9SBQFEG",
"name": "Possible Causes",
"value": null
},
{
"apiName": "3L5OTIL2I9Q8RATCRGFE",
"fieldType": null,
"guid": "3L5OTIL2I9Q8RATCRGFE",
"name": "5 Whys",
"value": null
},
{
"apiName": "4M6PUJM3JAR9SBUDSHGI",
"fieldType": null,
"guid": "4M6PUJM3JAR9SBUDSHGI",
"name": "Escape Point",
"value": null
}
],
"defaultAssignees": null,
"description": null,
"guid": "M4O7C14L1SB7Q9SB54K1",
"name": "Root Cause Analysis",
"order": 3,
"type": "REGULAR"
},
{
"allowOwnerToAddApprovers": true,
"approvers": [
{
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "9RBUZOR8OFWFYH0JSIPJ"
},
{
"email": "jdeckard@[Link]",
"fullName": "James Deckard",
"guid": "6O8RWLO5LCTCVEXGGMZQ"
},
{
"email": "jparker@[Link]",
"fullName": "John Parker",

Endpoints 939
 "guid": "BTDW1QTAQHYH0J2LLR4L"
}
],
"defaultApprovers": {
"userGroups": null,
"users": [
{
"email": "hwalker@everyroadgps.
com",
"fullName": "Heidi Walker",
"guid": "9RBUZOR8OFWFYH0JSIPJ"
},
{
"email": "jdeckard@everyroadgps.
com",
"fullName": "James Deckard",
"guid": "6O8RWLO5LCTCVEXGGMZQ"
},
{
"email": "jparker@everyroadgps.
com",
"fullName": "John Parker",
"guid": "BTDW1QTAQHYH0J2LLR4L"
}
]
},
"defaultAssignees": null,
"description": null,
"guid": "CUEX2RUBRI1XGZI1VUAJ",
"name": "Corrective Action Plan Approved?",
"order": 4,
"type": "SIGNOFF"
},
{
"attributes": [
{
"apiName": "6O8RWLO5LCTBUDWFUJHF",
"fieldType": null,
"guid": "6O8RWLO5LCTBUDWFUJHF",
"name": "Corrective Action",
"value": null
},
{
"apiName": "7P9SXMP6MDUCVEXGVKID",
"fieldType": null,
"guid": "7P9SXMP6MDUCVEXGVKID",
"name": "Implemented?",
"value": null
},
{
"apiName": "EWGZ4TWDTK1J2L4N2RP6",

940 Arena REST API Developer Guide

 "fieldType": null,
"guid": "EWGZ4TWDTK1J2L4N2RP6",
"name": "Implementation details",
"value": null
}
],
"defaultAssignees": null,
"description": null,
"guid": "N5P8D25M2TC8RATC65LC",
"name": "Corrective Action",
"order": 5,
"type": "REGULAR"
},
{
"attributes": [
{
"apiName": "ASCV0PS9PGXFYH0JYNLJ",
"fieldType": null,
"guid": "ASCV0PS9PGXFYH0JYNLJ",
"name": "Preventive Action",
"value": null
},
{
"apiName": "7P9SXMP6MDUCVEXGVKID",
"fieldType": null,
"guid": "7P9SXMP6MDUCVEXGVKID",
"name": "Implemented?",
"value": null
},
{
"apiName": "EWGZ4TWDTK1J2L4N2RP6",
"fieldType": null,
"guid": "EWGZ4TWDTK1J2L4N2RP6",
"name": "Implementation details",
"value": null
}
],
"defaultAssignees": null,
"description": null,
"guid": "O6Q9E36N3UD9SBUD76MV",
"name": "Preventive Action",
"order": 6,
"type": "REGULAR"
}
]
},
{
"active": true,
"creationDateTime": "2014-08-12T22:30:52Z",
"creator": {
"email": "cagustin@[Link]",

Endpoints 941
 "fullName": "Cole Agustin",
"guid": "L3N6B03K0R8RATCVDVBM"
},
"defaultNumberFormat": null,
"defaultOwner": null,
"description": null,
"guid": "P7RAF47O4VEATCVE87NX",
"name": "Nonconforming Materials Report (NCMR)
Template",
"numberFormats": null,
"shortName": "NCMR",
"steps": [
{
"attributes": [
{
"apiName": "FXH05UXEUL2K3M5O3SQ8",
"fieldType": null,
"guid": "FXH05UXEUL2K3M5O3SQ8",
"name": "Part Number",
"value": null
},
{
"apiName": "GYI16VYFVM3L4N6P4TRB",
"fieldType": null,
"guid": "GYI16VYFVM3L4N6P4TRB",
"name": "Part Name",
"value": null
},
{
"apiName": "HZJ27WZGWN4M5O7Q5US5",
"fieldType": null,
"guid": "HZJ27WZGWN4M5O7Q5US5",
"name": "Supplier",
"value": null
},
{
"apiName": "I0K38X0HXO5N6P8R6VTB",
"fieldType": null,
"guid": "I0K38X0HXO5N6P8R6VTB",
"name": "Supplier Part Number",
"value": null
},
{
"apiName": "J1L49Y1IYP6O7Q9S7WUA",
"fieldType": null,
"guid": "J1L49Y1IYP6O7Q9S7WUA",
"name": "Lot Number(s)",
"value": null
},
{
"apiName": "WEYHMBEVB2J1K3M5K982",

942 Arena REST API Developer Guide

 "fieldType": null,
"guid": "WEYHMBEVB2J1K3M5K982",
"name": "Serial Number(s) of
Nonconforming Parts",
"value": null
},
{
"apiName": "K2M5AZ2JZQ7P8RAT8XVI",
"fieldType": null,
"guid": "K2M5AZ2JZQ7P8RAT8XVI",
"name": "Description of
Nonconformance",
"value": null
}
],
"defaultAssignees": null,
"description": null,
"guid": "Q8SBG58P5WFBUDWF98OM",
"name": "Nonconformance Description",
"order": 1,
"type": "REGULAR"
},
{
"attributes": [
{
"apiName": "L3N6B03K0R8Q9SBU9YWA",
"fieldType": null,
"guid": "L3N6B03K0R8Q9SBU9YWA",
"name": "Action",
"value": null
}
],
"defaultAssignees": null,
"description": null,
"guid": "R9TCH69Q6XGCVEXGA9P2",
"name": "Action Taken",
"order": 2,
"type": "REGULAR"
},
{
"attributes": [
{
"apiName": "M4O7C14L1S9RATCVAZXO",
"fieldType": null,
"guid": "M4O7C14L1S9RATCVAZXO",
"name": "Permanent Correction
needed?",
"value": null
},
{
"apiName": "N5P8D25M2TASBUDWB0YM",

Endpoints 943
 "fieldType": null,
"guid": "N5P8D25M2TASBUDWB0YM",
"name": "Corrective Action number(s)",
"value": null
}
],
"defaultAssignees": null,
"description": null,
"guid": "SAUDI7AR7YHDWFYHBAQC",
"name": "Corrective Action",
"order": 3,
"type": "REGULAR"
}
]
}
]
}
Get a single Quality Process Template
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",

944 Arena REST API Developer Guide

 "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":[
{
"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"

Endpoints 945
 },
...
],
"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",
"order":6,
"type":"SIGNOFF"
},
{
"attributes":[
{
"guid":"UCWFY64KTWFBUDWFYBCW",
"name":"Implemented?"
},
...
],
"guid":"Q8SBU20GPSB7Q9SBUSI4",
"name":"Implement and Verify Corrective Actions",
"order":7,
"type":"REGULAR"
},
{
"attributes":[
{

946 Arena REST API Developer Guide

 "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
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

GET Quality Process Number Formats

/settings/qualityprocesses/numberformats
/settings/qualityprocesses/numberformats/<GUID>
This returns Quality Process Number Formats on page 1135 available in the
workspace. Appending a GUID to the URL returns the number format with that
GUID.

Endpoints 947
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",
"guid":"YG0J2A8OX0JSBUDWFUYM",
"lastUsed":"000000",
"name":"8D",
"nextValue":"000001",
"prefixes":[
{
"guid":"SAUDW42IRUCWFYH0JYZ4",

948 Arena REST API Developer Guide

 "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",
"prefixes":[
{
"guid":"SAUDW42IRUCWFYH0JYZ4",
"value":"8D-"

Endpoints 949
 }
]
}

GET Quality Process Attributes

/settings/qualityprocesses/attributes
Returns Attributes on page 1095 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.
creatableOnly true or false If this is set to true, it
returns only creatable
attributes, which are
settable during creation of
a quality process
If this is set to false, it
returns only non-creatable
attributes.

950 Arena REST API Developer Guide

Name Value Description
editableOnly true or false If this is set to true, it
returns only editable
attributes, which are
settable during update of
a quality process. 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
quality processes.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all Quality Process summary attributes including possible values
GET /settings/qualityprocesses/
attributes?includePossibleValues=true
{
"count":14,
"results":[
{
"allowsExplicitNullValue":false,
"apiName":"completedDateTime",

Endpoints 951
 "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"
],
"maxLength":4000,

952 Arena REST API Developer Guide

 "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
},

Endpoints 953
 {
"allowsExplicitNullValue":false,
"apiName":"status",
"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"
],

954 Arena REST API Developer Guide

 "required":true,
"searchable":true
},
{
"allowsExplicitNullValue":false,
"apiName":"type",
"creatable":true,
"editable":true,
"fieldType":"DROP_DOWN",
"inViews":[
"QUALITY_SUMMARY"
],
"possibleValues":[
"Critical",
"Low",
"Normal"
],
"required":false,
"searchable":true
}
]
}

GET Quality Process Step Attributes

/settings/qualityprocesses/steps/attributes
Returns Step Attributes on page 1144 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.

Endpoints 955
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all Quality Process Step attributes including possible values
GET /settings/qualityprocesses/steps/
attributes?includePossibleValues=true
{
"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",

956 Arena REST API Developer Guide

 "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",
"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",

Endpoints 957
 "required":false,
"searchable":true
},
...
]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

958 Arena REST API Developer Guide

Sample Response Body
Get all Quality Process Owners in the workspace
GET /settings/qualityprocesses/owners
{
"count":17,
"results":[
{
"fullName":"James Deckard",
"emailAddress":"jdeckard@[Link]",
"guid":"BJ4T3W9KW9TEWUKEFLLN"
},
{
"fullName":"Heidi Walker",
"emailAddress":"hwalker@[Link]",
"guid":"BJ4T3W9KW9TEWUKEFLLN"
},
{
"fullName":"Toshiro Makamuri",
"emailAddress":"tmakamuri@[Link]",
"guid":"BJ4T3W9KW9TEWUKEFLLN"
},
...
]
}

GET Tickets Attributes

/settings/tickets/attributes
Returns Attributes on page 1095 available for Tickets.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Endpoints 959
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 ticket.
If this is set to false, it
returns only non-creatable
attributes.
editableOnly true or false If this is set to true, it
returns only editable
attributes, which are
settable during update of
a ticket. 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
tickets.

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

960 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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,

Endpoints 961
 "revisionControlled": true,
"searchable": true,
"visibleWhenBlank": true
},
{
"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
},
...
}

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

962 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all tickets number prefixes
GET /settings/tickets/numbersequenceprefixes
{
"count": 2,
"results": [
{
"guid": "M4O7Q3OF25LH0J2L4NWL",
"value": "DEF-"
},
{
"guid": "L3N6P2NE14KGZI1K3MVY",
"value": "REQ-"
}
]
}

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.

Endpoints 963
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all Tickets number sequences defined for the workspace
/settings/tickets/numbersequences
{
"count": 2,
"results": [
{
"creationDateTime": "2016-12-13T19:24:21Z",
"guid": "3L5O7K5WJM2ZI1K3M5F5",
"lastUsed": "000002",
"name": "Defects",
"nextValue": "000003",
"prefixes": [
{
"guid": "M4O7Q3OF25LH0J2L4NWL",
"value": "DEF-"
}
]

964 Arena REST API Developer Guide

 },
{
"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-"
}
]
}

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

Endpoints 965
Searchable Attributes (for GET /settings/tickets/templates only)
Name Value Description
name string Ticket template name
active true or false true indicates active
templates.
false indicates inactive
templates.

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"defaultAssignee": {
"email": "tshaftoe@[Link]",
"fullName": "Tony Shaftoe",
"guid": "0I2L4H2TGJ0J2L4NWMTA"

966 Arena REST API Developer Guide

 },
"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,
"description": "Seeded Template for Defects",
"guid": "8QATCPA1OR83M5O7Q967",

Endpoints 967
 "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-"
}
]
}
]
}

968 Arena REST API Developer Guide

 ]
}
Get all active templates.
GET /settings/tickets/templates?active=true
{
"count": 2,
"results": [
{
"active": true,
"allowUserDefinedNumber": true,
"creationDateTime": "2016-11-13T17:12:52Z",
"creator": {
"email": null,
"fullName": "Arena Solutions",
"guid": "P7RAF47O4VCVEXGZI1K1"
},
"defaultAssignee": null,
"defaultNumberSequence": {
"guid": "6O8RWLO5LCV4N6P8R8T8",
"name": "Defects",
"prefixes": [
{
"guid": "P7RAF47O4VB7Q9SBUAT8",
"value": "DEF-"
}
]
},
"defaultTemplate": false,
"description": "Seeded Template for Defects",
"guid": "6O8RWLO5LCTO7Q9SB9W4",
"name": "Defects",
"numberSequences": [
{
"guid": "6O8RWLO5LCV4N6P8R8T8",
"name": "Defects",
"prefixes": [
{
"guid": "P7RAF47O4VB7Q9SBUAT8",
"value": "DEF-"
}
]
}
]
},
{
"active": true,
"allowUserDefinedNumber": true,
"creationDateTime": "2016-11-13T17:12:52Z",
"creator": {
"email": null,

Endpoints 969
 "fullName": "Arena Solutions",
"guid": "P7RAF47O4VCVEXGZI1K1"
},
"defaultAssignee": null,
"defaultNumberSequence": {
"guid": "5N7QVKN4KBU3M5O7Q7SD",
"name": "Requirements",
"prefixes": [
{
"guid": "Q8SBG58P5WC8RATCVBU1",
"value": "REQ-"
}
]
},
"defaultTemplate": false,
"description": "Seeded Template for Requirements",
"guid": "7P9SXMP6MDUP8RATCAX0",
"name": "Requirements",
"numberSequences": [
{
"guid": "5N7QVKN4KBU3M5O7Q7SD",
"name": "Requirements",
"prefixes": [
{
"guid": "Q8SBG58P5WC8RATCVBU1",
"value": "REQ-"
}
]
}
]
}
]
}
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": "[Link]@mzeroofhn@[Link]",
"fullName": "Eprn )Amviz( Nzeroofh",
"guid": "VDXGZCXOBEVEXGZI1T4Q"
},
"description": "User this for Engineering changes",
"evaluatorGroupDefault": null,
"guid": "HZJ2LYJAX0JTCVAHHI66",
"level": 3,
"name": "Engineering Change Request",
"numberingSequencePrefixDefault": {

970 Arena REST API Developer Guide

 "guid": "ASCVERC3QT95O7PRDYND",
"value": "ECR-"
},
"parentCategory": {
"guid": "L3N6P2NE14NXGZELLMAW",
"name": "Change Request"
},
"path": "Request\\Change Request\\Engineering Change Request",
"structural": false,
"systemDefined": false
}

GET Tickets Templates Attributes

/settings/tickets/templates/<GUID>/attributes
Returns Attributes on page 1095 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

Endpoints 971
Name Value Description
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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": [
{
"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",

972 Arena REST API Developer Guide

 "inViews": [
"VERIFY_SUMMARY"
],
"searchable": false
},
...
]
}

GET Users
/settings/users
/settings/users/<GUID>
Returns an array of Users on page 1148 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

Endpoints 973
Name Value Description
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
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all users
GET /settings/users
{
"count":25,
"results":[

974 Arena REST API Developer Guide

 {
"email":"johnsmith@[Link]",
"enabled":true,
"firstName":"John",
"fullName":"John Smith",
"guid":"1J3MRHIIRYFYH0J258QX",
"lastName":"Smith",
"type":"EMPLOYEE"
},
{
"email":"vihaanluthra@[Link]",
"enabled":true,
"firstName":"Vihaan",
"fullName":"Vihaan Luthra",
"guid":"8QATYOPPY5M5O7Q9C30O",
"lastName":"Luthra",
"type":"PARTNER"
},
{
"email":"jchang@[Link]",
"enabled":true,
"firstName":"Jensen",
"fullName":"Jensen Chang",
"guid":"7IJQWBOOA8J8O2D7C20PL",
"lastName":"Chang",
"type":"ADVANCED_SUPPLIER"
},
...
]
}
Get all users with the string john in the fullName attribute
GET /settings/users?fullName=*john
{
"count":2,
"results":[
{
"email":"jparker@[Link]",
"enabled":true,
"firstName":"John",
"fullName":"John Parker",
"guid":"7P9SBJSSP6N6P8RATPM6",
"lastName":"Parker",
"type":"EMPLOYEE"
},
{
"email":"jwelles@[Link]",
"enabled":true,
"firstName":"John",
"fullName":"John Welles",
"guid":"8QATCKTTQ7O7Q9SBUQNX",

Endpoints 975
 "lastName":"Welles",
"type":"EMPLOYEE"
}
]
}
Get all advanced supplier users
GET /settings/users?type=ADVANCED_SUPPLIER
{
"count":2,
"results":[
{
"email":"rmorgan@[Link]",
"enabled":true,
"firstName":"Robert",
"fullName":"Robert Morgan",
"guid":"8QATCTCSO1I1K3M5OKFT",
"lastName":"Morgan",
"type":"ADVANCED_SUPPLIER"
},
{
"email":"htully@[Link]",
"enabled":true,
"firstName":"Henry",
"fullName":"Henry Tully",
"guid":"9RBUDUDTP2J2L4N6PLGN",
"lastName":"Tully",
"type":"ADVANCED_SUPPLIER"
}
]
}
Get a single user
GET /settings/users/N5P8R8R73GXGZI1K3YH7
{
"email":"eandersen@[Link]",
"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."

976 Arena REST API Developer Guide

 }
]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all User Groups
GET /settings/usergroups
{
"count": 6,
"results": [

Endpoints 977
 {
"assignability": [
"ACCESS_POLICIES",
"CHANGES",
"QUALITY"
],
"creationDateTime": "2020-12-02T06:30:40Z",
"creator": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": "Limited Workspace Access to Non-
Admins",
"enabled": true,
"guid": "N5P8R4PG36CZI1K3MNJE",
"lastModifiedDateTime": "2020-12-02T06:30:40Z",
"modifiedBy": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "Level 3 Partial Administrator"
},
{
"assignability": [
"CHANGES",
"QUALITY"
],
"creationDateTime": "2020-12-21T07:23:48Z",
"creator": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": null,
"enabled": true,
"guid": "BTDWFSD4RU0N6P8RA955",
"lastModifiedDateTime": "2020-12-21T07:23:48Z",
"modifiedBy": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "Quality Assurance"
},
{
"assignability": [
"ACCESS_POLICIES"
],
"creationDateTime": "2020-12-21T17:56:29Z",

978 Arena REST API Developer Guide

 "creator": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"description": null,
"enabled": true,
} "guid": "CUEXGTE5SV1O7Q9SBA60",
"lastModifiedDateTime": "2020-12-22T19:31:49Z",
"modifiedBy": {
"email": "hwalker@[Link]",
"fullName": "Heidi Walker",
"guid": "WEYH0DYPCFWFYH0JSIPD"
},
"name": "*Level 3 Administrator -User Group"
},
...
]
}

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

Endpoints 979
Name Value Description
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific User Group
GET /settings/usergroups/<GUID>
{
"guid": "L3N6KHLNYFY8RAQ8SWYT",
"name": "Quality Assurance",
"description": "QA Team",
"enabled": true,
"creator": {
"email": "dsullivan@[Link]",
"fullName": "Don Sullivan",
"guid": "K2M5JGKMXEVEXGZI1T4P"
},
"creationDateTime": "2008-03-07T19:58:40Z",
"lastModifiedDateTime": "2017-06-18T22:52:40Z",
"modifiedBy": {
"email": "dsullivan@[Link]",
"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."
}
]
}

GET User Group Employees

/settings/usergroups/<GUID>/employees
Returns a list of employees in a specific User Group.

980 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all employees in a User Group.
GET /settings/usergroups/<GUID>
{
"count":25,
"results":[
{
"email":"johnsmith@[Link]",
"enabled":true,
"firstName":"John",
"fullName":"John Smith",
"guid":"1J3MRHIIRYFYH0J258QX",
"lastName":"Smith",
"type":"EMPLOYEE"
},
{

Endpoints 981
 "email":"vihaanluthra@[Link]",
"enabled":true,
"firstName":"Vihaan",
"fullName":"Vihaan Luthra",
"guid":"8QATYOPPY5M5O7Q9C30O",
"lastName":"Luthra",
"type":"EMPLOYEE"
},
{
"email":"jchang@[Link]",
"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."
}
]
}

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

982 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get an employee user of a specific User Group
GET /settings/usergroups/<GUID>/employees/<GUID>
{
"user": {
"email": "jappria@[Link]",
"enabled": true,
"firstName": "Joe",
"fullName": "Joe Appria",
"guid": "9RBU859BM3K3M5O7915S",
"lastName": "Appria",
"type": "EMPLOYEE"
}
}
Request with bad GUID
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

Endpoints 983
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get partner users of a specific User Group.
GET /settings/usergroups/<GUID>/partners
{
"count":25,
"results":[
{
"email":"johnsmith@[Link]",
"enabled":true,
"firstName":"John",
"fullName":"John Smith",

984 Arena REST API Developer Guide

 "guid":"1J3MRHIIRYFYH0J258QX",
"lastName":"Smith",
"type":"PARTNER"
},
{
"email":"mpatel@[Link]",
"enabled":true,
"firstName":"Marie",
"fullName":"Marie Patel",
"guid":"8QATYOPPY5M5O7Q9C30O",
"lastName":"Patel",
"type":"PARTNER"
},
{
"email":"jchang@[Link]",
"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."
}
]
}

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.

Endpoints 985
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a specific Partner user of a specific User Group.
GET /settings/usergroups/<GUID>/partners/<GUID>
{
"user": {
"email": "joep@[Link]",
"enabled": true,
"firstName": "Joe",
"fullName": "Joe Patria",
"guid": "K2M5JGKMXEVEXGZI1T4P",
"lastName": "Partner",
"type": "PARTNER"
}
}
Request with bad GUID
{
"status": 400,
"errors": [

986 Arena REST API Developer Guide

 {
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

GET User Group Machines

/settings/usergroups/<GUID>/machines
Returns a list of machine users 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all machine users in a User Group.
GET /settings/usergroups/<GUID>/machines

Endpoints 987
{
"count":25,
"results":[
{
"email":"ERP_integration@[Link]",
"enabled":true,
"firstName":"EveryHome ERP Integration",
"fullName":"EveryHome ERP Integration",
"guid":"9K3MRHIIRYFYH0J258QW",
"lastName":null,
"type":"MACHINE"
},
{
"email":"EveryHome_OutboundEvents@[Link]",
"enabled":true,
"firstName":"EveryHome Outbound Events",
"fullName":"EveryHome Outbound Events",
"guid":"9PKTYOPPY5M5O7Q9C43V",
"lastName":null,
"type":"MACHINE"
},
{
"email":"EveryHome_DXL_Integration@[Link]",
"enabled":true,
"firstName":"EveryHome DXL Integration",
"fullName":"EveryHome DXL Integration",
"guid":"7DYBWEDOOA8J8O2D7C29SX",
"lastName":null,
"type":"MACHINE"
},
...
]
}
Request with bad GUID
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

GET User Group Machine

/settings/usergroups/<GUID>/machines/<GUID>
Returns an machine user of a specific User Group.

988 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get an machine user of a specific User Group
GET /settings/usergroups/<GUID>/machines/<GUID>
{
"user": {
"email": "ERP_everyroad@[Link]",
"enabled": true,
"firstName": "EveryRoad ERP Integration",
"fullName": "EveryRoad ERP Integration",
"guid": "9RBU859BM3K3M5O7915S",
"lastName": null,
"type": "MACHINE"
}
}
Request with bad GUID
{

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

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

990 Arena REST API Developer Guide

Sample Response Body
Get all users in a specific User Group.
GET /settings/usergroups/<GUID>/users
{
"count": 2,
"results": [
{
"email": "jwelles@[Link]",
"enabled": false,
"firstName": "Jackie",
"fullName": "Jackie Welles",
"guid": "GYI1KSQSFEVEXGZI007P",
"lastName": "Welles",
"type": "EMPLOYEE"
},
{
"email": "mdeshawn@[Link]",
"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."
}
]
}

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.

Endpoints 991
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get a user of a specific User Group.
GET /settings/usergroups/<GUID>/users/<GUID>
{
"email": "jherrera@[Link]",
"enabled": true,
"firstName": "Judy",
"fullName": "Judy Herrera",
"guid": "XFZI1979WVCVEXGZI9IT",
"lastName": "Herrera",
"type": "PARTNER"
}
Request with bad GUID
{
"status": 400,
"errors": [
{
"code": 3011,

992 Arena REST API Developer Guide

 "message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

GET Suppliers
/suppliers
Returns a collection of Supplier on page 1145 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.

Endpoints 993
Searchable Attributes
Name Value Description
[additional attribute guid string This special search
value] permits searching for
strings in additional
attribute values. For
example GET /items?
VDXGZ7E0-
GO5N6P8PR55G=
*100pF where
VDXGZ7E0-
GO5N6P8PR55G 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 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?
UCWFY6FFCTCI1K3-
B82OC=2019-04-01

994 Arena REST API Developer Guide

Name Value Description
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.
For additional attribute field type MULTI_LINE_TEXT searches, different
values can be separated with an asterisk.
For additional attribute field types DROP_DOWN & FIXED_DROP_DOWN
searches, different values can be separated with a semi-colon.
Search in Zulu format is supported for custom attribute field type Date.
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
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 995
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",
"creator":{
"email":"hwalker@[Link]",
"fullName":"Heidi Walker"
},
"description":"Full service board supplier",
"guid":"YG0J2AJJGXGM5O7FOOG1",
"name":"Adaptive Circuit Boards",
"phoneNumbers":null,
"supplierId":"Adaptive",
"website":"[Link]"
},
{
"accountNumber":"1",
"addresses":null,
"approvalStatus":"approved",
"creationDateTime":"2018-04-27T00:18:52Z",
"creator":{
"email":"hwalker@[Link]",
"fullName":"Heidi Walker"
},
"description":"Board house",
"guid":"UCWFY6FFCTCI1K3B82OC",
"name":"The Board Room",
"phoneNumbers":null,
"supplierId":"theboardroominc,
"website":"[Link]"
}
]
}

GET Supplier (Profile)

/suppliers/<GUID>
Returns a Supplier on page 1145 object with a given GUID.

996 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"
},
{
"apiName":"custom1411226",
"fieldType":"FIXED_DROP_DOWN",
"guid":"I0K3MU330HYGZI1K9K72",
"name":"At-Risk Supplier?",

Endpoints 997
 "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/Region":"United States",
"label":"hq",
"postalCode":"94066",
"province":null,
"state":"CALIFORNIA"
},
"primary":true
}
],
"approvalStatus":"approved",
"creationDateTime":"2018-04-27T00:18:52Z",
"creator":{
"email":"hwalker@[Link]",
"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,
"extension":null,

998 Arena REST API Developer Guide

 "label":"Fax",
"number":"111-111-1110"
}
],
"supplierId":"atrisksupplier",
"website":"[Link]"
}
Request with bad GUID
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

POST Supplier Create

/suppliers
Creates a new Supplier on page 1145 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",

Endpoints 999
 "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",
"city":"San Bruno",
"state":"California",
"province":"",
"postalCode":"94066",
"Country/Region":"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":"[Link]"
}

1000 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Create a new supplier
/suppliers
{
"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"
},

Endpoints 1001
 {
"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/Region":"United States",
"label":"hq",
"postalCode":"94066",
"province":null,
"state":"CALIFORNIA"
},
"primary":true
}
],
"approvalStatus":"approved",
"creationDateTime":"2018-04-27T00:18:52Z",
"creator":{
"email":"hwalker@[Link]",
"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,
"extension":null,
"label":"Fax",
"number":"111-111-1110"
}
],
"supplierId": "theboardroominc",
"website":"[Link]"
}
Request with invalid Country/Region or state

1002 Arena REST API Developer Guide

{
"status":400,
"errors":[
{
"code":3045,
"message":"The Country/Region or state is invalid for
the supplier address."
}
]
}

PUT Supplier Update

/suppliers/<GUID>
Updates the metadata of a supplier on page 1145 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

Set Null
Name Value Description
setnull Append the URL with
setnull=true to set
supplierId,
accountNumber,
description, or website to
null. Attributes must be
included within the
request body and set to
null. Insert setnull after
the query string,
represented by a ?, after
the GUID

Sample Request Body

PUT /suppliers/<GUID>
{

Endpoints 1003
 "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/Region":"United States"
}
},
{
"primary":false,
"address":{
"label":"sales",
"address1":"1313 Mockingbird Lane",
"city":"Smalltown",
"state":"New York",
"province":"",
"postalCode":"01234",
"Country/Region":"United States"
}
}
],
"approvalStatus":"approved",
"description":"Full service board house",
"name":"The Board Room",
"phoneNumbers":[
{

1004 Arena REST API Developer Guide

 "number":"111-111-1111",
"label":"Main"
},
{
"number":"111-111-1110",
"label":"Fax"
}
],
"supplierId": "theboardroomllc",
"website":"[Link]"
}
PUT /suppliers/<GUID>?setnull=true
{
"supplierId": null
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Update the metadata for a supplier
/suppliers/<GUID>
{
"accountNumber":"1",
"additionalAttributes":[
{
"apiName":"custom1411225",
"fieldType":"DATE",
"guid":"HZJ2LT22ZGXFYH0J8J6T",

Endpoints 1005
 "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/Region":"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":"",
"postalCode":"01234",
"Country/Region":"United States"
},
"primary":false
}

1006 Arena REST API Developer Guide

 ],
"approvalStatus":"approved",
"creationDateTime":"2018-04-27T00:18:52Z",
"creator":{
"email":"hwalker@[Link]",
"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":"[Link]"
}
Set a Supplier attribute to null.
PUT /suppliers/<GUID>?setnull=true
{
"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",

Endpoints 1007
 "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/Region":"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":"",
"postalCode":"01234",
"Country/Region":"United States"
},
"primary":false
}
],
"approvalStatus":"approved",
"creationDateTime":"2018-04-27T00:18:52Z",
"creator":{
"email":"hwalker@[Link]",
"fullName":"Heidi Walker"
},
"description":"Full service board house",
"guid":"UCWFY6FFCTCI1K3B82OC",
"name":"The Board Room",
"phoneNumbers":[
{
"comment":null,
"extension":null,

1008 Arena REST API Developer Guide

 "label":"Main",
"number":"111-111-1111"
},
{
"comment":null,
"extension":null,
"label":"Fax",
"number":"111-111-1110"
}
],
"supplierId":null,
"website":"[Link]"
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

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

Endpoints 1009
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

GET Supplier Address

/suppliers/<GUID>/addresses/<GUID>
Returns a specific address with a given GUID of a Supplier on page 1145 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

1010 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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/Region": "United States",
"guid": "5N7Q9M7YLOZ3M5GLXZ0K",
"label": "SF Office",
"postalCode": "94003",
"province": null,
"state": "CALIFORNIA"
},
"primary": false
}
Request with bad GUID
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

GET Supplier Addresses

/suppliers/<GUID>/addresses

Endpoints 1011
Returns the addresses a Supplier on page 1145 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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/Region": "United States",
"guid": "5N7Q9M7YLOZ3M5GLXZ0K",
"label": "SF Office",
"postalCode": "94003",
"province": null,

1012 Arena REST API Developer Guide

 "state": "CALIFORNIA"
},
"primary": false
},
{
"address": {
"address1": "No.37 Xiangyang Rd.",
"address2": null,
"city": "Taipei City",
"Country/Region": "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."
}
]
}

GET Supplier Profile Phone Numbers

/suppliers/<GUID>/phonenumbers
Returns the phone numbers of a Supplier on page 1145 object with a given GUID.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Endpoints 1013
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"
},
{
"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"
}

1014 Arena REST API Developer Guide

 ]
}
Request with bad GUID
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

GET Supplier Phone Number

/suppliers/<GUID>/phonenumbers/<GUID>
Returns a specific phone number with a given GUID of a Supplier on page 1145
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 1015
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
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"0I2L4CLLIZISBUDUIUI4\" is not valid."
}
]
}

POST Supplier Profile Address Create

/suppliers/<GUID>/addresses
Creates new addresses for a Supplier on page 1145 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/Region": "United States",
"label": "Main",
"postalCode": "95131",
"province": null,
"state": "CALIFORNIA"
},
"primary": false

1016 Arena REST API Developer Guide

}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Create a new supplier address.
/suppliers/<GUID>/addresses
{
"address": {
"address1": "1738 Lundy Ave.",
"address2": null,
"city": "San Jose",
"Country/Region": "United States",
"guid": "0I2L4CLLIZISBUDUIUI4"
"label": "Main",
"postalCode": "95131",
"province": null,
"state": "CALIFORNIA"
},
"primary": false
}
Request with invalid Country/Region or state
{
"status":400,
"errors":[
{
"code":3045,
"message":"The Country/Region or state is invalid

Endpoints 1017
 for the supplier address."
}
]
}

POST Supplier Phone Number Create

/suppliers/<GUID>/phonenumbers
Creates a new phone number for a Supplier on page 1145 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

1018 Arena REST API Developer Guide

Sample Response Body
Create a new supplier phone number.
/suppliers/<GUID>/phonenumbers
{
"comment": "Rosalind Noyles",
"extension": "x2490"
"guid": "0I2L4CC150GZI1KTEM6N"
"label": "Main",
"number": "408-946-3581"
}

PUT Supplier Profile Address Edit

/suppliers/<GUID>/addresses/<GUID>
Updates an existing specific phone numbers of a supplier on page 1145 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/Region": "United States",
"label": "Main",
"postalCode": "85034",
"province": null,
"state": "ARIZONA"
},
"primary": false
}

Response Codes
Code Description
200 Success
400 Failure

Endpoints 1019
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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/Region": "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."
}
]
}

1020 Arena REST API Developer Guide

PUT Supplier Phone Number Edit
/suppliers/<GUID>/phonenumbers/<GUID>
Updates the existing phone numbers of a supplier on page 1145 with a given
GUID.

Request Header
Name Value Description
arena_session_id unique ID for session
obtained from login
content-type application/json

Set Null
Name Value Description
setnull Append the URL with
setnull=true to set
comment,extension, label,
number to null. Attributes
must be included within
the request body and set
to null. Insert setnull after
the query string,
represented by a ?, after
the GUID.

Sample Request Body

PUT /suppliers/<GUID>/phonenumbers/<GUID>
{
"comment": "Priya Chang",
"extension": "x3910",
"label": "Main Researcher",
"number": "512-746-3781"
}
PUT /suppliers/<GUID>/phonenumbers/<GUID>?setnull=true
{
"label":null
}

Response Codes
Code Description
200 Success
400 Failure

Endpoints 1021
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Update a specific phone number of a supplier.
/suppliers/<GUID>/phonenumbers/<GUID>
{
"comment": "Priya Chang",
"extension": "x3910",
"guid":"I0K3MU330HYGZI1K9K72",
"label": "Main Researcher",
"number": "512-746-3781"
}
Set a Supplier Phone attribute to null.
PUT /suppliers/<GUID>/phonenumbers/<GUID>?setnull=true
{
"comment": "Priya Chang",
"extension": "x3910",
"guid":"I0K3MU330HYGZI1K9K72",
"label": null,
"number": "512-746-3781"
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

1022 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

Endpoints 1023
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

1024 Arena REST API Developer Guide

GET Supplier File Associations
/Supplier/<GUID>/files
Returns a collection of File on page 1115 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

GET all files associated with a Supplier
GET /suppliers/VDXGZ7GGDUDUDRYLY132/files
{
"count": 2,
"results": [
{
"file": {
"author": {
"fullName": "Yvette Keller"

Endpoints 1025
 },
"category": {
"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 [Link]",
"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 [Link]",
"number": "FILE-000875",
"private": false,

1026 Arena REST API Developer Guide

 "size": 74607,
"storageMethodName": "FILE",
"title": "EveryRoad GPS Car Navigation Unit -
Model 300, Rendering"
},
"guid": "ASCVERC3QTAI1K1T6GP6"
},
...
]
}
Request with bad GUID
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

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

Endpoints 1027
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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"
},
"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 [Link]",
"number":"FILE-000059",
"private":false,
"size":416233,
"smartLink":"[Link] Q7Q6-P8RA-
QO30-O53P-SCDY-CYF3",
"storageMethod":0,

1028 Arena REST API Developer Guide

 "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."
}
]
}

POST Supplier File Add Existing

/suppliers/<GUID>/files
Associates an existing File Association on page 1118 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"
}
}

Endpoints 1029
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
Associate an existing file with a Supplier.
/suppliers/<GUID>/files
{
"file": {
"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) [Link]",
"number": "FILE-000888",
"private": false,
"size": 35086,
"storageMethodName": "FILE",
"title": "BASF Terluran GP-22 (ABS) Datasheet"
},
"guid": "BTDWFSD4RUBJ2L2U7HQD"
}

1030 Arena REST API Developer Guide

An error is returned if:
1. The GUID is not valid.
{
"status": 400,
"errors": [
{
"code": 3011,
"message": "The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 1031
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\"."
}
]
}

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

1032 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

GET Supplier Quality Processes

GET /suppliers/<GUID>/quality
GET /suppliers/<GUID>/quality/<GUID>
Returns a collection of Quality Process on page 1135 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

Endpoints 1033
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get quality processes for a supplier
GET /suppliers/<GUID>/quality
{
"count":1,
"results":[
{
"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",

1034 Arena REST API Developer Guide

 "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."
}
]
}

GET Supplier Items

/supplieritems
Returns an array of Supplier Item on page 1146 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

Endpoints 1035
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.

1036 Arena REST API Developer Guide

Searchable Attributes
Name Value Description
[additional attribute guid string This special search
value] permits searching for
strings in additional
attribute values. For
example GET /items?
VDXGZ7E0-
GO5N6P8PR55G=
*100pF where
VDXGZ7E0-
GO5N6P8PR55G 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 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?
HZJ2LT22ZGZ5O7-
QY77YO=2019-04-01

Endpoints 1037
Name Value Description
name string supplier item name
number true or false supplier item number
[Link] string supplier name
[Link] 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.
For additional attribute field type MULTI_LINE_TEXT searches, different
values can be separated with an asterisk.
For additional attribute field types DROP_DOWN & FIXED_DROP_DOWN
searches, different values can be separated with a semi-colon.
Search in Zulu format is supported for custom attribute field type Date.
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
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

1038 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all supplier items where the name includes "capacitor"
/supplieritems?name=*capacitor
{
"count":20,
"results":[
{
"creationDateTime":"2011-02-11T17:13:08Z",
"creator":{
"email":"hwalker@[Link]",
"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":"hwalker@[Link]",
"fullName":"Heidi Walker"
},
"description":null,
"guid":"ASCVEMVVS9SXGZIPGPK7",
"name":"Capacitor; Ceramic",
"number":"NMC0603X7R103K50TRPF",
"offTheShelf":true,
"supplier":{
"guid":"HZJ2LT22ZGZ5O7QY77YO"
},
"type":"PART",
"uom":"each"
},
...
]

Endpoints 1039
}
Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

GET Supplier Item Specs

/supplieritems/<GUID>
Returns a Supplier Item on page 1146 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

1040 Arena REST API Developer Guide

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"
},
{
"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":"hwalker@[Link]",
"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,

Endpoints 1041
 "message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

POST Supplier Item Create

/supplieritems
Creates a new Supplier Item on page 1146 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

1042 Arena REST API Developer Guide

Parameters
Name Value Description
proceedOnWarning Boolean Parameter operates
independent of the
Duplicate Supplier Item
Numbers Allowed setting.
• If set to true the
endpoint creates the
supplier item even if
an existing supplier
item with the same
number exists for that
supplier.
• If set to false the
endpoint will not
create the a supplier
item if a supplier item
exists for that
supplier.
If omitted from the url,
the assumed value is true.

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"
}

Endpoints 1043
 ],
"description":"Rear board crescent moon",
"name":"Rear board crescent moon",
"number":"BHM-27B6",
"offTheShelf":true,
"supplier":{
"guid":"UCWFY6FFCTCI1K3B82OC"
},
"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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Create a new supplier item
/supplieritems?proceedOnWarning=true
{
"additionalAttributes": [
{
"apiName": "custom902625",
"fieldType": "DROP_DOWN",
"guid": "2K4N6ENNK1I0J2L44BET",
"name": "First Article Tester",
"value": "Testing Lead"
},
{
"apiName": "custom902622",
"fieldType": "FIXED_DROP_DOWN",

1044 Arena REST API Developer Guide

 "guid": "ZH1K3BKKHYFXGZI118BV",
"name": "Compliance Risk?",
"value": "No"
},
{
"apiName": "custom902623",
"fieldType": "MULTI_LINE_TEXT",
"guid": "0I2L4CLLIZGYH0J229CD",
"name": "Notes",
"value": "Always check for stock"
},
{
"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": "hwalker@[Link]",
"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. Endpoint with proceedOnWarning set to false:
{
"status":400,
"errors":[
{
"code":3364,

Endpoints 1045
 "message":"Supplier item number \"PHST-M2x5\" exists
already for supplier \"Access Components, Inc.\"."
}
]
}
2. 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."
}
]
}
3. a general error occurs:
{
"status":400,
"errors":[
{
"code":4000,
"message":"Sorry, a system error occurred, please try again."
}
]
}

PUT Supplier Item Update

/supplieritems/<GUID>
Updates the metadata of a Supplier Item on page 1146 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

1046 Arena REST API Developer Guide

Parameters
Name Value Description
proceedOnWarning Boolean Parameter operates
independent of the
Duplicate Supplier Item
Numbers Allowed setting.
• If set to true the
endpoint creates the
supplier item even if
an existing supplier
item with the same
number exists for that
supplier.
• If set to false the
endpoint will not
create the a supplier
item if a supplier item
exists for that
supplier.
If omitted from the url,
the assumed value is true.

Set Null
Name Value Description
setnull Append the URL with
setnull=true to set name,
description, or type to
null. Attributes must be
included within the
request body and set to
null. Insert setnull after
the query string,
represented by a ?, after
the GUID.

Sample Request Body

PUT /supplieritems/<GUID>
{
"additionalAttributes":[
{
"guid":"ZH1K3BKKHYFXGZI118BV",
"value":"Yes"

Endpoints 1047
 },
{
"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"
}
PUT /supplieritems/<GUID>?setnull=true
{
"description":null
}

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

1048 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Update a given supplier item
/supplieritems/<GUID>?proceedOnWarning=true
{
"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",
"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",

Endpoints 1049
 "creator":{
"email":"hwalker@[Link]",
"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"
}
Set a Supplier Item attribute to null.
PUT /supplieritems/<GUID>?setnull=true
{
"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",
"guid":"1J3M5DMMJ0HZI1K33ADK",
"name":"Stock EOQ",
"value":"10"
},
{
"apiName":"custom902621",
"fieldType":"DATE",

1050 Arena REST API Developer Guide

 "guid":"YG0J2AJJGXEWFYH007AO",
"name":"Re-Evaluate On",
"value":"2020-01-01T07:59:59Z"
}
],
"creationDateTime":"2018-04-27T22:55:36Z",
"creator":{
"email":"hwalker@[Link]",
"fullName":"Heidi Walker"
},
"description":null,
"guid":"I0K3MU330H05O7QRXRV8",
"name":"Rear board half moon",
"number":"BHM-27B6",
"offTheShelf":true,
"supplier":{
"guid":"UCWFY6FFCTCI1K3B82OC"
},
"type":"PART",
"uom":"each"
}

1. Endpoint with proceedOnWarning set to false:

{
"status":400,
"errors":[
{
"code":3364,
"message":"Supplier item number \"PHST-M2x5\" exists
already for supplier \"Access Components, Inc.\"."
}
]
}
2. Request with bad GUID
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid."
}
]
}

GET Supplier Item Thumbnail Image

Content
GET /supplieritems/<GUID>/image/content

Endpoints 1051
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]

1052 Arena REST API Developer Guide

 }
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.

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

Endpoints 1053
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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.
{
"status":400,
"errors": [
{
"code": 3094,
"message": "The specified file is not a valid image."
}
]
}

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.

1054 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Responses
When creating a file with no uploaded content:
{
"guid":"5N7Q9M7YLO7N6PSJ5BSL"
}

Returns an error if the file is not a valid image file..

{
"status":400,

Endpoints 1055
 "errors":[
{
"code":3094,
"message":"The file must be associated with the item (supplier
item)."
}
]
}

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

1056 Arena REST API Developer Guide

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.

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."
}
]
}

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

Endpoints 1057
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}

GET Supplier Item Compliance

/supplieritems/<GUID>/compliance
Returns all Compliance Requirement on page 1109 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

1058 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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":"hwalker@[Link]",
"fullName":"Heidi Walker"
},
"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
{

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

GET Supplier Item Compliance

Requirement
GET /supplieritems/<GUID>/compliance/<GUID>
Returns a Compliance Requirement on page 1109 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

1060 Arena REST API Developer Guide

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.

Sample Responses
Get a single supplier item compliance requirement
GET /supplieritems/<GUID>/compliance/<GUID>
{
"evidenceType":"DIRECT_FILES",
"guid":"XFYH0J10J2CU9P5Z",
"lastModifiedBy":{
"email":"hwalker@[Link]",
"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."
}
]
}

PUT Supplier Item Compliance Update

PUT /supplierItems/<GUID>/compliance/<GUID>

Endpoints 1061
Updates a Compliance Requirement on page 1109 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

Set Null
Name Value Description
setnull Append the URL with
setnull=true to set mark
or rationale to null.
Attributes must be
included within the
request body and set to
null. Insert setnull after
the query string,
represented by a ?, after
the GUID.

Sample Request Body

PUT /supplierItems/<GUID>/compliance/<GUID>
{
"evidenceType":"DIRECT_FILES",
"mark":"blue checkmark on packaging",
"rationale":"evidence provided by files attached to supplier
item",
"status":"COMPLIANT"
}
PUT /supplierItems/<GUID>/compliance/<GUID>?setnull=
true
{
"mark":null
}

Response Codes
Code Description
201 Success
400 Failure

1062 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Update a compliance requirement for a supplier item
PUT /supplieritems/<GUID>/compliance/<GUID>
{
"evidenceType":"DIRECT_FILES",
"guid":"WEXGZI0ZI1K30FUO",
"lastModifiedBy":{
"fullName":"Heidi Walker"
},
"lastModifiedDateTime":"07/31/2015 05:50:26 PM",
"mark":null,
"rationale":"evidence provided by files attached to supplier
item",
"requirement":{
"guid":"GYI1KSZL19RQ9SBTZ4KV",
"name":"2011/65/EU RoHS"
},
"status":"COMPLIANT"
}
Set a Supplier Item Compliance attribute to null.
PUT /supplierItems/<GUID>/compliance/<GUID>?setnull=
true
{
"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",

Endpoints 1063
 "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."
}
]
}

GET Supplier Item File Associations

/supplieritems/<GUID>/files
Returns an array of File on page 1115 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

1064 Arena REST API Developer Guide

Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",
"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":"[Link]",
"number":"FILE-000814",
"private":false,
"size":31232,
"storageMethod":0,
"storageMethodName":"FILE",
"title":"7011X1-5"
},
"guid":"FXH05VWW5CUYH0W6I8ZD",
"primary":true
},
{
"file":{

Endpoints 1065
 "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%[Link]",
"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."
}
]
}

1066 Arena REST API Developer Guide

GET Supplier Item File Association
/supplieritems/<GUID>/files/<GUID>
Returns a File Association on page 1118 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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",

Endpoints 1067
 "path":"File\\Engineering\\Product Requirements Doc"
},
"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%[Link]",
"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."
}
]
}

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.

1068 Arena REST API Developer Guide

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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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."
}
]
}
2. An error is thrown by the file server
{

Endpoints 1069
 "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.

POST Supplier Item File Create

/supplieritems/<GUID>/files
Creates a new File Association on page 1118 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

1070 Arena REST API Developer Guide

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- GUID string GUID for new file
ItemFileAssociation-Guid association - only when
including content
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Request Body

• Creating a File and uploading content to Arena servers (text format):
Text attributes:
[Link]: Heidi Walker
[Link]: WEYHMCDDMTCM5O08WPWY
[Link]: Assembly Instructions
[Link]: 1
[Link]: txt
[Link]:false
[Link]: FILE
[Link]: 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",

Endpoints 1071
 "format":"pdf",
"location":"[Link]/docs/[Link]",
"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- GUID string GUID for new file
SupplierItemFileAsso- association - only
ciation-Guid when including
content
X-Arena-Next- date the scheduled time for
Request-Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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":"[Link]/docs/[Link]",
"mimeType":null,
"name":"[Link]",

1072 Arena REST API Developer Guide

 "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 \"[Link]\" is required."
}
]
}

POST Supplier Item File Content Update

/supplieritems/<GUID>/files/<GUID>/content
Updates file content for an existing File on page 1115 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

Endpoints 1073
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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":[
{

1074 Arena REST API Developer Guide

 "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."
}
]
}

POST Supplier Item File Add Existing

/supplieritems/<GUID>/files
Associates an existing File Association on page 1118 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"
}
}

Endpoints 1075
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Associate an existing file with a supplier item
{
"file":{
"author":{
"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%[Link]",
"number":"FILE-000843",
"private":false,
"size":28847,
"storageMethod":0,
"storageMethodName":"FILE",
"title":"Chicago Miniature Lamp 7011X Series Bicolor SMT
LEDs"
},
"guid":"I0K38YZZ8FX1K3Z9LB19",
"primary":false
}

1076 Arena REST API Developer Guide

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."
}
]
}

PUT Supplier Item File Association

Update
/supplieritems/<GUID>/files/<GUID>
Updates information about (but not the content of) an existing File on page 1115
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
}

Endpoints 1077
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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Update the details of a file associated with a supplier item
/supplieritems/<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":"[Link]",
"number":"FILE-000825",
"private":false,
"size":463360,
"storageMethod":0,

1078 Arena REST API Developer Guide

 "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."
}
]
}

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

Endpoints 1079
Name Value Description
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

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\"."
}
]
}

POST Supplier Item Compliance

POST /supplieritems/<GUID>/compliance
Creates a Compliance Requirement on page 1109 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",

1080 Arena REST API Developer Guide

 "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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Create a compliance requirement for a Supplier Item
POST /items/<GUID>/compliance
{
"evidenceType":"DIRECT_FILES",
"guid":"J1L4N0LCZ2KGZISABJ8Q",
"lastModifiedBy":{
"email":"hwalker@[Link]",
"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

Endpoints 1081
{
"status":400,
"errors":[
{
"code":3082,
"message":"Invalid evidence type."
}
]
}

DELETE Supplier Item Compliance

DELETE /supplieritems/<GUID>/compliance/<GUID>
Deletes a Compliance Requirement on page 1109 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- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

1082 Arena REST API Developer Guide

Sample Response Body
No JSON response.
Request with invalid evidence type or status
{
"status":400,
"errors":[
{
"code":3082,
"message":"Invalid evidence type."
}
]
}

GET Supplier Item Quality Processes

GET /supplieritems/<GUID>/quality
GET /supplieritems/<GUID>/quality/<GUID>
Returns an array of Quality Process on page 1135 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

Endpoints 1083
Name Value Description
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Sample Response Body

Get all quality processes that include a given supplier item
GET /supplieritems/0I2LQGHHQXGXGVRR5XND/quality
{
"count":1,
"results":[
{
"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

1084 Arena REST API Developer Guide

 }
}
Produces an error if the GUID is not valid.
{
"status":400,
"errors":[
{
"code":3011,
"message":"The guid \"0I2LQGHHQXGXGVRR5XND\" is not
valid."
}
]
}

GET Supplier Item Source Relationships

/supplieritems/<GUID>/sourcing
Returns a collection of Source Relationship on page 1143 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

Endpoints 1085
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.
[Link] 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
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

1086 Arena REST API Developer Guide

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": "[Link]
5N7QVLMMV2L2L0WWA3PY",
"app": "[Link]
}
},
"makeItem":false,
"mfrItem":{
"guid":"I0K38YZZ8FY3M55VE92O"
},
"notes":"Reel",
"vendorItem":{
"guid":"HZJ27XYY7EX2L44UD816"
},
"vendorItemConversionFactor":1
},
{
"activeProduction":false,
"activePrototype":false,
"amlRank":null,
"amlSplit":null,
"approved":true,
"guid": "VDXGZCXOBEWDWFGK9D4A",
"item":{
"guid":"VDXGLBCCLSBSBQMM0UZ1",
"name": "Capacitor, Ceramic Chip, 0.01uF, 0603",
"number": "120-00005",
"revisionNumber": "A",
"revisionStatus": "EFFEC|TIVE",
"status": 1,

Endpoints 1087
 "url": {
"api": "[Link]
VDXGLBCCLSBSBQMM0UZ1",
"app": "[Link]
}
},
"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."
}
]
}

GET Supplier Item Source Relationship

/supplieritems/<GUID>/sourcing/<GUID>
Returns a single Source Relationship on page 1143 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

1088 Arena REST API Developer Guide

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.
[Link] 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
Server ArenaSolutions
X-Arena-Next-Request- date the scheduled time for
Limit-Reset resetting of the count
X-Arena-Requests- number how many calls left
Remaining

Endpoints 1089
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": "[Link]
VDXGLBCCLSBSBQMM0UZ1",
"app": "[Link]
}
},
"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
}
Request with bad GUID:
{
"status":400,
"errors":[
{
"code":3011,

1090 Arena REST API Developer Guide

 "message":"The guid \"0I2LQGHHQXGXGVRR5XND\" is not
valid."
}
]
}

Endpoints 1091
 3
Objects
Address................................................................................................................ 1095
Attribute................................................................................................................ 1095
BOM Settings........................................................................................................ 1099
Category............................................................................................................... 1099
Request................................................................................................................ 1101
Request Affected Item ........................................................................................... 1102
Change ................................................................................................................ 1103
Change Compact .................................................................................................. 1105
Change Affected Item ............................................................................................ 1106
Change Item Disposition Attribute........................................................................... 1108
Change Implementation Task ................................................................................. 1108
Change Implementation Task Note ......................................................................... 1108
Change Number Prefix .......................................................................................... 1109
Change Routing .................................................................................................... 1109
Compliance Requirement....................................................................................... 1109
Import Definition .....................................................................................................1110
Import Run.............................................................................................................1112
Export ...................................................................................................................1113
Extract...................................................................................................................1114
Extract Run............................................................................................................1114
Extract Run File Association....................................................................................1115
File........................................................................................................................1115
File Compact..........................................................................................................1117
File Access Event...................................................................................................1117
File Assocation.......................................................................................................1118
Item.......................................................................................................................1118
Item Compact ....................................................................................................... 1120
Item BOM Line ...................................................................................................... 1121
BOM Substitutes ................................................................................................... 1121
Item Lifecycle Phase ............................................................................................. 1122
Item Number Format.............................................................................................. 1122

1092 Arena REST API Developer Guide

Compact Item Number Format ............................................................................... 1123
Item Revision ........................................................................................................ 1123
Item View.............................................................................................................. 1123
Item to Item References......................................................................................... 1124
Export Results: Item Specs ................................................................................... 1124
Export Results: Item BOM...................................................................................... 1126
Export Results: Item BOM Substitutes .................................................................... 1126
Export Results: Item Sourcing ................................................................................ 1127
Export Results: Item Files ...................................................................................... 1128
Export Results: File Summary ............................................................................... 1128
Export Results: Sourcing Supplier Item Specs ......................................................... 1129
Export Results: Sourcing Supplier Item Supplier Profile ............................................ 1130
Export Results: Sourcing Supplier Item Files ........................................................... 1131
Event Queue: Integration Information...................................................................... 1131
Event Queue: Integration Administrators ................................................................. 1132
Event Queue: Integration Event.............................................................................. 1132
Event Queue: Integration Event Items ..................................................................... 1133
Login .................................................................................................................... 1134
Markup ................................................................................................................. 1134
Quality Process Number Format............................................................................. 1135
Quality Process..................................................................................................... 1135
Quality Process Step ............................................................................................. 1136
Quality Process Template ...................................................................................... 1138
Quality Process Template Step............................................................................... 1139
Quality Affected Object .......................................................................................... 1139
Quality Affected..................................................................................................... 1140
Training Plans Summary ........................................................................................ 1140
Tickets Summary................................................................................................... 1141
Report .................................................................................................................. 1141
Report Run ........................................................................................................... 1142
Requirement ......................................................................................................... 1142
Source Relationship .............................................................................................. 1143
Quality Process Step Attribute ................................................................................ 1144
Supplier................................................................................................................ 1145
Supplier Phone Number......................................................................................... 1146
Supplier Item......................................................................................................... 1146
Supplier Item Compliance Requirement .................................................................. 1147
User ..................................................................................................................... 1148
User Compact ....................................................................................................... 1148
Where Used Line .................................................................................................. 1148

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.

Objects 1093
 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.

1094 Arena REST API Developer Guide

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/Region of a Supplier address
Region
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
Data
Field Type Available when Description
allowLo- Boolean Item Description, Indicates whether or not
werCase Item Name, Change lowercase characters are allowed
Description, Change in values for this attribute
Title
allow- Boolean Item Description, Indicates whether or not number
Numbers Item Name, Change characters are allowed in values
Description, Change for this attribute
Title
allowUp- Boolean Item Description, Indicates whether or not
perCase Item Name, Change uppercase characters are allowed
Description, Change in values for this attribute
Title
allowNeg- Boolean fieldType is Indicates whether or not negative
atives POSITIVE_ numbers are allowed for the
DOUBLE or attribute value. The value can be
NUMERIC true or false.
allowsEx- Boolean always available Indicates whether or not
plicitNull- submitting a value of null clears
Value the field, resulting in no value.
The value can be true or false.
This value is only true for

Objects 1095
 Data
Field Type Available when Description
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 Indicates whether or not an
attributes attribute is a custom attribute (a
non system-defined attribute
defined by an Account
Administrator). The value can be
true or false.
decimal- Integer fieldType is The number of decimal places for
Places POSITIVE_ a numeric value.
DOUBLE or
NUMERIC
default- String attribute is creatable The default value for an attribute.
Value and value is not null Only shown when its value is not
null and creatable is True.
deprecat- Boolean its value is True Indicates when an attribute is
ed being phased out of the Arena
REST API.
develo- String its value is not null End user information about the
perNotes 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.
excluded- Collection its value is not null Lists disallowed characters for
Values of Strings the attribute value
fieldType String always available The type of attribute. This value
can be SINGLE_LINE_TEXT,
MULTI_LINE_TEXT,

1096 Arena REST API Developer Guide

 Data
Field Type Available when Description
BOOLEAN, DROP_DOWN,
POSITIVE_DOUBLE, FIXED_
DROPDOWN, NUMERIC,
DATETIME
guid String custom is True Unique identifier for the attribute.
inViews Collection custom is False A list of views in the Arena
of Strings application in which the attribute
is shown.
max- Number fieldType is The maximum length of a text
Length SINGLE_LINE_ field. This is used for validation.
TEXT, MULTI_
LINE_TEXT, or
DROP_DOWN
maxSelec- Number multiSelect is True Maximum number of values
tions allowed for the attribute.
maxValue Double fieldType is The maximum value for an
POSITIVE_ integer or double field. This is
DOUBLE or also used for validation.
NUMERIC
multiSe- Boolean fieldType is FIXED_ Indicates whether or not an
lect DROP_DOWN attribute can have 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.
possible- Array of fieldType is DROP_ All possible values for a drop-
Values Strings DOWN or FIXED_ down list.
DROP_DOWN.
required Boolean creatable is True, Indicates whether or not an
global is True 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)

Objects 1097
 Data
Field Type Available when Description
revision- Boolean Item custom attributes Indicates whether or not edits to
Control- the attribute trigger the Modified
led 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.

1098 Arena REST API Developer Guide

BOM Settings
Field Data Type Description
automaticallyGenerateLi- Boolean Determines if line numbers on a BOM
neNumbers are be generated automatically (and
have no significance) or entered
manually and retained. The value can
be True or False.
checkReferenceDesigna- Boolean Determines if reference designators are
tors 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.
allowDuplica- Boolean This indicates whether or not Items included in
teRevisions 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
allowManual- Boolean This indicates whether or not users can
RevisionEntry 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.
creationDate- Date- The date and time (in Zulu format) an object
Time Formatted was created.
String
creator Reference The creator of a category. Contains the

Objects 1099
Field Data Type Description
attributes email, fullName, and guid.
description String The description of a category
deletionDate- Date- The date and time (in Zulu format) the category
Time Formatted 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)
enforceDefaul- Boolean This indicates whether or not the default
tEffectivity- effectivityType should be enforced for Changes
Type 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.
enforceDe- Boolean This indicates whether or not the default
faultNumber- numberingSequence should be enforced for
Sequence 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
initialImple- String The starting implementation status for Changes
mentationSta- assigned to the category.
tus
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 on page
1122 object. (only used for Item categories)
numberingSe- Reference Details about the numbering sequence prefix
used for Changes assigned to this category.

1100 Arena REST API Developer Guide

Field Data Type Description
quencePrefix- (only used for Change categories)
Default
path String The path of a category, for example: item
\assembly
parentCatego- Reference Details of the category that exists in a direct
ry 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.

Request
This object includes all fields in a Request.
Field Data Type Description
additionalAttributes Array of The additional attributes of a request.
Attributes This is an array of additional attributes.
Each additional attribute entry includes
a guid, a name, and a value.
category Reference The category of a request. This
compact category listing includes guid,
name, and path.
creator Reference The user that created the request.
Includes email, fullName, and guid.
creationDateTime Date- the date and time (in Zulu format) a
Formatted request was created
String
creatorParticipation Boolean True indicates that the creator is a
participant in the request.
deferDeadlineDateTime Date- The date and time (in Zulu format)
Formatted before which a request must be
String deferred.
deferralCode String Indicates the code used as a reason to

Objects 1101
Field Data Type Description
defer the request.
lifecycleDateTime Date- the date and time (in Zulu format) when
Formatted a request reaches a status.
String
lifecycleStatus String The lifecycle status of the request.
lifecycleDateTime String the date and time (in Zulu format) the
last lifecycle status request occurred
number String the number of a request
guid String unique ID of a request.
problem String Text field used for describing the
problem that is in discussion. This
attribute can be set to null.
requestCode String A set of codes used to categorize the
reason for the request (e.g.,
Performance).
requestedAction String The action proposed that will solve the
problem brought up by the request.
This attribute can be set to null.
resolutionCode String The code cited when resolving a
request (e.g., ‘Approved [Immediate]).
submissionDateTime String the date and time (in Zulu format) a
request was submitted.
submitter Reference the user who submitted the request for
approval. Includes email, fullName,
and guid.
title String the title of a request. This attribute can
be set to null.

Request Affected Item

Example
Request Affected Items appear in GET Request Item and GET Request Items
responses and describe what items are included in a request.

1102 Arena REST API Developer Guide

Field Data Type Description
item Reference Details of an affected item included in a
request. Includes: GUID, name. number,
revisionNumber, revisionStatus, and url (api
and application URL links).
guid String unique ID for an item on a request.
notes String Notes related to the item included in the
request. This attribute can be set to null.

Change
This object includes all fields in a Change.
Field Data Type Description
additionalAttributes Array of The additional attributes of a change.
Attributes This is an array of additional attributes.
Each additional attribute entry includes
a guid, a name, and a value.
approvalDeadlineDate- Date- The date and time (in Zulu format)
Time Formatted before which a change must be
String approved. If enforceApprovalDeadline
is set to true, the change is
automatically rejected once this
deadline is [Link] the Note on
Date/Time Handling on page 29. This
attribute can be set to null.
category Reference The category of a change. This compact
category listing includes guid, name,
and path.
creationDateTime Date- the date and time (in Zulu format) a
Formatted change was created
String
creator Reference The user that created the change.
Includes email, fullName, and guid.
description String The description of a change. This
attribute can be set to null.
effectiveDateTime Date- the date and time (in Zulu format) when
Formatted a change became effective
String
effectivityPlannedDate- Date- The date and time when a change will
Time Formatted become effective after approval. This is

Objects 1103
Field Data Type Description
String required only for changes of
effectivityType PERMANENT_ON_
DATE. See the Note on Date/Time
Handling on page 29
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- The date and time when a change will
Formatted expire. This is required only for
String changes of effectivityType
TEMPORARY. Can be edited by any
user when 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 [Link] the Note on Date/
Time Handling on page 29
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. This attribute can be
set to null.
implementationStatusDa- Date- the date and time (in Zulu format) the
teTime Formatted last implementation status edit occurred
String
implementationStatusEdi- Date- The user who last edited the
tor Formatted implementation status. Includes email,
String fullName, and guid.
lifecycleDateTime String the date and time (in Zulu format) the

1104 Arena REST API Developer Guide

Field Data Type Description
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
routings Array of The routings (groups of users who vote)
References included in 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. This attribute can
be set to null.
url Array of The direct urls of the object within the
References api and the application.

Change Compact
Field Data Type Description
category Reference The category of a change. This compact
category listing includes guid, name, and path.
creationDate- Date- the date and time (in Zulu format) a change was
Time Formatted created
String
creator Reference The user that created the change. Includes
email, fullName, and guid.
effectiveDate- Date- the date and time (in Zulu format) when a
Time Formatted change became effective
String
guid String unique ID of a change

Objects 1105
Field Data Type Description
implementa- String Impementation status of a change. Values can
tionStatus be NOT_STARTED, IN_PROGRESS,
NEEDS_ATTENTION, DONE, or NONE. This
attribute can be set to null.
lifecycleDate- Date- the date and time (in Zulu format) the last
Time Formatted lifecycle phase change occurred
String
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
submissionDa- Date- the date and time (in Zulu format) a change was
teTime Formatted submitted for approval
String
title String the title of a change. This attribute can be set to
null.
url Array of The direct urls of the object within the api and
References the application

Change Affected Item

Example
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.
Field Data Type Description
affectedItem- Reference Details of an affected item revision included in
Revision a change. This is the effective revision number.
See Revision on page 1123 object.
bomView Reference Details about the BOM view of an item
included in a change. See Item View on page
1123 object
dispositionAt- Collection of Details of the inventory disposition settings of
tributes References an item (e.g. In Design). See Disposition

1106 Arena REST API Developer Guide

Field Data Type Description
Attribute on page 1108 object.
filesView Reference Details about the Files view of an item included
in a change. See Item View on page 1123 object
guid String unique ID for a modified item.
materialEffec- Date- date when inventory disposition settings for a
tivityDateTime Formatted change become effective. This attribute can be
String set to null.
newItemRevi- Reference Details of the item revision entered on the
sion Specs view of the working revision in the Items
world. See Revision on page 1123 object.
newRevision- Reference Details of the item revision that will be released
Number by a change. (The value on the Specs view of
the working revision in the Items world). See
Revision on page 1123 object.
newLifecycle- Reference Details of the target lifecycle phase for an item
Phase included in a change
retraining String Available for Change Affected Items that are
also part of Training Plans. Possible values:
NO_RETRAIN; AFTER_APPROVED;
AFTER_EFFECTIVE
retrainingRe- Boolean Indicates that the Change Affected Item has a
quired retrain option for After Approval or After
Affective
sourcingView Reference Details about the Sourcing view of an item
included in a change. See Item View on page
1123 object.
specsView Reference Details about the Specs view of an item
included in a change. See Item View on page
1123 object.
url Array of The direct urls of the object within the api and
References the application.

Objects 1107
Change Item Disposition Attribute
Example
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 reserved for an 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 Implementation Task

Example
Change Implementation Tasks appear in GET Change Implementation Tasks and
GET Change Implementation Tasks and describe what tasks ares included in
implementing a Change.
Field Data Type Description
guid String unique ID for an object.
name String The name of a change implementation task.
assignee Reference References the user assigned to complete the
implementation task. Could be an individual or
a user group. This attribute can be set to null.
dueDate Date- The scheduled due date to complete the
Formatted implementation task.. This attribute can be set
String to null.
status String The status of the implementation task (e.g.,
Done).

Change Implementation Task Note

Example
Change Implementation Tasks appear in GET Change Implementation Task Notes
and GET Change Implementation Task Note and describe a note for a Change
Implementation Task.

1108 Arena REST API Developer Guide

Field Data Type Description
guid String unique ID for an object.
note String The note of a change implementation task. This
attribute can be set to null.
private Boolean If set to true the Change Implementation Note is
hidden from suppliers. If set to false the note is
not hidden from suppliers.
label String The label of the implementation task. (e.g., Cost
Impact).

Change Number Prefix

Field Data Type Description
guid String unique identifier for the number prefix
prefix String the string of letters and separator used as the
first segment of a change number

Change Routing
Example
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
lastModified- String the user who last modified a compliance
By requirement

Objects 1109
Field Data Type Description
lastModified- Date- the date and time (in Zulu format) a compliance
DateTime Formatted requirement was last modified
String
mark String the mark of a compliance requirement (physical
mark added to product or packaging). This
attribute can be set to null.
propagate Boolean Indicates whether or not a compliance
(applies to requirement is propagated to children. This
Items only) value can be true or false.
rationale String the rationale of a compliance requirement
(explanation of status). This attribute can be set
to null.
requirement Reference Details of the requirement. See Requirement on
page 1142 object.
status String The status of a compliance requirement. The
value can be UNKNOWN, COMPLIANT,
EXEMPT, NA, NON_COMPLIANT

Import Definition
Field Data Type Description
guid String The unique identifier for the import definition.
creationDate- Date- the date and time (in Zulu format) an import
Time Formatted definition was created
String
creator Reference The creator of an import definition. Contains
the email, user GUID, and fullName.
description String The description of an import definition.
name String The name of an import definition.
number String The number of an import definition.
resource String An object or object view being imported within
the definition.
mode String The function of an import definition. Current
supported modes are CREATE, EDIT,
OVERWRITE, REPLACE, and DELETE. See
Import Engine Modes.
options. String ALLOW permits duplicates to be created if
createDupli- permitted by settings.
cates

1110 Arena REST API Developer Guide

Field Data Type Description
ERROR returns an error indicating that there
are duplicate resources are permitted by Arena.
This is the default value if not specified. See
Import Options (Item Specs and Item BOM).
options. String APPLY_TO_ALL applies the edit to all
matchDupli- resources matching the key attributes.
cates ERROR returns an error indicating that there
are duplicates. This is the default value if not
specified.
options. String ALLOW replaces view resources for all
matchDuplica- matching parent resources.
teParents ERROR returns an error indicating that there
are duplicate parent resources. THis is the
default value if the option is not specified.
options. String
removeValue
options. String Multiselect lists are submitted with multiple
multiSelectDe- values in a text field. The values are delimited
limiter with the value in option "multiSelectDelimiter'.
The default value is a semicolon if not
specified.
options. String CHECK runs a check on the reference
checkRefDes designators for every created and edited BOM
line. If this option is not specified this is the
default.
DO_NOT_CHECK value prevents a reference
designator check.
options. String DateTime values must be specified using ISO-
timeZone 8601 which must include time and optionally
time zone. If time zone information is not
included, the option “timeZone” can be
specified for the import to set the time zone
accordingly. Since the default is UTC,
timeZone should be specified for date attributes
that are not within the United Kingdom.

Objects 1111
Field Data Type Description
options. String Adds imported items to a change. Supported
addToChange values include an existing and valid change
GUID, an existing and valid change number, or
a valid POST CHANGE request body.
options. String Provides a list of the mapping behavior that
mapping correlate the apiName with the sourceName for
the import definition. sourceName is the name
of the attribute within the excel or csv file.

Import Run
Field Data Type Description
guid String The unique identifier for the import definition.
creationDate- Date- the date and time (in Zulu format) an item was
Time Formatted created
String
completionDa- Date- The creator of an item. Contains the email and
teTime Formatted fullName.
String
creator String The creator of an import definition. Contains
the email, user GUID, and fullName.
number String A positive integer that starts at 1 and increments
by one after each time a specific import
definition is run.
status String The status of an import run. Values include:
CREATED, RUNNING, COMPLETE, and
ERROR. See POST Import Run endpoint.
warnings Reference Array of warning codes and messages.
commit True or False Defaults to true. If it is false, it can be set to
true; if it is true, it cannot be set to false. Used
to 'test' an import before importing it into a
workspace. Setting this field tl false allows
users to check the error messages before
actually performing the import. Once edits are
made users can use the PUT Import Run
endpoint with a value of true for commit to
finish the import.
submitFile- String The format of the source file. Supported file
Type types: EXCEL_WORKSHEET and CSV.

1112 Arena REST API Developer Guide

Field Data Type Description
submitWork- String If EXCEL_WORKSHEEY is specified for
sheetName submitFileType, this field can be used to select
the worksheet with the information to be
imported. First worksheet will be used if not
submitted. Error will return if the
submitFileType is not EXCEL_WORKSHEET.
submitContent File Stream The actual source file used for the import.
options. String Defaults to the time zone specified in the import
timeZone definition.
options. String Defaults to the Change specified in the import
addToChange definition.
successCount Number A positive integer that indicates the number of
resources that were imported.
errorCount Number A positive integer that indicates the number of
resources that failed to import.
totalCount Number A positive integer that indicates the number of
resources in the source file.
changes String Valid GET /changes body of change used.

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- the date and time (in Zulu format) an export
Formatted began
String
numberOfRe- String The number of resources included in the export
sources

Objects 1113
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 on page 1148 object.

Extract
Field Data Type Description
creationDate- Date- the date and time (in Zulu format) an extract
Time Formatted 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
completionDa- Date- the date and time (in Zulu format) an extract run
teTime Formatted was completed
String
completion- Date- the date and time (in Zulu format) an extract run
Date Formatted was completed. DEPRECATED - Please Use
String 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

1114 Arena REST API Developer Guide

Field Data Type Description
name String The extract name
runDateTime Date- the date and time (in Zulu format) an extract run
Formatted was started
String
scheduleDate Date- the date and time (in Zulu format) an extract run
Formatted was scheduled
String
status String Indicates the status of an extract run. The value
can be InProcess, Completed, Failed, or
Aborted.

Extract Run File Association

Field Data Type Description
downloadDa- Date- the date and time (in Zulu format) a run was
teTime Formatted first downloaded, either by a user in the
String application, or by the API.
file Reference Details of the associated file. See File on page
1115 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. This attribute can be set to null.
category Reference Details of the category to which the file is
assigned. See Category on page 1099 object.
corrected Boolean Indicates whether a File has been corrected or
not. True if corrected. False if not.
creationDate- Date- The date and time (in Zulu format) a file was
Time Formatted created
String
description String The description of a file. This attribute can be
set to null.
edition String The edition identifier of a file
format String The format of a file (e.g. PDF, docx). This
attribute can be set to null.

Objects 1115
Field Data Type Description
guid String The unique identifier for a file
hasMarkup Boolean Indicates whether or not a file has a markup.
lastModified Date- the date and time (in Zulu format) a file was
DateTime Formatted modified
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).
size Long The size of a file
storageMe- Integer DEPRECATED - Please use storageMethodName.
thod* 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).
storageMe- String Indicates whether or not a file is stored on the
thodName 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

1116 Arena REST API Developer Guide

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.
creationDate- Date- the date and time (in Zulu format) (in Zulu
Time Formatted time) at which a file edition was created
String
edition String The edition identifier of a file
format String The format of a file. This attribute can be set to
null.
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- the date and time (in Zulu format) the file was
Formatted 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 on page 1117 object.
user Reference Details of the User logging in. See Compact
User on page 1148 object.

Objects 1117
File Assocation
Field Data Type Description
file Reference The associated file. See File on page 1115
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
additionalAt- Array of The additional attributes of an item. Each
tributes Attributes additional attribute entry contains apiName,
fieldType, guid, name, and value. This attribute
can be set to null.
assemblyType String Determines if an item is an assembly, not an
assembly, or a top level assembly. Top level
assemblies are items that contain other items in
its own bill of materials but themselves are not
included as an item in another item's bill of
materials.
category Reference GUID of the category to which the item is
assigned. See Category on page 1099 object.
creationDate- Date- the date and time (in Zulu format) an item was
Time Formatted created
String
creator Reference The creator of an item. Contains the email and
fullName.
description String The description of an item. This attribute can be
set to null.
deviated Boolean Indicates whether or not an item is currently
affected by a temporary change. The value can
be true or false.
effectiveDate- Date- the date and time (in Zulu format) the effective
Time Formatted revision of an item was made effective.
String
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.

1118 Arena REST API Developer Guide

Field Data Type Description
inAssembly Boolean Determines if an item is in an assembly. Values
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 on page 1122 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.
modified- Boolean Indicates whether or not the Sourcing view of
Sourcing 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
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.
procurement- String Indicates whether an Item is Off the Shelf
Type (OTS) or Made to Specification (MTS).
production- Double The production cost of an item
Cost
prototypeCost Double The prototype cost of an item
revisionNum- String The revision of an item. This attribute can be
ber set to null.
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

Objects 1119
Field Data Type Description
(superseded).
standardCost Double The standard cost of an item. This attribute can
be set to null.
supersededDa- Date- The date and time upon which a revision
teTime Formatted became superseded (no longer the effective
String revision). Null unless you are returning a
superseded revision.
targetCost Double The target cost of an item. This attribute can be
set to null.
targetPrice Double The target price of an item. This attribute can be
set to null.
uom String The unit of measure of an item
url Array of The direct urls of the object within the api and
References the application.

Item Compact
Field Data Type Description
assemblyType String Determines if an item is an assembly, not an
assembly, or a top level assembly. Top level
assemblies are items that contain other items in
its own bill of materials but themselves are not
included as an item in another item's bill of
materials.
category Reference GUID representing the category to which the
item is assigned. See Category on page 1099
object.
creationDate- Date- the date and time (in Zulu format) an Item was
Time Formatted created
String
effectiveDate- Date- the date and time (in Zulu format) an Item
Time Formatted (specifically an item revision) became effective.
String
guid String The unique identifier for an object
inAssembly Boolean Determines if an item is in an assembly. Values
can be true or false.
lifecyclePhase Reference GUID and name of the lifecycle phase of an
item (e.g. In Design). See Item Lifecycle Phase
on page 1122 object.

1120 Arena REST API Developer Guide

Field Data Type Description
name String The name of an item
number String The number of an item
revisionNum- String The revision of an item. This attribute can be
ber set to null.
url Array of The direct urls of the object within the api and
References the application.

Item BOM Line

Field Data Type Description
additionalAt- Array of The additional attributes of a BOM line. This is
tributes additional an array of additional attributes. Each additional
Attributes attribute entry includes a value and apiName.
The apiName is used to identify this additional
attribute. This attribute can be set to null.
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. This attribute
can be set to null.
refDes String The reference designator values of a child item.
This attribute can be set to null.
quantity Integer The quantity of a child item
url Array of The direct urls of the object within the api and
References the application.

BOM Substitutes
Field Data Type Description
guid String The unique identifier for the BOM Substitute.
item Reference The Item being listed as a substitute.. Contains
the attributes guid, name, number,
revisionNumber, and revisionStatus
notes String The Notes of a BOM Substitute. This attribute
can be set to null.
quantity Integer The quantity of the BOM Substitute.

Objects 1121
Field Data Type Description
rank Integer The reference designator values of a child item.
url Reference 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
creationDate- Date- the date and time (in Zulu format) a
Time Formatted NumberFormat was created
String
exampleNum- String An example of a NumberFormat
ber
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
possibleValues Array of All possible values for a VALUE_LIST field.
Strings Each possible value includes value and
description fields.

1122 Arena REST API Developer Guide

Field Data Type Description
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
Date-
creationDate- the date and time (in Zulu format) a
Time Formatted NumberFormat was created
String
exampleNum- String An example of a NumberFormat.
ber
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 on page
1122 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
Example
Item BOM, Costing, Files, Sourcing, and Specs views can be included in
Changes.

Objects 1123
Field Data Type Description
includedInThi- Boolean Indicates whether or not the view is included in
sChange a Change. Values can be true or false.
lockedByAno- Boolean Indicates whether or not the view is locked by
therChange inclusion in another change. Values can be true
or false.
modifiedOn- Boolean Indicates whether or not the view has
WorkingRev modifications to its working revision. Values
can be true or false.
notes String User-entered notes about the item view entered
on a change

Item to Item References

Field Data Type Description
guid String The unique identifier for the Item to Item
reference.
item Reference The Item being listed as a reference.. Contains
the attributes guid, name, number,
revisionNumber, and revisionStatus
notes String The Notes of a BOM Substitute. This attribute
can be set to null.
quantity Integer The quantity of the BOM Substitute.
rank Integer The reference designator values of a child item.
url Array of The direct urls of the object within the api and
References the application.

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
revisionNum- String Revision
ber
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

1124 Arena REST API Developer Guide

Field Data Type Description
uom String The unit of measure for an Item
procurement- String OTS and MTS only
Type
offTheShelf Boolean True if procurementType=OTS, else False
owner Reference The owner of an Item
creationDate- Date- The date and time (in Zulu format) an Item was
Time Formatted 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.
effectiveDate- Date- The date and time (in Zulu format) an Item was
Time Formatted 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.
modified- Boolean Indicates whether or not the Sourcing view of
Sourcing 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.
modifiedCost- Boolean Indicates whether or not the Costing view of an
ing item contains working modifications. The value
can be true or false.
production- Double The production cost of an Item.
Cost
prototypeCost Double The prototype cost of an Item.
targetCost Double The target cost of an Item.
targetPrice Double The target price of an Item.

Objects 1125
Field Data Type Description
standardCost Double The standard cost of an Item.
revisionStatus String The Revision status of an Item. WORKING,
EFFECTIVE, SUPERSEDED
supersededDa- In Zulu format The date and time (in Zulu format) an Item was
teTime superseded.
M4O7LI- Custom An Item custom attribute.
MOZGZ7Q5- Attribute
TR50LG

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
M4O7LI- String BOM Custom Attributes
MOZGZ7Q5-
TR50LG

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.
[Link] String GUID of the BOM being substituted

1126 Arena REST API Developer Guide

Field Data Type Description
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..
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. Reference Details of the vendor Item. See Supplier Item
number 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.
activeProduc- Boolean Indicates if a source relationship is the active
tion production relationship. This value can be true
or false.
activeProto- Boolean Indicates if a source relationship is the active
type prototype relationship. This value can be true or
false.
amlRank Integer The AML rank. This value is numeric.
amlSplit Integer The AM percentage.
vendorItem- String The conversion factor of the vendor item (how
Conversion- many used per one bougt. e.g. for a roll of 100
Factor 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).

Objects 1127
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.
[Link] Reference The File associated with the Item. Includes
name, file location, guid, nunber, edition, title,
and storageMethodName.
latestEditio- Boolean Indicates whether or not a file is the latest
nAssociation 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.

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 When storageMethodName is WEB or FTP, the
value is 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.
storageMe- String Indicates where or not a file is stored on the
thodName 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.

1128 Arena REST API Developer Guide

Field Data Type Description
guid String The unique id of the File Summary
description String The description of the File.
author. String The author of a File.
fullName
format String The format of a File.
size Integer The size of a File.
creationDate- Date- The date and time (in Zulu format) the File was
Time Formatted created.
String
lastModified- Date- The date and time (in Zulu format) a File was
DataTime Formatted 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
supplier Reference Details of the Supplier. See Supplier object.
name String The supplier item name.
type StringPart, The type of supplier item (basic category). This
Process, value can be PART, PROCESS, or
Document DOCUMENT
uom String The unit of measure of the supplier item.

Objects 1129
Field Data Type Description
description String The description of a supplier item.
procurement- String Procurement Type. Can be OTS or MTS.
Type
offTheShelf Boolean True if procurment Type is OTS, else False
guid String The unique id for the Supplier Item Specs
creationDate- Date- The date and time (in Zulu format) the the
Time Formatted Supplier Item was created.
String
creator Reference The creator of the Supplier Item. Includes
fullName and email.
M4O7LI- Custom Supplier Item custom attribute.
MOZGZ7Q5- attribute
TR50LG

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.
accountNum- String The account number of the Supplier.
ber
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
creationDate- Date- The date and time (in Zulu format) the the
Time Formatted Supplier was created.
String
creator Reference The creator of the Supplier. Includes fullName,
guid, and email.
M4O7LI- Custom A Supplier custom attribute.
MOZGZ7Q5- attribute
TR50LG

1130 Arena REST API Developer Guide

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 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 Indicates whether or not a file is primary
primary file, (primary files are linked from the main view of
else False 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
integrationUs- Reference Integration user information. fullName, guid,
er and email included.

Objects 1131
Field Data Type Description
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.
creationDate- Date- The date and time (in Zulu format) the the
Time Formatted Integration was created.
String
modifyUser Reference User who last modified the Integration.
Included: fullName, guid and email.
modifyDate- Date- The date and time (in Zulu format) that the
Time Formatted integration was last modified.
String

Event Queue: Integration Administrators

Field Data Type Description
administrators Reference User designated as an Integration
Administrator.
fullName String Full name of the Integration Administrator.
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.
ItemsRecon- Boolean Indicates if all Items in the event are reconciled.
ciled 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.

1132 Arena REST API Developer Guide

Field Data Type Description
creator Reference User who caused the event. Included fields:
email, fullName, and guid.
creationDate- Date- The date and time (in Zulu format) that this
Time Formatted event was created.
String
change Reference Only appears if eventType is CHANGE.
Included fields: approvedOnDateTime,
category, effectiveDateTime, effectivityType,
guid, number, and title.
revisioningE- Reference Only appears if eventType is REVISIONING_
vent 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.
effectiveItem- Reference The effective revision of the Event Item.
Revision Includes: guid, number, revisionNumber,
lifecyclePhase, modifiedBOM, modifiedFiles,
modifiedSourcing, and modifiedSpecs.
supersededI- Reference The superseded revision of the Event Item.
temRevision 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.
reconciledDa- The date and time (in Zulu format) when the
teTime event Item was reconciled.
reconcileUser Reference The user who reconciled the Item. Included
fields: guid, fullName, and email.

Objects 1133
Login
Field Data Type Description
loginDateTime Date- the date and time (in Zulu format) a user's
Formatted session began
String
logoutDate- Date- the date and time (in Zulu format) a user's
Time Formatted session ended (null for currently logged in)
String
duration Integer The length in minutes of a session (null for
currently logged in)
connected- String The application Zone through which the user
Through connected to Arena. Values can be Arena;
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 on page
1148 object.

Markup
Field Data Type Description
author String The author of the markup. Contains fullName.
category Reference Details of the category to which the file is
assigned.
creationDate- Date- The date and time (in Zulu format) at which the
Time Formatted markup was created.
String
format String The format of a file (e.g. PDF, DOCX). This
attribute can be set to null.
guid String The unique identifier of a markup.
lastModified- Date The date and time (in Zulu format) at which the
DateTime Formatted markup was modified.
String
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.

1134 Arena REST API Developer Guide

Field Data Type Description
locked Boolean Indicates if the markup is locked to edits. The
value can be true or false.
size Number The size of the markup.
storageMe- String Indicates whether or not a file is stored on the
thodName 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 the markup

Quality Process Number Format

Field Data Type Description
creationDate- Date- the date and time (in Zulu format) a number
Time Formatted 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 The available prefixes for a number format.
strings Each prefix contains the attributes value and
guid.

Quality Process
Field Data Type Description
completedDa- Date- the date and time (in Zulu format) a Quality
teTime Formatted Process was completed
String
creationDate- Date- the date and time (in Zulu format) a Quality
Time Formatted 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

Objects 1135
Field Data Type Description
Process. This listing includes the attributes
approvals (null unless sign-off step), attributes,
and guid.
description String The description of a template. This attribute can
be set to null.
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.
targetComple- Date- The date a Quality Process is targeted for
tionDate Formatted completion. This attribute can be set to null.
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. This attribute can be set to
null.

Quality Process Step

Field Data Type Description
allowOwnerToAddAp- Boolean Determines if a step owner can add
provers users to the step as approvers. Available
only for steps of type SIGNOFF.
approvals Array of A reference to the approvals entered by
References approver users. Each value contains the
attributes fullName and guid. Available
only for steps of type SIGNOFF.

1136 Arena REST API Developer Guide

Field Data Type Description

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
References step. Lists users if assignee is a single
user. Lists userGroups if assignee is a
User Group.
attributes Array of A reference to the attributes on a step.
References Each value contains the attributes
apiName, fieldType, guid, name, and
value. Available only for steps of type
REGULAR.
completeDateTime Date- the date and time (in Zulu format) a
Formatted step was completed
String
completeUser String The user who completed the step.
Contains the attribute fullName.
dueDateTime Date- the date and time (in Zulu format) the
Formatted step must be completed NOTE: Only
String the date portion of this string is
honored. Time always appears as
23:59:59 local time. This attribute can
be set to null.
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.

Objects 1137
Field Data Type Description
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.
creationDate- Date- the date and time (in Zulu format) a template
Time Formatted was created
String
creator Reference The creator of a template. Contains the attribute
fullName.
defaultNum- Reference Details of the number format used by default
berFormat for processes created using a template. See Item
Number Format on page 1122 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
numberFor- Reference Details of the number formats available for
mats processes created using a template. See Quality
Process Number Format on page 1135 object.
shortName String The short name for a template
steps Array of A collection of references to steps included in a
references quality process template.

1138 Arena REST API Developer Guide

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.
References Each value contains the attribute guid.
Available only for steps of type
REGULAR.
allowOwnerToAddAp- Boolean Determines if a step owner can add
provers users to the step as approvers. Available
only for steps of type SIGNOFF.
approvers Array of A reference to the approvers included
References in a step. Each 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 on page 1140.
guid String The unique identifier for the affected
object. This attribute can be set to null.
notes String Notes entered for the affected object.
This attribute can be set to null.

Objects 1139
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.
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.

Training Plans Summary

Field Data Type Description
creationDate- Date- the date and time (in Zulu format) a Training
Time Formatted Plan was created
String
creator Reference The user who created the Training Plan.
Contains the email, fullName and guid.
daysToCom- Number The number of days the users have to complete
plete the training plan assignments.
description String The description of a Training Plan. This
attribute can be set to null.
guid String The unique identifier for an object
manager Reference User assigned to manage the Training Plan.
Includes: email, fullName, and guid.
name String The name of the Training Plan.

1140 Arena REST API Developer Guide

Field Data Type Description
number String The number of the Training Plan.
status String The status of a Training Plan.

Tickets Summary
Field Data Type Description
additionalAt- String The additional attributes of a Ticket. Includes:
tributes apiName, fieldType, guid, name, and value.
assignee String User assigned to resolve the ticket. Includes:
email, fullName, and guid.
creationDate- Date- the date and time (in Zulu format) a Ticket was
Time Formatted created
String
creator Reference The user who created the Quality Process.
Contains the atrributes fullName and guid.
description String The description of a ticket. This attribute can be
set to null.
fixVersion String The version where the ticket is scheduled to be
resolved.. This attribute can be set to null.
foundOn String The version were the issue was first discovered.
This attribute can be set to null.
guid String The unique identifier for an object
title String The name of a Ticket
number String The number of a Ticket
priority String The priority level of the Ticket.. This attribute
can be set to null.
status Reference The status of a Ticket. Includes: guid and value.
template Reference Details of the template upon which a Ticket was
based. Contains the attributes name and guid.

Report
Field Data Type Description
guid String the date and time (in Zulu format) an report
began
title String The title of the report

Objects 1141
Field Data Type Description
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- the date and time (in Zulu format) an report
Formatted began
String
description String The description of the report run
numberOfOb- Integer The number of objects in the report run
jects
report Reference Details of the report. See Report on page 1141
object
user Reference The User who ran the report. See Compact User
on page 1148 object.

Requirement
This object is only available through the Compliance Requirement object.

1142 Arena REST API Developer Guide

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
activeProduc- Boolean Indicates if a source relationship is the active
tion production relationship. This value can be true
or false.
activeProto- Boolean Indicates if a source relationship is the active
type prototype relationship. This value can be true or
false.
amlRank Integer The AML rank. This value is numeric. This
attribute can be set to null.
amlSplit Integer The AML split. This value is numeric. This
attribute can be set to null.
approved Boolean Indicates if a source relationship is approved.
This value can be true or false.
creationDate- Date- the date and time (in Zulu format) a source
Time Formatted relationship was created
String
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 on page 1146 object.
notes String The notes for a source relationship. This
attribute can be set to null.
vendorItem Reference Details of the vendor item. See Supplier Item on
page 1146 object.
vendorItem Number The conversion factor of the vendor item (how
Conversion- many used per one bought. e.g. for a roll of 100
Factor 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 The direct urls of the object within the api and
References the application.

Objects 1143
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.
allowNega- Boolean Indicates whether or not a numeric value can be
tives a negative number. The value can be true or
false.
creationDate- Date- the date and time (in Zulu format) a step
Time Formatted 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
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

1144 Arena REST API Developer Guide

Field Data Type Description
required Boolean Indicates whether the attribute is required on
creation.
possibleValues Array of All possible values for a drop-down list. This
Strings 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
accountNum- Integer The account number of the supplier. This
ber attribute can be set to null.
additionalAt- Array of The additional attributes of an item. This is an
tributes Attributes 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 The addresses associated with a supplier. Each
addresses address entry includes address1, address2, city,
Country/Region, 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 values for Country/
Region 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.
creationDate- Date- the date and time (in Zulu format) a supplier
Time Formatted was created.
String
creator Reference The creator of the supplier record. Contains the
full name of the creator.
description String The description of a supplier. This attribute can
be set to null.
guid String The unique identifier of a supplier
name String The name of a supplier

Objects 1145
Field Data Type Description
phoneNumbers Array of phone The phone numbers associated with a supplier.
numbers Each entry includes comment, extension, label,
and number.
supplierId String The unique identifier of a supplier in the Arena
database. This attribute can be set to null.
website String The website of a supplier. This attribute can be
set to null.

Supplier Phone Number

Field Data Type Description
comment String Comments field for the supplier phone number.
This attribute can be set to null.
extension String The extension of the phone number. This
attribute can be set to null.
guid String The unique identifier of a supplier phone
number.
label String The type of phone number. Mobile, Home, Fax,
etc. This attribute can be set to null.
number String The phone number of the supplier. This
attribute can be set to null.

Supplier Item
Field Data Type Description
additionalAt- Array of The additional attributes of an item. This is an
tributes Attributes array of additional attributes. Each additional
attribute entry includes a value and apiName.
The apiName is used to identify this additional
attribute.
creationDate- Date- DEPRECATED the date and time (in Zulu
Time* Formatted format) a supplier item was created.
String
Description String The description of a supplier item. This
attribute can be set to null.
guid String The unique id for a supplier item
name String The supplier item name. This attribute can be
set to null.
number String The supplier item number

1146 Arena REST API Developer Guide

Field Data Type Description
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 on page
1145 object.
type String The type of supplier item (basic category). This
value can be PART, PROCESS, or
DOCUMENT. This attribute can be set to null.
uom String The unit of measure of the supplier item

Supplier Item 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 supplier item
compliance requirement
lastModified- Reference the user who last modified a compliance
By requirement. Includes email and fullName.
lastModified- Date- the date and time (in Zulu format) a supplier
DateTime Formatted item compliance requirement was last modified
String
mark String the mark of a supplier item compliance
requirement (physical mark added to product or
packaging). This attribute can be set to null.
rationale String the rationale of a supplier item compliance
requirement (explanation of status). This
attribute can be set to null.
requirement Reference Details of the requirement. See Requirement on
page 1142 object.
status String The status of a supplier item compliance
requirement. The value can be UNKNOWN,
COMPLIANT, EXEMPT, NA, NON_
COMPLIANT

Objects 1147
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
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

1148 Arena REST API Developer Guide