Articles in this section

Available Arena APIs

When you configure an export, import, or other type of flow step using the prebuilt Arena connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Arena documentation. *You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Change

Get changes ticket references

X

Change affected item

Get change affected items

X

Get change affected item

X

Post change affected item add

X

Put change affected item edit

X

Delete Change Affected Item

X

Change implementation

Get change implementation tasks

X

Get change implementation task

X

Get change implementation task notes

X

Get change implementation task note

X

Get change implementation task files

X

Get change implementation task file

X

Delete remove a request from a change

X

Post change implementation task

X

Put change implementation task

X

Delete change implementation task

X

Post change implementation task note

X

Put change implementation task note

X

Delete change implementation task note

X

Post change implementation task file

X

Delete change implementation task file

X

Data extract

Get extracts search

X

Get extract

X

Get extract runs search

X

Get extract run

X

Get data extract latest

X

Get extract run files

X

Get extract run file content

X

Post-change status (complete)

X

Quality processes/status changes (reopen a quality process)

X

Event

Get events (search)

X

Get event

X

Get event item GUIDs

X

Get event item

X

Put event

X

Put event item

X

Export

Get export definitions (search)

X

Get export definition

X

Post export definition

X

Export run

Get extract runs

X

Get extract run

X

Get extract run files

X

Post export run

X

Post export run (multiple GUIDs)

X

File edition

Get file editions

X

Get file corrections

X

Get file correction

X

Post file correct

X

Post file checkout

X

Post cancel file checkout

X

Post file check-in

X

File markup

Get file markups

X

Get request file markups

X

Get file markup

X

Get file markup content

X

Delete request file markup

X

Post file markup create

X

Put file markup update

X

Delete file markup

X

File request association

Get file request associations

X

Get file request association

X

Files

Get files search

X

Get file summary

X

Get file content

X

Post file create

X

Put file summary update

X

Post file content update

X

Delete file

X

Get request

Get requests

X

Get request items

X

Get request file view associations

X

Get request files view association

X

Put request edit

X

Post request item add

X

Put item update

X

Delete request item

X

Post request files view add existing file

X

Delete request file view association

X

Import

Get import definitions (search)

X

Get import definition

X

Import run

Get import run

X

Get import run submit content file content

X

Get import run result content

X

Get import run error content

X

Arena extracts API

X

Post import run API endpoint

X

Integrations

Get integrations (search)

X

Get integrations

X

Item BOM

Get BOM

X

Get BOM line

X

Get BOM settings

X

Get BOM substitutes

X

Get BOM substitute

X

Get BOM attributes

X

Post BOM line create

X

Put BOM line update

X

Put BOM settings update

X

Delete BOM line

X

Post BOM substitute create

X

Put BOM substitute create

X

Delete BOM substitute

X

Item compliance

Get item compliance requirements

X

Put item compliance update

X

Item files

Get file item associations

X

Get file item association

X

Get item file associations

X

Post item file create

X

Post item file add existing

X

Post item file content update

X

Put item file association update

X

Delete item file association

X

Item lifecycle phase change

Post item lifecycle phase change

X

Item quality

Get item quality processes

X

Item references

Get item-to-item references

X

Get item ticket references

X

Post item-to-item reference create

X

Put item-to-item reference update

X

Delete item-to-item reference

X

Item revision

Get item revisions

X

Get item future changes

X

Items

Get items (search)

X

Get items (search) criteria parameter

X

Get item specs

X

Get item thumbnail image content

X

Post item create

X

Put item update

X

Create thumbnail image for item specs

X

Post item specs thumbnail image create from files view

X

Delete item thumbnail image

X

Delete supplier item thumbnail image

X

Outbound event integrations

Get outbound-events integrations (search)

X

Get outbound-event integrations

X

Get outbound-event integration triggers

X

Get outbound-event integration trigger

X

Get integration administrators

X

Get Outbound-events integration events

X

Get outbound-event integration event

X

Get outbound-event integration requests event

X

Get outbound-event integration changes event

X

Get outbound-event integration quality event

X

User profile API

X

Put outbound-event event item reconcile

X

Put outbound-event event change reconcile

X

Put outbound-event event quality reconcile

X

Quality process

Get file quality process associations

X

Get training plans associated with a file

X

Get a training plan associated with a file

X

Get quality processes search

X

Get quality process summary

X

Post quality process create

X

Put quality process update

X

Delete quality process

X

Post quality process complete

X

Post quality process reopen

X

Quality process affected

Get quality process step affected objects

X

Get quality process step affected object

X

Post quality process step affected object add

X

Delete quality process step affected object

X

Quality process steps

Get quality process steps

X

Get quality process step

X

Get quality process step decisions

X

Put quality process step update (user assignee)

X

Post quality process step complete

X

Post quality process step reopen

X

Recent activity

Get recent activity - user access

X

Get recent activity - exports

X

Get recent activity - report runs

X

Get recent activity - file access

X

Settings

Get request evaluator groups

X

Get change administrators

X

Get change attributes

X

Get change item attributes

X

Get change number prefixes

X

Get change category attributes

X

Get change categories

X

Get export setting attributes

X

Get requests categories

X

Get request attributes

X

Get request item attributes

X

Get request number prefixes

X

Get request number sequences

X

Get request administrators

X

Get change routings

X

Get change implementation task templates

X

Get change implementation task template

X

Get supplier attributes

X

Get file attributes

X

Get tickets number sequences

X

Get tickets templates

X

Get tickets templates attributes

X

Get users

X

Get user groups

X

Get user group

X

Get user group employees

X

Get item attributes

X

Get item categories

X

Get item category attributes

X

Get supplier item attributes

X

Supplier

Get suppliers

X

Get supplier (profile)

X

Get supplier address

X

Get supplier addresses

X

Get supplier profile phone numbers

X

Get supplier phone number

X

Post supplier create

X

Put supplier update

X

Delete supplier

X

Post supplier profile address create

X

Post supplier phone number create

X

Put supplier profile address edit

X

Put supplier phone number edit

X

Delete supplier address

X

Delete supplier phone number

X

Delete supplier file

X

Supplier item

Get supplier items

X

Get supplier item specs

X

Delete supplier item

X

Post supplier item create

X

Put supplier item update

X

Supplier item compliance

Get supplier item compliance requirements

X

Get supplier item compliance requirement

X

Post supplier item compliance

X

Put supplier item compliance update

X

Delete supplier item compliance

X

Supplier item files

Get file supplier item associations

X

Get file change associations

X

Get file change association

X

Get file supplier associations

X

Get file supplier associations

X

Get supplier item file associations

X

Get supplier item file content

X

Post supplier item file create

X

Post supplier item file content update

X

Post supplier item file add existing

X

Put supplier item file association update

X

Delete supplier item file association

X

Supplier item quality

Get supplier item quality processes

X

Supplier item sourcing

Get supplier item source relationships

X

Get supplier item source relationship

X

Supplier quality

Get supplier quality processes

X

Tickets

Get tickets

X

Get ticket

X

Get ticket files

X

Get ticket changes

X

Get ticket items

X

Get ticket quality processes

X

Get ticket tickets

X

Post ticket create

X

Put ticket edit

X

Post ticket status change

X

Delete ticket

X

Post tickets files view add existing file

X

Delete ticket remove file association

X

Post tickets add change reference

X

Delete ticket remove change association

X

Delete ticket remove item association

X

Post tickets add quality process reference

X

Delete ticket remove quality process association

X

Post tickets add ticket reference

X

Delete ticket remove ticket association

X

Training items

Get training records associated with an item

X

Get a training record associated with an item

X

Training plan

Get training plan record

X

Get training plan records

X

Get training plan quality process reference

X

Get training plan quality process references

X

Get training plan file

X

Get training plan files

X

Get training plan item

X

Get training plan items

X

Get training plan user

X

Get training users

X

Get training manager

X

Get training managers

X

Get training plan number sequences

X

Get training plan number sequence

X

Get training plan

X

Get training plans (search)

X

Delete training plan quality process

X

Post add training plan quality process

X

Delete training plan item

X

Post add training plan item

X

Post training plans files view add existing file

X

Delete training plans remove file association

X

Delete training plan users

X

Put update training plan user

X

Post add training plan users

X

Put training plan edit

X

Post training plans status change

X

Delete training plans

X

Post training plan create

X

Triggers

Get triggers

X

Get trigger

X

User

User information API

X

Post user with include profile

X

Post user

X

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.