### Get File by GUID Response Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/File/endpoint_get_files_details.md Example response for retrieving a specific file using its unique GUID. ```json { "author":{ "fullName":"Heidi Walker" }, "category":{ "guid":"M4O7QY5R7FY8RATAYXNX", "name":"Design Drawing", "path":"File\\Engineering\\Design Drawing" }, "chekedOut": false, "corrected": true, "creationDateTime":"2006-09-21T20:49:34Z", "description":"500 Board MPI", "edition":"01", "format":"pdf", "guid":"P7RAT18UAI1H0J2BDRVF", "hasMarkup":false, "lastModifiedDateTime":"2006-09-21T20:49:34Z", "latest":true, "location":null, "locked":false, "mimeType":"application/pdf", "name":"308-0345-a.pdf", "number":"FILE-000151", "private":false, "size":82121, "storageMethodName":"FILE", "title":"308-0345-a" } ``` -------------------------------- ### Sample Request Body for Adding File Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Training Plan Files/endpoint_create_trainingplans_file_add_association.md Use this JSON structure to specify the GUID of the existing file to be associated with the training plan. ```json { "file": { "guid": "UCTQE5NGZI1AXZ3W" } } ``` -------------------------------- ### Get All Events for an Outbound Integration Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Outbound-Events Integration (Event Engine)/Outbound-Events Events/endpoint_get_outbound_events_integration_events.md Use this endpoint to retrieve all events associated with a given outbound event integration GUID. No specific setup is required beyond having the integration GUID. ```json { "count": 6, "results": [ { "creationDateTime": "2021-08-28T05:36:50Z", "creator": { "email": "hwalker@everyroadgps.com", "fullName": "Heidi Walker", "guid": "WEYH0DYPCFWFYH0JSIPD" }, "eventType": "OUTBOUND_EVENT", "guid": "R9TCV8TK7ALL4N6P8NY5", "resourcesReconciled": false, "status": "NEEDS_UPDATE", "triggers": [ { "action": "WORKFLOW", "description": "Queues all Changes with a category of Manufacturing Change Order that move from lifecycle status of Submitted or Approved to Effective.", "guid": "M4O7Q3OF25GDWFYH0JPT", "name": "Manufacturing Change Order Release", "resource": "CHANGE" } ] }, { "creationDateTime": "2021-08-26T22:42:43Z", "creator": { "email": "hwalker@everyroadgps.com", "fullName": "Heidi Walker", "guid": "WEYH0DYPCFWFYH0JSIPD" }, "eventType": "OUTBOUND_EVENT", "guid": "ASCVERC3QT44N6P8R6HC", "resourcesReconciled": false, "status": "NEEDS_UPDATE", "triggers": [ { "action": "WORKFLOW", "description": "Intended to queue up instances of Corrective Action Reports transitioning from the Corrective Action Plan Approved? step to the Corrective Action step.", "guid": "L3N6P2NE14FCVEXGZIIQ", "name": "Corrective Action Report: Plan Step Approval", "resource": "QUALITY" } ] }, { "creationDateTime": "2021-08-26T22:28:58Z", "creator": { "email": "hwalker@everyroadgps.com", "fullName": "Heidi Walker", "guid": "WEYH0DYPCFWFYH0JSIPD" }, "eventType": "OUTBOUND_EVENT", "guid": "2K4N6J4VILWWFYH0JYA9", "resourcesReconciled": false, "status": "NEEDS_UPDATE", "triggers": [ { "action": "WORKFLOW", "description": "Intended to queue up instances of Corrective Action Reports transitioning from the Corrective Action Plan Approved? step to the Corrective Action step.", "guid": "L3N6P2NE14FCVEXGZIIQ", "name": "Corrective Action Report: Plan Step Approval", "resource": "QUALITY" } ] }, ... ] } ``` -------------------------------- ### Retrieve Outbound Integration Events Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Outbound Integrations - Event Queue/endpoint_get_events.md Example response body for a GET request to fetch events for a specific outbound integration GUID. ```json { "count": 4, "results": [ { "change": { "approvedOnDateTime": "2020-03-13T22:42:31Z", "effectiveDateTime": "2020-03-13T22:42:37Z", "effectivityType": "PERMANENT", "guid": "WEYH0DYPCFY1K2IIMYQ7", "number": "ECO-000022", "title": "Critical Changes" }, "creationDateTime": "2020-03-13T22:42:37Z", "eventType": "CHANGE", "guid": "1J3M5I3UHKV1K2IIMYQ7", "itemsReconciled": false, "status": "NEEDS_UPDATE" }, { "change": { "approvedOnDateTime": "2020-03-13T22:47:34Z", "effectiveDateTime": "2020-03-13T22:47:36Z", "effectivityType": "PERMANENT", "guid": "ZH1K3G1SFI14N5LLP1TU", "number": "ECO-000023", "title": "Critical Resistor Changes - Batch A" }, "creationDateTime": "2020-03-13T22:47:36Z", "eventType": "CHANGE", "guid": "4M6P8L6XKNY4N5LLP1T3", "itemsReconciled": false, "status": "NEEDS_UPDATE" }, { "change": { "approvedOnDateTime": "2020-03-13T22:51:34Z", "effectiveDateTime": "2020-03-13T22:51:35Z", "effectivityType": "PERMANENT", "guid": "1J3M5I3UHK36P7NNR3VD", "number": "ECO-000024", "title": "Critical Changes Resistors - Batch 2" }, "creationDateTime": "2020-03-13T22:51:35Z", "eventType": "CHANGE", "guid": "6O8RAN8ZMP06P7NNR3VZ", "itemsReconciled": false, "status": "NEEDS_UPDATE" }, { "change": { "approvedOnDateTime": "2020-03-13T23:51:14Z", "effectiveDateTime": "2020-03-13T23:51:15Z", "effectivityType": "PERMANENT", "guid": "4X7Q9B4WCS48G1USM7FL", "number": "ECO-000025", "title": "Critical Changes Resistors - Batch 3" }, "creationDateTime": "2020-03-13T23:51:15Z", "eventType": "CHANGE", "guid": "612BDU3RQK72X2WOW3VQ", "itemsReconciled": true, "status": "NEEDS_UPDATE" } ] } ``` -------------------------------- ### Sample Success Response Body Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Change Implementation Tasks/endpoint_get_change_implementationtasks.md Example of a successful response when retrieving implementation tasks. Includes task details like GUID, name, assignee, due date, and status. ```json { "count": 5, "results": [ { "guid": "J1L4IFJLWDWZI0G8FQA8", "name": "Check Supplier", "assignee": { "userGroup": { "guid": "VDXGURVX8OUH0J2L4HEJ", "name": "EveryHome Engineering USA" } }, "dueDate": "2022-03-07T08:00:00Z", "status": "NOT_STARTED" }, { "guid": "J1L4IFJLWDWZI0G8FQA8", "name": "Verify Final Tooling", "assignee": { }, "supplier": { "guid": "4M6P3046HXGM5OTJK65R", "name": "Onward Technology Corp" }, }, "dueDate": "2022-03-07T08:00:00Z", "status": "NOT_STARTED" }, ... ] } ``` -------------------------------- ### Sample Response Body for GET Change Implementation Statuses Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Change Status Workflow/endpoint_get_change_implementationstatuses.md This is an example of the JSON response body returned by the GET Change Implementation Statuses endpoint. It includes the total count of statuses and a list of status objects, each with a unique GUID and a human-readable name. ```JSON { "count": 5, "results": [ { "guid": "EWGZIVG7UXATCVEXGZIT", "name": "NOT_STARTED" }, { "guid": "FXH0JWH8VYBUDWFYH0JM", "name": "IN_PROGRESS" }, { "guid": "GYI1KXI9WZCVEXGZI1KC", "name": "NEEDS_ATTN" }, { "guid": "HZJ2LYJAX0DWFYH0J2LC", "name": "DONE" }, { "guid": "I0K3MZKBY1EXGZI1K3M9", "name": "BLANK" } ] } ``` -------------------------------- ### Sample Success Response for Adding Existing File Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Change Implementation Files/endpoint_create_change_implementation_file_association.md A successful response includes details of the associated file and a GUID for the association. This confirms the file has been linked to the Change's Implementation Files view. ```json { "file": { "author": { "fullName": "George C Lewis" }, "category": { "guid": "TBVEXAVM9CV5O7MTTUH9" }, "checkedOut": false, "corrected": false, "creationDateTime": "2011-06-02T19:30:28Z", "description": null, "edition": "1", "format": "pdf", "guid": "WEYH0DYPCFYEXGJAW2JP", "hasMarkup": false, "lastModifiedDateTime": "2011-06-02T19:30:28Z", "latest": true, "location": null, "locked": true, "mimeType": "application/pdf", "name": "ZIP-PWR-AC.pdf", "number": "FILE-000861", "private": false, "size": 120052, "storageMethod": 0, "storageMethodName": "FILE", "title": "ZIP-PWR-AC" }, "guid": "I0K3MZKBY1F3M5H1HVS5" } ``` -------------------------------- ### GET /supplieritems/{GUID}/sourcing/{GUID} Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Supplier Item/endpoint_get_supplier_item_source_relationship.md Retrieves a single Source Relationship object for a supplier item, identified by its GUID. The returned source relationship GUID is consistent with the one obtained from the GET items/{GUID}/sourcing endpoint. ```APIDOC ## GET /supplieritems//sourcing/ ### Description Returns a single Source Relationship object for a supplier item with a given GUID. The source relationship GUID in the response is identical to the source relationship GUID for GET items/<GUID>/sourcing. ### Method GET ### Endpoint /supplieritems/<GUID>/sourcing/<GUID> ### Parameters #### Query Parameters - **offset** (integer) - Optional - Specifies the position in the list of all source relationships where results should begin. All relationships before the offset in the search results are ignored. The default value is 0. - **limit** (integer) - Optional - Specifies the maximum number of returned results. The default value (no specified limit) is 20, the maximum is 400. - **item.status** (number) - Optional - Specifies the revision types of items that can be included in returned results. The possible values are 0 (working), 1 (effective), 2 (superseded). ### Request Header - **arena_session_id** (string) - Required - unique ID for session obtained from login - **content-type** (string) - Required - application/json ### Response #### Success Response (200) - **activeProduction** (boolean) - Indicates if the item is active in production. - **activePrototype** (boolean) - Indicates if the item is active as a prototype. - **amlRank** (any) - Rank in the Approved Manufacturer List (AML). - **amlSplit** (any) - Split percentage in the Approved Manufacturer List (AML). - **approved** (boolean) - Indicates if the item is approved. - **guid** (string) - The unique identifier for the source relationship. - **item** (object) - Details of the supplier item. - **guid** (string) - The unique identifier for the item. - **name** (string) - The name of the item. - **number** (string) - The item number. - **revisionNumber** (string) - The revision number of the item. - **revisionStatus** (string) - The revision status of the item (e.g., WORKING, EFFECTIVE, SUPERSEDED). - **status** (number) - The status code of the item. - **url** (object) - URLs related to the item. - **api** (string) - The API URL for the item. - **app** (string) - The application URL for the item. - **makeItem** (boolean) - Indicates if this is a make item. - **mfrItem** (object) - Details of the manufacturer item. - **guid** (string) - The unique identifier for the manufacturer item. - **number** (string) - The manufacturer item number. - **supplier** (object) - Details of the manufacturer's supplier. - **guid** (string) - The unique identifier for the supplier. - **name** (string) - The name of the supplier. - **notes** (any) - Notes associated with the source relationship. - **vendorItem** (object) - Details of the vendor item. - **guid** (string) - The unique identifier for the vendor item. - **number** (string) - The vendor item number. - **supplier** (object) - Details of the vendor's supplier. - **guid** (string) - The unique identifier for the supplier. - **name** (string) - The name of the supplier. - **vendorItemConversionFactor** (number) - The conversion factor for the vendor item. #### Response Example ```json { "activeProduction": false, "activePrototype": true, "amlRank": null, "amlSplit": null, "approved": true, "guid": "VDXGZCXOBEWDWFGK9D4A", "item": { "guid": "7P9SBO90NQ9H0ISBNGAO", "name": "Resistor, 2M Ohm, 1/16W, 5%, 0603, SMD", "number": "180-00011", "revisionNumber": "A", "revisionStatus": "EFFECTIVE", "status": 1, "url": { "api": "https://api.arenasolutions.com/v1/items/VDXGLBCCLSBSBQMM0UZ1", "app": "https://app.bom.com/VDXGLBCCLSBSBQMM0UZ1" } }, "makeItem": false, "mfrItem": { "guid": "5N7Q9M7YLO7CVESUDFBC", "number": "ERJ3GSYJ205V", "supplier": { "guid": "6O8RAN8ZMP8EXGRSZTP4", "name": "Matsushita" } }, "notes": null, "vendorItem": { "guid": "3L5O7K5WJM5ATCQSBD9A", "number": "ERJ3GSYJ205V", "supplier": { "guid": "3L5O7K5WJM5BUDOPWQM5", "name": "Avnet" } }, "vendorItemConversionFactor": 1 } ``` #### Error Response Example (400) ```json { "status":400, "errors":[ { "code":3011, "message":"The guid \"0I2LQGHHQXGXGVRR5XND\" is not valid." } ] } ``` ``` -------------------------------- ### Retrieve Training Plan Files Response Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Training Plan Files/endpoint_get_trainingplans_files.md Example JSON response body containing a list of files associated with a training plan. ```json { "count": 3, "results": [ { "file": { "author": { "fullName": "Heidi Walker" }, "category": { "guid": "2K4N6J4VIL4EXGV223PR", "name": "-uncategorized-" }, "checkedOut": false, "corrected": false, "creationDateTime": "2016-09-02T19:00:27Z", "description": null, "edition": "1", "format": "pdf", "guid": "L3N6P2NE14N3M5VBYQQ3", "hasMarkup": false, "lastModifiedDateTime": "2016-09-02T19:00:27Z", "latest": true, "location": null, "locked": true, "mimeType": "application/pdf", "name": "020-00001 SOP, Document Control Management.pdf", "number": "FILE-000961", "private": true, "size": 92146, "storageMethod": 0, "storageMethodName": "FILE", "title": "020-00001 SOP, Document Control Management" }, "guid": "HZJ2LYJAX0DSBUDVA6PX" }, { "file": { "author": { "fullName": "Heidi Walker" }, "category": { "guid": "2K4N6J4VIL4EXGV223PR", "name": "-uncategorized-" }, "checkedOut": false, "corrected": false, "creationDateTime": "2016-09-02T19:01:26Z", "description": null, "edition": "1", "format": "docx", "guid": "WEYH0DYPCFYEXG6M911I", "hasMarkup": false, "lastModifiedDateTime": "2016-09-02T19:01:26Z", "latest": true, "location": null, "locked": true, "mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "name": "020-00002 SOP, Change Control.docx", "number": "FILE-000964", "private": true, "size": 35440, "storageMethod": 0, "storageMethodName": "FILE", "title": "020-00002 SOP, Change Control" }, "guid": "I0K3MZKBY1ETCVEWB7QK" }, { "file": { "author": { "fullName": "Heidi Walker" }, "category": { "guid": "2K4N6J4VIL4EXGV223PR", "name": "-uncategorized-" }, "checkedOut": false, "corrected": false, "creationDateTime": "2016-09-02T19:02:08Z", "description": null, "edition": "1", "format": "docx", "guid": "4M6P8L6XKN6M5OEUH99C", "hasMarkup": false, "lastModifiedDateTime": "2016-09-02T19:02:08Z", "latest": true, "location": null, "locked": true, "mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "name": "020-00003 SOP, Control of Records.docx", "number": "FILE-000966", "private": true, "size": 35450, "storageMethod": 0, "storageMethodName": "FILE", "title": "020-00003 SOP, Control of Records" }, "guid": "J1L4N0LCZ2FUDWFXC8RA" } ] } ``` -------------------------------- ### Create Training Plan Source: https://context7.com/ptc-arena/arena-restapi-doc/llms.txt Creates a new Training Plan requiring Training Plan Manager privileges. Includes manager assignment and completion duration. ```bash # Create a training plan curl -X POST "https://api.arenasolutions.com/v1/trainingplans" \ -H "arena_session_id: YOUR_SESSION_ID" \ -H "Content-Type: application/json" \ -d '{ "numberSequencePrefix": { "value": "TRP-" }, "name": "EveryHome Green Efficiency Initiative 2022", "description": "All employees must review Green 2022 Initiative", "manager": { "guid": "J1L4N0LCZ2J2L4N6F6ZL" }, "daysToComplete": 30 }' ``` -------------------------------- ### Get All Item Number Formats Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Settings/endpoint_get_item_number_formats.md Use this endpoint to retrieve a list of all configured item number formats. The response includes details like creation date, example number, GUID, and name for each format. ```json { "count":6, "results":[ { "creationDateTime":"2011-02-05T00:08:14Z", "default":false, "exampleNumber":"150-0001", "guid":"VDXGZ7GGDUDM5O7OL7R3", "name":"Assembly" }, { "creationDateTime":"2011-01-05T00:26:30Z", "default":false, "exampleNumber":null, "guid":"WEYH08HHEVEN6P8PM8SK", "name":"Basic Item Number" }, { "creationDateTime":"2015-06-25T18:32:14Z", "default":false, "exampleNumber":"084-0071-0001", "guid":"FXH0JR00XEX6P8R839NG", "name":"Discrete Components" }, { "creationDateTime":"2011-02-05T00:03:24Z", "default":false, "exampleNumber":"070-0001", "guid":"YG0J2AJJGXGP8RAROAUE", "name":"Electrical" }, { "creationDateTime":"2011-02-05T00:22:21Z", "default":false, "exampleNumber":"060-0001", "guid":"ZH1K3BKKHYHQ9SBSPBVT", "name":"Labels and Packaging" }, { "creationDateTime":"2011-02-05T00:13:34Z", "default":false, "exampleNumber":"081-0001", "guid":"0I2L4CLLIZIRATCTQCWD", "name":"Mechanical" } ] } ``` -------------------------------- ### Sample Response Body for Files Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Change Implementation Tasks/Implementation Task Files/endpoint_get_change_implementationtasks_file.md This is a sample JSON response body when retrieving all files of an implementation task for a specific change. It includes file details such as GUID, number, edition, name, and storage method. ```json { "guid": "I0K3HEIKVCT8RATCV2DU", "file": { "guid": "GYI1FCGITAT9SB0IJX9M", "number": "FILE-046012", "edition": "1", "name": "implementation plan.pdf", "storageMethodName": "FILE", "title": "Implementation Plan" } } ``` -------------------------------- ### GET /outboundevents//events//requests/ Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Outbound-Events Integration (Event Engine)/Outbound-Events Event Resources and Reconciliation/endpoint_get_outbound_event_integration_requests_event.md Retrieves a specific request result by its GUID. ```APIDOC ## GET /outboundevents//events//requests/ ### Description Appending a GUID to the URL returns the specific request result guid from that event. ### Method GET ### Endpoint /outboundevents//events//requests/ ### Parameters #### Path Parameters - **GUID** (string) - Required - The unique identifier for the outbound event. - **GUID** (string) - Required - The unique identifier for the event. - **GUID** (string) - Required - The unique identifier for the specific request result. ### Request Header - **arena_session_id** (string) - Required - Unique ID for session obtained from login. - **content-type** (string) - Required - application/json ### Response #### Success Response (200) - **200** - Success #### Error Response (400) - **400** - Failure ``` -------------------------------- ### Sample Responses Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Outbound Integrations - Event Queue/endpoint_put_event_item.md Examples of successful responses and error handling for the PUT request. ```json { "effectiveItemRevision": { "guid": "N5P8R4PG36PXGY8R3VWP", "name": "Resistor, 47 Ohm, 1/10W, 5%, 0603, SMD", "number": "180-00009", "revisionNumber": "A", "lifecyclePhase": { "name": "In Production", "stage": "PRODUCTION", "guid": "DVFYHUF6TWEH0J2L4EYV" }, "modifiedSpecs": false, "modifiedBom": false, "modifiedSourcing": false, "modifiedFiles": false }, "guid": "R9TCV8TK7ALQ9SBMD74N", "reconciled": true, "reconciledDateTime": "2020-03-16T04:33:21Z", "reconciledUser": { "email": "hwalker@everyroadgps.com", "fullName": "Heidi Walker", "guid": "WEYH0DYPCFWFYH0JSIPD" }, "supersededItemRevision": { "guid": "8QATCPA1ORAI1JTCOHK9", "number": "180-00009", "revisionNumber": "A", "lifecyclePhase": { "name": "In Production", "stage": "PRODUCTION", "guid": "DVFYHUF6TWEH0J2L4EYV" } } } ``` ```json { "effectiveItemRevision": { "guid": "N5P8R4PG36PXGY8R3VWP", "name": "Resistor, 47 Ohm, 1/10W, 5%, 0603, SMD", "number": "180-00009", "revisionNumber": "A", "lifecyclePhase": { "name": "In Production", "stage": "PRODUCTION", "guid": "DVFYHUF6TWEH0J2L4EYV" }, "modifiedSpecs": false, "modifiedBom": false, "modifiedSourcing": false, "modifiedFiles": false }, "guid": "R9TCV8TK7ALQ9SBMD74N", "reconciled": false, "supersededItemRevision": { "guid": "8QATCPA1ORAI1JTCOHK9", "number": "180-00009", "revisionNumber": "A", "lifecyclePhase": { "name": "In Production", "stage": "PRODUCTION", "guid": "DVFYHUF6TWEH0J2L4EYV" } } } ``` ```json { "status": 400, "errors": [ { "code": 400, "message": "The format of the request is not valid. Please check the syntax." } ] } ``` ```json { "status": 400, "errors": [ { "code": 3011, "message": "The guid \"X9TCV8TK7AT1KZNA8V1Q\" is not valid." } ] } ``` -------------------------------- ### GET /files//supplieritems/ Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/File Associations/endpoint_get_file_supplier_item_association.md Retrieves the supplier item association GUID for a file identified by a specific GUID. ```APIDOC ## GET /files//supplieritems/ ### Description Returns a supplier item association GUID for a file with a given GUID. ### Method GET ### Endpoint /files//supplieritems/ ### Parameters #### Path Parameters - **GUID** (string) - Required - The unique identifier for the file. - **GUID** (string) - Required - The unique identifier for the supplier item association. ### Request Header - **arena_session_id** (string) - Required - Unique ID for session obtained from login. - **content-type** (string) - Required - application/json ### Response #### Success Response (200) - **guid** (string) - The GUID of the association. - **supplierItem** (object) - The supplier item details. #### Response Example { "guid":"O6Q9E455EL37Q95FRH30", "supplierItem":{ "guid":"O6Q9E455EL49SBB1KF69", "number":"AQW454A", "supplier":{ "guid":"I0K38YZZ8FY4N6B122AL", "name":"Aromat" } } } ``` -------------------------------- ### Retrieve Training Plan File Response Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Training Plan Files/endpoint_get_trainingplans_file.md Example JSON response body returned when successfully querying a file within a Training Plan. ```json { "file": { "author": { "fullName": "Heidi Walker" }, "category": { "guid": "2K4N6J4VIL4EXGV223PR", "name": "-uncategorized-" }, "checkedOut": false, "corrected": false, "creationDateTime": "2016-09-02T19:02:08Z", "description": null, "edition": "1", "format": "docx", "guid": "4M6P8L6XKN6M5OEUH99C", "hasMarkup": false, "lastModifiedDateTime": "2016-09-02T19:02:08Z", "latest": true, "location": null, "locked": true, "mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "name": "020-00003 SOP, Control of Records.docx", "number": "FILE-000966", "private": true, "size": 35450, "storageMethod": 0, "storageMethodName": "FILE", "title": "020-00003 SOP, Control of Records" }, "guid": "J1L4N0LCZ2FUDWFXC8RA" } ``` -------------------------------- ### GET /outboundevents//events//items/ Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Outbound-Events Integration (Event Engine)/Outbound-Events Event Resources and Reconciliation/endpoint_get_outbound_event_integration_item_event.md Retrieves details for a specific item-event. ```APIDOC ## GET /outboundevents//events//items/ ### Description Retrieves the details of a specific item-event from a specific event. ### Method GET ### Endpoint /outboundevents//events//items/ ### Parameters #### Path Parameters - **GUID** (string) - Required - The unique identifier for the outbound event integration. - **GUID** (string) - Required - The unique identifier for the event. - **GUID** (string) - Required - The unique identifier for the item-event. ### Response #### Success Response (200) - **guid** (string) - Unique identifier of the item-event. - **item** (object) - Item details. - **postEvents** (array) - List of post-event data. - **preEvents** (array) - List of pre-event data. - **reconciled** (boolean) - Reconciliation status. #### Response Example { "guid": "6O8RAN8ZMP0ZI1KQT6D7", "item": { "guid": "DVFYHUF6TWFN6KA8FX5O" }, "postEvents": [ { "guid": "DVFYHUF6TWFN6KA8FX5O" } ], "preEvents": [], "reconciled": false } ``` -------------------------------- ### GET /files//suppliers/ Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/File Associations/endpoint_get_file_suppliers_association.md Retrieves the association GUID for a file and supplier pair. ```APIDOC ## GET /files//suppliers/ ### Description Returns a File Supplier association GUID for a File with a given GUID. ### Method GET ### Endpoint /files//suppliers/ ### Parameters #### Path Parameters - **GUID** (string) - Required - The unique identifier for the file. - **GUID** (string) - Required - The unique identifier for the supplier. ### Request Header - **arena_session_id** (string) - Required - Unique ID for session obtained from login. - **content-type** (string) - Required - application/json ### Response #### Success Response (200) - **guid** (string) - The association GUID. - **supplier** (object) - The supplier details object. #### Response Example { "guid":"5N7QVLMMV2JRATA2GJ6E", "supplier":{ "guid":"UCWFKABBKRAGZINDEEM1", "name":"Avnet" } } ``` -------------------------------- ### Create Training Plan Request and Response Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Training Plans/endpoint_create_trainingplans.md Example payload for creating a training plan and the corresponding JSON response. ```json { "numberSequencePrefix": { "value": "TRP-" }, "name": "EveryHome Green Efficiency Initiative 2022", "description": "All employees must review Green 2022 Initiative", "manager": { "guid": "J1L4N0LCZ2J2L4N6F6ZL" }, "daysToComplete": 30 } ``` ```json { "creationDateTime": "2022-04-25T22:38:35Z", "creator": { "email": "hwalker@everyroadgps.com", "fullName": "Heidi Walker", "guid": "WEYH0DYPCFWFYH0JSIPD" }, "daysToComplete": 30, "description": "All employees must review Green 2022 Initiative", "guid": "FXH0JWH8VYF0J2L4NZB8", "manager": { "email": "tmakamuri@everyroadgps.com", "fullName": "Toshiro Makamuri", "guid": "J1L4N0LCZ2J2L4N6F6ZL" }, "name": "EveryHome Green Efficiency Initiative 2022", "number": "TRP-000004", "status": "OPEN" } ``` -------------------------------- ### GET /requests//items/ Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Request Items/endpoint_get_request_item.md Retrieves a specific item included in a request by providing the request GUID and the item GUID. ```APIDOC ## GET /requests//items/ ### Description Returns a Request Item with a given GUID included in a request with a given GUID. ### Method GET ### Endpoint /requests//items/ ### Parameters #### Path Parameters - **GUID** (string) - Required - The unique identifier for the request. - **GUID** (string) - Required - The unique identifier for the item. ### Request Header - **arena_session_id** (string) - Required - Unique ID for session obtained from login. - **content-type** (string) - Required - application/json ### Response #### Success Response (200) - **guid** (string) - The GUID of the request item. - **item** (object) - The item details including name, number, revision, and URLs. - **notes** (string) - Notes associated with the item in the request. #### Response Example { "guid": "TBVEXAVM9CPO7QZFFDRY", "item": { "guid": "3L5O7K5WJM5DWEO7JBIR", "name": "Screw, M3 x 6, ST, Torx", "number": "472-00001", "revisionNumber": "A", "revisionStatus": "EFFECTIVE", "url": { "api": "https://api.arenasolutions.com/v1/items/3L5O7K5WJM5DWEO7JBIR", "app": "https://app.bom.com/3L5O7K5WJM5DWEO7JBIR" } }, "notes": "Similar to 472-00002 but with Torx drive style" } ``` -------------------------------- ### Retrieve Supplier Files Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Supplier Files/endpoint_get_supplier_file_assocs.md Example response body showing a successful retrieval of all files associated with a specific supplier. ```json { "count": 2, "results": [ { "file": { "author": { "fullName": "Yvette Keller" }, "category": { "guid": "7P9SBO90NQ9J2L0778VN" }, "checkedOut": false, "corrected": false, "creationDateTime": "2011-07-05T23:25:38Z", "description": null, "edition": "1", "format": "pdf", "guid": "FXH0JWH8VYHXGZ2TFLZS", "hasMarkup": false, "lastModifiedDateTime": "2011-07-05T23:26:08Z", "latest": true, "location": null, "locked": true, "mimeType": "application/pdf", "name": "RoHS Certificate of Compliance 2.pdf", "number": "FILE-000942", "private": false, "size": 29846, "storageMethodName": "FILE", "title": "RoHS Certificate of Compliance" }, "guid": "9RBUDQB2PS9H0J0S5FOB" }, { "file": { "author": { "fullName": "Kathy Davies" }, "category": { "guid": "CUEXGTE5SVEO7Q5CCD07" }, "checkedOut": false, "corrected": false, "creationDateTime": "2011-06-16T21:36:24Z", "description": "Rendered and color from 20-0002 base drawing", "edition": "2", "format": "png", "guid": "CUEXGTE5SVEUDWZQCIWW", "hasMarkup": false, "lastModifiedDateTime": "2011-06-16T21:36:24Z", "latest": true, "location": null, "locked": true, "mimeType": "image/x-png", "name": "EveryRoad Render4.png", "number": "FILE-000875", "private": false, "size": 74607, "storageMethodName": "FILE", "title": "EveryRoad GPS Car Navigation Unit - Model 300, Rendering" }, "guid": "ASCVERC3QTAI1K1T6GP6" }, ... ] } ``` -------------------------------- ### GET /imports//runs/ Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Import Engine/Import Run/endpoint_get_import_run.md Retrieves the details of a specific import run using the import GUID and the run GUID. ```APIDOC ## GET /imports//runs/ ### Description Returns an Import Run with a given GUID. ### Method GET ### Endpoint /imports//runs/ ### Parameters #### Path Parameters - **GUID** (string) - Required - The unique identifier for the import. - **GUID** (string) - Required - The unique identifier for the run. ### Request Header - **arena_session_id** (string) - Required - Unique ID for session obtained from login - **content-type** (string) - Required - application/json ### Response #### Success Response (200) - **guid** (string) - The unique identifier of the run - **number** (number) - The run number - **creationDateTime** (string) - ISO 8601 timestamp of creation - **creator** (object) - Information about the user who created the run - **status** (string) - The current status of the run (e.g., COMPLETE) #### Response Example { "guid": "R9TCQNRT4L47Q9VQWUF3", "number": 14, "creationDateTime": "2021-09-15T00:00:00Z", "creator": { "email": "rjones@arenasolutions.com", "fullName": "Roy Arena", "guid": "4M6P3046HYFYH0J258QJ" }, "status": "COMPLETE" } ``` -------------------------------- ### Response Body Examples Source: https://github.com/ptc-arena/arena-restapi-doc/blob/main/Arena REST API/Endpoints/Change Implementation Tasks/Implementation Task Files/endpoint_post_change_implementationtask_file.md Examples of successful and error response bodies for the implementation task file operation. ```json { "guid": "I0K3HEIKVCT8RATCV2DU", "file": { "guid": "GYI1FCGITAT9SB0IJX9M", "number": "FILE-046012", "edition": "1", "name": "implementation plan.pdf", "storageMethodName": "FILE", "title": "Implementation Plan" } ``` ```json { "status":400, "errors":[ { "code":3011, "message":"The guid \"XFWQ0GZGZDJ015J12\" is not valid." } ] } ```