Skip to main content
Altcraft Docs LogoAltcraft Docs Logo
User guideDeveloper guideAdmin guide
Company siteHelp center
English
  • Русский
  • English
v73
  • v74
  • v73
  • v72
Login
  • Getting Started
  • Administrator documentation
  • Functional characteristics
  • Technology description
  • System requirements
  • Admin Panel
  • Platform installation
  • Platform configuration
  • Platform maintenance
  • Custom channels guide
    • Overview
    • Creating and configuring a channel
    • Entity field configuration
    • Template language
    • Entities
    • Pipes
      • Pipe: Basic Concepts
      • Result
      • Errors
      • Log
      • Pack
      • Unpack
      • HTTP Request
      • Store Set
      • Store Get
      • Selector
      • SQL
      • Eventer
      • Scheduler
    • Pipelines
  • Extra
  • Processing HTTP/HTTPS traffic
  • Administrator API
This is documentation for Altcraft Platform v73. This documentation is no longer maintained.
The information for up-to-date platform version at this page is available (v74).
  • Custom channels guide
  • Pipes
  • Unpack
Documentation for version v73

Unpack

Description​

The Unpack pipe unmarshals JSON or XML from the $in.body field and writes the result to $in.data

Peculiarities:

$in.body must be a byte array

Structure​

FieldType of valueExampleRequiredDescription
idnumber10yesPipe's ID
typestring"unpack"yesType of a pipe
paramsUnpackParamsObject
noType-specific parameters
outsOutsObject
noPipe's outputs

UnpackParamsObject
FieldTypeExampleReqieredDefaultDescription
typestring"JSON"no"JSON"Format. Possible values: -JSON - XML

Errors​

  1. $in.body is not found.
  2. $in.body is not a byte array.
  3. params.type is not valid
  4. Byte unmarshalling error.

Examples​

{
"id": 10,
"type": "unpack",
"params": {
"type": "XML"
},
"outs": {
"success": 20,
"error": 1000
}
}
{
"id": 10,
"type": "unpack",
"outs": {
"success": 15,
"error": 1001
}
}
Last updated on Nov 13, 2023
Previous
Pack
Next
HTTP Request
  • Description
  • Structure
  • Errors
  • Examples
© 2015 - 2025 Altcraft, LLC. All rights reserved.