![arena-plm-v2 icon](/docs/img/components/icons/60/YXJlbmEtcGxtLXYy.png) # Arena Solutions Connector key: arena-plm-v2[Source](https://github.com/prismatic-io/components/tree/main/components/arena-plm-v2)[API Docs](https://ptc-arena.github.io/arena-dev-help/)[API Changelog](https://ptc-arena.github.io/arena-dev-help/changelog/)[Connector Changelog](#changelog) ## Description[​](#description "Direct link to Description") 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](https://www.arenasolutions.com/). 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[​](#api-documentation "Direct link to API Documentation") This component was built using the [Arena Developer & API Help Center](https://ptc-arena.github.io/arena-dev-help/). ## Connections[​](#connections "Direct link to Connections") ### API Key[​](#arenaapikey "Direct link to API Key") **key: arenaApiKey** Authenticate requests to Arena using an API session key. #### Prerequisites[​](#prerequisites "Direct link to Prerequisites") * An Arena account with API access enabled. * An API session ID generated from the Arena instance. #### Setup Steps[​](#setup-steps "Direct link to 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](https://ptc-arena.github.io/arena-dev-help/get-started/connecting/). 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[​](#configure-the-connection "Direct link to 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. | Input | Notes | Example | | ---------------------------- | -------------------------------------------------------------------------------------- | ------------------------------- | | API Key (arena\_session\_id) | The Arena API session ID for authentication. This is obtained from the Arena instance. | | | Arena Environment | Select the Arena environment region, or choose Custom URL to enter a custom URL. | https\://api.arenasolutions.com | | Custom Arena URL | The custom Arena API base URL, used only when 'Custom URL' is selected above. | https\://api.arenasolutions.com | | Request Timeout | The request timeout in milliseconds (default: 30 seconds). | 30000 | ### OAuth 2.0 Client Credentials[​](#arenaoauth "Direct link to OAuth 2.0 Client Credentials") **key: arenaOAuth** 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[​](#prerequisites-1 "Direct link to 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[​](#setup-steps-1 "Direct link to 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](https://ptc-arena.github.io/arena-dev-help/oauth/oauth_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[​](#configure-the-connection-1 "Direct link to 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. | Input | Notes | Example | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------- | | Arena Environment | Select the Arena environment region, or choose Custom URL to enter a custom URL. | https\://api.arenasolutions.com | | Client ID | The OAuth client ID issued by Arena for the machine user. The machine user's workspace determines which workspace requests target. | | | Client Secret | The OAuth client secret issued by Arena for the machine user. | | | Custom Arena URL | The custom Arena API base URL, used only when 'Custom URL' is selected above. | https\://api.arenasolutions.com | | Scopes | Arena requests no OAuth scopes for the client credentials flow. | | | Request Timeout | The request timeout in milliseconds (default: 30 seconds). | 30000 | | Token URL | The OAuth 2.0 token endpoint that issues the access token. Arena supplies this URL along with the client credentials for the machine user. | | ### Username and Password[​](#arenausernamepassword "Direct link to Username and Password") **key: arenaUsernamePassword** Authenticate to Arena using an account email and password, optionally scoped to a specific workspace. Creating a dedicated integration user is recommended. #### Prerequisites[​](#prerequisites-2 "Direct link to 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[​](#setup-steps-2 "Direct link to 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[​](#configure-the-connection-2 "Direct link to 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. | Input | Notes | Example | | ----------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------- | | Arena Environment | Select the Arena environment region, or choose Custom URL to enter a custom URL. | https\://api.arenasolutions.com | | Custom Arena URL | The custom Arena API base URL, used only when 'Custom URL' is selected above. | https\://api.arenasolutions.com | | Email/Username | The Arena account email address or username for authentication. | user\@company.com | | Password | The Arena account password for authentication. | | | Request Timeout | The request timeout in milliseconds (default: 30 seconds). | 30000 | | Workspace ID | The Arena workspace ID to log into. If not specified, will log into the user's current or last used workspace. | 12345 | ## Triggers[​](#triggers "Direct link to Triggers") ### New Events[​](#pollchangestrigger "Direct link to 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. | **key: pollChangesTrigger** | Input | Notes | Example | | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Integration | The outbound integration whose event feed is polled. Arena publishes events per integration, so one must be configured in Arena before this trigger can run. | OI1AB2CD3EF4GH5IJ6KL7MN1 | | Reconciliation Status | Restricts each recurrence to events in one reconciliation state. Leave unset to receive events regardless of whether Arena has marked them reconciled. | false | | Look-back Date | How far back the initial sync reaches, as an ISO 8601 date/time. Leave it unset and the first recurrence records its position without reporting anything, so only events created after that point are delivered. Consulted on the first recurrence only. | 2026-01-01T00:00:00Z | This trigger polls an Arena outbound integration for events created since the last recurrence. Arena publishes events per integration: each configured outbound integration keeps its own feed, recording changes such as an effective change order or a revised item. The trigger reports only newly created events, because an Arena event is immutable. It is written once and never modified, so there is no updated-event category to report. Refer to the [Arena Developer & API Help Center](https://ptc-arena.github.io/arena-dev-help/) for the outbound integration event API reference. #### How It Works[​](#how-it-works "Direct link to How It Works") 1. The trigger runs on the configured schedule. 2. It asks Arena for one page of the events the selected integration created inside the window it is currently covering. 3. If that page came back full, more events remain and the trigger records where the next page starts. If it came back short, the window is exhausted and the trigger commits its position. 4. It returns the page's events. A recurrence that matches nothing and has nothing left to cover reports no changes rather than an empty result. **Initial sync** An initial sync seeds a complete starting state rather than reporting a change, and this trigger performs one whenever **Look-back Date** is set. It begins on the first recurrence, covers everything created between that date and the moment it starts, and seeds each event exactly once. **No input is ignored while it runs**: **Reconciliation Status** filters the sync exactly as it filters every later recurrence, because an Arena event feed is already the record of what changed and narrowing it leaves no gap to fill. The window's upper bound is fixed when the sync begins, so events created while it is still being covered are not picked up by the sync itself. Once the window is exhausted the trigger stores that bound as its position, and the first incremental recurrence resumes from exactly there, so nothing between the two is lost. No field in the payload marks the handoff. With batching enabled the whole window is covered inside one poll cycle; with batching off it is covered one page per scheduled recurrence, and the position is not committed until the last page arrives. An interrupted sync repeats its window rather than skipping past it. Leave **Look-back Date** unset and there is no sync: the first recurrence records its position without asking Arena anything, and only events created after that point are delivered. The value is consulted once, on the first recurrence only. **Batching** Batching is enabled per flow on this trigger. Once enabled, each changed record is dispatched as its own execution, or grouped by the configured batch size. Batch size and the number of batches dispatched concurrently can both be overridden per instance. Raising concurrency increases the request volume sent to Arena. To turn it on, select the flow's trigger, open the **Flow control** tab, and switch on **Enable Batching**. Under **Batch Size**, keep **Trigger default** to use the size this trigger ships with, or choose **Custom batch size** to set a specific size. **Batch Concurrency** is optional; leave it blank for no batch-level limit. With batching off, a downstream step reads the events from `trigger.results.body.data.createdRecords`. With batching on that path does not exist: each execution receives a single tagged item instead, whose event is at `record` and whose category is at `changeType`. Any step that reads the older path must be updated before batching is enabled, or it will find nothing. Because batching is enabled per flow, the change is scoped to that flow rather than to the component or to other flows using this trigger. #### Returned Data[​](#returned-data "Direct link to Returned Data") With batching off, the trigger returns an object with: Example Response (Non-Batched) ```json { "data": { "createdRecords": [ { "guid": "9OE00VN11OE22VN33OE44VN5", "eventType": "CHANGE_EFFECTIVE", "status": "COMPLETED", "creationDateTime": "2026-03-21T08:40:00Z", "reconciled": false, "change": { "guid": "CH1AB2CD3EF4GH5IJ6KL7MN8", "number": "ECO-000512", "title": "Update resistor tolerance on control board" } } ] } } ``` With batching on, each execution receives one item, or a group of them at a batch size above one: Example Response (Batched) ```json { "changeType": "created", "record": { "guid": "9OE00VN11OE22VN33OE44VN5", "eventType": "CHANGE_EFFECTIVE", "status": "COMPLETED", "creationDateTime": "2026-03-21T08:40:00Z", "reconciled": false, "change": { "guid": "CH1AB2CD3EF4GH5IJ6KL7MN8", "number": "ECO-000512", "title": "Update resistor tolerance on control board" } } } ``` Arena answers with one of two event shapes depending on how the selected integration is configured: a change-based feed carries `reconciled` and `reconciledDateTime`, while an item-based feed carries `itemsReconciled` instead. Both carry `guid`, `eventType`, `status` and `creationDateTime`, and whichever shape Arena sends is passed through in full. Fields shown are representative. The full response object includes additional properties. Example Payload for New Events[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/triggers/pollChangesTrigger.json "Download example payload") Loading… *** ## Data Sources[​](#data-sources "Direct link to Data Sources") ### Notification JSON Form[​](#notificationjsonform "Direct link to Notification JSON Form") Configure notification enablement, delivery channel, resource type, and message fields. | **key: notificationJsonForm** | **type: jsonForm** | Input | Notes | Example | | ---------- | ---------------------------- | ------- | | Connection | The Arena connection to use. | | *** ### Select Category[​](#categoriespicklist "Direct link to Select Category") Select from available Arena categories for the specified object type. | **key: categoriesPicklist** | **type: picklist** | Input | Notes | Example | | --------------- | ---------------------------------------------------- | ---------------- | | Assignable Only | Filter to only assignable categories | na | | Connection | The Arena connection to use. | | | Include Deleted | Whether to include deleted categories in the results | na | | Object Type | The type of object to get categories for | changes | | Path | Filter categories by path (optional) | /Engineering/ECO | Example Payload for Select Category[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/data-sources/categoriesPicklist.json "Download example payload") Loading… *** ### Select Category Attributes[​](#categoryattributesobjectselection "Direct link to Select Category Attributes") Select category attributes with metadata fields and multi-select capability. | **key: categoryAttributesObjectSelection** | **type: objectSelection** | Input | Notes | Example | | --------------------------- | ------------------------------------------------------------- | ------------------------ | | Category GUID | The GUID of the category to get attributes for | DSTCCGB4AJ3YQQ39H2HVG92V | | Connection | The Arena connection to use. | | | Include Inactive Attributes | When true, inactive attributes are included in the selection. | false | | Object Type | The type of object to get category attributes for | changes | Example Payload for Select Category Attributes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/data-sources/categoryAttributesObjectSelection.json "Download example payload") Loading… *** ### Select Change Category Routing[​](#changecategoryroutingspicklist "Direct link to Select Change Category Routing") Select from available routings for the specified change category. | **key: changeCategoryRoutingsPicklist** | **type: picklist** | Input | Notes | Example | | ------------- | ----------------------------------------------------------------------- | ------------------------ | | Category GUID | The unique identifier (GUID) of the change category to get routings for | DSEMMXWDIRAFEGB2EZKHHLXZ | | Connection | The Arena connection to use. | | Example Payload for Select Change Category Routing[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/data-sources/changeCategoryRoutingsPicklist.json "Download example payload") Loading… *** ### Select Export[​](#exportspicklist "Direct link to Select Export") Select from Arena export definitions. | **key: exportsPicklist** | **type: picklist** | Input | Notes | Example | | ----------------- | ---------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Creator Email | Filter by creator email | alex.chen\@example.com | | Creator Full Name | Filter by creator full name | Alex Chen | | Creator GUID | Filter by creator GUID | DS4KL5MN6OP7QR8ST9UV0WX1 | | Description | Filter by export description | | | Limit | Maximum number of results to return (default 20, max 400). | 50 | | Export Name | Filter by export name | | | Export Number | Filter by export number | | | Offset | Number of results to skip (default 0). | 0 | *** ### Select Integration[​](#integrationspicklist "Direct link to Select Integration") Select from available outbound integrations in Arena PLM. | **key: integrationsPicklist** | **type: picklist** | Input | Notes | Example | | ----------------------- | ----------------------------------------------- | ---------------------- | | Connection | The Arena connection to use. | | | Enabled Status Filter | Filter by enabled/disabled status | true | | Integration Name Filter | Filter outbound integrations by name (optional) | Item Sync — Production | Example Payload for Select Integration[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/data-sources/integrationsPicklist.json "Download example payload") Loading… *** ### Select Number Sequence Prefix[​](#numbersequenceprefixespicklist "Direct link to Select Number Sequence Prefix") Select from available number sequence prefixes for the specified object type. | **key: numberSequencePrefixesPicklist** | **type: picklist** | Input | Notes | Example | | ----------- | ------------------------------------------------------ | ------- | | Connection | The Arena connection to use. | | | Object Type | The type of object to get number sequence prefixes for | changes | Example Payload for Select Number Sequence Prefix[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/data-sources/numberSequencePrefixesPicklist.json "Download example payload") Loading… *** ### Select Outbound Event Integration[​](#outboundeventintegrationspicklist "Direct link to Select Outbound Event Integration") Select from available outbound event integrations in Arena PLM. | **key: outboundEventIntegrationsPicklist** | **type: picklist** | Input | Notes | Example | | ----------------------- | -------------------------------------- | ------- | | Connection | The Arena connection to use. | | | Enabled Status Filter | Filter by enabled/disabled status | all | | Integration Name Filter | Filter integrations by name (optional) | | Example Payload for Select Outbound Event Integration[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/data-sources/outboundEventIntegrationsPicklist.json "Download example payload") Loading… *** ### Select Quality Process Template[​](#qualityprocesstemplatespicklist "Direct link to Select Quality Process Template") Select from available Arena quality process templates (returns GUID as key). | **key: qualityProcessTemplatesPicklist** | **type: picklist** | Input | Notes | Example | | ---------- | ---------------------------- | ------- | | Connection | The Arena connection to use. | | Example Payload for Select Quality Process Template[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/data-sources/qualityProcessTemplatesPicklist.json "Download example payload") Loading… *** ## Actions[​](#actions "Direct link to Actions") ### Add Evaluation Issue Response[​](#addevaluationissueresponse "Direct link to Add Evaluation Issue Response") Add a response to an evaluation issue in Arena PLM system. | **key: addEvaluationIssueResponse** | Input | Notes | Example | | ------------ | ---------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Issue GUID | GUID of the evaluation issue to respond to. | RQ4KL5MN6OP7QR8ST9UV0WX1 | | Request GUID | GUID of the request containing the evaluation issue. | RQ4KL5MN6OP7QR8ST9UV0WX1 | | Response | Response to the evaluation issue. | | Example Payload for Add Evaluation Issue Response[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/addEvaluationIssueResponse.json "Download example payload") Loading… *** ### Add File to Training Plan[​](#addfiletotrainingplan "Direct link to Add File to Training Plan") Add a file to a training plan. | **key: addFileToTrainingPlan** | Input | Notes | Example | | -------------------------- | ---------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | File GUID | GUID of the file to add to the training plan. | GNZAQ5I94Y9DGMRS8NENGR3R | | Latest Edition Association | When true, the file is associated with its latest edition. | true | | Training GUID | GUID of the training plan. | TR1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Add File to Training Plan[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/addFileToTrainingPlan.json "Download example payload") Loading… *** ### Add Item to Change[​](#additemtochange "Direct link to Add Item to Change") Adds an item to a change with a specific GUID in Arena PLM system. | **key: addItemToChange** | Input | Notes | Example | | ------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------ | | BOM View JSON | Optional BOM view control object with 'includedInThisChange' (boolean) and 'notes' (string) properties. | | | Change GUID | GUID of the change to update. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Disposition Attribute JSON | Provide disposition attributes as raw JSON array. Each attribute should have 'guid' and 'value' properties. | | | Files View JSON | Optional Files view control object with 'includedInThisChange' (boolean) and 'notes' (string) properties. | | | Material Effectivity Date Time | Material effectivity date and time (ISO format). | 2024-01-15T10:00:00Z | | New Item Revision GUID | GUID of the working revision of the Item being added. | CH1AB2CD3EF4GH5IJ6KL7MN8 | | New Lifecycle Phase GUID | GUID of the new lifecycle phase. | CH5D4TZKH884FUWA7TYZCCIA | | New Revision Number | New revision number (can be omitted if a next revision is available in workspaces with Revision Sequences). | B | | Retraining Required | Whether retraining is required for this change. | | | Sourcing View JSON | Optional Sourcing view control object with 'includedInThisChange' (boolean) and 'notes' (string) properties. | | | Specs View JSON | Optional Specs view control object with 'includedInThisChange' (boolean) and 'notes' (string) properties. | | Example Payload for Add Item to Change[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/addItemToChange.json "Download example payload") Loading… *** ### Add Item to Request[​](#additemtorequest "Direct link to Add Item to Request") Add an item to a request in Arena PLM system. | **key: addItemToRequest** | Input | Notes | Example | | ------------ | ----------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Item GUID | GUID of the item to add to the request. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Notes | Optional notes about adding this item to the request. | | | Request GUID | GUID of the request to add the item to. | RQ4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Add Item to Request[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/addItemToRequest.json "Download example payload") Loading… *** ### Add Item to Training Plan[​](#additemtotrainingplan "Direct link to Add Item to Training Plan") Add an item to a training plan. | **key: addItemToTrainingPlan** | Input | Notes | Example | | ------------- | --------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Item GUID | GUID of the item to add to the training plan. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Training GUID | GUID of the training plan. | TR1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Add Item to Training Plan[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/addItemToTrainingPlan.json "Download example payload") Loading… *** ### Add Quality Process to Training Plan[​](#addqualitytotrainingplan "Direct link to Add Quality Process to Training Plan") Add a quality process to a training plan. | **key: addQualityToTrainingPlan** | Input | Notes | Example | | -------------------- | ------------------------------------------------------------ | ----------------------------- | | Connection | The Arena connection to use. | | | Quality Process GUID | GUID of the quality process to add. | qp123-456-789-abc-def567890 | | Step GUID | Optional GUID of a specific step within the quality process. | step123-456-789-abc-def567890 | | Training GUID | GUID of the training plan. | TR1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Add Quality Process to Training Plan[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/addQualityToTrainingPlan.json "Download example payload") Loading… *** ### Add Quality Step Approver[​](#addqualitystepapprover "Direct link to Add Quality Step Approver") Add decision makers to a quality process sign-off step. | **key: addQualityStepApprover** | Input | Notes | Example | | -------------------- | ------------------------------------------------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Decision Type | The type of decision requirement for the approver. | | | Group GUID | The GUID of the user group to add as approver (either user or group required). | QP4KL5MN6OP7QR8ST9UV0WX1 | | Quality Process GUID | The GUID of the quality process containing the step. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Step GUID | The GUID of the quality process sign-off step. | GN4KL5MN6OP7QR8ST9UV0WX1 | | User GUID | The GUID of the user to add as approver (either user or group required). | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Add Quality Step Approver[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/addQualityStepApprover.json "Download example payload") Loading… *** ### Add Requirement Child[​](#addrequirementchild "Direct link to Add Requirement Child") Add a child requirement to a requirement. | **key: addRequirementChild** | Input | Notes | Example | | ---------------------- | ----------------------------------------- | ------------------------ | | Child Requirement GUID | The GUID of the child requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Connection | The Arena connection to use. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Add Requirement Child[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/addRequirementChild.json "Download example payload") Loading… *** ### Add Requirement File[​](#addrequirementfile "Direct link to Add Requirement File") Attach a file to a requirement. | **key: addRequirementFile** | Input | Notes | Example | | ---------------- | ----------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | File GUID | The unique identifier (GUID) of the file. | GNZAQ5I94Y9DGMRS8NENGR3R | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Add Requirement File[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/addRequirementFile.json "Download example payload") Loading… *** ### Add Requirement Quality[​](#addrequirementquality "Direct link to Add Requirement Quality") Link a quality process to a requirement. | **key: addRequirementQuality** | Input | Notes | Example | | -------------------- | ----------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Quality Process GUID | The GUID of the quality process to link. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Quality Step GUID | The GUID of the specific quality step within the quality process. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Add Requirement Quality[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/addRequirementQuality.json "Download example payload") Loading… *** ### Add Requirement Ticket[​](#addrequirementticket "Direct link to Add Requirement Ticket") Link a ticket to a requirement. | **key: addRequirementTicket** | Input | Notes | Example | | ---------------- | -------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Ticket GUID | The GUID of the ticket to link to the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Add Requirement Ticket[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/addRequirementTicket.json "Download example payload") Loading… *** ### Add Requirement Trace[​](#addrequirementtrace "Direct link to Add Requirement Trace") Add a new trace link to a requirement. | **key: addRequirementTrace** | Input | Notes | Example | | ----------------------------- | ------------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Trace Direction | Direction of the trace link (UPSTREAM or DOWNSTREAM). | | | Trace Item GUID | GUID of the item to link via trace (use when objectType is ITEM). | RM4KL5MN6OP7QR8ST9UV0WX1 | | Trace Object Type | The type of object being traced (ITEM or REQUIREMENT). | | | Relationship Type GUID | The GUID of the trace relationship type. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Trace Target Requirement GUID | GUID of the requirement to link via trace (use when objectType is REQUIREMENT). | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Add Requirement Trace[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/addRequirementTrace.json "Download example payload") Loading… *** ### Add Ticket Change[​](#addticketchange "Direct link to Add Ticket Change") Link a change to a ticket in Arena PLM system. | **key: addTicketChange** | Input | Notes | Example | | ----------- | ------------------------------- | ------------------------ | | Change GUID | The GUID of the change to link. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Add Ticket Change[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/addTicketChange.json "Download example payload") Loading… *** ### Add Ticket File[​](#addticketfile "Direct link to Add Ticket File") Link a file to a ticket in Arena PLM system. | **key: addTicketFile** | Input | Notes | Example | | -------------- | ----------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Edition Number | Specific edition number of the file (optional). | | | File GUID | The GUID of the file to link. | GNZAQ5I94Y9DGMRS8NENGR3R | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Add Ticket File[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/addTicketFile.json "Download example payload") Loading… *** ### Add Ticket Item[​](#addticketitem "Direct link to Add Ticket Item") Link an item to a ticket in Arena PLM system. | **key: addTicketItem** | Input | Notes | Example | | --------------------------- | ------------------------------------------------------------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item to link. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Latest Revision Association | When true, always associates the latest revision of the item rather than a fixed revision. | false | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Add Ticket Item[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/addTicketItem.json "Download example payload") Loading… *** ### Add Ticket Quality Process[​](#addticketqualityprocess "Direct link to Add Ticket Quality Process") Link a quality process to a ticket in Arena PLM system. | **key: addTicketQualityProcess** | Input | Notes | Example | | -------------------- | ------------------------------------------------------------ | -------------------------------- | | Connection | The Arena connection to use. | | | Quality Process GUID | The GUID of the quality process to link. | TK1AB2CD3EF4GH5IJ6KL7MN8 | | Step GUID | Optional GUID of a specific step within the quality process. | def456abc-789-123-jkl-mnopqrs890 | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Add Ticket Quality Process[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/addTicketQualityProcess.json "Download example payload") Loading… *** ### Add Ticket Reference[​](#addticketreference "Direct link to Add Ticket Reference") Link another ticket as a reference to a ticket in Arena PLM system. | **key: addTicketReference** | Input | Notes | Example | | ---------------------- | ------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Referenced Ticket GUID | The GUID of the ticket to reference. | TK1AB2CD3EF4GH5IJ6KL7MN8 | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Add Ticket Reference[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/addTicketReference.json "Download example payload") Loading… *** ### Add User to Training Plan[​](#addusertotrainingplan "Direct link to Add User to Training Plan") Add a user to a training plan. | **key: addUserToTrainingPlan** | Input | Notes | Example | | ------------- | ------------------------------------------------------------- | ----------------------------- | | Connection | The Arena connection to use. | | | Due Date | Optional due date for the user to complete the training plan. | 2024-12-31T00:00:00Z | | Training GUID | GUID of the training plan. | TR1AB2CD3EF4GH5IJ6KL7MN8 | | User GUID | GUID of the user to add to the training plan. | user123-456-789-abc-def567890 | Example Payload for Add User to Training Plan[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/addUserToTrainingPlan.json "Download example payload") Loading… *** ### Attach File to Request[​](#attachfiletorequest "Direct link to Attach File to Request") Attach a new file to a request in Arena PLM system. | **key: attachFileToRequest** | Input | Notes | Example | | ------------ | ------------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | File GUID | GUID of the file to attach to the request. | GNZAQ5I94Y9DGMRS8NENGR3R | | Request GUID | GUID of the request to attach the file to. | RQ4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Attach File to Request[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/attachFileToRequest.json "Download example payload") Loading… *** ### Change Evaluation Issue Status[​](#changeevaluationissuestatus "Direct link to Change Evaluation Issue Status") Change the status of an evaluation issue in Arena PLM system. | **key: changeEvaluationIssueStatus** | Input | Notes | Example | | ------------ | ---------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Issue GUID | GUID of the evaluation issue to change status for. | RQ4KL5MN6OP7QR8ST9UV0WX1 | | Request GUID | GUID of the request containing the evaluation issue. | RQ4KL5MN6OP7QR8ST9UV0WX1 | | Response | Optional response when changing the issue status. | | | Status | New status for the evaluation issue. | | Example Payload for Change Evaluation Issue Status[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/changeEvaluationIssueStatus.json "Download example payload") Loading… *** ### Change File Checkout Status[​](#changefilecheckoutstatus "Direct link to Change File Checkout Status") Check a file edition in or out by changing its checkout status. | **key: changeFileCheckoutStatus** | Input | Notes | Example | | ------------------ | ---------------------------------------------------------------------------------------- | ------- | | Connection | The Arena connection to use. | | | File Checkout Data | File checkout data including file GUID, action (checkin/checkout), and optional content. | | | File Content | The file content to upload during checkin (binary format). | | Example Payload for Change File Checkout Status[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/changeFileCheckoutStatus.json "Download example payload") Loading… *** ### Change Item Lifecycle Phase[​](#changeitemlifecyclephase "Direct link to Change Item Lifecycle Phase") Release a new revision of an item to a target lifecycle phase (Design or Production). | **key: changeItemLifecyclePhase** | Input | Notes | Example | | --------------------------- | --------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Notes | Optional notes for the lifecycle phase change. | Released to production for initial launch | | Proceed on Notice | When true, the request proceeds even if it generates notices, which are warnings that do not prevent execution. | false | | Revision Number | Optional revision number for the new revision (if not auto-generated). | B | | Target Lifecycle Phase GUID | The GUID of the target lifecycle phase to transition the item to. | ITUBMHBI4KB7XU873JRVNZ2K | Example Payload for Change Item Lifecycle Phase[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/changeItemLifecyclePhase.json "Download example payload") Loading… *** ### Change Lifecycle Status[​](#changelifecyclestatus "Direct link to Change Lifecycle Status") Move a change to a new lifecycle phase by updating its status in Arena PLM system. | **key: changeLifecycleStatus** | Input | Notes | Example | | ---------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------ | | Administrators | Array of user GUIDs to assign as administrators. | \[{"guid": "abc123-def456-ghi789"}] | | Administrator Configuration Needed | When true, administrator configuration is needed for this transition. | false | | Change GUID | GUID of the change to update. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Comment | Optional comment for the lifecycle status change. | Approved by engineering team after review | | Connection | The Arena connection to use. | | | From Status | The current lifecycle status of the change (for validation). | OPEN | | Implementation Status | Implementation status object with guid and value properties. | {"guid": "status-guid", "value": "IN\_PROGRESS"} | | Target Status | The target lifecycle status to move the change to. | APPROVED | Example Payload for Change Lifecycle Status[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/changeLifecycleStatus.json "Download example payload") Loading… *** ### Change Quality Process Status[​](#changequalityprocessstatus "Direct link to 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. | **key: changeQualityProcessStatus** | Input | Notes | Example | | -------------------- | -------------------------------------------------------------------------------------- | ------------------------ | | Comment | Optional comment for the status change. | | | Connection | The Arena connection to use. | | | Quality Process GUID | The GUID of the quality process. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Request Type | Choose whether to change the overall quality process status or a specific step status. | | | Status | The new status for the quality process (required for Quality Process Status Change). | | | Step GUID | The GUID of the quality process step (required for Quality Step Workflow). | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Change Quality Process Status[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/changeQualityProcessStatus.json "Download example payload") Loading… *** ### Change Request Status[​](#changerequeststatus "Direct link to Change Request Status") Change the lifecycle status of a request in Arena PLM system. | **key: changeRequestStatus** | Input | Notes | Example | | ------------------------ | ---------------------------------------------------------------- | ------------------------ | | Comment | Optional comment about the status change. | | | Connection | The Arena connection to use. | | | Defer Deadline Date Time | ISO 8601 datetime when the deferred request should be revisited. | 2026-05-10T09:15:00Z | | Deferral Code | Code indicating the reason for deferral. | | | From Status | Current status of the request (optional). | | | Request GUID | GUID of the request to change status for. | RQ4KL5MN6OP7QR8ST9UV0WX1 | | Resolution Code | Code indicating the type of resolution. | | | Resolution Notes | Notes about the resolution (typically used when closing). | | | New Status | New lifecycle status for the request. | | Example Payload for Change Request Status[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/changeRequestStatus.json "Download example payload") Loading… *** ### Change Requirement Status[​](#changerequirementstatus "Direct link to Change Requirement Status") Change the status of a requirement. | **key: changeRequirementStatus** | Input | Notes | Example | | ---------------- | ----------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Status | The new status value for the requirement. | | Example Payload for Change Requirement Status[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/changeRequirementStatus.json "Download example payload") Loading… *** ### Change Ticket Status[​](#changeticketstatus "Direct link to Change Ticket Status") Change the status of a ticket in Arena PLM system. | **key: changeTicketStatus** | Input | Notes | Example | | ----------- | ------------------------------------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Notes | Optional notes for the status change. | | | Status | New status for the ticket (NOT\_STARTED, IN\_PROGRESS, COMPLETED). | | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Change Ticket Status[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/changeTicketStatus.json "Download example payload") Loading… *** ### Change Training Plan Status[​](#changetrainingplanstatus "Direct link to Change Training Plan Status") Change the status of a training plan (OPEN/CLOSED). | **key: changeTrainingPlanStatus** | Input | Notes | Example | | ------------- | ------------------------------------------- | -------------------------------------------- | | Comment | Optional comment for the status change. | Training completed by all required personnel | | Connection | The Arena connection to use. | | | Status | New status for the training plan. | | | Training GUID | GUID of the training plan to update status. | TR1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Change Training Plan Status[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/changeTrainingPlanStatus.json "Download example payload") Loading… *** ### Create BOM Line[​](#createbomline "Direct link to Create BOM Line") Add a new BOM line (Bill of Materials line) to an item in Arena PLM system with the specified properties. | **key: createBomLine** | Input | Notes | Example | | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | | Additional Attribute JSON | Provide additional attributes as raw JSON. If provided, this will be used instead of additionalAttributes and attributeDefinitions. | | | Additional Attributes | Additional custom attributes for the object. Key should be the attribute GUID, value should be the attribute value. | attr-guid-123: Custom Value | | Attribute Definitions | List of CategoryAttributeDefinitionVo objects that define the types and properties of attributes. This is required when creating additional attributes to ensure proper value type conversion (e.g., NUMBER/POSITIVE\_DOUBLE/COST types will be parsed as numbers). | | | BOM Item GUID | GUID of the item to add to the BOM. | BM1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Notes | Additional notes for the BOM line. | Use high-precision resistors | | Quantity | Quantity of the item in the BOM. | 2.5 | | Reference Designator | Reference designator for the BOM line (e.g., R1, C2, U5). | R1, R2, R3 | Example Payload for Create BOM Line[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createBomLine.json "Download example payload") Loading… *** ### Create BOM Substitute[​](#createbomsubstitute "Direct link to Create BOM Substitute") Add a new substitute component to a specific BOM line in Arena PLM system. | **key: createBomSubstitute** | Input | Notes | Example | | --------------- | ------------------------------------------------------------------- | ---------------------------- | | BOM Item GUID | GUID of the item to add to the BOM. | BM1AB2CD3EF4GH5IJ6KL7MN8 | | BOM Line GUID | GUID of the BOM line to retrieve, update, or delete. | BM4XIKY75ZITAA28ZABJKCAT | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Notes | Additional notes for the BOM line. | Use high-precision resistors | | Quantity | Quantity of the item in the BOM. | 2.5 | | Substitute Rank | Ranking order of the substitute (1 = primary, 2 = secondary, etc.). | 1 | Example Payload for Create BOM Substitute[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createBomSubstitute.json "Download example payload") Loading… *** ### Create Change[​](#createchange "Direct link to Create Change") Create a new change in Arena PLM system with the specified properties. | **key: createChange** | Input | Notes | Example | | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | | Additional Attribute JSON | Provide additional attributes as raw JSON. If provided, this will be used instead of additionalAttributes and attributeDefinitions. | | | Additional Attributes | Additional custom attributes for the object. Key should be the attribute GUID, value should be the attribute value. | attr-guid-123: Custom Value | | Approval Deadline | Deadline for change approval in ISO format. | 2025-08-15T10:00:00Z | | Attribute Definitions | List of CategoryAttributeDefinitionVo objects that define the types and properties of attributes. This is required when creating additional attributes to ensure proper value type conversion (e.g., NUMBER/POSITIVE\_DOUBLE/COST types will be parsed as numbers). | | | Category GUID | GUID of the category to assign to this change. | CH1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Change Description | Detailed description of the change. | Updated component design to improve manufacturing efficiency | | Effectivity Planned Date Time | Planned effectivity date time for the change in ISO format. | 2025-09-01T08:00:00Z | | Effectivity Type | Type of effectivity for the change. | | | Enforce Approval Deadline | When true, the approval deadline is enforced. | false | | Expiration Date Time | Expiration date time for the change in ISO format. | 2026-08-15T10:00:00Z | | Number Sequence Prefix | Number sequence prefix for generating the change number. | ECO | | Routings | List of routing GUIDs for the change approval workflow. Select multiple routings from the available options for the specified category. | \["routing-guid-123", "routing-guid-456"] | | Supplier Visibility | When true, the change is visible to suppliers. | false | | Change Title | The title/name of the change to create. | Component Design Update v3.0 | Example Payload for Create Change[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createChange.json "Download example payload") Loading… *** ### Create Change File Association[​](#createchangefileassociation "Direct link to Create Change File Association") Create a new change file association in Arena PLM system. | **key: createChangeFileAssociation** | Input | Notes | Example | | ----------- | ------------------------------------------------------- | ------------------------ | | Change GUID | GUID of the change to update. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | File GUID | GUID of the existing file to associate with the change. | GNZAQ5I94Y9DGMRS8NENGR3R | Example Payload for Create Change File Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createChangeFileAssociation.json "Download example payload") Loading… *** ### Create Change Implementation File[​](#createchangeimplementationfile "Direct link to Create Change Implementation File") Attach a new implementation file to a change. | **key: createChangeImplementationFile** | Input | Notes | Example | | ----------- | ------------------------------------------------------------ | ------------------------ | | Change GUID | The GUID of the change to attach the implementation file to. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | File GUID | The GUID of the file to attach as an implementation file. | GNZAQ5I94Y9DGMRS8NENGR3R | Example Payload for Create Change Implementation File[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createChangeImplementationFile.json "Download example payload") Loading… *** ### Create Change Implementation Task[​](#createchangeimplementationtask "Direct link to Create Change Implementation Task") Create a new implementation task for a change. | **key: createChangeImplementationTask** | Input | Notes | Example | | ------------------------ | ----------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Assignee User Group GUID | The GUID of the user group to assign this task to. Use either Assignee User GUID or Assignee User Group GUID, not both. | CH4KL5MN6OP7QR8ST9UV0WX1 | | Assignee User GUID | The GUID of the user to assign this task to. Use either Assignee User GUID or Assignee User Group GUID, not both. | CH4KL5MN6OP7QR8ST9UV0WX1 | | Change GUID | The GUID of the change to create an implementation task for. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Due Date | The due date for the task (ISO 8601 format). | 2026-05-10T09:15:00Z | | Task Name | The name of the implementation task. | | Example Payload for Create Change Implementation Task[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createChangeImplementationTask.json "Download example payload") Loading… *** ### Create Change Implementation Task File[​](#createchangeimplementationtaskfile "Direct link to Create Change Implementation Task File") Attach a file to an implementation task. | **key: createChangeImplementationTaskFile** | Input | Notes | Example | | ------------------------ | ---------------------------------------------------------- | ------------------------ | | Change GUID | The GUID of the change. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | File GUID | The GUID of the file to attach. | GNZAQ5I94Y9DGMRS8NENGR3R | | Implementation Task GUID | The GUID of the implementation task to attach the file to. | CH4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Create Change Implementation Task File[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createChangeImplementationTaskFile.json "Download example payload") Loading… *** ### Create Change Implementation Task Note[​](#createchangeimplementationtasknote "Direct link to Create Change Implementation Task Note") Create a new note for an implementation task. | **key: createChangeImplementationTaskNote** | Input | Notes | Example | | ------------------------ | ----------------------------------------------------- | ------------------------ | | Change GUID | The GUID of the change. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Implementation Task GUID | The GUID of the implementation task to add a note to. | CH4KL5MN6OP7QR8ST9UV0WX1 | | Private | When true, the note is marked as private. | false | | Label | Optional label for the note. | | | Note Content | The content of the note to add. | | Example Payload for Create Change Implementation Task Note[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createChangeImplementationTaskNote.json "Download example payload") Loading… *** ### Create Change Markup File[​](#createchangemarkupfile "Direct link to Create Change Markup File") Attach a new markup file to a change. | **key: createChangeMarkupFile** | Input | Notes | Example | | ----------- | ---------------------------------------------------- | ------------------------ | | Change GUID | The GUID of the change to attach the markup file to. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | File GUID | The GUID of the file to attach as a markup file. | GNZAQ5I94Y9DGMRS8NENGR3R | Example Payload for Create Change Markup File[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createChangeMarkupFile.json "Download example payload") Loading… *** ### Create Export[​](#createexport "Direct link to Create Export") Create a new export definition. | **key: createExport** | Input | Notes | Example | | ----------- | -------------------------------------------------------- | ------- | | Connection | The Arena connection to use. | | | Export Data | Export definition data including name, description, etc. | | Example Payload for Create Export[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createExport.json "Download example payload") Loading… *** ### Create Extract[​](#createextract "Direct link to Create Extract") Create a new extract definition. | **key: createExtract** | Input | Notes | Example | | ------------ | --------------------------------------------------------- | ------- | | Connection | The Arena connection to use. | | | Extract Data | Extract definition data including name, description, etc. | | Example Payload for Create Extract[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createExtract.json "Download example payload") Loading… *** ### Create File Correction[​](#createfilecorrection "Direct link to Create File Correction") Upload a corrected version of a file (multipart/form-data). | **key: createFileCorrection** | Input | Notes | Example | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------ | | Comments | Comment for the file correction. | | | Connection | The Arena connection to use. | | | File | The file to upload to Arena. Supports files up to 2GB in size. | | | File GUID | The unique identifier (GUID) of the file. | GNZAQ5I94Y9DGMRS8NENGR3R | | Have Content | When true, the cloud file content is downloaded. | false | | Remove Original Content | When true, the original content is removed. | false | | Storage Method | Storage method for the file. Use 'FILE' to store on Arena servers, 'FTP' for FTP server, 'WEB' for web link, or 'PLACE\_HOLDER' for placeholder. | FILE | Example Payload for Create File Correction[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createFileCorrection.json "Download example payload") Loading… *** ### Create File Edition[​](#createfileedition "Direct link to Create File Edition") Upload file to create next edition by file GUID. | **key: createFileEdition** | Input | Notes | Example | | ------------------- | --------------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Description | Description for the new file edition. | | | File Content | The file content to upload (binary format). Optional for FTP/WEB storage methods. | | | File GUID | The GUID of the file to create edition for. | GNZAQ5I94Y9DGMRS8NENGR3R | | Format | The file format or extension recorded on the file edition. | | | Location | Web or FTP address where the file resides (for FTP/WEB storage methods). | | | Storage Method Name | Storage method: FILE (Arena servers), FTP (user FTP server), or WEB (web link). | | | Title | Title for the new file edition. | | Example Payload for Create File Edition[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createFileEdition.json "Download example payload") Loading… *** ### Create File Markup[​](#createfilemarkup "Direct link to Create File Markup") Upload a markup file for a file (multipart/form-data). | **key: createFileMarkup** | Input | Notes | Example | | -------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------ | | Connection | The Arena connection to use. | | | File GUID | The unique identifier (GUID) of the file. | GNZAQ5I94Y9DGMRS8NENGR3R | | File Author Full Name | Full name of the file author. | John Doe | | File Category GUID | GUID of the category to filter files by. | GNSGE2D4YMGB4UITKVB7KZSW | | File | The file to upload to Arena. Supports files up to 2GB in size. | | | File Format | File format/extension (e.g., 'pdf', 'docx', 'png'). If not specified, will be extracted from file name. | pdf | | Markup Storage Method Name | Storage method for the markup file: FILE (Arena servers), FTP (user FTP server), or WEB (web link). | | | File Title | The title/name for the file in Arena. | Product Specification Document | | Reserved | When true, the markup file is reserved. | false | Example Payload for Create File Markup[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createFileMarkup.json "Download example payload") Loading… *** ### Create File With Content[​](#createfilewithcontent "Direct link to Create File With Content") Upload a file to Arena PLM system with specified metadata. Supports files up to 2GB. | **key: createFileWithContent** | Input | Notes | Example | | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------- | | File Author Full Name | Full name of the file author. | John Doe | | File Category GUID | GUID of the category to filter files by. | GNSGE2D4YMGB4UITKVB7KZSW | | Connection | The Arena connection to use. | | | File Description | Optional description for the file. | Technical specification document for product version 2.1 | | File Edition | Edition of the file, which Arena increments each time new content is checked in. | 1.0 | | File | The file to upload to Arena. Supports files up to 2GB in size. | | | File Format | File format/extension (e.g., 'pdf', 'docx', 'png'). If not specified, will be extracted from file name. | pdf | | File Private | When true, the file is private. | false | | Storage Method | Storage method for the file. Use 'FILE' to store on Arena servers, 'FTP' for FTP server, 'WEB' for web link, or 'PLACE\_HOLDER' for placeholder. | FILE | | File Title | The title/name for the file in Arena. | Product Specification Document | Example Payload for Create File With Content[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createFileWithContent.json "Download example payload") Loading… *** ### Create Import[​](#createimport "Direct link to Create Import") Create a new import definition. | **key: createImport** | Input | Notes | Example | | ----------- | -------------------------------------------------------- | ------- | | Connection | The Arena connection to use. | | | Import Data | Import definition data including name, description, etc. | | Example Payload for Create Import[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createImport.json "Download example payload") Loading… *** ### Create Item[​](#createitem "Direct link to Create Item") Create a new item in Arena PLM system with the specified properties. | **key: createItem** | Input | Notes | Example | | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | Additional Attribute JSON | Provide additional attributes as raw JSON. If provided, this will be used instead of additionalAttributes and attributeDefinitions. | | | Additional Attributes | Additional custom attributes for the object. Key should be the attribute GUID, value should be the attribute value. | attr-guid-123: Custom Value | | Attribute Definitions | List of CategoryAttributeDefinitionVo objects that define the types and properties of attributes. This is required when creating additional attributes to ensure proper value type conversion (e.g., NUMBER/POSITIVE\_DOUBLE/COST types will be parsed as numbers). | | | Category GUID | GUID of the category to assign to this item. | IT1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Item Description | Detailed description of the item. | Main circuit board assembly for product revision 2.1 | | Item Name | The name/title of the item to create. | Circuit Board Assembly v2.1 | | Number Format Fields | Fields for the number format. Key should be the field GUID, value should be the field value. | K2M5JGKMXEVI1K2AXGLN: 999-0011 | | Number Format GUID | GUID of the number format to use for generating the item number. | IT4IVLHFUC584FSNJJLVR6I2 | | Off The Shelf | When true, this is an off-the-shelf item. | false | | Owner Full Name | Full name of the user who will own this item. | John Doe | | Production Cost | Production cost of the item. | 25.50 | | Prototype Cost | Prototype cost of the item. | 125.00 | | Revision Number | Revision number for the item (if not auto-generated). | A | | Shared Item | When true, this item is shared across workspaces. | false | | Standard Cost | Standard cost of the item. | 28.75 | | Target Cost | Target cost of the item. | 30.00 | | Target Price | Target selling price of the item. | 45.00 | | Unit of Measure | Unit of measure for the item (e.g., 'EA', 'LB', 'FT'). | EA | Example Payload for Create Item[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createItem.json "Download example payload") Loading… *** ### Create Item File Association[​](#createitemfileassociation "Direct link to Create Item File Association") Upload a new file and associate it with an item in Arena PLM system (multipart/form-data). | **key: createItemFileAssociation** | Input | Notes | Example | | -------------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | | File Author Full Name | Full name of the file author. | John Doe | | File Category GUID | GUID of the category to filter files by. | GNSGE2D4YMGB4UITKVB7KZSW | | Connection | The Arena connection to use. | | | File Description | Optional description for the file. | Technical specification document for product version 2.1 | | File Edition | Edition of the file, which Arena increments each time new content is checked in. | 1.0 | | File | The file to upload to Arena. Supports files up to 2GB in size. | | | File Format | File format/extension (e.g., 'pdf', 'docx', 'png'). If not specified, will be extracted from file name. | pdf | | File Private | When true, the file is private. | false | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Latest Edition Association | When true, the file is associated with its latest edition. | true | | Primary File | When true, this is the primary file association. | false | | File Storage Method Name | Storage method holding the file: FILE, FTP, WEB or PLACE\_HOLDER. | Default Storage | | File Title | The title/name for the file in Arena. | Product Specification Document | Example Payload for Create Item File Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createItemFileAssociation.json "Download example payload") Loading… *** ### Create Item from JSON[​](#createitemfromjson "Direct link to 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. | **key: createItemFromJson** | Input | Notes | Example | | -------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Category GUID | GUID of the category to assign to this item. | IT1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Item Description | Detailed description of the item. | Main circuit board assembly for product revision 2.1 | | Item JSON Payload | Complete JSON payload for item creation. Core attribute inputs will override values in this JSON if provided. | { "name": "Circuit Board Assembly", "description": "Main circuit board", "category": { "guid": "abc123" }, "additionalAttributes": \[ { "guid": "custom-attr-guid", "value": "custom value" } ] } | | Item Name | The name/title of the item to create. If provided, overrides the name in JSON payload. | Circuit Board Assembly v2.1 | | Number Format Fields | Fields for the number format. Key should be the field GUID, value should be the field value. | K2M5JGKMXEVI1K2AXGLN: 999-0011 | | Number Format GUID | GUID of the number format to use for generating the item number. | IT4IVLHFUC584FSNJJLVR6I2 | | Off The Shelf | When true, this is an off-the-shelf item. | false | | Owner Full Name | Full name of the user who will own this item. | John Doe | | Production Cost | Production cost of the item. | 25.50 | | Prototype Cost | Prototype cost of the item. | 125.00 | | Revision Number | Revision number for the item (if not auto-generated). | A | | Shared Item | When true, this item is shared across workspaces. | false | | Standard Cost | Standard cost of the item. | 28.75 | | Target Cost | Target cost of the item. | 30.00 | | Target Price | Target selling price of the item. | 45.00 | | Unit of Measure | Unit of measure for the item (e.g., 'EA', 'LB', 'FT'). | EA | Example Payload for Create Item from JSON[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createItemFromJson.json "Download example payload") Loading… *** ### Create Item Image[​](#createitemimage "Direct link to Create Item Image") Upload and set an image as the thumbnail of an item. | **key: createItemImage** | Input | Notes | Example | | ------------- | --------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Image Content | The image file content to upload, base64 encoded. | | | Filename | The filename for the image (e.g., 'thumbnail.jpg'). | specification.pdf | | Item GUID | The GUID of the item to add an image to. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Create Item Image[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createItemImage.json "Download example payload") Loading… *** ### Create Item Number Format Field[​](#createitemnumberformatfield "Direct link to Create Item Number Format Field") Add a new field to a specific item number format in Arena PLM system. | **key: createItemNumberFormatField** | Input | Notes | Example | | ----------- | --------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Field Data | The field data to create (name, fieldType, etc.). | | | Format GUID | The GUID of the item number format to add field to. | IT4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Create Item Number Format Field[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createItemNumberFormatField.json "Download example payload") Loading… *** ### Create Item Number Reservation[​](#createitemnumberreservation "Direct link to Create Item Number Reservation") Create a new item number reservation in Arena PLM system. | **key: createItemNumberReservation** | Input | Notes | Example | | ---------------- | ------------------------------------------------------ | ------- | | Connection | The Arena connection to use. | | | Reservation Data | The reservation data to create (name, category, etc.). | | Example Payload for Create Item Number Reservation[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createItemNumberReservation.json "Download example payload") Loading… *** ### Create Quality Process[​](#createqualityprocess "Direct link to Create Quality Process") Create a new Quality Process in Arena PLM system. | **key: createQualityProcess** | Input | Notes | Example | | --------------------------- | ------------------------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Description | Description of the quality process. | | | Quality Process Name | The name of the quality process. | | | Number Format Prefix GUID | The GUID of the number format prefix for the template. | QP4KL5MN6OP7QR8ST9UV0WX1 | | Owner GUID | The GUID of the quality process owner. | QP4KL5MN6OP7QR8ST9UV0WX1 | | Target Completion Date Time | Target completion date and time (ISO format). | 2024-12-31T23:59:59Z | | Template GUID | The GUID of the quality process template. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Quality Process Type | The type of quality process. | | Example Payload for Create Quality Process[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createQualityProcess.json "Download example payload") Loading… *** ### Create Quality Process Step Affected Object[​](#createqualityprocessstepaffected "Direct link to 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. | **key: createQualityProcessStepAffected** | Input | Notes | Example | | -------------------- | ------------------------------------------------------------------- | ------------------------ | | Affected Object GUID | The GUID of the object to be affected (item, change, file, etc.). | QP4KL5MN6OP7QR8ST9UV0WX1 | | Connection | The Arena connection to use. | | | Notes | Optional notes for the affected object. | | | Quality Process GUID | The GUID of the quality process containing the step. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Step GUID | The GUID of the quality process step to add the affected object to. | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Create Quality Process Step Affected Object[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createQualityProcessStepAffected.json "Download example payload") Loading… *** ### Create Quality Process Step Affected Quality[​](#createqualityprocessstepaffectedquality "Direct link to 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. | **key: createQualityProcessStepAffectedQuality** | Input | Notes | Example | | ---------------------------- | --------------------------------------------------------------------------- | ------------------------ | | Affected Step GUID | The GUID of the quality process step to be affected. | QP4KL5MN6OP7QR8ST9UV0WX1 | | Connection | The Arena connection to use. | | | Affected Quality Object GUID | Optional GUID for the affected quality object. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Quality Process GUID | The GUID of the quality process containing the step. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Step GUID | The GUID of the quality process step to add the quality affected object to. | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Create Quality Process Step Affected Quality[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createQualityProcessStepAffectedQuality.json "Download example payload") Loading… *** ### Create Quality Process Step Affected URL[​](#createqualityprocessstepaffectedurl "Direct link to 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. | **key: createQualityProcessStepAffectedUrl** | Input | Notes | Example | | ------------------------ | ----------------------------------------------------------------------- | ----------------------------- | | Connection | The Arena connection to use. | | | Description | Description for the URL. | | | Display Name | Display name for the URL. | Important Document | | Affected URL Object GUID | Optional GUID for the affected URL object. | GN4KL5MN6OP7QR8ST9UV0WX1 | | URL Link | The URL link to be added as an affected object. | https\://example.com/document | | Quality Process GUID | The GUID of the quality process containing the step. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Step GUID | The GUID of the quality process step to add the URL affected object to. | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Create Quality Process Step Affected URL[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createQualityProcessStepAffectedUrl.json "Download example payload") Loading… *** ### Create Request[​](#createrequest "Direct link to Create Request") Create a new request in Arena PLM system. | **key: createRequest** | Input | Notes | Example | | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | | Additional Attribute JSON | Provide additional attributes as raw JSON. If provided, this will be used instead of additionalAttributes and attributeDefinitions. | | | Additional Attributes | Additional custom attributes for the object. Key should be the attribute GUID, value should be the attribute value. | attr-guid-123: Custom Value | | Attribute Definitions | List of CategoryAttributeDefinitionVo objects that define the types and properties of attributes. This is required when creating additional attributes to ensure proper value type conversion (e.g., NUMBER/POSITIVE\_DOUBLE/COST types will be parsed as numbers). | | | Category GUID | GUID of the category to assign to this request. | GNLMBALQ4EZWDYIEZCJSHGRK | | Connection | The Arena connection to use. | | | Creator Participation | When true, the creator participates in the request evaluation. | false | | Evaluator Group GUID | GUID of the evaluator group for this request. | RQ4KL5MN6OP7QR8ST9UV0WX1 | | Number Sequence Prefix | Prefix for the request number sequence. | ECO | | Problem Description | Description of the problem that needs to be addressed. | | | Request Code | Code associated with the request. | | | Requested Action | Description of the action requested to solve the problem. | | | Supplier Visibility | When true, the request is visible to suppliers. | false | | Request Title | The title of the request. | | Example Payload for Create Request[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createRequest.json "Download example payload") Loading… *** ### Create Request Evaluation Issue[​](#createrequestevaluationissue "Direct link to Create Request Evaluation Issue") Create a new evaluation issue for a request in Arena PLM system. | **key: createRequestEvaluationIssue** | Input | Notes | Example | | ------------------- | ------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Issue Description | Description of the evaluation issue to create. | | | Request GUID | GUID of the request to create the evaluation issue for. | RQ4KL5MN6OP7QR8ST9UV0WX1 | | Supplier Visibility | When true, the issue is visible to suppliers. | false | Example Payload for Create Request Evaluation Issue[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createRequestEvaluationIssue.json "Download example payload") Loading… *** ### Create Request Markup File[​](#createrequestmarkupfile "Direct link to Create Request Markup File") Create a markup file for a request in Arena PLM system. | **key: createRequestMarkupFile** | Input | Notes | Example | | ------------ | -------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Markup GUID | GUID of the markup to associate with the request. | RQ4KL5MN6OP7QR8ST9UV0WX1 | | Request GUID | GUID of the request to create the markup file for. | RQ4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Create Request Markup File[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createRequestMarkupFile.json "Download example payload") Loading… *** ### Create Requirement[​](#createrequirement "Direct link to Create Requirement") Create a new requirement in Arena PLM. | **key: createRequirement** | Input | Notes | Example | | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | | Additional Attribute JSON | Provide additional attributes as raw JSON. If provided, this will be used instead of additionalAttributes and attributeDefinitions. | | | Additional Attributes | Additional custom attributes for the object. Key should be the attribute GUID, value should be the attribute value. | attr-guid-123: Custom Value | | Assignee GUID | GUID of the user to assign the requirement to. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Attribute Definitions | List of CategoryAttributeDefinitionVo objects that define the types and properties of attributes. This is required when creating additional attributes to ensure proper value type conversion (e.g., NUMBER/POSITIVE\_DOUBLE/COST types will be parsed as numbers). | | | Connection | The Arena connection to use. | | | Description | The description of the requirement. | | | Number | Custom requirement number (optional). | | | Number Sequence Prefix | Number sequence prefix for auto-generating requirement number. | ECO | | Priority | The priority of the requirement. The accepted values come from the priority attribute configured in Arena, for example High or Medium. | | | Requirement Template GUID | The GUID of the requirement template. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Title | The title of the requirement. | | Example Payload for Create Requirement[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createRequirement.json "Download example payload") Loading… *** ### Create Sourcing Relationship[​](#createsourcingrelationship "Direct link to Create Sourcing Relationship") Create a new sourcing relationship for an item in Arena PLM system. | **key: createSourcingRelationship** | Input | Notes | Example | | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | AML Rank | Approved Manufacturer List rank (integer). | 1 | | Approved | When true, the sourcing relationship is approved. | false | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Make Item | When true, the relationship is a make item, meaning the part is manufactured in house rather than bought from the supplier. | false | | Manufacturer Item GUID | GUID of the manufacturer item. | SPQDZ6CQ75S3ENCGW6DXTGPP | | Notes | Additional notes for the sourcing relationship. | Primary supplier for production runs | | Vendor Item Conversion Factor | Conversion factor between vendor and manufacturer items. | 1.0 | | Vendor Item GUID | GUID of the vendor item. | SPW6UKHVR5KUVQGN48AHK9CZ | Example Payload for Create Sourcing Relationship[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createSourcingRelationship.json "Download example payload") Loading… *** ### Create Supplier[​](#createsupplier "Direct link to Create Supplier") Create a new supplier in Arena PLM system with the specified information. | **key: createSupplier** | Input | Notes | Example | | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | | Account Number | Account number for the supplier. | ACCT-12345 | | Additional Attributes | Additional custom attributes for the object. Key should be the attribute GUID, value should be the attribute value. | attr-guid-123: Custom Value | | Addresses | JSON array of address objects to assign to the supplier. | | | Approval Status GUID | GUID of the approval status setting to assign to this supplier. | SP1AB2CD3EF4GH5IJ6KL7MN8 | | Attribute Definitions | List of CategoryAttributeDefinitionVo objects that define the types and properties of attributes. This is required when creating additional attributes to ensure proper value type conversion (e.g., NUMBER/POSITIVE\_DOUBLE/COST types will be parsed as numbers). | | | Connection | The Arena connection to use. | | | Description | Description of the supplier. | | | Supplier Name | The name of the supplier. | | | Phone Numbers | JSON array of phone number objects to assign to the supplier. | | | Supplier ID | The unique identifier for the supplier. | SUP-000145 | | Website | The supplier's public website, recorded for reference on the supplier record. | https\://www\.supplier.com | Example Payload for Create Supplier[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createSupplier.json "Download example payload") Loading… *** ### Create Supplier Address[​](#createsupplieraddress "Direct link to Create Supplier Address") Add an address to a supplier in Arena PLM system. | **key: createSupplierAddress** | Input | Notes | Example | | ------------------ | ---------------------------------------------------------------------- | ------------------------ | | Address | Street address lines, city, state, province, postal code, and country. | | | Connection | The Arena connection to use. | | | Is Primary Address | When true, this address is the primary address for the supplier. | true | | Address Label | Label for the address (e.g., 'Main Office', 'Billing', 'Shipping'). | Main Office | | Supplier GUID | GUID of the supplier that provides this item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Create Supplier Address[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createSupplierAddress.json "Download example payload") Loading… *** ### Create Supplier File Association[​](#createsupplierfileassociation "Direct link to Create Supplier File Association") Associate an existing file with a supplier in Arena PLM system. | **key: createSupplierFileAssociation** | Input | Notes | Example | | ------------- | --------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | File GUID | The unique identifier (GUID) of the file. | GNZAQ5I94Y9DGMRS8NENGR3R | | Supplier GUID | GUID of the supplier that provides this item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Create Supplier File Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createSupplierFileAssociation.json "Download example payload") Loading… *** ### Create Supplier Item[​](#createsupplieritem "Direct link to Create Supplier Item") Create a new supplier item in Arena PLM system with the specified properties. | **key: createSupplierItem** | Input | Notes | Example | | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | | Additional Attribute JSON | Provide additional attributes as raw JSON. If provided, this will be used instead of additionalAttributes and attributeDefinitions. | | | Additional Attributes | Additional custom attributes for the object. Key should be the attribute GUID, value should be the attribute value. | attr-guid-123: Custom Value | | Attribute Definitions | List of CategoryAttributeDefinitionVo objects that define the types and properties of attributes. This is required when creating additional attributes to ensure proper value type conversion (e.g., NUMBER/POSITIVE\_DOUBLE/COST types will be parsed as numbers). | | | Connection | The Arena connection to use. | | | Supplier Item Description | Detailed description of the supplier item. | High-quality circuit board for electronic assembly | | Supplier Item Name | The name of the supplier item. | Circuit Board PCB-123 | | Supplier Item Number | The number/part number of the supplier item. | PCB-123-V2 | | Off The Shelf | When true, this is an off-the-shelf supplier item. | false | | Procurement Type | Procurement type for the supplier item. | | | Supplier GUID | GUID of the supplier that provides this item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | | Supplier Item Type | The type/category of the supplier item. | Component | | Supplier Item Unit of Measure | Unit of measure for the supplier item (e.g., 'EA', 'LB', 'FT'). | EA | Example Payload for Create Supplier Item[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createSupplierItem.json "Download example payload") Loading… *** ### Create Supplier Item File[​](#createsupplieritemfile "Direct link to Create Supplier Item File") Upload a file and associate it with a supplier item. Supports files up to 2GB with multipart form data upload. | **key: createSupplierItemFile** | Input | Notes | Example | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------- | | File Author Full Name | Full name of the file author. | John Doe | | File Category GUID | GUID of the category to filter files by. | GNSGE2D4YMGB4UITKVB7KZSW | | Connection | The Arena connection to use. | | | File Description | Optional description for the file. | Technical specification document for product version 2.1 | | File Edition | Edition of the file, which Arena increments each time new content is checked in. | 1.0 | | File | The file to upload to Arena. Supports files up to 2GB in size. | | | File Format | File format/extension (e.g., 'pdf', 'docx', 'png'). If not specified, will be extracted from file name. | pdf | | Latest Edition Association | When true, the file is associated with its latest edition. | true | | Primary File | When true, this is the primary file for the supplier item. | false | | File Private | When true, the file is private. | false | | Storage Method | Storage method for the file. Use 'FILE' to store on Arena servers, 'FTP' for FTP server, 'WEB' for web link, or 'PLACE\_HOLDER' for placeholder. | FILE | | Supplier Item GUID | The GUID of the supplier item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | | File Title | The title/name for the file in Arena. | Product Specification Document | Example Payload for Create Supplier Item File[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createSupplierItemFile.json "Download example payload") Loading… *** ### Create Supplier Phone Number[​](#createsupplierphonenumber "Direct link to Create Supplier Phone Number") Add a phone number to a supplier in Arena PLM system. | **key: createSupplierPhoneNumber** | Input | Notes | Example | | ---------------------- | ----------------------------------------------------------- | ------------------------ | | Phone Number Comment | Additional comment about the phone number. | Primary contact number | | Connection | The Arena connection to use. | | | Phone Number Extension | Phone number extension if applicable. | 123 | | Phone Number Label | Label for the phone number (e.g., 'Main', 'Fax', 'Mobile'). | Main | | Phone Number | Phone number in the format the supplier record stores it. | +1-555-123-4567 | | Supplier GUID | GUID of the supplier that provides this item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Create Supplier Phone Number[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createSupplierPhoneNumber.json "Download example payload") Loading… *** ### Create Ticket[​](#createticket "Direct link to Create Ticket") Create a new ticket in Arena PLM system. | **key: createTicket** | Input | Notes | Example | | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | | Additional Attribute JSON | Provide additional attributes as raw JSON. If provided, this will be used instead of additionalAttributes and attributeDefinitions. | | | Additional Attributes | Additional custom attributes for the object. Key should be the attribute GUID, value should be the attribute value. | attr-guid-123: Custom Value | | Attribute Definitions | List of CategoryAttributeDefinitionVo objects that define the types and properties of attributes. This is required when creating additional attributes to ensure proper value type conversion (e.g., NUMBER/POSITIVE\_DOUBLE/COST types will be parsed as numbers). | | | Connection | The Arena connection to use. | | | Number | Custom ticket number (optional - will use template default if not provided). | | | Number Sequence Prefix | Number sequence prefix for auto-generating ticket number. | ECO | | Template GUID | The GUID of the template. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Title | The title of the ticket. | | Example Payload for Create Ticket[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/createTicket.json "Download example payload") Loading… *** ### Delete BOM Line[​](#deletebomline "Direct link to Delete BOM Line") Delete a specific BOM line from an item in Arena PLM system. | **key: deleteBomLine** | Input | Notes | Example | | ------------- | ---------------------------------------------------- | ------------------------ | | BOM Line GUID | GUID of the BOM line to retrieve, update, or delete. | BM4XIKY75ZITAA28ZABJKCAT | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Delete BOM Line[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteBomLine.json "Download example payload") Loading… *** ### Delete BOM Substitute[​](#deletebomsubstitute "Direct link to Delete BOM Substitute") Delete a specific BOM substitute from Arena PLM system. | **key: deleteBomSubstitute** | Input | Notes | Example | | --------------- | ---------------------------------------------------------- | ------------------------ | | BOM Line GUID | GUID of the BOM line to retrieve, update, or delete. | BM4XIKY75ZITAA28ZABJKCAT | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Substitute GUID | GUID of the BOM substitute to retrieve, update, or delete. | BMSJ6Z57GF3S43WZZ58HQ59S | Example Payload for Delete BOM Substitute[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteBomSubstitute.json "Download example payload") Loading… *** ### Delete Change[​](#deletechange "Direct link to Delete Change") Delete an existing change from Arena PLM system. | **key: deleteChange** | Input | Notes | Example | | ----------- | ----------------------------- | ------------------------ | | Change GUID | GUID of the change to update. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | Example Payload for Delete Change[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteChange.json "Download example payload") Loading… *** ### Delete Change File Association[​](#deletechangefileassociation "Direct link to Delete Change File Association") Delete a change file association from Arena PLM system. | **key: deleteChangeFileAssociation** | Input | Notes | Example | | ---------------------------- | ------------------------------------ | ------------------------ | | Change File Association GUID | GUID of the change-file association. | CHRXMFA8H3PN48IAAH7PV9L3 | | Change GUID | GUID of the change to update. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | Example Payload for Delete Change File Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteChangeFileAssociation.json "Download example payload") Loading… *** ### Delete Change Item Association[​](#deletechangeitemassociation "Direct link to 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. | **key: deleteChangeItemAssociation** | Input | Notes | Example | | ---------------------------- | ---------------------------------------------- | ------------------------ | | Change GUID | GUID of the change to update. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Change Item Association GUID | GUID of the change-item association to update. | CHVVLTU2VVPNU6P4IVW8MN4V | | Connection | The Arena connection to use. | | Example Payload for Delete Change Item Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteChangeItemAssociation.json "Download example payload") Loading… *** ### Delete Change Markup File[​](#deletechangemarkupfile "Direct link to Delete Change Markup File") Remove a markup file association from a change. | **key: deleteChangeMarkupFile** | Input | Notes | Example | | ---------------------------- | -------------------------------------------------- | ------------------------ | | Change File Association GUID | The GUID of the change file association to delete. | CHRXMFA8H3PN48IAAH7PV9L3 | | Change GUID | The GUID of the change. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | Example Payload for Delete Change Markup File[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteChangeMarkupFile.json "Download example payload") Loading… *** ### Delete Extract[​](#deleteextract "Direct link to Delete Extract") Delete an extract definition. | **key: deleteExtract** | Input | Notes | Example | | ------------ | --------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Extract GUID | The GUID of the extract definition to delete. | ET4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Delete Extract[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteExtract.json "Download example payload") Loading… *** ### Delete File[​](#deletefile "Direct link to 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. | **key: deleteFile** | Input | Notes | Example | | ---------- | ----------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | File GUID | The unique identifier (GUID) of the file. | GNZAQ5I94Y9DGMRS8NENGR3R | Example Payload for Delete File[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteFile.json "Download example payload") Loading… *** ### Delete Item[​](#deleteitem "Direct link to Delete Item") Delete an existing item from Arena PLM system with the specified GUID. | **key: deleteItem** | Input | Notes | Example | | ---------- | ---------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Delete Item[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteItem.json "Download example payload") Loading… *** ### Delete Item File Association[​](#deleteitemfileassociation "Direct link to Delete Item File Association") Delete an item file association from Arena PLM system. | **key: deleteItemFileAssociation** | Input | Notes | Example | | -------------------------- | ---------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Item File Association GUID | GUID of the item file association. | IT1AB2CD3EF4GH5IJ6KL7MN8 | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Delete Item File Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteItemFileAssociation.json "Download example payload") Loading… *** ### Delete Item Image[​](#deleteitemimage "Direct link to Delete Item Image") Remove the thumbnail image from an item. | **key: deleteItemImage** | Input | Notes | Example | | ---------- | ---------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item to remove the image from. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Delete Item Image[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteItemImage.json "Download example payload") Loading… *** ### Delete Quality Process[​](#deletequalityprocess "Direct link to 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. | **key: deleteQualityProcess** | Input | Notes | Example | | -------------------- | ------------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Quality Process GUID | The GUID of the quality process to delete. | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Delete Quality Process[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteQualityProcess.json "Download example payload") Loading… *** ### Delete Quality Process Step Affected Object[​](#deletequalityprocessstepaffected "Direct link to 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. | **key: deleteQualityProcessStepAffected** | Input | Notes | Example | | -------------------- | -------------------------------------------------------------------- | ------------------------ | | Affected Object GUID | The GUID of the affected object to delete. | QP4KL5MN6OP7QR8ST9UV0WX1 | | Connection | The Arena connection to use. | | | Quality Process GUID | The GUID of the quality process containing the step. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Step GUID | The GUID of the quality process step containing the affected object. | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Delete Quality Process Step Affected Object[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteQualityProcessStepAffected.json "Download example payload") Loading… *** ### Delete Request[​](#deleterequest "Direct link to Delete Request") Delete a specific request from Arena PLM system. | **key: deleteRequest** | Input | Notes | Example | | ------------ | ------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Request GUID | GUID of the request to delete. | RQ4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Delete Request[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteRequest.json "Download example payload") Loading… *** ### Delete Request Markup File[​](#deleterequestmarkupfile "Direct link to Delete Request Markup File") Delete a request markup file from Arena PLM system. | **key: deleteRequestMarkupFile** | Input | Notes | Example | | ----------------------------- | ------------------------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Request File Association GUID | GUID of the request markup file association to delete. | RQ4KL5MN6OP7QR8ST9UV0WX1 | | Request GUID | GUID of the request containing the markup file. | RQ4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Delete Request Markup File[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteRequestMarkupFile.json "Download example payload") Loading… *** ### Delete Requirement[​](#deleterequirement "Direct link to Delete Requirement") Delete a requirement. | **key: deleteRequirement** | Input | Notes | Example | | ---------------- | ----------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Delete Requirement[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteRequirement.json "Download example payload") Loading… *** ### Delete Requirement Trace[​](#deleterequirementtrace "Direct link to Delete Requirement Trace") Delete a trace link from a requirement. | **key: deleteRequirementTrace** | Input | Notes | Example | | ---------------- | ----------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Trace Link GUID | The unique identifier of the trace link. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Delete Requirement Trace[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteRequirementTrace.json "Download example payload") Loading… *** ### Delete Sourcing Relationship[​](#deletesourcingrelationship "Direct link to Delete Sourcing Relationship") Delete a specified sourcing relationship for an item in Arena PLM system. | **key: deleteSourcingRelationship** | Input | Notes | Example | | -------------------------- | ---------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Sourcing Relationship GUID | GUID of the sourcing relationship. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Delete Sourcing Relationship[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteSourcingRelationship.json "Download example payload") Loading… *** ### Delete Supplier[​](#deletesupplier "Direct link to Delete Supplier") Delete a supplier from Arena PLM system. This action cannot be undone. | **key: deleteSupplier** | Input | Notes | Example | | ------------- | --------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Supplier GUID | GUID of the supplier that provides this item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Delete Supplier[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteSupplier.json "Download example payload") Loading… *** ### Delete Supplier Address[​](#deletesupplieraddress "Direct link to Delete Supplier Address") Delete an address from a supplier in Arena PLM system. This action cannot be undone. | **key: deleteSupplierAddress** | Input | Notes | Example | | ------------- | --------------------------------------------- | ------------------------ | | Address GUID | The unique identifier (GUID) of the address. | SP23PEPH52BD74BBYPPBHGAY | | Connection | The Arena connection to use. | | | Supplier GUID | GUID of the supplier that provides this item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Delete Supplier Address[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteSupplierAddress.json "Download example payload") Loading… *** ### Delete Supplier File Association[​](#deletesupplierfileassociation "Direct link to Delete Supplier File Association") Delete a file association from a supplier in Arena PLM system. This action cannot be undone. | **key: deleteSupplierFileAssociation** | Input | Notes | Example | | ------------------------------ | -------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Supplier File Association GUID | The unique identifier (GUID) of the supplier file association. | SPWCC5835PR4AZIWCN7FZ6K9 | | Supplier GUID | GUID of the supplier that provides this item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Delete Supplier File Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteSupplierFileAssociation.json "Download example payload") Loading… *** ### Delete Supplier Item[​](#deletesupplieritem "Direct link to Delete Supplier Item") Delete a specific supplier item from Arena PLM system using its GUID. | **key: deleteSupplierItem** | Input | Notes | Example | | ------------------ | ------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Supplier Item GUID | The GUID of the supplier item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Delete Supplier Item[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteSupplierItem.json "Download example payload") Loading… *** ### Delete Supplier Phone Number[​](#deletesupplierphonenumber "Direct link to Delete Supplier Phone Number") Delete a phone number from a supplier in Arena PLM system. This action cannot be undone. | **key: deleteSupplierPhoneNumber** | Input | Notes | Example | | ----------------- | ------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Phone Number GUID | The unique identifier (GUID) of the phone number. | SPSSLP7UXXNQ2YRAFWY593XU | | Supplier GUID | GUID of the supplier that provides this item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Delete Supplier Phone Number[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteSupplierPhoneNumber.json "Download example payload") Loading… *** ### Delete Ticket[​](#deleteticket "Direct link to Delete Ticket") Delete a specific ticket from Arena PLM system. | **key: deleteTicket** | Input | Notes | Example | | ----------- | ---------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Delete Ticket[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/deleteTicket.json "Download example payload") Loading… *** ### Download Export Run File Content[​](#downloadexportrunfilecontent "Direct link to Download Export Run File Content") Download the actual content of a file from an export run. | **key: downloadExportRunFileContent** | Input | Notes | Example | | --------------- | ---------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Export GUID | The GUID of the export definition. | EX4KL5MN6OP7QR8ST9UV0WX1 | | Export Run GUID | The GUID of the export run. | EX4KL5MN6OP7QR8ST9UV0WX1 | | File GUID | The GUID of the file to download. | GNZAQ5I94Y9DGMRS8NENGR3R | Example Payload for Download Export Run File Content[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/downloadExportRunFileContent.json "Download example payload") Loading… *** ### Download Extract Run File Content[​](#downloadextractrunfilecontent "Direct link to Download Extract Run File Content") Download the actual file content from an extract run. | **key: downloadExtractRunFileContent** | Input | Notes | Example | | ------------------------- | ------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Extract GUID | The GUID of the extract definition. | ET4KL5MN6OP7QR8ST9UV0WX1 | | Extract Run GUID | The GUID of the extract run. | ET4KL5MN6OP7QR8ST9UV0WX1 | | Run File Association GUID | The GUID of the run file association to download. | ET4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Download Extract Run File Content[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/downloadExtractRunFileContent.json "Download example payload") Loading… *** ### Download File Content[​](#downloadfilecontent "Direct link to Download File Content") Download file content by its GUID. | **key: downloadFileContent** | Input | Notes | Example | | ---------- | --------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | File GUID | The GUID of the file to download. | GNZAQ5I94Y9DGMRS8NENGR3R | Example Payload for Download File Content[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/downloadFileContent.json "Download example payload") Loading… *** ### Force Complete Import[​](#forcecompleteimport "Direct link to Force Complete Import") Force an import run to complete, even if there are errors. | **key: forceCompleteImport** | Input | Notes | Example | | --------------- | --------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Import GUID | The GUID of the import definition. | IM4KL5MN6OP7QR8ST9UV0WX1 | | Import Run GUID | The GUID of the import run to force complete. | IM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Force Complete Import[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/forceCompleteImport.json "Download example payload") Loading… *** ### Get BOM Line[​](#getbomline "Direct link to Get BOM Line") Retrieve detailed information of a specific BOM line for an item in Arena PLM system. | **key: getBomLine** | Input | Notes | Example | | ----------------------------------- | ----------------------------------------------------------------------- | ------------------------ | | BOM Line GUID | GUID of the BOM line to retrieve, update, or delete. | BM4XIKY75ZITAA28ZABJKCAT | | Connection | The Arena connection to use. | | | Include BOM Substitutes | When true, substitute components are included in the BOM line response. | false | | Include Empty Additional Attributes | When true, empty additional attributes are included in the response. | false | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Get BOM Line[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getBomLine.json "Download example payload") Loading… *** ### Get BOM Settings[​](#getbomsettings "Direct link to Get BOM Settings") Retrieve BOM settings for an item in Arena PLM system. | **key: getBomSettings** | Input | Notes | Example | | ---------- | ---------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Get BOM Settings[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getBomSettings.json "Download example payload") Loading… *** ### Get BOM Substitute[​](#getbomsubstitute "Direct link to Get BOM Substitute") Retrieve detailed information of a specific BOM substitute in Arena PLM system. | **key: getBomSubstitute** | Input | Notes | Example | | --------------- | ---------------------------------------------------------- | ------------------------ | | BOM Line GUID | GUID of the BOM line to retrieve, update, or delete. | BM4XIKY75ZITAA28ZABJKCAT | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Substitute GUID | GUID of the BOM substitute to retrieve, update, or delete. | BMSJ6Z57GF3S43WZZ58HQ59S | Example Payload for Get BOM Substitute[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getBomSubstitute.json "Download example payload") Loading… *** ### Get Change by GUID[​](#getchangebyguid "Direct link to Get Change by GUID") Retrieve detailed information of a specific change by its GUID from Arena PLM system. | **key: getChangeByGuid** | Input | Notes | Example | | ----------------------------------- | ----------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Change GUID | The GUID of the object. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Include Empty Additional Attributes | When true, includes additional attributes even when they have no value. | false | Example Payload for Get Change by GUID[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getChangeByGuid.json "Download example payload") Loading… *** ### Get Change File Association[​](#getchangefileassociation "Direct link to Get Change File Association") Returns details of a specific file association with a change. | **key: getChangeFileAssociation** | Input | Notes | Example | | ---------------------------- | ------------------------------------ | ------------------------ | | Change File Association GUID | GUID of the change-file association. | CHRXMFA8H3PN48IAAH7PV9L3 | | Change GUID | GUID of the change to update. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | Example Payload for Get Change File Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getChangeFileAssociation.json "Download example payload") Loading… *** ### Get Change Implementation Task[​](#getchangeimplementationtask "Direct link to Get Change Implementation Task") Get details of a specific implementation task. | **key: getChangeImplementationTask** | Input | Notes | Example | | ------------------------ | ------------------------------------------------ | ------------------------ | | Change GUID | The GUID of the change. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Implementation Task GUID | The GUID of the implementation task to retrieve. | CH4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Change Implementation Task[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getChangeImplementationTask.json "Download example payload") Loading… *** ### Get Change Item Association[​](#getchangeitemassociation "Direct link to Get Change Item Association") Returns a Change Affected Item with a given GUID included in a change with a given GUID. The response includes inventory disposition and information about each view of the item, including whether or not the view is included in the change and whether or not it contains modifications to the working revision. | **key: getChangeItemAssociation** | Input | Notes | Example | | ---------------------------- | ---------------------------------------------- | ------------------------ | | Change GUID | GUID of the change to update. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Change Item Association GUID | GUID of the change-item association to update. | CHVVLTU2VVPNU6P4IVW8MN4V | | Connection | The Arena connection to use. | | Example Payload for Get Change Item Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getChangeItemAssociation.json "Download example payload") Loading… *** ### Get Event[​](#getevent "Direct link to Get Event") Returns an Event object matching the GUID from Arena PLM system. | **key: getEvent** | Input | Notes | Example | | ---------------- | ------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Event GUID | The GUID of the integration event. | IN1AB2CD3EF4GH5IJ6KL7MN8 | | Integration GUID | The GUID of the outbound integration. | IN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Get Event[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getEvent.json "Download example payload") Loading… *** ### Get Event Item[​](#geteventitem "Direct link to Get Event Item") Returns an Item from an integration event with a given GUID from Arena PLM system. | **key: getEventItem** | Input | Notes | Example | | ---------------- | ---------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Event GUID | The GUID of the integration event. | IN1AB2CD3EF4GH5IJ6KL7MN8 | | Event Item GUID | The GUID of the item in the integration event. | IN1AB2CD3EF4GH5IJ6KL7MN8 | | Integration GUID | The GUID of the outbound integration. | IN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Get Event Item[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getEventItem.json "Download example payload") Loading… *** ### Get Export[​](#getexport "Direct link to Get Export") Get details of a specific export definition. | **key: getExport** | Input | Notes | Example | | ----------- | ---------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Export GUID | The GUID of the export definition to retrieve. | EX4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Export[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getExport.json "Download example payload") Loading… *** ### Get Export Run[​](#getexportrun "Direct link to Get Export Run") Get details of a specific export run. | **key: getExportRun** | Input | Notes | Example | | --------------- | --------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Export GUID | The GUID of the export definition. | EX4KL5MN6OP7QR8ST9UV0WX1 | | Export Run GUID | The GUID of the export run to retrieve. | EX4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Export Run[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getExportRun.json "Download example payload") Loading… *** ### Get Extract[​](#getextract "Direct link to Get Extract") Get details of a specific extract definition. | **key: getExtract** | Input | Notes | Example | | ------------ | ----------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Extract GUID | The GUID of the extract definition to retrieve. | ET4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Extract[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getExtract.json "Download example payload") Loading… *** ### Get Extract Run[​](#getextractrun "Direct link to Get Extract Run") Get details of a specific extract run. | **key: getExtractRun** | Input | Notes | Example | | ---------------- | ---------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Extract GUID | The GUID of the extract definition. | ET4KL5MN6OP7QR8ST9UV0WX1 | | Extract Run GUID | The GUID of the extract run to retrieve. | ET4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Extract Run[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getExtractRun.json "Download example payload") Loading… *** ### Get File by GUID[​](#getfilebyguid "Direct link to Get File by GUID") Get file details by GUID from Arena PLM system. | **key: getFileByGuid** | Input | Notes | Example | | ---------- | ----------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | File GUID | The unique identifier (GUID) of the file. | GNZAQ5I94Y9DGMRS8NENGR3R | Example Payload for Get File by GUID[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getFileByGuid.json "Download example payload") Loading… *** ### Get File Category Attribute Details[​](#getfilecategoryattributedetails "Direct link to Get File Category Attribute Details") Get details of a specific attribute in a category in Arena PLM system. | **key: getFileCategoryAttributeDetails** | Input | Notes | Example | | ------------------------- | --------------------------------------------------------------------------------------------- | ------------------------ | | Attribute Definition GUID | The GUID of the attribute definition to get details for. | FL4KL5MN6OP7QR8ST9UV0WX1 | | Category GUID | The GUID of the category. | GNLMBALQ4EZWDYIEZCJSHGRK | | Connection | The Arena connection to use. | | | Object Type | The object type whose category attribute to retrieve. Valid values: items, changes, requests. | | Example Payload for Get File Category Attribute Details[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getFileCategoryAttributeDetails.json "Download example payload") Loading… *** ### Get File Category Details[​](#getfilecategorydetails "Direct link to Get File Category Details") Get details of a specific file category in Arena PLM system. | **key: getFileCategoryDetails** | Input | Notes | Example | | ------------- | ------------------------------------------------- | ------------------------ | | Category GUID | The GUID of the file category to get details for. | GNLMBALQ4EZWDYIEZCJSHGRK | | Connection | The Arena connection to use. | | Example Payload for Get File Category Details[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getFileCategoryDetails.json "Download example payload") Loading… *** ### Get File Watermark Content[​](#getfilewatermarkcontent "Direct link to Get File Watermark Content") Get watermark content for a file. | **key: getFileWatermarkContent** | Input | Notes | Example | | ---------- | -------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | File GUID | The GUID of the file to get watermark content for. | GNZAQ5I94Y9DGMRS8NENGR3R | Example Payload for Get File Watermark Content[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getFileWatermarkContent.json "Download example payload") Loading… *** ### Get Import[​](#getimport "Direct link to Get Import") Get details of a specific import definition. | **key: getImport** | Input | Notes | Example | | ----------- | ---------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Import GUID | The GUID of the import definition to retrieve. | IM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Import[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getImport.json "Download example payload") Loading… *** ### Get Import Run[​](#getimportrun "Direct link to Get Import Run") Get details of a specific import run. | **key: getImportRun** | Input | Notes | Example | | --------------- | --------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Import GUID | The GUID of the import definition. | IM4KL5MN6OP7QR8ST9UV0WX1 | | Import Run GUID | The GUID of the import run to retrieve. | IM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Import Run[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getImportRun.json "Download example payload") Loading… *** ### Get Import Run Error Content[​](#getimportrunerrorcontent "Direct link to Get Import Run Error Content") Get the error content for an import run. | **key: getImportRunErrorContent** | Input | Notes | Example | | --------------- | ---------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Import GUID | The GUID of the import definition. | IM4KL5MN6OP7QR8ST9UV0WX1 | | Import Run GUID | The GUID of the import run. | IM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Import Run Error Content[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getImportRunErrorContent.json "Download example payload") Loading… *** ### Get Import Run Result Content[​](#getimportrunresultcontent "Direct link to Get Import Run Result Content") Get the result content for an import run. | **key: getImportRunResultContent** | Input | Notes | Example | | --------------- | ---------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Import GUID | The GUID of the import definition. | IM4KL5MN6OP7QR8ST9UV0WX1 | | Import Run GUID | The GUID of the import run. | IM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Import Run Result Content[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getImportRunResultContent.json "Download example payload") Loading… *** ### Get Import Run Submit Content[​](#getimportrunsubmitcontent "Direct link to Get Import Run Submit Content") Get the submitted content for an import run. | **key: getImportRunSubmitContent** | Input | Notes | Example | | --------------- | ---------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Import GUID | The GUID of the import definition. | IM4KL5MN6OP7QR8ST9UV0WX1 | | Import Run GUID | The GUID of the import run. | IM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Import Run Submit Content[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getImportRunSubmitContent.json "Download example payload") Loading… *** ### Get Integration[​](#getintegration "Direct link to Get Integration") Returns a specific outbound integrations object matching the given GUID from Arena PLM system. | **key: getIntegration** | Input | Notes | Example | | ---------------- | ------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Integration GUID | The GUID of the outbound integration. | IN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Get Integration[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getIntegration.json "Download example payload") Loading… *** ### Get Item by GUID[​](#getitembyguid "Direct link to Get Item by GUID") Retrieve detailed information of an item by its GUID from Arena PLM system. | **key: getItemByGuid** | Input | Notes | Example | | ----------------------------------- | --------------------------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Include Empty Additional Attributes | When true, empty additional attributes are included in the response. | false | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Response View | The Arena response view to request, which controls which fields are returned for each record. | compact | Example Payload for Get Item by GUID[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getItemByGuid.json "Download example payload") Loading… *** ### Get Item File Association[​](#getitemfileassociation "Direct link to Get Item File Association") Returns details of a specific file association with an item. | **key: getItemFileAssociation** | Input | Notes | Example | | -------------------------- | ---------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Item File Association GUID | GUID of the item file association. | IT1AB2CD3EF4GH5IJ6KL7MN8 | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Get Item File Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getItemFileAssociation.json "Download example payload") Loading… *** ### Get Item Image Content[​](#getitemimagecontent "Direct link to Get Item Image Content") Download the thumbnail image content for an item. | **key: getItemImageContent** | Input | Notes | Example | | ---------- | ---------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item to get image content for. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Get Item Image Content[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getItemImageContent.json "Download example payload") Loading… *** ### Get Item Number Format by GUID[​](#getitemnumberformatbyguid "Direct link to Get Item Number Format by GUID") Get details of a specific item number format by GUID from Arena PLM system. | **key: getItemNumberFormatByGuid** | Input | Notes | Example | | ------------------ | ------------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Number Format GUID | The GUID of the number format to retrieve. | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Item Number Format by GUID[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getItemNumberFormatByGuid.json "Download example payload") Loading… *** ### Get Item Number Format Field[​](#getitemnumberformatfield "Direct link to Get Item Number Format Field") Get details of a specific field for an item number format from Arena PLM system. | **key: getItemNumberFormatField** | Input | Notes | Example | | ----------- | ------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Field GUID | The GUID of the number format field. | IT4KL5MN6OP7QR8ST9UV0WX1 | | Format GUID | The GUID of the item number format. | IT4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Item Number Format Field[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getItemNumberFormatField.json "Download example payload") Loading… *** ### Get Item Revisions[​](#getitemrevisions "Direct link to Get Item Revisions") Retrieve all version information (working, effective, past revisions) of an item. | **key: getItemRevisions** | Input | Notes | Example | | ---------- | ------------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item to get revisions for. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Get Item Revisions[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getItemRevisions.json "Download example payload") Loading… *** ### Get Latest Completed Export Run[​](#getlatestcompletedexportrun "Direct link to Get Latest Completed Export Run") Get the most recently completed export run for an export definition. | **key: getLatestCompletedExportRun** | Input | Notes | Example | | ----------- | ------------------------------------------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Export GUID | The GUID of the export definition. | EX4KL5MN6OP7QR8ST9UV0WX1 | | View | Optional view parameter (e.g., 'withFiles' to include file information). | | Example Payload for Get Latest Completed Export Run[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getLatestCompletedExportRun.json "Download example payload") Loading… *** ### Get Latest Completed Extract Run[​](#getlatestcompletedextractrun "Direct link to Get Latest Completed Extract Run") Get the most recent completed extract run for a specific extract. | **key: getLatestCompletedExtractRun** | Input | Notes | Example | | ------------ | ----------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Extract GUID | The GUID of the extract definition. | ET4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Latest Completed Extract Run[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getLatestCompletedExtractRun.json "Download example payload") Loading… *** ### Get Quality Process by GUID[​](#getqualityprocessbyguid "Direct link to Get Quality Process by GUID") Returns a Quality Process object with a specific GUID from Arena PLM system. | **key: getQualityProcessByGuid** | Input | Notes | Example | | -------------------- | -------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Quality Process GUID | The GUID of the quality process to retrieve. | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Quality Process by GUID[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getQualityProcessByGuid.json "Download example payload") Loading… *** ### Get Quality Process Number Format by GUID[​](#getqualityprocessnumberformatbyguid "Direct link to Get Quality Process Number Format by GUID") Get details of a specific quality process number format by GUID from Arena PLM system. | **key: getQualityProcessNumberFormatByGuid** | Input | Notes | Example | | ------------------ | ---------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Number Format GUID | The GUID of the quality process number format to retrieve. | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Quality Process Number Format by GUID[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getQualityProcessNumberFormatByGuid.json "Download example payload") Loading… *** ### Get Quality Process Step Affected Object by GUID[​](#getqualityprocessstepaffectedbyguid "Direct link to Get Quality Process Step Affected Object by GUID") Returns an Affected Object with a given GUID that appears in a step with a given GUID in a Quality Process with a given GUID from Arena PLM system. | **key: getQualityProcessStepAffectedByGuid** | Input | Notes | Example | | -------------------- | -------------------------------------------------------------------- | ------------------------ | | Affected Object GUID | The GUID of the affected object to retrieve. | QP4KL5MN6OP7QR8ST9UV0WX1 | | Connection | The Arena connection to use. | | | Quality Process GUID | The GUID of the quality process containing the step. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Step GUID | The GUID of the quality process step containing the affected object. | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Quality Process Step Affected Object by GUID[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getQualityProcessStepAffectedByGuid.json "Download example payload") Loading… *** ### Get Quality Process Step Attribute Group by GUID[​](#getqualityprocessstepattributegroupbyguid "Direct link to Get Quality Process Step Attribute Group by GUID") Get details of a specific attribute group for quality process steps by GUID from Arena PLM system. | **key: getQualityProcessStepAttributeGroupByGuid** | Input | Notes | Example | | -------------------- | -------------------------------------------- | ------------------------ | | Attribute Group GUID | The GUID of the attribute group to retrieve. | QP4KL5MN6OP7QR8ST9UV0WX1 | | Connection | The Arena connection to use. | | Example Payload for Get Quality Process Step Attribute Group by GUID[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getQualityProcessStepAttributeGroupByGuid.json "Download example payload") Loading… *** ### Get Quality Process Step by GUID[​](#getqualityprocessstepbyguid "Direct link to Get Quality Process Step by GUID") Returns a Quality Process Step object with a given GUID for a Quality Process with a given GUID from Arena PLM system. | **key: getQualityProcessStepByGuid** | Input | Notes | Example | | ----------------------------------- | -------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Include Empty Additional Attributes | When true, empty additional attributes are included in the response. | false | | Quality Process GUID | The GUID of the quality process containing the step. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Step GUID | The GUID of the quality process step to retrieve. | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Quality Process Step by GUID[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getQualityProcessStepByGuid.json "Download example payload") Loading… *** ### Get Quality Process Template by GUID[​](#getqualityprocesstemplatebyguid "Direct link to Get Quality Process Template by GUID") Get details of a specific quality process template by GUID from Arena PLM system. | **key: getQualityProcessTemplateByGuid** | Input | Notes | Example | | ------------- | ----------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Template GUID | The GUID of the quality process template to retrieve. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Get Quality Process Template by GUID[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getQualityProcessTemplateByGuid.json "Download example payload") Loading… *** ### Get Request by GUID[​](#getrequestbyguid "Direct link to Get Request by GUID") Retrieve detailed information of a request by its GUID from Arena PLM system. | **key: getRequestByGuid** | Input | Notes | Example | | ----------------------------------- | -------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Include Empty Additional Attributes | When true, empty additional attributes are included in the response. | false | | Request GUID | GUID of the request to retrieve. | RQ4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Request by GUID[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getRequestByGuid.json "Download example payload") Loading… *** ### Get Requirement[​](#getrequirement "Direct link to Get Requirement") Get details of a specific requirement by GUID. | **key: getRequirement** | Input | Notes | Example | | ---------------- | ----------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Requirement[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getRequirement.json "Download example payload") Loading… *** ### Get Requirement File Association[​](#getrequirementfileassociation "Direct link to Get Requirement File Association") Get a specific file association for a requirement. | **key: getRequirementFileAssociation** | Input | Notes | Example | | --------------------- | --------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | File Association GUID | The GUID of the requirement-file association. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Requirement File Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getRequirementFileAssociation.json "Download example payload") Loading… *** ### Get Requirement Parent[​](#getrequirementparent "Direct link to Get Requirement Parent") Get parent requirements for a requirement. | **key: getRequirementParent** | Input | Notes | Example | | ---------------- | ----------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Requirement Parent[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getRequirementParent.json "Download example payload") Loading… *** ### Get Requirement Quality Association[​](#getrequirementqualityassociation "Direct link to Get Requirement Quality Association") Get details of a specific quality process linked to a requirement. | **key: getRequirementQualityAssociation** | Input | Notes | Example | | ------------------------ | ------------------------------------------------ | ------------------------ | | Quality Association GUID | The GUID of the requirement-quality association. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Connection | The Arena connection to use. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Requirement Quality Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getRequirementQualityAssociation.json "Download example payload") Loading… *** ### Get Requirement Template[​](#getrequirementtemplate "Direct link to Get Requirement Template") Get details of a specific requirement template. | **key: getRequirementTemplate** | Input | Notes | Example | | ------------------------- | ------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Requirement Template GUID | The GUID of the requirement template. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Requirement Template[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getRequirementTemplate.json "Download example payload") Loading… *** ### Get Requirement Ticket Association[​](#getrequirementticketassociation "Direct link to Get Requirement Ticket Association") Get details of a specific ticket linked to a requirement. | **key: getRequirementTicketAssociation** | Input | Notes | Example | | ----------------------- | ----------------------------------------------- | ------------------------ | | Ticket Association GUID | The GUID of the requirement-ticket association. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Connection | The Arena connection to use. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Requirement Ticket Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getRequirementTicketAssociation.json "Download example payload") Loading… *** ### Get Requirement Trace[​](#getrequirementtrace "Direct link to Get Requirement Trace") Get a specific trace link for a requirement. | **key: getRequirementTrace** | Input | Notes | Example | | ---------------- | ----------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Trace Link GUID | The unique identifier of the trace link. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Get Requirement Trace[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getRequirementTrace.json "Download example payload") Loading… *** ### Get Supplier by GUID[​](#getsupplierbyguid "Direct link to Get Supplier by GUID") Retrieve detailed information of a specific supplier from Arena PLM system using its GUID. | **key: getSupplierByGuid** | Input | Notes | Example | | ----------------------------------- | -------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Include Empty Additional Attributes | When true, empty additional attributes are included in the response. | false | | Supplier GUID | GUID of the supplier that provides this item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Get Supplier by GUID[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getSupplierByGuid.json "Download example payload") Loading… *** ### Get Supplier Item by GUID[​](#getsupplieritembyguid "Direct link to Get Supplier Item by GUID") Retrieve detailed information for a specific supplier item from Arena PLM system using its GUID. | **key: getSupplierItemByGuid** | Input | Notes | Example | | ----------------------------------- | -------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Include Empty Additional Attributes | When true, empty additional attributes are included in the response. | false | | Supplier Item GUID | The GUID of the supplier item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Get Supplier Item by GUID[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getSupplierItemByGuid.json "Download example payload") Loading… *** ### Get Supplier Item File Content[​](#getsupplieritemfilecontent "Direct link to Get Supplier Item File Content") Download the binary content of a file associated with a supplier item. Returns the file content as binary data with content type information. | **key: getSupplierItemFileContent** | Input | Notes | Example | | ----------------------------------- | ----------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Supplier Item File Association GUID | The GUID of the supplier item file association. | SP1AB2CD3EF4GH5IJ6KL7MN8 | | Supplier Item GUID | The GUID of the supplier item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Get Supplier Item File Content[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getSupplierItemFileContent.json "Download example payload") Loading… *** ### Get Supplier Quality Process Association[​](#getsupplierqualityprocessassociation "Direct link to Get Supplier Quality Process Association") Retrieve a specific quality process association for a supplier from Arena PLM system. | **key: getSupplierQualityProcessAssociation** | Input | Notes | Example | | --------------------------------- | ------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Supplier GUID | GUID of the supplier that provides this item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | | Supplier Quality Association GUID | The unique identifier (GUID) of the supplier quality process association. | SPTMBUM8PSQ6CEQTYFG4IA3Z | Example Payload for Get Supplier Quality Process Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getSupplierQualityProcessAssociation.json "Download example payload") Loading… *** ### Get Ticket by GUID[​](#getticketbyguid "Direct link to Get Ticket by GUID") Get details of a specific ticket by GUID from Arena PLM system. | **key: getTicketByGuid** | Input | Notes | Example | | ----------- | ---------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Get Ticket by GUID[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/getTicketByGuid.json "Download example payload") Loading… *** ### List API Usage[​](#listapiusages "Direct link to List API Usage") Get API usage information from Arena PLM system. | **key: listApiUsages** | Input | Notes | Example | | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | | Connection | The Arena connection to use. | | | Date Time From | Filter by date/time from (ISO format). | 2023-01-01T00:00:00Z | | Date Time To | Filter by date/time to (ISO format). | 2023-12-31T23:59:59Z | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Pagination | Maximum number of results to return and number of results to skip. | | Example Payload for List API Usage[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listApiUsages.json "Download example payload") Loading… *** ### List BOM[​](#listbom "Direct link to List BOM") Retrieve the BOM (Bill of Materials) collection for an item in Arena PLM system. | **key: listBom** | Input | Notes | Example | | ----------------------------- | -------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Include Additional Attributes | When true, additional attributes are included in the response. | false | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List BOM[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listBom.json "Download example payload") Loading… *** ### List BOM Attributes[​](#listbomattributes "Direct link to List BOM Attributes") List all attributes for item BOM in Arena PLM system with optional filtering. | **key: listBomAttributes** | Input | Notes | Example | | ----------------------- | ---------------------------------------------------------- | ------- | | Connection | The Arena connection to use. | | | Creatable Only | Filter to only attributes that can be set during creation. | na | | Editable Only | Filter to only attributes that can be edited. | na | | Include Deleted | Whether to include deleted attributes in the results. | na | | Include Possible Values | Whether to include possible values for attributes. | na | | Searchable Only | Filter to only attributes that can be searched. | na | Example Payload for List BOM Attributes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listBomAttributes.json "Download example payload") Loading… *** ### List BOM Substitutes[​](#listbomsubstitutes "Direct link to List BOM Substitutes") Retrieve the substitute collection for a specific BOM line in Arena PLM system. | **key: listBomSubstitutes** | Input | Notes | Example | | ------------- | ---------------------------------------------------- | ------------------------ | | BOM Line GUID | GUID of the BOM line to retrieve, update, or delete. | BM4XIKY75ZITAA28ZABJKCAT | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List BOM Substitutes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listBomSubstitutes.json "Download example payload") Loading… *** ### List Categories[​](#listcategories "Direct link to List Categories") List all categories for a specified object type (items, files, changes, requests) in Arena PLM system with optional filtering. | **key: listCategories** | Input | Notes | Example | | --------------- | ----------------------------------------------------- | ---------------- | | Action | Filter categories by the specified action. | | | Assignable Only | Filter to only assignable categories. | na | | Connection | The Arena connection to use. | | | Include Deleted | Whether to include deleted categories in the results. | na | | Object Type | The type of object to get categories for. | items | | Path | Filter categories by path (optional). | /Engineering/ECO | | User | Filter categories accessible to the specified user. | | Example Payload for List Categories[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listCategories.json "Download example payload") Loading… *** ### List Category Attributes[​](#listcategoryattributes "Direct link to List Category Attributes") Get attributes for a specific category and object type in Arena PLM system with optional filtering. | **key: listCategoryAttributes** | Input | Notes | Example | | ----------------------- | ---------------------------------------------------------------------------------- | ------------------------ | | Action | Filter attributes by the specified action. | | | Category GUID | The GUID of the category to get attributes for. | GNLMBALQ4EZWDYIEZCJSHGRK | | Connection | The Arena connection to use. | | | Creatable Only | Filter to only attributes that can be set during creation. | na | | Editable Only | Filter to only attributes that can be edited. | na | | Include Possible Values | Whether to include possible values for attributes. | na | | Object Type | The type of object (items, files, changes, requests, suppliers, or supplieritems). | | | Searchable Only | Filter to only attributes that can be searched. | na | | User | Filter attributes accessible to the specified user. | | Example Payload for List Category Attributes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listCategoryAttributes.json "Download example payload") Loading… *** ### List Change Administrators[​](#listchangesadministrators "Direct link to List Change Administrators") List all administrators for changes or requests in Arena PLM system. | **key: listChangesAdministrators** | Input | Notes | Example | | ----------- | ----------------------------------------------------------------------- | ------- | | Connection | The Arena connection to use. | | | Object Type | The type of objects whose administrators to list (changes or requests). | changes | Example Payload for List Change Administrators[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listChangesAdministrators.json "Download example payload") Loading… *** ### List Change Alerts[​](#listchangealerts "Direct link to List Change Alerts") Retrieve all alerts for a specific change. | **key: listChangeAlerts** | Input | Notes | Example | | ----------- | ----------------------------------------- | ------------------------ | | Change GUID | The GUID of the change to get alerts for. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | Example Payload for List Change Alerts[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listChangeAlerts.json "Download example payload") Loading… *** ### List Change Category Item Attributes[​](#listchangecategoryitemattributes "Direct link to List Change Category Item Attributes") List item attributes for a specific change category in Arena PLM system with optional filtering. | **key: listChangeCategoryItemAttributes** | Input | Notes | Example | | ----------------------- | --------------------------------------------------------------- | ------------------------ | | Category GUID | The unique identifier of the change category. | GNLMBALQ4EZWDYIEZCJSHGRK | | Connection | The Arena connection to use. | | | Creatable Only | Filter to only attributes that can be used when creating items. | na | | Editable Only | Filter to only editable attributes. | na | | Include Deleted | Whether to include deleted attributes in the results. | na | | Include Possible Values | Whether to include possible values for attributes. | na | | Searchable Only | Filter to only searchable attributes. | na | Example Payload for List Change Category Item Attributes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listChangeCategoryItemAttributes.json "Download example payload") Loading… *** ### List Change Category Routings[​](#listchangecategoryroutings "Direct link to List Change Category Routings") List all routings for a specific change category in Arena PLM system. | **key: listChangeCategoryRoutings** | Input | Notes | Example | | ------------- | ------------------------------------------------------------------------ | -------------------------------- | | Category GUID | The unique identifier (GUID) of the change category to get routings for. | J1K2L3M4N5O6P7Q8R9S0T1U2V3W4X5Y6 | | Connection | The Arena connection to use. | | Example Payload for List Change Category Routings[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listChangeCategoryRoutings.json "Download example payload") Loading… *** ### List Change File Associations[​](#listchangefileassociations "Direct link to List Change File Associations") Returns a list of files associated with a specific change. | **key: listChangeFileAssociations** | Input | Notes | Example | | ----------- | ----------------------------- | ------------------------ | | Change GUID | GUID of the change to update. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | Example Payload for List Change File Associations[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listChangeFileAssociations.json "Download example payload") Loading… *** ### List Change History[​](#listchangehistory "Direct link to List Change History") Retrieve the history of a specific change. | **key: listChangeHistory** | Input | Notes | Example | | ----------- | ------------------------------------------ | ------------------------ | | Change GUID | The GUID of the change to get history for. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | Example Payload for List Change History[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listChangeHistory.json "Download example payload") Loading… *** ### List Change Implementation Files[​](#listchangeimplementationfiles "Direct link to List Change Implementation Files") List all implementation files for a specific change. | **key: listChangeImplementationFiles** | Input | Notes | Example | | ----------- | ------------------------------------------------------- | ------------------------ | | Change GUID | The GUID of the change to get implementation files for. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | Example Payload for List Change Implementation Files[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listChangeImplementationFiles.json "Download example payload") Loading… *** ### List Change Implementation Task Files[​](#listchangeimplementationtaskfiles "Direct link to List Change Implementation Task Files") List all files for a specific implementation task. | **key: listChangeImplementationTaskFiles** | Input | Notes | Example | | ------------------------ | ----------------------------------------------------- | ------------------------ | | Change GUID | The GUID of the change. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Implementation Task GUID | The GUID of the implementation task to get files for. | CH4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Change Implementation Task Files[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listChangeImplementationTaskFiles.json "Download example payload") Loading… *** ### List Change Implementation Task Notes[​](#listchangeimplementationtasknotes "Direct link to List Change Implementation Task Notes") List all notes for a specific implementation task. | **key: listChangeImplementationTaskNotes** | Input | Notes | Example | | ------------------------ | ----------------------------------------------------- | ------------------------ | | Change GUID | The GUID of the change. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Implementation Task GUID | The GUID of the implementation task to get notes for. | CH4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Change Implementation Task Notes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listChangeImplementationTaskNotes.json "Download example payload") Loading… *** ### List Change Implementation Tasks[​](#listchangeimplementationtasks "Direct link to List Change Implementation Tasks") List all implementation tasks for a specific change. | **key: listChangeImplementationTasks** | Input | Notes | Example | | ----------- | ------------------------------------------------------- | ------------------------ | | Change GUID | The GUID of the change to get implementation tasks for. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | Example Payload for List Change Implementation Tasks[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listChangeImplementationTasks.json "Download example payload") Loading… *** ### List Change Items[​](#listchangeitems "Direct link to List Change Items") Returns all Change Affected Items included in a change with a given GUID. The response includes inventory disposition 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. | **key: listChangeItems** | Input | Notes | Example | | ----------- | ----------------------------- | ------------------------ | | Change GUID | GUID of the change to update. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | Example Payload for List Change Items[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listChangeItems.json "Download example payload") Loading… *** ### List Change Markup Files[​](#listchangemarkupfiles "Direct link to List Change Markup Files") List all markup files for a specific change. | **key: listChangeMarkupFiles** | Input | Notes | Example | | ----------- | ----------------------------------------------- | ------------------------ | | Change GUID | The GUID of the change to get markup files for. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | Example Payload for List Change Markup Files[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listChangeMarkupFiles.json "Download example payload") Loading… *** ### List Changes[​](#listchanges "Direct link to List Changes") Get changes from the Arena PLM system with filtering options. | **key: listChanges** | Input | Notes | Example | | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Any Search | Filter by a term matched against any searchable change field, rather than one named field. | solder mask | | Category GUID | The GUID of the category. | GNLMBALQ4EZWDYIEZCJSHGRK | | Connection | The Arena connection to use. | | | Creator GUID | Filter by creator GUID. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Effective DateTime | Filter by the date and time the change became effective, in ISO 8601 format. | 2026-05-10T09:15:00Z | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Implementation Status | Filter by the progress of the change's implementation tasks, such as NOT\_STARTED, IN\_PROGRESS or COMPLETE. | IN\_PROGRESS | | Include Child Categories | When true, includes changes from child categories of the specified category. | false | | Lifecycle Status Type | Filter by the change's lifecycle status, such as OPEN, SUBMITTED, APPROVED or EFFECTIVE. | APPROVED | | Change Number | Arena-assigned number identifying the resource, distinct from its GUID. | | | Pagination | Maximum number of results to return and number of results to skip. | | | Submission DateTime | Filter by the date and time the change was submitted for approval, in ISO 8601 format. | 2026-05-02T14:30:00Z | | Change Title | Human-readable title of the resource, shown in the Arena UI. | | Example Payload for List Changes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listChanges.json "Download example payload") Loading… *** ### List Evaluation Issue Responses[​](#listevaluationissueresponses "Direct link to List Evaluation Issue Responses") List all responses to a specific evaluation issue in Arena PLM system. | **key: listEvaluationIssueResponses** | Input | Notes | Example | | ------------ | ---------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Issue GUID | GUID of the evaluation issue to get responses for. | RQ4KL5MN6OP7QR8ST9UV0WX1 | | Request GUID | GUID of the request containing the evaluation issue. | RQ4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Evaluation Issue Responses[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listEvaluationIssueResponses.json "Download example payload") Loading… *** ### List Event Associations[​](#listeventassociations "Direct link to List Event Associations") Returns unreconciled event objects matching the given search criteria for a specific integration from Arena PLM system. | **key: listEventAssociations** | Input | Notes | Example | | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Creation Date From | Filter by creation date from (ISO format). | 2023-01-01T00:00:00Z | | Creation Date To | Filter by creation date to (ISO format). | 2023-12-31T23:59:59Z | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Integration GUID | The GUID of the outbound integration. | IN1AB2CD3EF4GH5IJ6KL7MN8 | | Items Reconciled Filter | Filter events by whether their items have been reconciled. | | | Pagination | Maximum number of results to return and number of results to skip. | | Example Payload for List Event Associations[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listEventAssociations.json "Download example payload") Loading… *** ### List Event Item GUIDs[​](#listeventitemguids "Direct link to List Event Item GUIDs") Returns a list of Item revision GUIDs from an integration event from Arena PLM system. | **key: listEventItemGuids** | Input | Notes | Example | | ----------------- | ------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Event GUID | The GUID of the integration event. | IN1AB2CD3EF4GH5IJ6KL7MN8 | | Integration GUID | The GUID of the outbound integration. | IN1AB2CD3EF4GH5IJ6KL7MN8 | | Reconciled Filter | Filter by reconciliation status. | | Example Payload for List Event Item GUIDs[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listEventItemGuids.json "Download example payload") Loading… *** ### List Event Items[​](#listeventitems "Direct link to List Event Items") Returns items of an outbound integrations matching the given search criteria for a specific event from Arena PLM system. | **key: listEventItems** | Input | Notes | Example | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Event GUID | The GUID of the integration event. | IN1AB2CD3EF4GH5IJ6KL7MN8 | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Integration GUID | The GUID of the outbound integration. | IN1AB2CD3EF4GH5IJ6KL7MN8 | | Pagination | Maximum number of results to return and number of results to skip. | | | Reconciled Filter | Filter by reconciliation status. | | | Reconciled Date From | Filter by reconciled date from (ISO format). | 2023-01-01T00:00:00Z | | Reconciled Date To | Filter by reconciled date to (ISO format). | 2023-12-31T23:59:59Z | Example Payload for List Event Items[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listEventItems.json "Download example payload") Loading… *** ### List Export Runs[​](#listexportruns "Direct link to List Export Runs") Get export runs for a specific export definition. | **key: listExportRuns** | Input | Notes | Example | | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Export GUID | The GUID of the export definition. | EX4KL5MN6OP7QR8ST9UV0WX1 | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Latest Completed | Filters export runs by the latest completed flag. Accepted values are true and false; any other value omits the filter. | | | Export Number | Filter by export number. | | | Pagination | Maximum number of results to return and number of results to skip. | | | Status | Filter by export run lifecycle status. | | Example Payload for List Export Runs[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listExportRuns.json "Download example payload") Loading… *** ### List Exports[​](#listexports "Direct link to List Exports") Search for export definitions using filters like name or creator. | **key: listExports** | Input | Notes | Example | | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Creator Email | Filter by creator email. | alex.chen\@example.com | | Creator Full Name | Filter by creator full name. | Alex Chen | | Creator GUID | Filter by creator GUID. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Description | Filter by export description. | | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Export Name | Filter by export name. | | | Export Number | Filter by export number. | | | Pagination | Maximum number of results to return and number of results to skip. | | Example Payload for List Exports[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listExports.json "Download example payload") Loading… *** ### List Extract Run Files[​](#listextractrunfiles "Direct link to List Extract Run Files") Get metadata for files generated by an extract run. | **key: listExtractRunFiles** | Input | Notes | Example | | ---------------- | ----------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Extract GUID | The GUID of the extract definition. | ET4KL5MN6OP7QR8ST9UV0WX1 | | Extract Run GUID | The GUID of the extract run. | ET4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Extract Run Files[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listExtractRunFiles.json "Download example payload") Loading… *** ### List Extract Runs[​](#listextractruns "Direct link to List Extract Runs") Get extract runs for a specific extract definition. | **key: listExtractRuns** | Input | Notes | Example | | ------------ | ----------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Extract GUID | The GUID of the extract definition. | ET4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Extract Runs[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listExtractRuns.json "Download example payload") Loading… *** ### List Extracts[​](#listextracts "Direct link to List Extracts") Search for extract definitions using filters like name or creator. | **key: listExtracts** | Input | Notes | Example | | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | --------- | | Connection | The Arena connection to use. | | | Creator Full Name | Filter by the full name of the integration user who set up the extract. | Alex Chen | | Enabled | When true, only enabled extracts are returned. | false | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Extract Name | Filter by extract name. | | | Pagination | Maximum number of results to return and number of results to skip. | | Example Payload for List Extracts[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listExtracts.json "Download example payload") Loading… *** ### List File Attributes[​](#listfileattributes "Direct link to List File Attributes") Get all attributes for files in Arena PLM system with optional filtering. | **key: listFileAttributes** | Input | Notes | Example | | ----------------------- | ---------------------------------------------------------- | ------- | | Connection | The Arena connection to use. | | | Creatable Only | Filter to only attributes that can be set during creation. | na | | Editable Only | Filter to only attributes that can be edited. | na | | Include Deleted | Whether to include deleted attributes. | na | | Include Possible Values | Whether to include possible values for attributes. | na | | Searchable Only | Filter to only attributes that can be searched. | na | Example Payload for List File Attributes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listFileAttributes.json "Download example payload") Loading… *** ### List File Categories[​](#listfilecategories "Direct link to List File Categories") Get all categories for files in Arena PLM system. | **key: listFileCategories** | Input | Notes | Example | | --------------- | -------------------------------------- | ---------------- | | Action | Filter categories by action type. | | | Assignable | Filter to only assignable categories. | na | | Connection | The Arena connection to use. | | | Include Deleted | Whether to include deleted categories. | na | | Path | Filter categories by path. | /Engineering/ECO | | User | Filter categories by user access. | | Example Payload for List File Categories[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listFileCategories.json "Download example payload") Loading… *** ### List File Category Attributes[​](#listfilecategoryattributes "Direct link to List File Category Attributes") Get attributes for a specific file category in Arena PLM system with optional filtering. | **key: listFileCategoryAttributes** | Input | Notes | Example | | ----------------------- | ---------------------------------------------------------- | ------------------------ | | Category GUID | The GUID of the file category to get attributes for. | GNLMBALQ4EZWDYIEZCJSHGRK | | Connection | The Arena connection to use. | | | Creatable Only | Filter to only attributes that can be set during creation. | na | | Editable Only | Filter to only attributes that can be edited. | na | | Include Possible Values | Whether to include possible values for attributes. | na | | Searchable Only | Filter to only attributes that can be searched. | na | Example Payload for List File Category Attributes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listFileCategoryAttributes.json "Download example payload") Loading… *** ### List File Corrections[​](#listfilecorrections "Direct link to List File Corrections") Retrieve all file correction information of a file. | **key: listFileCorrections** | Input | Notes | Example | | ---------- | -------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | File GUID | The GUID of the file to get corrections for. | GNZAQ5I94Y9DGMRS8NENGR3R | Example Payload for List File Corrections[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listFileCorrections.json "Download example payload") Loading… *** ### List File Editions[​](#listfileeditions "Direct link to List File Editions") Retrieve all edition information of a file. | **key: listFileEditions** | Input | Notes | Example | | ---------- | ----------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | File GUID | The GUID of the file to get editions for. | GNZAQ5I94Y9DGMRS8NENGR3R | Example Payload for List File Editions[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listFileEditions.json "Download example payload") Loading… *** ### List File Markups[​](#listfilemarkups "Direct link to List File Markups") Retrieve all markup file associations for a file. | **key: listFileMarkups** | Input | Notes | Example | | ---------- | ---------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | File GUID | The GUID of the file to get markups for. | GNZAQ5I94Y9DGMRS8NENGR3R | Example Payload for List File Markups[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listFileMarkups.json "Download example payload") Loading… *** ### List Files[​](#listfiles "Direct link to List Files") Get files from Arena PLM system with search and filtering options. | **key: listFiles** | Input | Notes | Example | | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | File Category GUID | GUID of the category to filter files by. | GNSGE2D4YMGB4UITKVB7KZSW | | Connection | The Arena connection to use. | | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | File Format | File format/extension (e.g., 'pdf', 'docx', 'png'). If not specified, will be extracted from file name. | pdf | | Include Child Categories | When true, includes files from child categories of the specified category. | false | | File Name | Filter files by name. | spec.pdf | | File Number | Filter files by number. | FILE-001 | | Pagination | Maximum number of results to return and number of results to skip. | | | File Title | Filter files by title. | Design Specification | Example Payload for List Files[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listFiles.json "Download example payload") Loading… *** ### List Import Runs[​](#listimportruns "Direct link to List Import Runs") Get import runs for a specific import definition. | **key: listImportRuns** | Input | Notes | Example | | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Creator Email | Filter by creator email. | alex.chen\@example.com | | Creator Full Name | Filter by creator full name. | Alex Chen | | Creator GUID | Filter by creator GUID. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Import GUID | The GUID of the import definition. | IM4KL5MN6OP7QR8ST9UV0WX1 | | Run Number | Filter by run number. | | | Pagination | Maximum number of results to return and number of results to skip. | | | Status | Filter by run status. | | Example Payload for List Import Runs[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listImportRuns.json "Download example payload") Loading… *** ### List Imports[​](#listimports "Direct link to List Imports") Search for import definitions using filters like name or creator. | **key: listImports** | Input | Notes | Example | | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Creator Email | Filter by creator email. | alex.chen\@example.com | | Creator Full Name | Filter by creator full name. | Alex Chen | | Creator GUID | Filter by creator GUID. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Description | Filter by import description. | | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Mode | Filter by import mode. | | | Import Name | Filter by import name. | | | Import Number | Filter by import number. | | | Pagination | Maximum number of results to return and number of results to skip. | | | Resource | Filter by import resource type. | | Example Payload for List Imports[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listImports.json "Download example payload") Loading… *** ### List Integration Administrators[​](#listintegrationadministrators "Direct link to List Integration Administrators") Returns all the integration administrators of a specific outbound integrations object matching the given GUID from Arena PLM system. | **key: listIntegrationAdministrators** | Input | Notes | Example | | ---------------- | ------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Integration GUID | The GUID of the outbound integration. | IN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Integration Administrators[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listIntegrationAdministrators.json "Download example payload") Loading… *** ### List Integration Filters[​](#listintegrationfilters "Direct link to List Integration Filters") Returns filter settings for a specific outbound integration from Arena PLM system. | **key: listIntegrationFilters** | Input | Notes | Example | | ---------------- | ------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Integration GUID | The GUID of the outbound integration. | IN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Integration Filters[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listIntegrationFilters.json "Download example payload") Loading… *** ### List Integrations[​](#listintegrations "Direct link to List Integrations") Returns a collection of outbound integrations objects matching the given search criteria from Arena PLM system. | **key: listIntegrations** | Input | Notes | Example | | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------- | | Connection | The Arena connection to use. | | | Enabled Filter | When true, only integrations that are enabled are returned. | false | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Name Filter | Filter integrations by name. | | | Pagination | Maximum number of results to return and number of results to skip. | | Example Payload for List Integrations[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listIntegrations.json "Download example payload") Loading… *** ### List Item File Associations[​](#listitemfileassociations "Direct link to List Item File Associations") Returns a list of files associated with a specific item. | **key: listItemFileAssociations** | Input | Notes | Example | | ---------- | ---------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Item File Associations[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listItemFileAssociations.json "Download example payload") Loading… *** ### List Item Future Changes[​](#listitemfuturechanges "Direct link to List Item Future Changes") Retrieve future changes that will affect this item. | **key: listItemFutureChanges** | Input | Notes | Example | | ---------- | ----------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item to get future changes for. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Item Future Changes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listItemFutureChanges.json "Download example payload") Loading… *** ### List Item History[​](#listitemhistory "Direct link to List Item History") Retrieve the complete history of changes made to an item. | **key: listItemHistory** | Input | Notes | Example | | ---------- | ---------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item to get history for. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Item History[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listItemHistory.json "Download example payload") Loading… *** ### List Item Lifecycle Phases[​](#listitemlifecyclephases "Direct link to List Item Lifecycle Phases") List all lifecycle phases for items from Arena PLM system. | **key: listItemLifecyclePhases** | Input | Notes | Example | | ---------- | ---------------------------- | ------- | | Connection | The Arena connection to use. | | Example Payload for List Item Lifecycle Phases[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listItemLifecyclePhases.json "Download example payload") Loading… *** ### List Item Number Format Fields[​](#listitemnumberformatfields "Direct link to List Item Number Format Fields") List all fields for a specific item number format from Arena PLM system. | **key: listItemNumberFormatFields** | Input | Notes | Example | | ----------- | ----------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Format GUID | The GUID of the item number format to get fields for. | IT4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Item Number Format Fields[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listItemNumberFormatFields.json "Download example payload") Loading… *** ### List Item Number Formats[​](#listitemnumberformats "Direct link to List Item Number Formats") List all item number formats from Arena PLM system with optional filtering. | **key: listItemNumberFormats** | Input | Notes | Example | | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------- | | Active Only | Filter to only active number formats. | | | Connection | The Arena connection to use. | | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Name Filter | Filter number formats by name. | | | Pagination | Maximum number of results to return and number of results to skip. | | Example Payload for List Item Number Formats[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listItemNumberFormats.json "Download example payload") Loading… *** ### List Item Number Reservations[​](#listitemnumberreservations "Direct link to List Item Number Reservations") Search for item number reservations from Arena PLM system with optional filtering. | **key: listItemNumberReservations** | Input | Notes | Example | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Category GUID | Filter by category GUID. | GNLMBALQ4EZWDYIEZCJSHGRK | | Connection | The Arena connection to use. | | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Include Item Numbers | When true, item numbers are included in the response. | true | | Name Filter | Filter by reservation name. | | | Pagination | Maximum number of results to return and number of results to skip. | | Example Payload for List Item Number Reservations[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listItemNumberReservations.json "Download example payload") Loading… *** ### List Item Requirements[​](#listitemrequirements "Direct link to List Item Requirements") List all compliance requirements for items from Arena PLM system. | **key: listItemRequirements** | Input | Notes | Example | | ---------- | ---------------------------- | ------- | | Connection | The Arena connection to use. | | Example Payload for List Item Requirements[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listItemRequirements.json "Download example payload") Loading… *** ### List Item Training Plans[​](#listitemtrainingplans "Direct link to List Item Training Plans") Retrieve training plans associated with an item. | **key: listItemTrainingPlans** | Input | Notes | Example | | ---------- | ----------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item to get training plans for. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Item Training Plans[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listItemTrainingPlans.json "Download example payload") Loading… *** ### List Item Training Records[​](#listitemtrainingrecords "Direct link to List Item Training Records") Retrieve training records for an item. | **key: listItemTrainingRecords** | Input | Notes | Example | | ---------- | ------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item to get training records for. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Item Training Records[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listItemTrainingRecords.json "Download example payload") Loading… *** ### List Item Where Used[​](#listitemwhereused "Direct link to List Item Where Used") Retrieve upper assembly information where the item is used as a BOM component. | **key: listItemWhereUsed** | Input | Notes | Example | | ---------- | --------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item to find where it's used. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Item Where Used[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listItemWhereUsed.json "Download example payload") Loading… *** ### List Items[​](#listitems "Direct link to List Items") Search and return a list of items from Arena PLM system matching the specified criteria with pagination support. | **key: listItems** | Input | Notes | Example | | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Assembly Type | Filter items by assembly type. | | | Category GUID | Filter items by category GUID. | IT1AB2CD3EF4GH5IJ6KL7MN8 | | Category Name | Filter items by category name. | Electronics | | Connection | The Arena connection to use. | | | Creator Email | Filter items by creator's email. | john.doe\@company.com | | Creator Full Name | Filter items by creator's full name. | Jane Smith | | Creator GUID | Filter items by creator's GUID. | ITP4F558HNQZKLNN3R2UQFDY | | Description | Search for items with specific description. | Main circuit board | | Effective Date Time | Filter items by effective date time in ISO format. | 2025-08-15T10:00:00Z | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | In Assembly | Filter items by whether they are in an assembly. | na | | Include Child Categories | When true, items from child categories are included. | false | | Lifecycle Phase GUID | Filter items by lifecycle phase GUID. | IT9X6BKEEHKSJRHQRIRF3FUR | | Lifecycle Phase Stage | Filter items by lifecycle phase stage. | Production | | Modified BOM | Filter items by whether BOM is modified. | na | | Modified Files | Filter items by whether files are modified. | na | | Modified Sourcing | Filter items by whether sourcing is modified. | na | | Modified Specs | Filter items by whether specs are modified. | na | | Item Name | Search for items with specific name. | Circuit Board Assembly | | Item Number | Search for items with specific number. | IT-001 | | Owner Full Name | Filter items by owner's full name. | John Doe | | Pagination | Maximum number of results to return and number of results to skip. | | | Response View | The Arena response view to request, which controls which fields are returned for each record. | compact | | Revision Number | Filter items by revision number. | A | Example Payload for List Items[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listItems.json "Download example payload") Loading… *** ### List Number Sequence Prefixes[​](#listnumbersequenceprefixes "Direct link to List Number Sequence Prefixes") List all prefixes for number sequences for a given object type in Arena PLM system. | **key: listNumberSequencePrefixes** | Input | Notes | Example | | ----------- | ------------------------------------------------------- | ------- | | Connection | The Arena connection to use. | | | Object Type | The type of object to get number sequence prefixes for. | changes | Example Payload for List Number Sequence Prefixes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listNumberSequencePrefixes.json "Download example payload") Loading… *** ### List Outbound Event Integration Administrators[​](#listoutboundeventintegrationadministrators "Direct link to List Outbound Event Integration Administrators") List administrators of a specific outbound event integration. | **key: listOutboundEventIntegrationAdministrators** | Input | Notes | Example | | ---------------- | ------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Integration GUID | The GUID of the outbound event integration. | IG4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Outbound Event Integration Administrators[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listOutboundEventIntegrationAdministrators.json "Download example payload") Loading… *** ### List Outbound Event Integration Events[​](#listoutboundeventintegrationevents "Direct link to List Outbound Event Integration Events") List all events for a specific outbound event integration. | **key: listOutboundEventIntegrationEvents** | Input | Notes | Example | | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Integration GUID | The GUID of the outbound event integration. | IG4KL5MN6OP7QR8ST9UV0WX1 | | Order | Sort order for results. | | | Pagination | Maximum number of results to return and number of results to skip. | | | Resources Reconciled Filter | Filter by reconciliation status of resources. | | Example Payload for List Outbound Event Integration Events[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listOutboundEventIntegrationEvents.json "Download example payload") Loading… *** ### List Outbound Event Integration Triggers[​](#listoutboundeventintegrationtriggers "Direct link to List Outbound Event Integration Triggers") List all triggers for a specific outbound event integration. | **key: listOutboundEventIntegrationTriggers** | Input | Notes | Example | | ---------------- | ------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Integration GUID | The GUID of the outbound event integration. | IG4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Outbound Event Integration Triggers[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listOutboundEventIntegrationTriggers.json "Download example payload") Loading… *** ### List Outbound Event Integrations[​](#listoutboundeventintegrations "Direct link to List Outbound Event Integrations") Get outbound event integrations from Arena PLM system. | **key: listOutboundEventIntegrations** | Input | Notes | Example | | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------- | | Connection | The Arena connection to use. | | | Enabled Status | Filter by enabled/disabled status ('true' or 'false'). | | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Integration Name | Filter by integration name. | | | Pagination | Maximum number of results to return and number of results to skip. | | Example Payload for List Outbound Event Integrations[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listOutboundEventIntegrations.json "Download example payload") Loading… *** ### List Outbound Event Resources[​](#listoutboundeventresources "Direct link to List Outbound Event Resources") List all resources for a specific event in an outbound event integration. | **key: listOutboundEventResources** | Input | Notes | Example | | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Event GUID | The GUID of the specific event. | IG4KL5MN6OP7QR8ST9UV0WX1 | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Integration GUID | The GUID of the outbound event integration. | IG4KL5MN6OP7QR8ST9UV0WX1 | | Object Type | The type of object to retrieve resources for. | | | Pagination | Maximum number of results to return and number of results to skip. | | | Reconciled Status Filter | Filter by reconciliation status. | | | Reconciled Date Time From | Filter by reconciled datetime range start. | 2023-01-01T00:00:00Z | | Reconciled Date Time To | Filter by reconciled datetime range end. | 2023-12-31T23:59:59Z | Example Payload for List Outbound Event Resources[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listOutboundEventResources.json "Download example payload") Loading… *** ### List Quality Process Number Formats[​](#listqualityprocessnumberformats "Direct link to List Quality Process Number Formats") List number formats for quality processes from Arena PLM system. | **key: listQualityProcessNumberFormats** | Input | Notes | Example | | ---------- | ---------------------------- | ------- | | Connection | The Arena connection to use. | | Example Payload for List Quality Process Number Formats[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listQualityProcessNumberFormats.json "Download example payload") Loading… *** ### List Quality Process Owners[​](#listqualityprocessowners "Direct link to List Quality Process Owners") List users who can be assigned as quality process owners from Arena PLM system. | **key: listQualityProcessOwners** | Input | Notes | Example | | ---------- | ---------------------------- | ------- | | Connection | The Arena connection to use. | | Example Payload for List Quality Process Owners[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listQualityProcessOwners.json "Download example payload") Loading… *** ### List Quality Process Step Affected Objects[​](#listqualityprocessstepaffected "Direct link to List Quality Process Step Affected Objects") Returns a collection of Affected Objects for a step with a given GUID in a Quality Process with a given GUID from Arena PLM system. | **key: listQualityProcessStepAffected** | Input | Notes | Example | | -------------------- | ------------------------------------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Quality Process GUID | The GUID of the quality process containing the step. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Step GUID | The GUID of the quality process step to get affected objects from. | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Quality Process Step Affected Objects[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listQualityProcessStepAffected.json "Download example payload") Loading… *** ### List Quality Process Step Attribute Groups[​](#listqualityprocessstepattributegroups "Direct link to List Quality Process Step Attribute Groups") List attribute groups for quality process steps from Arena PLM system. | **key: listQualityProcessStepAttributeGroups** | Input | Notes | Example | | ---------- | ---------------------------- | ------- | | Connection | The Arena connection to use. | | Example Payload for List Quality Process Step Attribute Groups[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listQualityProcessStepAttributeGroups.json "Download example payload") Loading… *** ### List Quality Process Step Attributes[​](#listqualityprocessstepattributes "Direct link to List Quality Process Step Attributes") List all attributes for quality process steps from Arena PLM system. | **key: listQualityProcessStepAttributes** | Input | Notes | Example | | ----------------------- | ------------------------------------------------------------------------- | ------- | | Connection | The Arena connection to use. | | | Creatable Only | When true, only attributes that can be used during creation are returned. | false | | Editable Only | When true, only attributes that can be edited are returned. | false | | Include Deleted | When true, deleted attributes are included in the results. | false | | Include Possible Values | When true, possible values for dropdown attributes are included. | false | | Searchable Only | When true, only attributes that can be used in searches are returned. | false | Example Payload for List Quality Process Step Attributes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listQualityProcessStepAttributes.json "Download example payload") Loading… *** ### List Quality Process Steps[​](#listqualityprocesssteps "Direct link to List Quality Process Steps") Returns a collection of Quality Process Step objects for a Quality Process with a given GUID from Arena PLM system. | **key: listQualityProcessSteps** | Input | Notes | Example | | -------------------- | ------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Quality Process GUID | The GUID of the quality process to get steps for. | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Quality Process Steps[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listQualityProcessSteps.json "Download example payload") Loading… *** ### List Quality Process Template Attribute Groups[​](#listqualityprocesstemplateattributegroups "Direct link to List Quality Process Template Attribute Groups") List attribute groups for a specific quality process template from Arena PLM system. | **key: listQualityProcessTemplateAttributeGroups** | Input | Notes | Example | | ------------- | ----------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Template GUID | The GUID of the quality process template. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Quality Process Template Attribute Groups[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listQualityProcessTemplateAttributeGroups.json "Download example payload") Loading… *** ### List Quality Process Template Attributes[​](#listqualityprocesstemplateattributes "Direct link to List Quality Process Template Attributes") List all attributes for a specific quality process template from Arena PLM system. | **key: listQualityProcessTemplateAttributes** | Input | Notes | Example | | ----------------------- | ------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Creatable Only | When true, only attributes that can be used during creation are returned. | false | | Editable Only | When true, only attributes that can be edited are returned. | false | | Include Deleted | When true, deleted attributes are included in the results. | false | | Include Possible Values | When true, possible values for dropdown attributes are included. | false | | Searchable Only | When true, only attributes that can be used in searches are returned. | false | | Template GUID | The GUID of the quality process template. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Quality Process Template Attributes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listQualityProcessTemplateAttributes.json "Download example payload") Loading… *** ### List Quality Process Templates[​](#listqualityprocesstemplates "Direct link to List Quality Process Templates") List all quality process templates from Arena PLM system with optional filtering. | **key: listQualityProcessTemplates** | Input | Notes | Example | | ------------- | ------------------------------------------- | ------- | | Active Only | When true, only active templates are shown. | true | | Connection | The Arena connection to use. | | | Template Name | Filter by quality process template name. | | Example Payload for List Quality Process Templates[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listQualityProcessTemplates.json "Download example payload") Loading… *** ### List Quality Processes[​](#listqualityprocesses "Direct link to List Quality Processes") Get quality processes from Arena PLM system with search and filtering options. | **key: listQualityProcesses** | Input | Notes | Example | | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Creator Full Name | Filter by creator full name. | Alex Chen | | Creator GUID | Filter by creator GUID. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Description | Filter by quality process description. | | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Quality Name | Filter by quality process name. | | | Quality Number | Filter by quality process number. | | | Owner Full Name | Filter by owner full name. | Alex Chen | | Owner GUID | Filter by owner GUID. | QP4KL5MN6OP7QR8ST9UV0WX1 | | Pagination | Maximum number of results to return and number of results to skip. | | | Status | Filter by quality process status. | | | Template GUID | Filter by quality process template GUID. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Quality Type | Filter by quality process type. | | Example Payload for List Quality Processes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listQualityProcesses.json "Download example payload") Loading… *** ### List Quality Step Decisions[​](#listqualitystepdecisions "Direct link to List Quality Step Decisions") Retrieve all decisions made by users in a quality process sign-off step. | **key: listQualityStepDecisions** | Input | Notes | Example | | -------------------- | ---------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Quality Process GUID | The GUID of the quality process containing the step. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Step GUID | The GUID of the quality process sign-off step. | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Quality Step Decisions[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listQualityStepDecisions.json "Download example payload") Loading… *** ### List Recent Export Activities[​](#listrecentactivityexports "Direct link to List Recent Export Activities") View recent export activities from Arena PLM system. | **key: listRecentActivityExports** | Input | Notes | Example | | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | | Connection | The Arena connection to use. | | | Date Time From | Filter by date/time from (ISO format). | 2023-01-01T00:00:00Z | | Date Time To | Filter by date/time to (ISO format). | 2023-12-31T23:59:59Z | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Pagination | Maximum number of results to return and number of results to skip. | | Example Payload for List Recent Export Activities[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRecentActivityExports.json "Download example payload") Loading… *** ### List Recent File Access Activities[​](#listrecentactivityfileaccesses "Direct link to List Recent File Access Activities") View recent file access activities from Arena PLM system. | **key: listRecentActivityFileAccesses** | Input | Notes | Example | | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | | Connection | The Arena connection to use. | | | Date Time From | Filter by date/time from (ISO format). | 2023-01-01T00:00:00Z | | Date Time To | Filter by date/time to (ISO format). | 2023-12-31T23:59:59Z | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Pagination | Maximum number of results to return and number of results to skip. | | Example Payload for List Recent File Access Activities[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRecentActivityFileAccesses.json "Download example payload") Loading… *** ### List Recent Report Run Activities[​](#listrecentactivityreportruns "Direct link to List Recent Report Run Activities") View recent report run activities from Arena PLM system. | **key: listRecentActivityReportRuns** | Input | Notes | Example | | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | | Connection | The Arena connection to use. | | | Date Time From | Filter by date/time from (ISO format). | 2023-01-01T00:00:00Z | | Date Time To | Filter by date/time to (ISO format). | 2023-12-31T23:59:59Z | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Pagination | Maximum number of results to return and number of results to skip. | | Example Payload for List Recent Report Run Activities[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRecentActivityReportRuns.json "Download example payload") Loading… *** ### List Recent User Access Activities[​](#listrecentactivityuseraccesses "Direct link to List Recent User Access Activities") View recent user access activities from Arena PLM system. | **key: listRecentActivityUserAccesses** | Input | Notes | Example | | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | | Connection | The Arena connection to use. | | | Date Time From | Filter by date/time from (ISO format). | 2023-01-01T00:00:00Z | | Date Time To | Filter by date/time to (ISO format). | 2023-12-31T23:59:59Z | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Pagination | Maximum number of results to return and number of results to skip. | | Example Payload for List Recent User Access Activities[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRecentActivityUserAccesses.json "Download example payload") Loading… *** ### List Request Administrators[​](#listrequestadministrators "Direct link to List Request Administrators") List administrators for requests in Arena PLM system. | **key: listRequestAdministrators** | Input | Notes | Example | | ---------- | ---------------------------- | ------- | | Connection | The Arena connection to use. | | Example Payload for List Request Administrators[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequestAdministrators.json "Download example payload") Loading… *** ### List Request Changes[​](#listrequestchanges "Direct link to List Request Changes") List all changes associated with a request in Arena PLM system. | **key: listRequestChanges** | Input | Notes | Example | | ------------ | --------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Request GUID | GUID of the request to get changes for. | RQ4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Request Changes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequestChanges.json "Download example payload") Loading… *** ### List Request Evaluation Issues[​](#listrequestevaluationissues "Direct link to List Request Evaluation Issues") List all evaluation issues for a request in Arena PLM system. | **key: listRequestEvaluationIssues** | Input | Notes | Example | | ------------ | ------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Request GUID | GUID of the request to get evaluation issues for. | RQ4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Request Evaluation Issues[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequestEvaluationIssues.json "Download example payload") Loading… *** ### List Request Evaluator Groups[​](#listrequestevaluatorgroups "Direct link to List Request Evaluator Groups") List all evaluator groups for requests in Arena PLM system. | **key: listRequestEvaluatorGroups** | Input | Notes | Example | | ---------- | ---------------------------- | ------- | | Connection | The Arena connection to use. | | Example Payload for List Request Evaluator Groups[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequestEvaluatorGroups.json "Download example payload") Loading… *** ### List Request Files[​](#listrequestfiles "Direct link to List Request Files") List all files attached to a request in Arena PLM system. | **key: listRequestFiles** | Input | Notes | Example | | ------------ | ------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Request GUID | GUID of the request to get files for. | RQ4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Request Files[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequestFiles.json "Download example payload") Loading… *** ### List Request Item Attributes[​](#listrequestitemattributes "Direct link to List Request Item Attributes") List all attributes for request items with optional filtering. | **key: listRequestItemAttributes** | Input | Notes | Example | | ----------------------- | ---------------------------------------------------------- | ------- | | Connection | The Arena connection to use. | | | Creatable Only | Filter to only attributes that can be set during creation. | na | | Editable Only | Filter to only attributes that can be edited. | na | | Include Deleted | Whether to include deleted attributes. | na | | Include Possible Values | Whether to include possible values for attributes. | na | | Searchable Only | Filter to only attributes that can be searched. | na | Example Payload for List Request Item Attributes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequestItemAttributes.json "Download example payload") Loading… *** ### List Request Items[​](#listrequestitems "Direct link to List Request Items") List all items associated with a request in Arena PLM system. | **key: listRequestItems** | Input | Notes | Example | | ------------ | ------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Request GUID | GUID of the request to get items for. | RQ4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Request Items[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequestItems.json "Download example payload") Loading… *** ### List Request Markup Files[​](#listrequestmarkupfiles "Direct link to List Request Markup Files") List all markup files attached to a request in Arena PLM system. | **key: listRequestMarkupFiles** | Input | Notes | Example | | ------------ | -------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Request GUID | GUID of the request to get markup files for. | RQ4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Request Markup Files[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequestMarkupFiles.json "Download example payload") Loading… *** ### List Request Number Sequence Prefixes[​](#listrequestnumbersequenceprefixes "Direct link to List Request Number Sequence Prefixes") List all prefixes for number sequences for requests in Arena PLM system. | **key: listRequestNumberSequencePrefixes** | Input | Notes | Example | | ---------- | ---------------------------- | ------- | | Connection | The Arena connection to use. | | Example Payload for List Request Number Sequence Prefixes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequestNumberSequencePrefixes.json "Download example payload") Loading… *** ### List Request Number Sequences[​](#listrequestnumbersequences "Direct link to List Request Number Sequences") List all number sequences for a given object type in Arena PLM system. | **key: listRequestNumberSequences** | Input | Notes | Example | | ----------- | --------------------------------------------------- | -------- | | Connection | The Arena connection to use. | | | Object Type | The object type for which to list number sequences. | requests | Example Payload for List Request Number Sequences[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequestNumberSequences.json "Download example payload") Loading… *** ### List Request Quality Processes[​](#listrequestqualityprocesses "Direct link to List Request Quality Processes") List all quality processes linked to a request in Arena PLM system. | **key: listRequestQualityProcesses** | Input | Notes | Example | | ------------ | ------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Request GUID | GUID of the request to get quality processes for. | RQ4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Request Quality Processes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequestQualityProcesses.json "Download example payload") Loading… *** ### List Request Status Change Attributes[​](#listrequeststatuschangeattributes "Direct link to List Request Status Change Attributes") List attributes triggered by request status changes. These attributes can be utilized in the POST requests/statuschanges endpoints. | **key: listRequestStatusChangeAttributes** | Input | Notes | Example | | ---------- | ---------------------------- | ------- | | Connection | The Arena connection to use. | | Example Payload for List Request Status Change Attributes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequestStatusChangeAttributes.json "Download example payload") Loading… *** ### List Requests[​](#listrequests "Direct link to List Requests") Search for requests in Arena PLM system using filters like number, title, or status. | **key: listRequests** | Input | Notes | Example | | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Category GUID | Filter by request category GUID. | GNLMBALQ4EZWDYIEZCJSHGRK | | Connection | The Arena connection to use. | | | Creator GUID | Filter by request creator GUID. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Deferral Code | Filter by deferral code. | | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Include Child Categories | When true, requests from child categories are included. | false | | Lifecycle Status | Filter by lifecycle status (e.g., UNSUBMITTED, SUBMITTED, PROMOTED, CLOSED, DEFERRED). | | | Request Number | Filter by request number. | | | Pagination | Maximum number of results to return and number of results to skip. | | | Request Code | Filter by request code. | | | Resolution Code | Filter by resolution code. | | | Request Title | Filter by request title. | | Example Payload for List Requests[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequests.json "Download example payload") Loading… *** ### List Requirement Children[​](#listrequirementchildren "Direct link to List Requirement Children") Get child requirements for a requirement. | **key: listRequirementChildren** | Input | Notes | Example | | ---------------- | ----------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | | View | Set to "tree" for hierarchical view or "list" for flat view | tree | Example Payload for List Requirement Children[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequirementChildren.json "Download example payload") Loading… *** ### List Requirement Files[​](#listrequirementfiles "Direct link to List Requirement Files") Get all file associations for a requirement. | **key: listRequirementFiles** | Input | Notes | Example | | ---------------- | ----------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Requirement Files[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequirementFiles.json "Download example payload") Loading… *** ### List Requirement History[​](#listrequirementhistory "Direct link to List Requirement History") Get the change history for a requirement. | **key: listRequirementHistory** | Input | Notes | Example | | ---------------- | ----------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Requirement History[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequirementHistory.json "Download example payload") Loading… *** ### List Requirement Quality[​](#listrequirementquality "Direct link to List Requirement Quality") List all quality processes linked to a requirement. | **key: listRequirementQuality** | Input | Notes | Example | | ---------------- | ----------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Requirement Quality[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequirementQuality.json "Download example payload") Loading… *** ### List Requirement Relationship Types[​](#listrequirementrelationshiptypes "Direct link to List Requirement Relationship Types") List all relationship types for requirements. | **key: listRequirementRelationshipTypes** | Input | Notes | Example | | ---------- | ---------------------------- | ------- | | Connection | The Arena connection to use. | | Example Payload for List Requirement Relationship Types[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequirementRelationshipTypes.json "Download example payload") Loading… *** ### List Requirement Template Attributes[​](#listrequirementtemplateattributes "Direct link to List Requirement Template Attributes") List all attributes for a specific requirement template. | **key: listRequirementTemplateAttributes** | Input | Notes | Example | | ------------------------- | ------------------------------------------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Creatable Only | When true, only attributes that can be set during creation are returned. | false | | Editable Only | When true, only editable attributes are returned. | false | | Include Possible Values | When true, possible values for dropdown or list attributes are included. | false | | Searchable Only | When true, only searchable attributes are returned. | false | | Requirement Template GUID | The GUID of the requirement template. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Requirement Template Attributes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequirementTemplateAttributes.json "Download example payload") Loading… *** ### List Requirement Templates[​](#listrequirementtemplates "Direct link to List Requirement Templates") List all requirement templates. | **key: listRequirementTemplates** | Input | Notes | Example | | ----------- | ---------------------------------------------- | ------- | | Active | When true, only active templates are returned. | true | | Connection | The Arena connection to use. | | | Name Filter | Optional filter by requirement template name. | | Example Payload for List Requirement Templates[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequirementTemplates.json "Download example payload") Loading… *** ### List Requirement Tickets[​](#listrequirementtickets "Direct link to List Requirement Tickets") List all tickets linked to a requirement. | **key: listRequirementTickets** | Input | Notes | Example | | ---------------- | ----------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for List Requirement Tickets[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequirementTickets.json "Download example payload") Loading… *** ### List Requirement Traces[​](#listrequirementtraces "Direct link to List Requirement Traces") Get requirement traces by direction. | **key: listRequirementTraces** | Input | Notes | Example | | ---------------- | ------------------------------------------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Trace Direction | Direction of the trace link (UPSTREAM or DOWNSTREAM). | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Suspect | When true, only requirements with a suspected trace status are returned. | false | Example Payload for List Requirement Traces[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequirementTraces.json "Download example payload") Loading… *** ### List Requirements[​](#listrequirements "Direct link to List Requirements") Search for requirements using filters. | **key: listRequirements** | Input | Notes | Example | | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Any | Full-text search across all fields. | | | Assignee Full Name | Filter by assignee full name. | Alex Chen | | Assignee GUID | Filter by assignee GUID. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Connection | The Arena connection to use. | | | Creator Full Name | Filter by creator full name. | Alex Chen | | Creator GUID | Filter by creator GUID. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Description | Filter by description text. | | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Modification Date Time | Filter by modification date/time. | 2026-05-10T09:15:00Z | | Number | Filter by requirement number. | | | Pagination | Maximum number of results to return and number of results to skip. | | | Priority | Filter by priority. | | | Status | Filter by requirement status. | | | Requirement Template GUID | The GUID of the requirement template. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Title | Filter by requirement title. | | Example Payload for List Requirements[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listRequirements.json "Download example payload") Loading… *** ### List Sourcing Relationships[​](#listsourcingrelationships "Direct link to List Sourcing Relationships") Get sourcing relationships from Arena PLM system. | **key: listSourcingRelationships** | Input | Notes | Example | | ---------- | ---------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Sourcing Relationships[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listSourcingRelationships.json "Download example payload") Loading… *** ### List Supplier Addresses[​](#listsupplieraddresses "Direct link to List Supplier Addresses") Retrieve all addresses for a supplier from Arena PLM system. | **key: listSupplierAddresses** | Input | Notes | Example | | ------------- | --------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Supplier GUID | GUID of the supplier that provides this item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Supplier Addresses[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listSupplierAddresses.json "Download example payload") Loading… *** ### List Supplier Approval Statuses[​](#listsupplierapprovalstatuses "Direct link to List Supplier Approval Statuses") Search and return a list of supplier approval statuses from Arena PLM system with pagination support. | **key: listSupplierApprovalStatuses** | Input | Notes | Example | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------- | | Connection | The Arena connection to use. | | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Approval Status Name | Filter approval statuses by name. | | | Pagination | Maximum number of results to return and number of results to skip. | | | Approval Status Type | Filter approval statuses by type. | | Example Payload for List Supplier Approval Statuses[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listSupplierApprovalStatuses.json "Download example payload") Loading… *** ### List Supplier File Associations[​](#listsupplierfileassociations "Direct link to List Supplier File Associations") Retrieve all file associations for a supplier from Arena PLM system. | **key: listSupplierFileAssociations** | Input | Notes | Example | | ------------- | --------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Supplier GUID | GUID of the supplier that provides this item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Supplier File Associations[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listSupplierFileAssociations.json "Download example payload") Loading… *** ### List Supplier Item Compliance[​](#listsupplieritemcompliance "Direct link to List Supplier Item Compliance") Retrieve all compliance requirements for a specific supplier item from Arena PLM system. | **key: listSupplierItemCompliance** | Input | Notes | Example | | ------------------ | ------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Supplier Item GUID | The GUID of the supplier item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Supplier Item Compliance[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listSupplierItemCompliance.json "Download example payload") Loading… *** ### List Supplier Item Files[​](#listsupplieritemfiles "Direct link to List Supplier Item Files") Retrieve a list of all files associated with a specific supplier item from Arena PLM system. | **key: listSupplierItemFiles** | Input | Notes | Example | | ------------------ | ------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Supplier Item GUID | The GUID of the supplier item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Supplier Item Files[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listSupplierItemFiles.json "Download example payload") Loading… *** ### List Supplier Item Requirements[​](#listsupplieritemrequirements "Direct link to List Supplier Item Requirements") List all compliance requirements for supplier items from Arena PLM system. | **key: listSupplierItemRequirements** | Input | Notes | Example | | ---------- | ---------------------------- | ------- | | Connection | The Arena connection to use. | | Example Payload for List Supplier Item Requirements[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listSupplierItemRequirements.json "Download example payload") Loading… *** ### List Supplier Item Sourcing[​](#listsupplieritemsourcing "Direct link to List Supplier Item Sourcing") Retrieve all sourcing relationships for a specific supplier item from Arena PLM system. | **key: listSupplierItemSourcing** | Input | Notes | Example | | ------------------ | ------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Supplier Item GUID | The GUID of the supplier item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Supplier Item Sourcing[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listSupplierItemSourcing.json "Download example payload") Loading… *** ### List Supplier Items[​](#listsupplieritems "Direct link to List Supplier Items") Search and return a list of supplier items from Arena PLM system matching the specified criteria with pagination support. | **key: listSupplierItems** | Input | Notes | Example | | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Search by Name | Search for supplier items by name. | | | Search by Number | Search for supplier items by number/part number. | | | Pagination | Maximum number of results to return and number of results to skip. | | | Search by Supplier GUID | Search for supplier items by supplier GUID. | SP4KL5MN6OP7QR8ST9UV0WX1 | | Search by Supplier Name | Search for supplier items by supplier name. | | Example Payload for List Supplier Items[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listSupplierItems.json "Download example payload") Loading… *** ### List Supplier Phone Numbers[​](#listsupplierphonenumbers "Direct link to List Supplier Phone Numbers") Retrieve all phone numbers for a supplier from Arena PLM system. | **key: listSupplierPhoneNumbers** | Input | Notes | Example | | ------------- | --------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Supplier GUID | GUID of the supplier that provides this item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Supplier Phone Numbers[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listSupplierPhoneNumbers.json "Download example payload") Loading… *** ### List Supplier Quality Process Associations[​](#listsupplierqualityprocessassociations "Direct link to List Supplier Quality Process Associations") Retrieve all quality process associations for a supplier from Arena PLM system. | **key: listSupplierQualityProcessAssociations** | Input | Notes | Example | | ------------- | --------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Supplier GUID | GUID of the supplier that provides this item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Supplier Quality Process Associations[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listSupplierQualityProcessAssociations.json "Download example payload") Loading… *** ### List Suppliers[​](#listsuppliers "Direct link to List Suppliers") Search and return a list of suppliers from Arena PLM system matching the specified criteria with pagination support. | **key: listSuppliers** | Input | Notes | Example | | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | Connection | The Arena connection to use. | | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Search by Supplier Name | Search for supplier items by supplier name. | | | Pagination | Maximum number of results to return and number of results to skip. | | | Supplier ID Search | Filter suppliers by unique identifier. | SUP-000145 | Example Payload for List Suppliers[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listSuppliers.json "Download example payload") Loading… *** ### List Ticket Changes[​](#listticketchanges "Direct link to List Ticket Changes") List all changes referenced by a specific ticket from Arena PLM system. | **key: listTicketChanges** | Input | Notes | Example | | ----------- | ---------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Ticket Changes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listTicketChanges.json "Download example payload") Loading… *** ### List Ticket Files[​](#listticketfiles "Direct link to List Ticket Files") List all files referenced by a specific ticket from Arena PLM system. | **key: listTicketFiles** | Input | Notes | Example | | ----------- | ---------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Ticket Files[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listTicketFiles.json "Download example payload") Loading… *** ### List Ticket Items[​](#listticketitems "Direct link to List Ticket Items") List all items referenced by a specific ticket from Arena PLM system. | **key: listTicketItems** | Input | Notes | Example | | ----------- | ---------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Ticket Items[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listTicketItems.json "Download example payload") Loading… *** ### List Ticket Quality Processes[​](#listticketqualityprocesses "Direct link to List Ticket Quality Processes") List all quality processes referenced by a specific ticket from Arena PLM system. | **key: listTicketQualityProcesses** | Input | Notes | Example | | ----------- | ---------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Ticket Quality Processes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listTicketQualityProcesses.json "Download example payload") Loading… *** ### List Ticket References[​](#listticketreferences "Direct link to List Ticket References") List all tickets referenced by a specific ticket from Arena PLM system. | **key: listTicketReferences** | Input | Notes | Example | | ----------- | ---------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Ticket References[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listTicketReferences.json "Download example payload") Loading… *** ### List Ticket Template Attributes[​](#listtickettemplateattributes "Direct link to List Ticket Template Attributes") List all attributes for a specific ticket template from Arena PLM system. | **key: listTicketTemplateAttributes** | Input | Notes | Example | | ----------------------- | ---------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Creatable Only | When true, only attributes that can be used during creation are shown. | false | | Editable Only | When true, only attributes that can be edited are shown. | false | | Include Possible Values | When true, possible values for dropdown attributes are included. | false | | Searchable Only | When true, only searchable attributes are shown. | false | | Template GUID | The GUID of the template. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Ticket Template Attributes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listTicketTemplateAttributes.json "Download example payload") Loading… *** ### List Ticket Templates[​](#listtickettemplates "Direct link to List Ticket Templates") List all ticket templates from Arena PLM system with optional filtering. | **key: listTicketTemplates** | Input | Notes | Example | | ------------- | ------------------------------------------- | ------- | | Active Only | When true, only active templates are shown. | true | | Connection | The Arena connection to use. | | | Template Name | Filter by ticket template name. | | Example Payload for List Ticket Templates[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listTicketTemplates.json "Download example payload") Loading… *** ### List Tickets[​](#listtickets "Direct link to List Tickets") Search for tickets using filters like number, title, or status from Arena PLM system. | **key: listTickets** | Input | Notes | Example | | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Ticket Number | Filter by ticket number. | | | Pagination | Maximum number of results to return and number of results to skip. | | | Status | Filter by ticket status (e.g., NOT\_STARTED, IN\_PROGRESS, COMPLETE). | | | Template GUID | Filter by template GUID. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Ticket Title | Filter by ticket title. | | Example Payload for List Tickets[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listTickets.json "Download example payload") Loading… *** ### List Training Managers[​](#listtrainingmanagers "Direct link to List Training Managers") List all training managers in Arena PLM system. | **key: listTrainingManagers** | Input | Notes | Example | | ---------- | ---------------------------- | ------- | | Connection | The Arena connection to use. | | Example Payload for List Training Managers[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listTrainingManagers.json "Download example payload") Loading… *** ### List Training Plan Files[​](#listtrainingplanfiles "Direct link to List Training Plan Files") List files associated with a training plan. | **key: listTrainingPlanFiles** | Input | Notes | Example | | ------------- | ---------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Training GUID | GUID of the training plan. | TR1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Training Plan Files[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listTrainingPlanFiles.json "Download example payload") Loading… *** ### List Training Plan Items[​](#listtrainingplanitems "Direct link to List Training Plan Items") List items associated with a training plan. | **key: listTrainingPlanItems** | Input | Notes | Example | | ------------- | ---------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Training GUID | GUID of the training plan. | TR1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Training Plan Items[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listTrainingPlanItems.json "Download example payload") Loading… *** ### List Training Plan Quality Processes[​](#listtrainingplanquality "Direct link to List Training Plan Quality Processes") List quality processes associated with a training plan. | **key: listTrainingPlanQuality** | Input | Notes | Example | | ------------- | ---------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Training GUID | GUID of the training plan. | TR1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Training Plan Quality Processes[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listTrainingPlanQuality.json "Download example payload") Loading… *** ### List Training Plan Records[​](#listtrainingplanrecords "Direct link to List Training Plan Records") List all training records associated with a training plan. | **key: listTrainingPlanRecords** | Input | Notes | Example | | ------------- | ---------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Training GUID | GUID of the training plan. | TR1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Training Plan Records[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listTrainingPlanRecords.json "Download example payload") Loading… *** ### List Training Plan Users[​](#listtrainingplanusers "Direct link to List Training Plan Users") List all users assigned to a training plan. | **key: listTrainingPlanUsers** | Input | Notes | Example | | ------------- | ---------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Training GUID | GUID of the training plan. | TR1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for List Training Plan Users[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listTrainingPlanUsers.json "Download example payload") Loading… *** ### List Training Plans[​](#listtrainingplans "Direct link to List Training Plans") Search for training plans using filters like number, name, status, or manager. | **key: listTrainingPlans** | Input | Notes | Example | | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | Connection | The Arena connection to use. | | | Fetch All | When true, automatically retrieves every page of results. The Pagination Limit is ignored, while Offset is honored as the starting point. | false | | Manager Full Name | Filter by training manager full name. | John Doe | | Manager GUID | Filter by training manager GUID. | TR1AB2CD3EF4GH5IJ6KL7MN8 | | Training Name | Filter by training name. | Safety Training | | Training Number | Filter by training number. | TRN-001 | | Pagination | Maximum number of results to return and number of results to skip. | | | Status | Filter by training plan status. | OPEN | | User GUID | Filter by assigned user GUID. | user123-456-789-abc-def567890 | Example Payload for List Training Plans[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/listTrainingPlans.json "Download example payload") Loading… *** ### Raw Request[​](#rawrequest "Direct link to Raw Request") Make custom HTTP requests to the Arena API with full control over endpoint, method, payload, headers, and response handling. Useful for accessing endpoints not covered by specific actions. | **key: rawRequest** | Input | Notes | Example | | ------------------ | ---------------------------------------------------------------------------------------------- | ------- | | Additional Headers | Additional HTTP headers as key-value pairs (authentication headers are handled automatically). | | | Connection | The Arena connection to use. | | | Endpoint | API endpoint path (e.g., /items, /changes, /categories). | /items | | File Data | File data for file upload requests (Buffer or file content). | | | Form Data | Form data payload for requests (key-value pairs). | | | HTTP Method | HTTP method for the request. | GET | | JSON Payload | JSON payload for POST/PUT/PATCH requests. | | | Query Parameters | Query parameters as key-value pairs. | | | Response Type | Expected response format. | json | Example Payload for Raw Request[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/rawRequest.json "Download example payload") Loading… *** ### Remove File from Request[​](#removefilefromrequest "Direct link to Remove File from Request") Remove a file from a request in Arena PLM system. | **key: removeFileFromRequest** | Input | Notes | Example | | ----------------------------- | ----------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Request File Association GUID | GUID of the request-file association to remove. | RQ4KL5MN6OP7QR8ST9UV0WX1 | | Request GUID | GUID of the request to remove the file from. | RQ4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Remove File from Request[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/removeFileFromRequest.json "Download example payload") Loading… *** ### Remove File from Training Plan[​](#removefilefromtrainingplan "Direct link to Remove File from Training Plan") Remove a file from a training plan. | **key: removeFileFromTrainingPlan** | Input | Notes | Example | | ------------------------------ | ------------------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Training File Association GUID | GUID of the training file association to remove. | TN29ZKZ6A3F58PSI8QGWXDS5 | | Training GUID | GUID of the training plan. | TR1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Remove File from Training Plan[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/removeFileFromTrainingPlan.json "Download example payload") Loading… *** ### Remove Item from Training Plan[​](#removeitemfromtrainingplan "Direct link to Remove Item from Training Plan") Remove an item from a training plan. | **key: removeItemFromTrainingPlan** | Input | Notes | Example | | ------------------------------ | ------------------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Training GUID | GUID of the training plan. | TR1AB2CD3EF4GH5IJ6KL7MN8 | | Training Item Association GUID | GUID of the training item association to remove. | TN6AYSAL5W4CUBQKQK6LXEPW | Example Payload for Remove Item from Training Plan[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/removeItemFromTrainingPlan.json "Download example payload") Loading… *** ### Remove Quality Process from Training Plan[​](#removequalityfromtrainingplan "Direct link to Remove Quality Process from Training Plan") Remove a quality process from a training plan. | **key: removeQualityFromTrainingPlan** | Input | Notes | Example | | -------------- | -------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Reference GUID | GUID of the quality process association to remove. | TNCBDJS2ZQEVHYYXBDYYIGCQ | | Training GUID | GUID of the training plan. | TR1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Remove Quality Process from Training Plan[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/removeQualityFromTrainingPlan.json "Download example payload") Loading… *** ### Remove Requirement Child[​](#removerequirementchild "Direct link to Remove Requirement Child") Remove a child requirement from a requirement. | **key: removeRequirementChild** | Input | Notes | Example | | ---------------------- | ----------------------------------------- | ------------------------ | | Child Requirement GUID | The GUID of the child requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Connection | The Arena connection to use. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Remove Requirement Child[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/removeRequirementChild.json "Download example payload") Loading… *** ### Remove Requirement File Association[​](#removerequirementfileassociation "Direct link to Remove Requirement File Association") Remove a file association from a requirement. | **key: removeRequirementFileAssociation** | Input | Notes | Example | | --------------------- | --------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | File Association GUID | The GUID of the requirement-file association. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Remove Requirement File Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/removeRequirementFileAssociation.json "Download example payload") Loading… *** ### Remove Requirement Quality Association[​](#removerequirementqualityassociation "Direct link to Remove Requirement Quality Association") Unlink a quality process from a requirement. | **key: removeRequirementQualityAssociation** | Input | Notes | Example | | ------------------------ | ------------------------------------------------ | ------------------------ | | Quality Association GUID | The GUID of the requirement-quality association. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Connection | The Arena connection to use. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Remove Requirement Quality Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/removeRequirementQualityAssociation.json "Download example payload") Loading… *** ### Remove Requirement Ticket Association[​](#removerequirementticketassociation "Direct link to Remove Requirement Ticket Association") Unlink a ticket from a requirement. | **key: removeRequirementTicketAssociation** | Input | Notes | Example | | ----------------------- | ----------------------------------------------- | ------------------------ | | Ticket Association GUID | The GUID of the requirement-ticket association. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Connection | The Arena connection to use. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Remove Requirement Ticket Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/removeRequirementTicketAssociation.json "Download example payload") Loading… *** ### Remove Ticket Change[​](#removeticketchange "Direct link to Remove Ticket Change") Unlink a change from a ticket in Arena PLM system. | **key: removeTicketChange** | Input | Notes | Example | | ---------------- | --------------------------------------------- | ------------------------ | | Association GUID | The GUID of the change association to remove. | TK1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Remove Ticket Change[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/removeTicketChange.json "Download example payload") Loading… *** ### Remove Ticket File[​](#removeticketfile "Direct link to Remove Ticket File") Unlink a file from a ticket in Arena PLM system. | **key: removeTicketFile** | Input | Notes | Example | | ---------------- | ------------------------------------------- | ------------------------ | | Association GUID | The GUID of the file association to remove. | TK1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Remove Ticket File[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/removeTicketFile.json "Download example payload") Loading… *** ### Remove Ticket Item[​](#removeticketitem "Direct link to Remove Ticket Item") Unlink an item from a ticket in Arena PLM system. | **key: removeTicketItem** | Input | Notes | Example | | ---------------- | ------------------------------------------- | ------------------------ | | Association GUID | The GUID of the item association to remove. | TK1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Remove Ticket Item[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/removeTicketItem.json "Download example payload") Loading… *** ### Remove Ticket Quality Process[​](#removeticketqualityprocess "Direct link to Remove Ticket Quality Process") Unlink a quality process from a ticket in Arena PLM system. | **key: removeTicketQualityProcess** | Input | Notes | Example | | ---------------- | ------------------------------------------------------ | ------------------------ | | Association GUID | The GUID of the quality process association to remove. | TK1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Remove Ticket Quality Process[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/removeTicketQualityProcess.json "Download example payload") Loading… *** ### Remove Ticket Reference[​](#removeticketreference "Direct link to Remove Ticket Reference") Unlink a referenced ticket from a ticket in Arena PLM system. | **key: removeTicketReference** | Input | Notes | Example | | ---------------- | --------------------------------------------- | ------------------------ | | Association GUID | The GUID of the ticket association to remove. | TK1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Remove Ticket Reference[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/removeTicketReference.json "Download example payload") Loading… *** ### Rerun Import[​](#rerunimport "Direct link to Rerun Import") Re-execute an import run with updated data. | **key: rerunImport** | Input | Notes | Example | | --------------- | ------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Import GUID | The GUID of the import definition. | IM4KL5MN6OP7QR8ST9UV0WX1 | | Import Run GUID | The GUID of the import run to rerun. | IM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Rerun Import[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/rerunImport.json "Download example payload") Loading… *** ### Run Export[​](#runexport "Direct link to Run Export") Execute an export definition and create a new export run. | **key: runExport** | Input | Notes | Example | | ----------- | ----------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Export GUID | The GUID of the export definition to run. | EX4KL5MN6OP7QR8ST9UV0WX1 | | Run Data | Optional parameters for the export run. | | Example Payload for Run Export[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/runExport.json "Download example payload") Loading… *** ### Run Extract[​](#runextract "Direct link to Run Extract") Execute an extract definition and create a new extract run. | **key: runExtract** | Input | Notes | Example | | ------------ | ------------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Extract GUID | The GUID of the extract definition to run. | ET4KL5MN6OP7QR8ST9UV0WX1 | | Run Data | Optional parameters for the extract run. | | Example Payload for Run Extract[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/runExtract.json "Download example payload") Loading… *** ### Run Import[​](#runimport "Direct link to Run Import") Execute an import definition and create a new import run with file uploads. | **key: runImport** | Input | Notes | Example | | --------------------- | ----------------------------------------------------------------- | ------------------------ | | Actor | Actor identifier (default 10). | 10 | | Commit | When true, the import run is committed. Defaults to true. | true | | Connection | The Arena connection to use. | | | Debug | When true, debug mode is enabled. Defaults to true. | true | | File Content | Additional file content to upload for the import (binary format). | | | Import GUID | The GUID of the import definition to run. | IM4KL5MN6OP7QR8ST9UV0WX1 | | Submit Content File | The submit content file to upload for the import (binary format). | | | Submit File Type | Type of the submit file being uploaded. | | | Submit Worksheet Name | Name of the worksheet to submit (for Excel files). | | Example Payload for Run Import[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/runImport.json "Download example payload") Loading… *** ### Submit Quality Step Decision[​](#submitqualitystepdecision "Direct link to Submit Quality Step Decision") Make a decision (approve/reject/comment) on a quality process sign-off step. | **key: submitQualityStepDecision** | Input | Notes | Example | | -------------------- | ---------------------------------------------------- | ------------------------ | | Comments | Optional comments for the decision. | | | Connection | The Arena connection to use. | | | Decision | The decision to make on the sign-off step. | | | Decision GUID | The GUID of the decision to submit. | QP4KL5MN6OP7QR8ST9UV0WX1 | | Quality Process GUID | The GUID of the quality process containing the step. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Step GUID | The GUID of the quality process step. | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Submit Quality Step Decision[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/submitQualityStepDecision.json "Download example payload") Loading… *** ### Update BOM Line[​](#updatebomline "Direct link to Update BOM Line") Update information of a specific BOM line for an item in Arena PLM system. | **key: updateBomLine** | Input | Notes | Example | | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | | Additional Attribute JSON | Provide additional attributes as raw JSON. If provided, this will be used instead of additionalAttributes and attributeDefinitions. | | | Additional Attributes | Additional custom attributes for the object. Key should be the attribute GUID, value should be the attribute value. | attr-guid-123: Custom Value | | Attribute Definitions | List of CategoryAttributeDefinitionVo objects that define the types and properties of attributes. This is required when creating additional attributes to ensure proper value type conversion (e.g., NUMBER/POSITIVE\_DOUBLE/COST types will be parsed as numbers). | | | BOM Line GUID | GUID of the BOM line to retrieve, update, or delete. | BM4XIKY75ZITAA28ZABJKCAT | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Notes | Additional notes for the BOM line. | Use high-precision resistors | | Quantity | Quantity of the item in the BOM. | 2.5 | | Reference Designator | Reference designator for the BOM line (e.g., R1, C2, U5). | R1, R2, R3 | | Set Null Fields | When true, empty or null fields are set explicitly (for updates). | false | Example Payload for Update BOM Line[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateBomLine.json "Download example payload") Loading… *** ### Update BOM Settings[​](#updatebomsettings "Direct link to Update BOM Settings") Update BOM settings for an item in Arena PLM system. | **key: updateBomSettings** | Input | Notes | Example | | ----------------------------------- | ------------------------------------------------------------------ | ------------------------ | | Automatically Generate Line Numbers | When true, line numbers are automatically generated for BOM lines. | false | | Check Reference Designators | When true, reference designators are checked in the BOM. | false | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Update BOM Settings[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateBomSettings.json "Download example payload") Loading… *** ### Update BOM Substitute[​](#updatebomsubstitute "Direct link to Update BOM Substitute") Update information of a specific BOM substitute in Arena PLM system. | **key: updateBomSubstitute** | Input | Notes | Example | | --------------- | ------------------------------------------------------------------- | ---------------------------- | | BOM Line GUID | GUID of the BOM line to retrieve, update, or delete. | BM4XIKY75ZITAA28ZABJKCAT | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Notes | Additional notes for the BOM line. | Use high-precision resistors | | Quantity | Quantity of the item in the BOM. | 2.5 | | Substitute Rank | Ranking order of the substitute (1 = primary, 2 = secondary, etc.). | 1 | | Substitute GUID | GUID of the BOM substitute to retrieve, update, or delete. | BMSJ6Z57GF3S43WZZ58HQ59S | Example Payload for Update BOM Substitute[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateBomSubstitute.json "Download example payload") Loading… *** ### Update Change[​](#updatechange "Direct link to Update Change") Update an existing change in Arena PLM system with the specified properties. | **key: updateChange** | Input | Notes | Example | | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | | Additional Attribute JSON | Provide additional attributes as raw JSON. If provided, this will be used instead of additionalAttributes and attributeDefinitions. | | | Additional Attributes | Additional custom attributes for the object. Key should be the attribute GUID, value should be the attribute value. | attr-guid-123: Custom Value | | Approval Deadline | Deadline for change approval in ISO format. | 2025-08-15T10:00:00Z | | Attribute Definitions | List of CategoryAttributeDefinitionVo objects that define the types and properties of attributes. This is required when creating additional attributes to ensure proper value type conversion (e.g., NUMBER/POSITIVE\_DOUBLE/COST types will be parsed as numbers). | | | Category GUID | GUID of the category to assign to this change. | CH1AB2CD3EF4GH5IJ6KL7MN8 | | Change GUID | GUID of the change to update. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Change Description | Detailed description of the change. | Updated component design to improve manufacturing efficiency | | Effectivity Planned Date Time | Planned effectivity date time for the change in ISO format. | 2025-09-01T08:00:00Z | | Effectivity Type | Type of effectivity for the change. | | | Enforce Approval Deadline | When true, the approval deadline is enforced. | false | | Expiration Date Time | Expiration date time for the change in ISO format. | 2026-08-15T10:00:00Z | | Implementation Status | Implementation status of the change. | In Progress | | Supplier Visibility | When true, the change is visible to suppliers. | false | | Change Title | The title/name of the change to update. | Component Design Update v3.0 | Example Payload for Update Change[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateChange.json "Download example payload") Loading… *** ### Update Change Implementation Task[​](#updatechangeimplementationtask "Direct link to Update Change Implementation Task") Update an existing implementation task for a change. | **key: updateChangeImplementationTask** | Input | Notes | Example | | ------------------------ | ----------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Assignee User Group GUID | The GUID of the user group to assign this task to. Use either Assignee User GUID or Assignee User Group GUID, not both. | CH4KL5MN6OP7QR8ST9UV0WX1 | | Assignee User GUID | The GUID of the user to assign this task to. Use either Assignee User GUID or Assignee User Group GUID, not both. | CH4KL5MN6OP7QR8ST9UV0WX1 | | Change GUID | The GUID of the change that owns the implementation task. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Due Date | The updated due date for the task (ISO 8601 format). | 2026-05-10T09:15:00Z | | Implementation Task GUID | The GUID of the implementation task to update. | CH4KL5MN6OP7QR8ST9UV0WX1 | | Task Name | The updated name of the implementation task. | | | Status | The updated status of the implementation task. | | Example Payload for Update Change Implementation Task[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateChangeImplementationTask.json "Download example payload") Loading… *** ### Update Change Implementation Task Note[​](#updatechangeimplementationtasknote "Direct link to Update Change Implementation Task Note") Update an existing note on a change implementation task. | **key: updateChangeImplementationTaskNote** | Input | Notes | Example | | ------------------------ | ------------------------------------------------------- | ------------------------ | | Change GUID | The GUID of the change. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Implementation Task GUID | The GUID of the implementation task that owns the note. | CH4KL5MN6OP7QR8ST9UV0WX1 | | Private | When true, the note is private. | false | | Label | The updated label for the note. | | | Note Content | The updated content of the note. | | | Note GUID | The GUID of the note to update. | CH4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Update Change Implementation Task Note[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateChangeImplementationTaskNote.json "Download example payload") Loading… *** ### Update Change Item Association[​](#updatechangeitemassociation "Direct link to Update Change Item Association") Updates modification information for an item on a change with a given change-item association GUID, included in a change with a given GUID. | **key: updateChangeItemAssociation** | Input | Notes | Example | | -------------------------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------ | | BOM View Included in Change | When true, the BOM view is included in this change. | false | | BOM View Notes | Notes for the BOM view modification. | | | Change GUID | GUID of the change to update. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Change Item Association GUID | GUID of the change-item association to update. | CHVVLTU2VVPNU6P4IVW8MN4V | | Connection | The Arena connection to use. | | | Disposition Attribute JSON | Provide disposition attributes as raw JSON array. Each attribute should have 'guid' and 'value' properties. | | | Files View Included in Change | When true, the files view is included in this change. | false | | Files View Notes | Notes for the files view modification. | | | Material Effectivity Date Time | Material effectivity date and time (ISO format). | 2024-01-15T10:00:00Z | | New Lifecycle Phase GUID | GUID of the new lifecycle phase. | CH5D4TZKH884FUWA7TYZCCIA | | New Revision Number | New revision number for the item (required when making edits). | B | | Retraining Required | When true, retraining is required for this change. | false | | Sourcing View Included in Change | When true, the sourcing view is included in this change. | false | | Sourcing View Notes | Notes for the sourcing view modification. | | | Specs View Included in Change | When true, the specs view is included in this change. | false | | Specs View Notes | Notes for the specs view modification. | | Example Payload for Update Change Item Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateChangeItemAssociation.json "Download example payload") Loading… *** ### Update Event Item Reconciled[​](#updateeventitemreconciled "Direct link to Update Event Item Reconciled") Updates the reconciliation status for a specific event Item with a GUID in an event with a given GUID from Arena PLM system. Requires integration administrator security. | **key: updateEventItemReconciled** | Input | Notes | Example | | ---------------- | ---------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Event GUID | The GUID of the integration event. | IN1AB2CD3EF4GH5IJ6KL7MN8 | | Event Item GUID | The GUID of the item in the integration event. | IN1AB2CD3EF4GH5IJ6KL7MN8 | | Integration GUID | The GUID of the outbound integration. | IN1AB2CD3EF4GH5IJ6KL7MN8 | | Reconciled | When true, the event item is reconciled. | false | Example Payload for Update Event Item Reconciled[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateEventItemReconciled.json "Download example payload") Loading… *** ### Update Extract[​](#updateextract "Direct link to Update Extract") Update an existing extract definition. | **key: updateExtract** | Input | Notes | Example | | ------------ | --------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Extract Data | Updated extract definition data. | | | Extract GUID | The GUID of the extract definition to update. | ET4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Update Extract[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateExtract.json "Download example payload") Loading… *** ### Update File Content[​](#updatefilecontent "Direct link to Update File Content") Upload and update file content by its GUID with multipart form data. | **key: updateFileContent** | Input | Notes | Example | | ------------ | ------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | File Content | The file content to upload (binary format). | | | File GUID | The GUID of the file to update. | GNZAQ5I94Y9DGMRS8NENGR3R | Example Payload for Update File Content[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateFileContent.json "Download example payload") Loading… *** ### Update Import[​](#updateimport "Direct link to Update Import") Update an existing import definition. | **key: updateImport** | Input | Notes | Example | | ----------- | -------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Import Data | Updated import definition data. | | | Import GUID | The GUID of the import definition to update. | IM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Update Import[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateImport.json "Download example payload") Loading… *** ### Update Item[​](#updateitem "Direct link to Update Item") Update an existing item in Arena PLM system with the specified properties. | **key: updateItem** | Input | Notes | Example | | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | Additional Attribute JSON | Provide additional attributes as raw JSON. If provided, this will be used instead of additionalAttributes and attributeDefinitions. | | | Additional Attributes | Additional custom attributes for the object. Key should be the attribute GUID, value should be the attribute value. | attr-guid-123: Custom Value | | Attribute Definitions | List of CategoryAttributeDefinitionVo objects that define the types and properties of attributes. This is required when creating additional attributes to ensure proper value type conversion (e.g., NUMBER/POSITIVE\_DOUBLE/COST types will be parsed as numbers). | | | Category GUID | GUID of the category to assign to this item. | IT1AB2CD3EF4GH5IJ6KL7MN8 | | Connection | The Arena connection to use. | | | Item Description | Detailed description of the item. | Main circuit board assembly for product revision 2.1 | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Item Name | The name/title of the item (optional for updates). | Circuit Board Assembly v2.1 | | Number Format Fields | Fields for the number format. Key should be the field GUID, value should be the field value. | K2M5JGKMXEVI1K2AXGLN: 999-0011 | | Number Format GUID | GUID of the number format to use for generating the item number. | IT4IVLHFUC584FSNJJLVR6I2 | | Off The Shelf | When true, this is an off-the-shelf item. | false | | Owner Full Name | Full name of the user who will own this item. | John Doe | | Revision Number | Revision number for the item (if not auto-generated). | A | | Shared Item | When true, this item is shared across workspaces. | false | | Standard Cost | Standard cost of the item. | 28.75 | | Target Cost | Target cost of the item. | 30.00 | | Target Price | Target selling price of the item. | 45.00 | | Unit of Measure | Unit of measure for the item (e.g., 'EA', 'LB', 'FT'). | EA | Example Payload for Update Item[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateItem.json "Download example payload") Loading… *** ### Update Item File Association[​](#updateitemfileassociation "Direct link to Update Item File Association") Update metadata of an item file association (latestEditionAssociation, primary). | **key: updateItemFileAssociation** | Input | Notes | Example | | -------------------------- | ---------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Item File Association GUID | GUID of the item file association. | IT1AB2CD3EF4GH5IJ6KL7MN8 | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Latest Edition Association | Whether the latest edition of the file should be associated to the item. | true | | Primary | When true, the associated file becomes the primary file in the relationship. | false | Example Payload for Update Item File Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateItemFileAssociation.json "Download example payload") Loading… *** ### Update Outbound Event Reconciliation[​](#updateoutboundeventreconciliation "Direct link to Update Outbound Event Reconciliation") Update the reconciliation status of a specific event. | **key: updateOutboundEventReconciliation** | Input | Notes | Example | | -------------------- | ---------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Event GUID | The GUID of the specific event. | IG4KL5MN6OP7QR8ST9UV0WX1 | | Integration GUID | The GUID of the outbound event integration. | IG4KL5MN6OP7QR8ST9UV0WX1 | | Resources Reconciled | When true, the resources have been reconciled. | false | Example Payload for Update Outbound Event Reconciliation[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateOutboundEventReconciliation.json "Download example payload") Loading… *** ### Update Outbound Event Resource Reconciliation[​](#updateoutboundeventresourcereconciliation "Direct link to Update Outbound Event Resource Reconciliation") Update the reconciliation status of a specific resource. | **key: updateOutboundEventResourceReconciliation** | Input | Notes | Example | | ----------------------- | ---------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Event GUID | The GUID of the specific event. | IG4KL5MN6OP7QR8ST9UV0WX1 | | Integration GUID | The GUID of the outbound event integration. | IG4KL5MN6OP7QR8ST9UV0WX1 | | Integration Update GUID | The GUID of the specific resource update. | IG4KL5MN6OP7QR8ST9UV0WX1 | | Object Type | The type of object for the resource. | | | Resources Reconciled | When true, the resources have been reconciled. | false | Example Payload for Update Outbound Event Resource Reconciliation[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateOutboundEventResourceReconciliation.json "Download example payload") Loading… *** ### Update Quality Process[​](#updatequalityprocess "Direct link to Update Quality Process") Updates the metadata of a Quality Process object with a given GUID in Arena PLM system. | **key: updateQualityProcess** | Input | Notes | Example | | --------------------------- | ----------------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Quality Process Update Data | JSON object containing quality process update data (QualityProcessUpdateVo schema). | 2026-05-10T09:15:00Z | | Quality Process GUID | The GUID of the quality process to update. | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Update Quality Process[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateQualityProcess.json "Download example payload") Loading… *** ### Update Quality Process Step[​](#updatequalityprocessstep "Direct link to Update Quality Process Step") Update a specific step in a quality process within Arena PLM system. | **key: updateQualityProcessStep** | Input | Notes | Example | | ------------------------ | ----------------------------------------------------------------------------- | ------------------------ | | Connection | The Arena connection to use. | | | Quality Step Update Data | JSON object containing quality step update data (QualityStepUpdateVo schema). | 2026-05-10T09:15:00Z | | Quality Process GUID | The GUID of the quality process containing the step. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Step GUID | The GUID of the quality process step to update. | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Update Quality Process Step[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateQualityProcessStep.json "Download example payload") Loading… *** ### Update Quality Process Step Affected Object[​](#updatequalityprocessstepaffected "Direct link to Update Quality Process Step Affected Object") Updates an existing Affected Object with a given GUID in a step with a given GUID in a Quality Process with a given GUID. Current supported Affected Objects are ITEMS, CHANGES, SUPPLIERS, SUPPLIER ITEMS, FILES, QUALITY, and URLs from Arena PLM system. | **key: updateQualityProcessStepAffected** | Input | Notes | Example | | -------------------- | -------------------------------------------------------------------- | ------------------------ | | Affected Object GUID | The GUID of the affected object to update. | QP4KL5MN6OP7QR8ST9UV0WX1 | | Connection | The Arena connection to use. | | | Notes | Notes for the affected object. | | | Quality Process GUID | The GUID of the quality process containing the step. | GN4KL5MN6OP7QR8ST9UV0WX1 | | Step GUID | The GUID of the quality process step containing the affected object. | GN4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Update Quality Process Step Affected Object[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateQualityProcessStepAffected.json "Download example payload") Loading… *** ### Update Request[​](#updaterequest "Direct link to Update Request") Update an existing request in Arena PLM system. | **key: updateRequest** | Input | Notes | Example | | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | | Additional Attribute JSON | Provide additional attributes as raw JSON. If provided, this will be used instead of additionalAttributes and attributeDefinitions. | | | Additional Attributes | Additional custom attributes for the object. Key should be the attribute GUID, value should be the attribute value. | attr-guid-123: Custom Value | | Attribute Definitions | List of CategoryAttributeDefinitionVo objects that define the types and properties of attributes. This is required when creating additional attributes to ensure proper value type conversion (e.g., NUMBER/POSITIVE\_DOUBLE/COST types will be parsed as numbers). | | | Category GUID | GUID of the category to assign to this request. | GNLMBALQ4EZWDYIEZCJSHGRK | | Connection | The Arena connection to use. | | | Number Sequence Prefix | Prefix for the request number sequence. | ECO | | Problem Description | Description of the problem that needs to be addressed. | | | Request Code | Code associated with the request. | | | Requested Action | Description of the action requested to solve the problem. | | | Request GUID | GUID of the request to update. | RQ4KL5MN6OP7QR8ST9UV0WX1 | | Supplier Visibility | When true, the request is visible to suppliers. | false | | Request Title | The title of the request. | | Example Payload for Update Request[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateRequest.json "Download example payload") Loading… *** ### Update Requirement[​](#updaterequirement "Direct link to Update Requirement") Update an existing requirement. | **key: updateRequirement** | Input | Notes | Example | | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | | Additional Attribute JSON | Provide additional attributes as raw JSON. If provided, this will be used instead of additionalAttributes and attributeDefinitions. | | | Additional Attributes | Additional custom attributes for the object. Key should be the attribute GUID, value should be the attribute value. | attr-guid-123: Custom Value | | Assignee GUID | GUID of the user to assign the requirement to. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Attribute Definitions | List of CategoryAttributeDefinitionVo objects that define the types and properties of attributes. This is required when creating additional attributes to ensure proper value type conversion (e.g., NUMBER/POSITIVE\_DOUBLE/COST types will be parsed as numbers). | | | Connection | The Arena connection to use. | | | Description | The description of the requirement. | | | Priority | The priority of the requirement. The accepted values come from the priority attribute configured in Arena, for example High or Medium. | | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Set Null Fields | When true, empty or null fields are set explicitly (for updates). | false | | Title | The title of the requirement. | | Example Payload for Update Requirement[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateRequirement.json "Download example payload") Loading… *** ### Update Requirement Trace[​](#updaterequirementtrace "Direct link to Update Requirement Trace") Update an existing trace link for a requirement. | **key: updateRequirementTrace** | Input | Notes | Example | | ---------------------- | ------------------------------------------------ | ------------------------ | | Connection | The Arena connection to use. | | | Relationship Type GUID | The GUID of the trace relationship type. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Requirement GUID | The unique identifier of the requirement. | RM4KL5MN6OP7QR8ST9UV0WX1 | | Suspect | When true, the trace link is flagged as suspect. | false | | Trace Link GUID | The unique identifier of the trace link. | RM4KL5MN6OP7QR8ST9UV0WX1 | Example Payload for Update Requirement Trace[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateRequirementTrace.json "Download example payload") Loading… *** ### Update Sourcing Relationship[​](#updatesourcingrelationship "Direct link to Update Sourcing Relationship") Update information of a specified sourcing relationship for an item in Arena PLM system. | **key: updateSourcingRelationship** | Input | Notes | Example | | ----------------------------- | -------------------------------------------------------------------------------------- | ------------------------------------ | | AML Rank | Approved Manufacturer List rank (integer). | 1 | | AML Split | AML split percentage (for update operations). | 50.5 | | Approved | When true, the sourcing relationship is approved. | false | | Connection | The Arena connection to use. | | | Item GUID | The GUID of the item. | GN1AB2CD3EF4GH5IJ6KL7MN8 | | Manufacturer Item GUID | GUID of the manufacturer item. | SPQDZ6CQ75S3ENCGW6DXTGPP | | Notes | Additional notes for the sourcing relationship. | Primary supplier for production runs | | Set Null | When true, unspecified fields are set to null when updating the sourcing relationship. | false | | Sourcing Relationship GUID | GUID of the sourcing relationship. | SP1AB2CD3EF4GH5IJ6KL7MN8 | | Vendor Item Conversion Factor | Conversion factor between vendor and manufacturer items. | 1.0 | | Vendor Item GUID | GUID of the vendor item. | SPW6UKHVR5KUVQGN48AHK9CZ | Example Payload for Update Sourcing Relationship[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateSourcingRelationship.json "Download example payload") Loading… *** ### Update Supplier[​](#updatesupplier "Direct link to Update Supplier") Update an existing supplier in Arena PLM system with the specified information. | **key: updateSupplier** | Input | Notes | Example | | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | | Account Number | Account number for the supplier. | ACCT-12345 | | Additional Attributes | Additional custom attributes for the object. Key should be the attribute GUID, value should be the attribute value. | attr-guid-123: Custom Value | | Addresses | JSON array of address objects to assign to the supplier. | | | Approval Status GUID | GUID of the approval status setting to assign to this supplier. | SP1AB2CD3EF4GH5IJ6KL7MN8 | | Attribute Definitions | List of CategoryAttributeDefinitionVo objects that define the types and properties of attributes. This is required when creating additional attributes to ensure proper value type conversion (e.g., NUMBER/POSITIVE\_DOUBLE/COST types will be parsed as numbers). | | | Connection | The Arena connection to use. | | | Description | Description of the supplier. | | | Supplier Name | The name of the supplier. | | | Phone Numbers | JSON array of phone number objects to assign to the supplier. | | | Supplier GUID | GUID of the supplier that provides this item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | | Supplier ID | The unique identifier for the supplier. | SUP-000145 | | Website | The supplier's public website, recorded for reference on the supplier record. | https\://www\.supplier.com | Example Payload for Update Supplier[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateSupplier.json "Download example payload") Loading… *** ### Update Supplier Address[​](#updatesupplieraddress "Direct link to Update Supplier Address") Update an address for a supplier in Arena PLM system. | **key: updateSupplierAddress** | Input | Notes | Example | | ------------------ | ---------------------------------------------------------------------- | ------------------------ | | Address | Street address lines, city, state, province, postal code, and country. | | | Address GUID | The unique identifier (GUID) of the address. | SP23PEPH52BD74BBYPPBHGAY | | Connection | The Arena connection to use. | | | Is Primary Address | When true, this address is the primary address for the supplier. | true | | Address Label | Label for the address (e.g., 'Main Office', 'Billing', 'Shipping'). | Main Office | | Supplier GUID | GUID of the supplier that provides this item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Update Supplier Address[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateSupplierAddress.json "Download example payload") Loading… *** ### Update Supplier File Association[​](#updatesupplierfileassociation "Direct link to Update Supplier File Association") Update a file association for a supplier in Arena PLM system. | **key: updateSupplierFileAssociation** | Input | Notes | Example | | ------------------------------ | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | | File Author Full Name | Full name of the file author. | John Doe | | File Category GUID | GUID of the category to filter files by. | GNSGE2D4YMGB4UITKVB7KZSW | | Connection | The Arena connection to use. | | | File Description | Optional description for the file. | Technical specification document for product version 2.1 | | File Edition | Edition of the file, which Arena increments each time new content is checked in. | 1.0 | | File Format | File format/extension (e.g., 'pdf', 'docx', 'png'). If not specified, will be extracted from file name. | pdf | | Primary File | When true, this is the primary file association. | false | | File Private | When true, the file is private. | false | | Latest Edition Association | When true, the file is associated with its latest edition. | true | | File Storage Method Name | Storage method holding the file: FILE, FTP, WEB or PLACE\_HOLDER. | Default Storage | | Supplier File Association GUID | The unique identifier (GUID) of the supplier file association. | SPWCC5835PR4AZIWCN7FZ6K9 | | Supplier GUID | GUID of the supplier that provides this item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | | File Title | The title/name for the file in Arena. | Product Specification Document | Example Payload for Update Supplier File Association[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateSupplierFileAssociation.json "Download example payload") Loading… *** ### Update Supplier Item[​](#updatesupplieritem "Direct link to Update Supplier Item") Update an existing supplier item in Arena PLM system with the specified properties. | **key: updateSupplierItem** | Input | Notes | Example | | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | | Additional Attribute JSON | Provide additional attributes as raw JSON. If provided, this will be used instead of additionalAttributes and attributeDefinitions. | | | Additional Attributes | Additional custom attributes for the object. Key should be the attribute GUID, value should be the attribute value. | attr-guid-123: Custom Value | | Attribute Definitions | List of CategoryAttributeDefinitionVo objects that define the types and properties of attributes. This is required when creating additional attributes to ensure proper value type conversion (e.g., NUMBER/POSITIVE\_DOUBLE/COST types will be parsed as numbers). | | | Connection | The Arena connection to use. | | | Supplier Item Description | Detailed description of the supplier item. | High-quality circuit board for electronic assembly | | Supplier Item Name | The name of the supplier item. | Circuit Board PCB-123 | | Supplier Item Number | The number/part number of the supplier item. | PCB-123-V2 | | Off The Shelf | When true, this is an off-the-shelf supplier item. | false | | Procurement Type | Procurement type for the supplier item. | | | Supplier Item GUID | The GUID of the supplier item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | | Supplier Item Type | The type/category of the supplier item. | Component | | Supplier Item Unit of Measure | Unit of measure for the supplier item (e.g., 'EA', 'LB', 'FT'). | EA | Example Payload for Update Supplier Item[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateSupplierItem.json "Download example payload") Loading… *** ### Update Supplier Phone Number[​](#updatesupplierphonenumber "Direct link to Update Supplier Phone Number") Update a phone number for a supplier in Arena PLM system. | **key: updateSupplierPhoneNumber** | Input | Notes | Example | | ---------------------- | ------------------------------------------------------------------ | ------------------------ | | Phone Number Comment | Additional comment about the phone number. | Primary contact number | | Connection | The Arena connection to use. | | | Phone Number Extension | Phone number extension if applicable. | 123 | | Phone Number Label | Label for the phone number (e.g., 'Main', 'Fax', 'Mobile'). | Main | | Phone Number | The supplier's phone number. Leave empty to keep the stored value. | +1-555-123-4567 | | Phone Number GUID | The unique identifier (GUID) of the phone number. | SPSSLP7UXXNQ2YRAFWY593XU | | Supplier GUID | GUID of the supplier that provides this item. | SP1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Update Supplier Phone Number[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateSupplierPhoneNumber.json "Download example payload") Loading… *** ### Update Ticket[​](#updateticket "Direct link to Update Ticket") Update an existing ticket in Arena PLM system. | **key: updateTicket** | Input | Notes | Example | | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | | Additional Attribute JSON | Provide additional attributes as raw JSON. If provided, this will be used instead of additionalAttributes and attributeDefinitions. | | | Additional Attributes | Additional custom attributes for the object. Key should be the attribute GUID, value should be the attribute value. | attr-guid-123: Custom Value | | Assignee GUID | GUID of the user to assign to this ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | | Attribute Definitions | List of CategoryAttributeDefinitionVo objects that define the types and properties of attributes. This is required when creating additional attributes to ensure proper value type conversion (e.g., NUMBER/POSITIVE\_DOUBLE/COST types will be parsed as numbers). | | | Connection | The Arena connection to use. | | | Description | The updated description of the ticket. | | | Fix Version | The fix version for this ticket. | | | Found On | The version on which the issue was found. | | | Priority | The priority of the ticket (e.g. HIGH, MEDIUM, LOW). | | | Ticket GUID | The GUID of the ticket. | TK1AB2CD3EF4GH5IJ6KL7MN8 | | Title | The updated title of the ticket. | | Example Payload for Update Ticket[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateTicket.json "Download example payload") Loading… *** ### Update Training Plan[​](#updatetrainingplan "Direct link to Update Training Plan") Update an existing training plan. | **key: updateTrainingPlan** | Input | Notes | Example | | ---------------- | ------------------------------------------ | ----------------------------------------------- | | Connection | The Arena connection to use. | | | Days to Complete | Number of days to complete the training. | 30 | | Description | Updated description for the training plan. | Comprehensive safety training for all employees | | Manager GUID | GUID of the training manager. | mgr123-456-789-abc-def567890 | | Training Name | Updated name for the training plan. | Advanced Safety Training | | Training GUID | GUID of the training plan to update. | TR1AB2CD3EF4GH5IJ6KL7MN8 | Example Payload for Update Training Plan[⤓](https://prismatic.io/docs/example-payloads/arena-plm-v2/actions/updateTrainingPlan.json "Download example payload") Loading… *** ## Changelog[​](#changelog "Direct link to Changelog") ### 2026-09-04[​](#2026-09-04 "Direct link to 2026-09-04") Initial release of the Arena Solutions component. * Added 317 actions for managing items, BOMs, changes, requests, quality processes, requirements, suppliers, tickets, training plans and files * Added **API Key**, **Username and Password**, and **OAuth 2.0 Client Credentials** connection types * Added the **New Events** polling trigger, which reports events created in an Arena outbound integration feed and dispatches each event individually or in configured batches once batching is enabled; enabling it changes the shape a downstream step receives * Added an optional **Look-back Date** input on the **New Events** trigger for performing an initial sync of events. The initial sync begins on the first recurrence, backfills every event created on or after the specified date and seeds each once. Leave it empty to start from the first recurrence with no backfill * Added output schemas to 312 actions for improved field mapping during configuration * Added data sources for selecting categories, category attributes, change category routings, number sequence prefixes, quality process templates, exports, outbound integrations and outbound event integrations from live Arena data, plus a **Notification JSON Form** data source for configuring notification delivery and message fields * Added a **Pagination** structured object to list actions, where **Fetch All** stays a top-level toggle, and an **Address** structured object to supplier addresses * Added **Raw Request** for sending arbitrary requests to endpoints the dedicated actions do not cover