Website logo
Docs
API Reference
Postman Collection
Release Notes
Navigate through spaces
⌘K
Overview
API Reference Overview
How to use the API 'Try It' feature
Authentication And Authorization (AAA) Service
Role Management
User Management
Authentication
Connection Management
Group Management
Participant Service
Tenant
Participant Type
Participant Type - Custom Code Config
Participant Type - Attributes Config
Participant Type - State Machine
Participant
Templates
Participant State
Participant - Batch Processing
Container Service
Container Type
Container Type - Custom Code Config
Container Type - Attributes Config
Container Type - State Machine Config
Container
Container State
Container Group
Container - Batch Processing
Dispatch Service
Job Type
Job Workflow
Job
Job - Config
Dispatch Type
Dispatch
Mobile APIs
Dispatch - Config
Ledger
Ledger in batch
Custom Code Config
Workflow Service
Execution Task
Changelog
Execution Macro
Execution Workflow
Execution Workflow Instance
Health Check
SDS Service
App
Vault
Data
File Management Service
Folders
Files
State Machine Service
State Machine Config
Entity
Events
Reasons
Instance State
Movement Tracking Service
Trace Data
Missing Sequence Numbers
Snapped Distance
IOT Device
Geofence
MTS Subscription
Entity Service
Entity Type
State Machine Config
Entity Instance
Entity Type - Custom Code Config
Entity Instance State
Templates
Entity - Batch Processing
Notification Service
App Notification
Filter
Event
Change Log
Location Service
Location
Country
State
City
Search
Order Service
Order Config
Order State Machine Configuration
Order State Machine Transition
Work Order State Machine Configuration
Work Order State Transition
Order
Batch Order
Custom Code Config
Plugin Callback
External Reference APIs
Work Order Config
Work Order Status
Plugins
PluginWorkflow
Address Service
Address Config
Address
User FPA
Users
Facility FPA
Facilities
Vehicle FPA
Vehicles
LogisticsOrder API
Order
Batch Order
AAA - External Authorizer
Authorization
Orchestrator
Plugins
PluginWorkflow
Rules
Get Entity Status
DLQ Service
Query & Listing
Default Plugins
Job Manager
Work Order Manager
Container Manager
Workflow Manager
Cancellation Manager
Scheduler Service
Scheduler Service
Docs powered by Archbee
Participant Service
Participant Type

Get configuration of a participant type

1min
GET

API to get basic configuration of a participant type specified by participantTypeId. Important: Core Attributes Configuration and State Machine Configuration of the participant type is not included in the response.

PATH PARAMETERS
participantTypePluralName
ParticipantTypePluralName
*
A unique *plural name* i.e. a term that defines multiple participants of this participant type. This is used as collection name in resource URL for this participant type and as participant id prefix.
HEADER PARAMETERS
X-COREOS-REQUEST-ID
string
*
Unique requestId
X-COREOS-TID
string
*
Tenant id
X-COREOS-ACCESS
string
*

Unique core-os access token

X-COREOS-USERINFO
string

core-os user info

RESPONSES
200
OK. - The request succeeded.
ParticipantTypeResponse
data
ParticipantTypeResponseMetaData
request
Request
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error
ErrorResponse
error
Error
*
Error Information
request
Request
*
401
Unauthorized - The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that tenant.
ErrorResponse
error
Error
*
Error Information
request
Request
*
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
*
Error Information
request
Request
*




Updated 24 Aug 2023
Did this page help you?
PREVIOUS
Get all participant types and their configurations
NEXT
Update participant type configuration
Docs powered by Archbee