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

1. Endpoints

1.1. Default

1.1.1. importXmlDocument

POST /xml/project/{mappingDefinitionId}/document/{dataSourceType}/{documentId}

Import XML

Description

Import a XML schema or instance and return a Document object

Parameters
Path Parameters
Name Description Required Default Pattern

mappingDefinitionId

Mapping Definition ID

X

null

dataSourceType

DataSource Type

X

null

documentId

Document ID

X

null

Body Parameter
Name Description Required Default Pattern

XmlInspectionRequest

XmlInspectionRequest object XmlInspectionRequest

-

Return Type
Content Type
  • application/json

Responses
Table 1. http response codes
Code Message Datatype

200

Return a Document object represented by XmlDocument

XmlInspectionResponse

Samples

1.1.2. ping

GET /xml/ping

Ping

Description

Simple liveness check method used in liveness checks. Must not be protected via authetication.

Parameters
Return Type
Content Type
  • text/plain

Responses
Table 2. http response codes
Code Message Datatype

200

Return 'pong'

[String]

Samples

2. Models

2.1. Action

Field Name Required Type Description Format

@type

String

2.2. Field

Field Name Required 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, ENUM, 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.3. Fields

Field Name Required Type Description Format

field

List of Field

2.4. StringList

Field Name Required Type Description Format

string

List of [string]

2.5. XmlDocument

Field Name Required 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, ENUM, FLOAT, INTEGER, LONG, NONE, NUMBER, SHORT, STRING, TIME, TIME_TZ, UNSIGNED_BYTE, UNSIGNED_INTEGER, UNSIGNED_LONG, UNSIGNED_SHORT, UNSUPPORTED,

format

String

name

String

fields

Fields

xmlNamespaces

XmlNamespaces

jsonType

X

String

2.6. XmlInspectionRequest

Field Name Required Type Description Format

documentId

String

documentName

String

documentDescription

String

uri

String

dataSourceType

String

Enum: SOURCE, TARGET,

documentType

String

Enum: CORE, CSV, DFDL, JAVA, JSON, KAFKA_AVRO, KAFKA_JSON, XML, XSD, CONSTANT, PROPERTY,

inspectionType

String

Enum: SCHEMA, INSTANCE, JAVA_CLASS,

options

Map of [string]

fieldNameExclusions

StringList

typeNameExclusions

StringList

namespaceExclusions

StringList

inspectPaths

List of [string]

searchPhrase

String

xmlData

String

jsonType

X

String

2.7. XmlInspectionResponse

Field Name Required Type Description Format

xmlDocument

XmlDocument

errorMessage

String

executionTime

Long

int64

jsonType

X

String

2.8. XmlNamespace

Field Name Required Type Description Format

alias

String

uri

String

locationUri

String

targetNamespace

Boolean

2.9. XmlNamespaces

Field Name Required Type Description Format

xmlNamespace

List of XmlNamespace