Abstract
DFDL Service provides DFDL inspection service which generate an AtlasMap Document object from instance document or DFDL schema.

1. Endpoints

1.1. Default

1.1.1. inspect

POST /dfdl/inspect

Inspect DFDL

Description

Inspect a DFDL schema or instance and return a Document object

Parameters
Body Parameter
Name Description Required Default Pattern

DfdlInspectionRequest

DfdlInspectionRequest object DfdlInspectionRequest

-
Return Type

DfdlInspectionResponse

Content Type

  • application/json

Responses
Table 1. HTTP Response Codes
Code Message Datatype

200

Return a Document object represented by XmlDocument

DfdlInspectionResponse
Samples

1.1.2. simpleHelloWorld

GET /dfdl/simple

Simple

Description

Simple hello service

Parameters
Query Parameters
Name Description Required Default Pattern

from

-

null
Return Type

[String]

Content Type

  • text/plain

Responses
Table 2. HTTP Response Codes
Code Message Datatype

200

Return a response

[String]
Samples

2. Models

2.1. Action

Field Name Required Nullable Type Description Format

@type

String

2.2. DfdlInspectionRequest

Field Name Required Nullable Type Description Format

fieldNameExclusions

StringList

typeNameExclusions

StringList

namespaceExclusions

StringList

xmlData

String

uri

String

type

[String]

Enum: ALL, INSTANCE, SCHEMA, NONE,

dfdlSchemaName

String

options

Map of [string]

jsonType

X

String

2.3. DfdlInspectionResponse

Field Name Required Nullable Type Description Format

xmlDocument

XmlDocument

errorMessage

String

executionTime

Long

int64

jsonType

X

String

2.4. Field

Field Name Required Nullable Type Description Format

actions

List of Action

value

Object

arrayDimensions

Integer

int32

arraySize

Integer

int32

collectionType

[String]

Enum: ALL, ARRAY, LIST, MAP, NONE,

docId

String

index

Integer

int32

path

String

required

Boolean

status

[String]

Enum: SUPPORTED, UNSUPPORTED, CACHED, ERROR, NOT_FOUND, EXCLUDED,

fieldType

[String]

Enum: ANY, ANY_DATE, BIG_INTEGER, BOOLEAN, BYTE, BYTE_ARRAY, CHAR, COMPLEX, DATE, DATE_TIME, DATE_TIME_TZ, DATE_TZ, DECIMAL, DOUBLE, FLOAT, INTEGER, LONG, NONE, NUMBER, SHORT, STRING, TIME, TIME_TZ, UNSIGNED_BYTE, UNSIGNED_INTEGER, UNSIGNED_LONG, UNSIGNED_SHORT, UNSUPPORTED,

format

String

name

String

jsonType

X

String

2.5. Fields

Field Name Required Nullable Type Description Format

field

List of Field

2.6. StringList

Field Name Required Nullable Type Description Format

string

List of [string]

2.7. XmlDocument

Field Name Required Nullable Type Description Format

fields

Fields

xmlNamespaces

XmlNamespaces

jsonType

X

String

2.8. XmlNamespace

Field Name Required Nullable Type Description Format

alias

String

uri

String

locationUri

String

targetNamespace

Boolean

2.9. XmlNamespaces

Field Name Required Nullable Type Description Format

xmlNamespace

List of XmlNamespace