Enum reference

Many parameters accept enum values rather than arbitrary strings. The tables below list every valid value. Pass the enum member from the SDK (e.g. JobStatusName.COMPLETED) or the equivalent string when calling the REST API.

AccessRelation

Value	Description
viewer	Read-only access
editor	Read-write access
owner	Full ownership including sharing
administrator	Administrative privileges
executor	Permission to execute jobs
upstreamremoteowner	Owner of an upstream remote

AccessResourceType

Value
model | artifact | job | file | filerevision | tool | function | functionversion | tenant | system | functionauthsecret | authintegration | document

AccessSubjectType

Value
user

AgentStatusName

Value	Description
Idle	Agent is idle and available
ClaimingJob	Agent is claiming a job
ValidatingJob	Agent is validating a job
ExecutingJob	Agent is executing a job
UploadingJob	Agent is uploading job results
ExecutionFailed	Job execution failed
ExecutionSuccess	Job execution succeeded
UpdatingAgent	Agent is being updated
SuccessfulAgentUpdate	Agent update succeeded
FailedAgentUpdate	Agent update failed
UpdatingModule	Module is being updated
SuccessfulModuleUpdate	Module update succeeded
FailedModuleUpdate	Module update failed
Paused	Agent is paused
Unknown	Status is unknown

ArchiveStatus

Used for filtering list endpoints.

Value	Description
active	Only active (non-archived) items
archived	Only archived items
all	Both active and archived items

ArchiveStatusName

Value
Archived | Active

AuthIntegrationType

Value	Description
google_accounts	Google Accounts
windchill	PTC Windchill
teamwork_cloud	Cameo/TWC Teamwork Cloud
dassault_3d_passport	Dassault 3DPassport
ping_id	Ping Identity
microsoft_entra	Microsoft Entra ID

BulkSharingAccessRelation

Value
viewer | editor

ControlTaggingObjectType

Value
model | artifact | file | user | system | resource | unknown

FilterBy

Value	Description
created_by_id	Resources created by the current user
-created_by_id	Resources shared with the current user (not created by them)

FunctionAuthType

Value	Description
jwt	JSON Web Token
token	Static token
basic	HTTP Basic Auth
oauth1	OAuth 1.0
oauth2	OAuth 2.0
cas_delegated_3dx	CAS-delegated 3DEXPERIENCE

JobStatusName

Value	Description
Created	Job has been created
Pending	Job is queued and waiting for an agent
Claimed	An agent has claimed the job
Validating	Agent is validating the job inputs
Running	Job is executing
Uploading	Agent is uploading results
Completed	Job finished successfully
Failed	Job execution failed
Canceled	Job was canceled
Unknown	Status is unknown

OS

Identifies the target operating system for job execution.

Value
Windows 11 | Windows 10 | Windows Server 2019 | Windows Server 2022 | Ubuntu 24.04 | Ubuntu 22.04 | Ubuntu 20.04 | RHEL 8 | RHEL 9 | RHEL 10 | macOS 14 | macOS 15 | macOS 26

PatchOp

Value	Description
set	Add or replace
delete	Remove

Permission

Value
member | manage | view | edit | execute | archive | tenant_access | controltag_access | controltag_manage | infoseclevel_access | infoseclevel_manage | access_own_manage | access_administrate_manage | access_edit_manage | access_view_manage | upstream_remote_sync | access

PermissionResourceType

Value
model | agent | agentpool | artifact | file | comment | filerevision | token | job | tool | function | functionversion | system | tenant | controltag | infoseclevel | functionauthsecret | upstreamremote | authintegration | document | resource

PermissionSubjectType

Value
user | model | agent | agentpool | artifact | file | comment | filerevision | token | job | tool | function | functionversion | system | tenant | controltag | infoseclevel | functionauthsecret | authintegration | upstreamremote | document | resource

ResourceType

Value
model | artifact | comment | job | document | resource

ToolInclude

Value	Description
functions	Include functions in response
function_versions	Include function versions in response

TrackedFileSpecifierType

Value
Locked | Latest

UsabilityStatusParams

Value
supported | deprecated | all

UserModelInputs

Value	Description
single	Function accepts a single user model
multiple	Function accepts multiple user models

UserStateOption

Value
active | all

UserType

Value
human | agent | all