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
Container Service
Container

containerization/decontainerization of the container

1min
PUT

Grouping together container into a container. The container that goes inside another container is said to be containerized.

  • containerId - The child container ID that needs to be add in parent container.

  • parentId - The parent container ID that needs to be add as parent of a container.

  • action - field to represent action to be performed on the container.

PARAMETERDESCRIPTIONTYPEVALIDATION
parentId*Field to represent container ID of the parent container. During the containerization process, this value is assigned to represent which container contains this container.stringExample- box:9c9b1138-7cdd-11eb-9439-0242ac130002
action*field to represent action to be performed on the container.field to represent action to be performed on the container.
callbackRepresents callback URL, which can be to notify status(success/failed) of API.stringA valid URL.
*This is required.
HTTP Status Code Summary
CodeDescription
202 - Accepted
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
404 - Not FoundThe requested resource doesn't exist.
503 - Server ErrorSomething went wrong.. (These are rare.)
PATH PARAMETERS
containerId
string
*
Example: container:9c9b1138-7cdd-11eb-9439-0242ac130002
Unique id of Container
HEADER PARAMETERS
X-COREOS-REQUEST-ID
string
*
Unique request id.
X-COREOS-TID
string
*
Example: delhivery1234
Tenant id
X-COREOS-ACCESS
string
*

Core-os access token

X-COREOS-USERINFO
string

Core-os user info

X-COREOS-CALLBACK-SECRET
string

Core-os access token

BODY PARAMETERS
body
ParentIdRequest
*
parent id
parentId
string
*
Example: box:9c9b1138-7cdd-11eb-9439-0242ac130002
Field to represent container ID of the parent container. During the containerization process, this value is assigned to represent which container contains this container.
action
string<CONTAINERIZE | DECONTAINERIZE>
*
Example: CONTAINERIZE
Field to represent action to be performed on the container.
RESPONSES
202
Containerization or decontainerization
ChildContainerResponse
data
object
request
Request
400
Bad Request
ErrorResponse
error
Error
Error Information
request
Request
401
Unauthorized
ErrorResponse
error
Error
Error Information
request
Request
404
Not Found
ErrorResponse
error
Error
Error Information
request
Request
503
Server Error
ErrorResponse
error
Error
Error Information
request
Request




Updated 24 Aug 2023
Did this page help you?
PREVIOUS
Fetch details of container by trackingId
NEXT
containerization/decontainerization of the container
Docs powered by Archbee