Arena Solutions Connector

Arena, a PTC business, is a cloud-native product lifecycle management (PLM) and quality management system (QMS) platform that unifies product information, people, and processes to accelerate product design, development, and delivery. Learn more at Arena Solutions.

This component provides the ability to manage items and their bills of materials, route change requests and engineering changes through review and approval, run quality processes and record step decisions, and work with the files, suppliers, and training records attached to product data in Arena.

API Documentation

This component was built using the Arena Developer & API Help Center.

Connections

API Key

Authenticate requests using an API key.

Authenticate requests to Arena using an API session key.

Prerequisites

• An Arena account with API access enabled.
• An API session ID generated from the Arena instance.

Setup Steps

1. Contact arena-sales@ptc.com to activate REST API access for the account. Access is not enabled by default, and each account carries a request limit per 24-hour period.
2. Confirm the account used for the integration is an Employee or Partner user. Supplier users cannot access the Arena REST API.
3. Obtain an API session ID by sending the account's username and password to Arena's Log In request. The response returns the session ID as arena_session_id.
4. Copy the arena_session_id value into the connection.

A session expires 90 minutes after its last action. This connection re-authenticates automatically when Arena rejects a request, so a long-running integration does not need the session refreshed by hand.

Configure the Connection

• Arena Environment: Select the regional Arena endpoint (North America, GovCloud, Europe, United Kingdom, or China), or choose Custom URL to supply a specific base URL.
• Custom Arena URL: The API base URL, used only when Arena Environment is set to Custom URL. Must use https.
• API Key (arena_session_id): The Arena API session ID used to authenticate requests.
• Request Timeout: Optional request timeout in milliseconds.

OAuth 2.0 Client Credentials

Authenticate using OAuth 2.0 Client Credentials.

Authenticate to Arena using the OAuth 2.0 Client Credentials grant. The token exchange is handled automatically: supply the token endpoint and credentials, and the access token is requested and refreshed without further configuration.

Prerequisites

• An Arena machine user with API access enabled.
• OAuth 2.0 client credentials (Client ID and Client Secret) issued by Arena for that machine user.
• The token endpoint URL supplied by Arena for the target environment.

Setup Steps

1. Contact arena-sales@ptc.com to activate REST API access for the account. Access is not enabled by default, and each account carries a request limit per 24-hour period.
2. Ask an Arena coach or Arena customer support to add a Machine User to the account. OAuth credentials are issued to that user, and the workspace it is granted when created is the workspace every request targets.
3. In Arena, go to Workspace Settings > OAuth Applications and click New OAuth Application. Refer to Arena's OAuth2 guide for details.
4. Give the application a name and a description, then click Create.
5. Copy the generated Client ID and Client Secret into the connection, and store them in a secure vault.
6. Enter the token endpoint URL Arena supplies alongside those credentials as the Token URL.

Requests target the workspace the machine user was granted when it was created, so no workspace needs to be configured here. Arena recommends giving a machine user access to a single workspace.

No scopes are requested for this flow, so the Scopes field stays empty.

Configure the Connection

• Arena Environment: Select the regional Arena endpoint (North America, GovCloud, Europe, United Kingdom, or China), or choose Custom URL to supply a specific base URL.
• Custom Arena URL: The API base URL, used only when Arena Environment is set to Custom URL. Must use https.
• Token URL: The OAuth 2.0 token endpoint that issues the access token, supplied by Arena along with the client credentials.
• Client ID: The OAuth client identifier issued by Arena.
• Client Secret: The OAuth client secret issued by Arena.
• Request Timeout: The request timeout in milliseconds. Defaults to 30 seconds.

This connection uses OAuth 2.0, a common authentication mechanism for integrations.
Read about how OAuth 2.0 works here.

Username and Password

Authenticate using a username, password, and workspace ID.

Authenticate to Arena using an account email and password, optionally scoped to a specific workspace. Creating a dedicated integration user is recommended.

Prerequisites

• An Arena account with API access enabled.
• The account email and password used to sign in.
• Optionally, the ID of the workspace to log into.

Setup Steps

1. Contact arena-sales@ptc.com to activate REST API access for the account. Access is not enabled by default, and each account carries a request limit per 24-hour period.
2. Create a dedicated integration user rather than reusing a person's login, so the integration keeps working when that person's password changes. The user must be an Employee or Partner; Supplier users cannot access the Arena REST API.
3. Note the email address and password of that user.
4. Optionally note the ID of the workspace the integration should target. When omitted, Arena logs into the account's current or last-used workspace.

Arena exchanges these credentials for a session that expires 90 minutes after its last action. This connection re-authenticates automatically, so no manual refresh is required.

Configure the Connection

• Arena Environment: Select the regional Arena endpoint (North America, GovCloud, Europe, United Kingdom, or China), or choose Custom URL to supply a specific base URL.
• Custom Arena URL: The API base URL, used only when Arena Environment is set to Custom URL. Must use https.
• Email/Username: The Arena account email or username used to sign in.
• Password: The Arena account password used to sign in.
• Workspace ID: Optional. The Arena workspace ID to log into. If omitted, the account's current or last-used workspace is used.
• Request Timeout: Optional request timeout in milliseconds.

Triggers

New Events

Checks an Arena outbound integration for events created since the last recurrence, delivering them as a single result or, with batching enabled, as one execution per event. Arena events are immutable, so only newly created events are reported.

Actions

Add Evaluation Issue Response

Add a response to an evaluation issue in Arena PLM system.

Add File to Training Plan

Add a file to a training plan.

Add Item to Change

Adds an item to a change with a specific GUID in Arena PLM system.

Add Item to Request

Add an item to a request in Arena PLM system.

Add Item to Training Plan

Add an item to a training plan.

Add Quality Process to Training Plan

Add a quality process to a training plan.

Add Quality Step Approver

Add decision makers to a quality process sign-off step.

Add Requirement Child

Add a child requirement to a requirement.

Add Requirement File

Attach a file to a requirement.

Add Requirement Quality

Link a quality process to a requirement.

Add Requirement Ticket

Link a ticket to a requirement.

Add Requirement Trace

Add a new trace link to a requirement.

Add Ticket Change

Link a change to a ticket in Arena PLM system.

Add Ticket File

Link a file to a ticket in Arena PLM system.

Add Ticket Item

Link an item to a ticket in Arena PLM system.

Add Ticket Quality Process

Link a quality process to a ticket in Arena PLM system.

Add Ticket Reference

Link another ticket as a reference to a ticket in Arena PLM system.

Add User to Training Plan

Add a user to a training plan.

Attach File to Request

Attach a new file to a request in Arena PLM system.

Change Evaluation Issue Status

Change the status of an evaluation issue in Arena PLM system.

Change File Checkout Status

Check a file edition in or out by changing its checkout status.

Change Item Lifecycle Phase

Release a new revision of an item to a target lifecycle phase (Design or Production).

Change Lifecycle Status

Move a change to a new lifecycle phase by updating its status in Arena PLM system.

Change Quality Process Status

Change the status of a quality process or one of its steps in Arena PLM system. Supports both quality process level status changes and individual step status changes.

Change Request Status

Change the lifecycle status of a request in Arena PLM system.

Change Requirement Status

Change the status of a requirement.

Change Ticket Status

Change the status of a ticket in Arena PLM system.

Change Training Plan Status

Change the status of a training plan (OPEN/CLOSED).

Create BOM Line

Add a new BOM line (Bill of Materials line) to an item in Arena PLM system with the specified properties.

Create BOM Substitute

Add a new substitute component to a specific BOM line in Arena PLM system.

Create Change

Create a new change in Arena PLM system with the specified properties.

Create Change File Association

Create a new change file association in Arena PLM system.

Create Change Implementation File

Attach a new implementation file to a change.

Create Change Implementation Task

Create a new implementation task for a change.

Create Change Implementation Task File

Attach a file to an implementation task.

Create Change Implementation Task Note

Create a new note for an implementation task.

Create Change Markup File

Attach a new markup file to a change.

Create Export

Create a new export definition.

Create Extract

Create a new extract definition.

Create File Correction

Upload a corrected version of a file (multipart/form-data).

Create File Edition

Upload file to create next edition by file GUID.

Create File Markup

Upload a markup file for a file (multipart/form-data).

Create File With Content

Upload a file to Arena PLM system with specified metadata. Supports files up to 2GB.

Create Import

Create a new import definition.

Create Item

Create a new item in Arena PLM system with the specified properties.

Create Item File Association

Upload a new file and associate it with an item in Arena PLM system (multipart/form-data).

Create Item from JSON

Create a new item in Arena PLM using a JSON payload with optional core attribute overrides. Individual inputs take priority over JSON values.

Create Item Image

Upload and set an image as the thumbnail of an item.

Create Item Number Format Field

Add a new field to a specific item number format in Arena PLM system.

Create Item Number Reservation

Create a new item number reservation in Arena PLM system.

Create Quality Process

Create a new Quality Process in Arena PLM system.

Create Quality Process Step Affected Object

Adds an Affected Object in a step with a given GUID in a Quality Process with a given GUID. The type can be ITEM, REQUEST, CHANGE, SUPPLIER, SUPPLIER ITEM, or FILE from Arena PLM system.

Create Quality Process Step Affected Quality

Adds a Quality Affected Object in a step with a given GUID in a Quality Process with a given GUID from Arena PLM system.

Create Quality Process Step Affected URL

Adds a URL Affected Object in a step with a given GUID in a Quality Process with a given GUID from Arena PLM system.

Create Request

Create a new request in Arena PLM system.

Create Request Evaluation Issue

Create a new evaluation issue for a request in Arena PLM system.

Create Request Markup File

Create a markup file for a request in Arena PLM system.

Create Requirement

Create a new requirement in Arena PLM.

Create Sourcing Relationship

Create a new sourcing relationship for an item in Arena PLM system.

Create Supplier

Create a new supplier in Arena PLM system with the specified information.

Create Supplier Address

Add an address to a supplier in Arena PLM system.

Create Supplier File Association

Associate an existing file with a supplier in Arena PLM system.

Create Supplier Item

Create a new supplier item in Arena PLM system with the specified properties.

Create Supplier Item File

Upload a file and associate it with a supplier item. Supports files up to 2GB with multipart form data upload.

Create Supplier Phone Number

Add a phone number to a supplier in Arena PLM system.

Create Ticket

Create a new ticket in Arena PLM system.

Delete BOM Line

Delete a specific BOM line from an item in Arena PLM system.

Delete BOM Substitute

Delete a specific BOM substitute from Arena PLM system.

Delete Change

Delete an existing change from Arena PLM system.

Delete Change File Association

Delete a change file association from Arena PLM system.

Delete Change Item Association

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.

Delete Change Markup File

Remove a markup file association from a change.

Delete Extract

Delete an extract definition.

Delete File

Delete the latest edition of a file with the specified GUID. When a file has multiple editions, only the latest, unlocked edition can be deleted. To delete an entire file with multiple editions, repeat the request for all editions.

Delete Item

Delete an existing item from Arena PLM system with the specified GUID.

Delete Item File Association

Delete an item file association from Arena PLM system.

Delete Item Image

Remove the thumbnail image from an item.

Delete Quality Process

Deletes a Quality Process with a given GUID from Arena PLM system. Note: Any full user can delete a Quality Process via the API.

Delete Quality Process Step Affected Object

Deletes an Affected Object with a given GUID from Quality Process step with a given GUID in a Quality Process with a given GUID from Arena PLM system.

Delete Request

Delete a specific request from Arena PLM system.

Delete Request Markup File

Delete a request markup file from Arena PLM system.

Delete Requirement

Delete a requirement.

Delete Requirement Trace

Delete a trace link from a requirement.

Delete Sourcing Relationship

Delete a specified sourcing relationship for an item in Arena PLM system.

Delete Supplier

Delete a supplier from Arena PLM system. This action cannot be undone.

Delete Supplier Address

Delete an address from a supplier in Arena PLM system. This action cannot be undone.

Delete Supplier File Association

Delete a file association from a supplier in Arena PLM system. This action cannot be undone.

Delete Supplier Item

Delete a specific supplier item from Arena PLM system using its GUID.

Delete Supplier Phone Number

Delete a phone number from a supplier in Arena PLM system. This action cannot be undone.

Delete Ticket

Delete a specific ticket from Arena PLM system.

Download Export Run File Content

Download the actual content of a file from an export run.

Download Extract Run File Content

Download the actual file content from an extract run.

Download File Content

Download file content by its GUID.

Force Complete Import

Force an import run to complete, even if there are errors.

Get BOM Line

Retrieve detailed information of a specific BOM line for an item in Arena PLM system.

Get BOM Settings

Retrieve BOM settings for an item in Arena PLM system.

Get BOM Substitute

Retrieve detailed information of a specific BOM substitute in Arena PLM system.

Get Change by GUID

Retrieve detailed information of a specific change by its GUID from Arena PLM system.

Get Change File Association

Returns details of a specific file association with a change.

Get Change Implementation Task

Get details of a specific implementation task.