TransformerSummary

Contains the details for a transformer object. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.

createdAt

Returns a timestamp indicating when the transformer was created. For example, 2023-07-20T19:58:44.624Z.

Type: Timestamp

Required: Yes

ediType

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

Type: EdiType object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

fileFormat

Returns that the currently supported file formats for EDI transformations are JSON and XML.

Type: String

Valid Values: XML | JSON

Required: Yes

mappingTemplate

Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 350000.

Required: Yes

name

Returns the descriptive name for the transformer.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 254.

Required: Yes

status

Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.

Type: String

Valid Values: active | inactive

Required: Yes

transformerId

Returns the system-assigned unique identifier for the transformer.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_-]+

Required: Yes

modifiedAt

Returns a timestamp representing the date and time for the most recent change for the transformer object.

Type: Timestamp

Required: No

sampleDocument

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

TransformerSummary

Contents

See Also