Abstract
Core Service provides basic operations which is not specific to the individual data formats, Create/Get/Update/Remove mapping definition stored in Design Time Service local storage, validate mapping, retrieve metadata for available field actions and etc.

1. Endpoints

1.1. Default

1.1.1. changeMappedFieldIndex

PUT /project/{mappingDefinitionId}/mapping/{mappingId}/field/{dataSourceType}/{fieldIndex}/index

Change Mapped Field Index

Description

Change the mapped field’s index value

Parameters
Path Parameters
Name Description Required Default Pattern

mappingDefinitionId

Mapping Definition ID

X

null

mappingId

Mapping ID

X

null

dataSourceType

Source or Target Mapping

X

null

fieldIndex

Current Mapped Field Index

X

null
Body Parameter
Name Description Required Default Pattern

body

[integer]

-
Return Type

-

Responses
Table 1. http response codes
Code Message Datatype

200

The mapped field formerly at index {fieldIndex} is now at {index}.

<<>>
Samples

1.1.2. deleteAll

DELETE /all

Delete all

Description

Delete all user-defined library JAR files and mapping projects

Parameters
Return Type

-

Responses
Table 2. http response codes
Code Message Datatype

200

All user-defined libarary JARs and mapping projects were deleted successfully

<<>>

204

Unable to delete all user-defined JAR files and mapping projects

<<>>
Samples

1.1.3. deleteAllMappingProjects

DELETE /project

Delete All Mapping projects

Description

Delete all mapping projects including Mapping Definitions and Documents saved on the server

Parameters
Return Type

-

Responses
Table 3. http response codes
Code Message Datatype

200

All mapping projects were deleted successfully

<<>>

204

Unable to delete all mapping projects

<<>>
Samples

1.1.4. deleteDocumentRequest

DELETE /project/{mappingDefinitionId}/document/{dataSourceType}/{documentId}

Delete Document

Description

Delete the Document

Parameters
Path Parameters
Name Description Required Default Pattern

mappingDefinitionId

Mapping Definition ID

X

null

dataSourceType

DataSource Type

X

null

documentId

Document ID

X

null
Return Type

-

Responses
Table 4. http response codes
Code Message Datatype

204

Document was not found

<<>>

500

Document access error

<<>>
Samples

1.1.5. deleteLibraries

DELETE /library

Remove All User-Defined JAR libraries

Description

Remove all user-defined JAR files saved on the server

Parameters
Return Type

-

Responses
Table 5. http response codes
Code Message Datatype

200

All user-defined JAR files were removed successfully

<<>>

204

Unable to remove all user-defined JAR files

<<>>
Samples

1.1.6. deleteMappingProjectById

DELETE /project/{mappingDefinitionId}

Delete Mapping Project by ID

Description

Delete the mapping project including a Mapping Definition and Documents related to specified ID

Parameters
Path Parameters
Name Description Required Default Pattern

mappingDefinitionId

Mapping Definition ID

X

null
Return Type

-

Responses
Table 6. http response codes
Code Message Datatype

200

Mapping project was removed successfully

<<>>

204

Unable to remove a mapping project for the specified ID

<<>>
Samples

1.1.7. getADMRequest

GET /project/{mappingDefinitionId}/adm

Get Mapping

Description

Retrieve a mapping file saved on the server

Parameters
Path Parameters
Name Description Required Default Pattern

mappingDefinitionId

Mapping ID

X

null
Return Type

[File]

Content Type

  • application/octet-stream

Responses
Table 7. http response codes
Code Message Datatype

200

Return an ADM file content

[File]

204

ADM file was not found

<<>>

500

ADM file access error

<<>>
Samples

1.1.8. getDocumentCatalogRequest

GET /project/{mappingDefinitionId}/document

Get DocumentCatalog

Description

Retrieve a Document catalog file saved on the server

Parameters
Path Parameters
Name Description Required Default Pattern

mappingDefinitionId

Mapping Definition ID

X

null
Return Type

DocumentCatalog

Content Type

  • application/json

Responses
Table 8. http response codes
Code Message Datatype

200

Return a DocumentCatalog content

DocumentCatalog

204

Document catalog file was not found

<<>>

500

Document catalog file access error

<<>>
Samples

1.1.9. getDocumentInspectionResultRequest

GET /project/{mappingDefinitionId}/document/{dataSourceType}/{documentId}/inspected

Get Document inspection result

Description

Get the Document inspection result

Parameters
Path Parameters
Name Description Required Default Pattern

mappingDefinitionId

Mapping Definition ID

X

null

dataSourceType

DataSource Type

X

null

documentId

Document ID

X

null
Return Type

-

Responses
Table 9. http response codes
Code Message Datatype

404

Document inspection result was not found

<<>>

500

Document inspection result access error

<<>>
Samples

1.1.10. getMappingRequest

GET /project/{mappingDefinitionId}/mapping

Get Mapping

Description

Retrieve a mapping file saved on the server

Parameters
Path Parameters
Name Description Required Default Pattern

mappingDefinitionId

Mapping Definition ID

X

null
Return Type

AtlasMapping

Content Type

  • application/json

  • application/xml

  • application/octet-stream

Responses
Table 10. http response codes
Code Message Datatype

200

Return a mapping file content

AtlasMapping

204

Mapping file was not found

<<>>

500

Mapping file access error

<<>>
Samples

1.1.11. importADMArchiveRequest

PUT /project/{mappingDefinitionId}/adm

Import ADM archive

Description

Import an ADM archive file on the server

Parameters
Path Parameters
Name Description Required Default Pattern

mappingDefinitionId

Mapping definition ID

X

null
Body Parameter
Name Description Required Default Pattern

body

ADM archive file content [binary]

-
Return Type

-

Responses
Table 11. http response codes
Code Message Datatype

200

Succeeded

<<>>

500

ADM archive file import error

<<>>
Samples

1.1.12. listFieldActions

GET /fieldAction

List FieldActions

Description

Retrieves a list of available field action

Parameters
Return Type

ActionDetails

Content Type

  • application/json

Responses
Table 12. http response codes
Code Message Datatype

200

Return a list of field action detail

ActionDetails
Samples

1.1.13. listLibraryClasses

GET /library/class

List Library Classes

Description

Retrieves a list of available Java library class names from uploaded JARs.

Parameters
Return Type

[ArrayList<String]>

Content Type

  • application/json

Responses
Table 13. http response codes
Code Message Datatype

200

Return a list of loadable class names

[ArrayList<String]>
Samples

1.1.14. listMappingBuilderClasses

GET /library/class/mappingBuilder

List mapping builder classes

Description

List mapping builder classes which defines custom mapping logic

Parameters
Return Type

[ArrayList<String]>

Content Type

  • application/json

Responses
Table 14. http response codes
Code Message Datatype

200

Return a list of loadable class names

[ArrayList<String]>
Samples

1.1.15. listMappingDefinitionNames

GET /project

List Mapping Definition names

Description

Retrieves a list of mapping definition names

Parameters
Query Parameters
Name Description Required Default Pattern

filter

-

null
Return Type

StringMap

Content Type

  • application/json

Responses
Table 15. http response codes
Code Message Datatype

200

Return a list of mapping definition names

StringMap
Samples

1.1.16. ping

GET /ping

Ping

Description

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

Parameters
Return Type

[String]

Content Type

  • /

Responses
Table 16. http response codes
Code Message Datatype

200

Return 'pong'

[String]
Samples

1.1.17. processMappingRequest

POST /project/{mappingDefinitionId}/mapping/process

Process Mapping

Description

Process Mapping by feeding input data

Parameters
Path Parameters
Name Description Required Default Pattern

mappingDefinitionId

Mapping Definition ID

X

null
Body Parameter
Name Description Required Default Pattern

AtlasMapping

Mapping file content AtlasMapping

-
Return Type

ProcessMappingResponse

Content Type

  • application/json

Responses
Table 17. http response codes
Code Message Datatype

200

Return a mapping result

ProcessMappingResponse

204

Skipped empty mapping execution

<<>>
Samples

1.1.18. removeAllMappingsRequest

DELETE /project/{mappingDefinitionId}/mapping

Remove All Mappings

Description

Remove all mappings from a mapping definition

Parameters
Path Parameters
Name Description Required Default Pattern

mappingDefinitionId

Mapping Definition ID

X

null
Return Type

-

Responses
Table 18. http response codes
Code Message Datatype

200

All mappings for the specified mapping definition were removed successfully

<<>>

204

The specified mapping definition was not found

<<>>
Samples

1.1.19. removeFieldMappingRequest

DELETE /project/{mappingDefinitionId}/mapping/{mappingId}/field/{dataSourceType}/{fieldIndex}

Remove Field From Mapping

Description

Remove the specific field from the specified mapping in the mapping definition

Parameters
Path Parameters
Name Description Required Default Pattern

mappingDefinitionId

Mapping Definition ID

X

null

mappingId

Mapping ID

X

null

dataSourceType

Source or Target Mapping

X

null

fieldIndex

Field Index

X

null
Return Type

-

Responses
Table 19. http response codes
Code Message Datatype

200

The mapping at the specified index within the specified mapping definition was removed successfully

<<>>

204

The specified mapping definition was not found

<<>>
Samples

1.1.20. removeMappingRequest

DELETE /project/{mappingDefinitionId}/mapping/{mappingIndex}

Remove Mapping

Description

Remove a specific mapping from the mapping definition

Parameters
Path Parameters
Name Description Required Default Pattern

mappingDefinitionId

Mapping Definition ID

X

null

mappingIndex

Mapping Index

X

null
Return Type

-

Responses
Table 20. http response codes
Code Message Datatype

200

The mapping at the specified index within the specified mapping definition was removed successfully

<<>>

204

The specified mapping definition was not found

<<>>
Samples

1.1.21. setDocumentNameRequest

PUT /project/{mappingDefinitionId}/document/{dataSourceType}/{documentId}/name

Set Document Name

Description

Set the Document Name of an existing Document

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

body

[string]

-
Return Type

-

Responses
Table 21. http response codes
Code Message Datatype

204

Document was not found

<<>>

500

Document access error

<<>>
Samples

1.1.22. updateMappingRequest

PUT /project/{mappingDefinitionId}/mapping

Update Mapping

Description

Update existing mapping file on the server

Parameters
Path Parameters
Name Description Required Default Pattern

mappingDefinitionId

Mapping Definition ID

X

null
Body Parameter
Name Description Required Default Pattern

AtlasMapping

Mapping file content AtlasMapping

-
Return Type

-

Responses
Table 22. http response codes
Code Message Datatype

200

Succeeded

<<>>
Samples

1.1.23. uploadLibrary

PUT /library

Upload Library

Description

Upload a Java library archive file

Parameters
Body Parameter
Name Description Required Default Pattern

body

[object]

-
Return Type

-

Responses
Table 23. http response codes
Code Message Datatype

200

Library upload successful.

<<>>
Samples

1.1.24. validateMappingRequest

POST /project/{mappingDefinitionId}/mapping/validate

Validate Mapping

Description

Validate mapping file

Parameters
Path Parameters
Name Description Required Default Pattern

mappingDefinitionId

Mapping Definition ID

X

null
Body Parameter
Name Description Required Default Pattern

AtlasMapping

Mapping file content AtlasMapping

-
Return Type

Validations

Content Type

  • application/json

Responses
Table 24. http response codes
Code Message Datatype

200

Return a validation result

Validations
Samples

1.1.25. version

GET /version

Version

Description

Retrieves AtlasMap core library version.

Parameters
Return Type

[String]

Content Type

  • /

Responses
Table 25. 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. ActionDetail

Field Name Required Type Description Format

parameters

ActionParameters

name

String

custom

Boolean

className

String

method

String

sourceType

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,

targetType

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,

multiplicity

String

Enum: ONE_TO_ONE, ONE_TO_MANY, MANY_TO_ONE, ZERO_TO_ONE, MANY_TO_MANY,

actionSchema

JsonSchema

2.3. ActionDetails

Field Name Required Type Description Format

actionDetail

List of ActionDetail

2.4. ActionParameter

Field Name Required Type Description Format

values

List of [string]

name

String

displayName

String

description

String

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,

2.5. ActionParameters

Field Name Required Type Description Format

parameter

List of ActionParameter

2.6. AtlasMapping

Field Name Required Type Description Format

dataSource

List of DataSource

mappings

Mappings

lookupTables

LookupTables

constants

Constants

properties

Properties

name

String

version

String

jsonType

X

String

2.7. AtlasMappingResult

Field Name Required Type Description Format

targetDocuments

List of TargetDocument

audits

Audits

2.8. Audit

Field Name Required Type Description Format

message

String

docId

String

docName

String

path

String

value

String

status

String

Enum: ALL, INFO, WARN, ERROR, NONE,

2.9. Audits

Field Name Required Type Description Format

audit

List of Audit

2.10. BaseMapping

Field Name Required Type Description Format

alias

String

description

String

mappingType

String

Enum: ALL, COLLECTION, COMBINE, LOOKUP, MAP, SEPARATE, NONE,

jsonType

X

String

2.11. Constant

Field Name Required Type Description Format

name

String

value

String

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,

2.12. Constants

Field Name Required Type Description Format

constant

List of Constant

2.13. DataSource

Field Name Required Type Description Format

id

String

name

String

description

String

uri

String

dataSourceType

String

Enum: SOURCE, TARGET,

characterEncoding

String

locale

String

jsonType

X

String

2.14. DocumentCatalog

Field Name Required Type Description Format

sources

List of DocumentMetadata

targets

List of DocumentMetadata

2.15. DocumentMetadata

Field Name Required Type Description Format

id

String

name

String

description

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,

inspectionParameters

Map of [string]

fieldNameExclusions

StringList

typeNameExclusions

StringList

namespaceExclusions

StringList

2.16. 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.17. FieldGroup

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

field

List of Field

2.18. JsonSchema

Field Name Required Type Description Format

id

String

get$ref

String

get$schema

String

disallow

List of JsonSchema

required

Boolean

readonly

Boolean

description

String

extends

List of JsonSchema

type

X

String

2.19. LookupEntry

Field Name Required Type Description Format

sourceValue

String

sourceType

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,

targetValue

String

targetType

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,

2.20. LookupTable

Field Name Required Type Description Format

lookupEntry

List of LookupEntry

name

String

description

String

2.21. LookupTables

Field Name Required Type Description Format

lookupTable

List of LookupTable

2.22. Mapping

Field Name Required Type Description Format

alias

String

description

String

mappingType

String

Enum: ALL, COLLECTION, COMBINE, LOOKUP, MAP, SEPARATE, NONE,

expression

String

inputFieldGroup

FieldGroup

inputField

List of Field

outputField

List of Field

id

String

delimiter

String

delimiterString

String

lookupTableName

String

strategy

String

strategyClassName

String

jsonType

X

String

2.23. Mappings

Field Name Required Type Description Format

mapping

List of BaseMapping

2.24. ProcessMappingResponse

Field Name Required Type Description Format

mapping

Mapping

audits

Audits

atlasMappingResult

AtlasMappingResult

jsonType

X

String

2.25. Properties

Field Name Required Type Description Format

property

List of Property

2.26. Property

Field Name Required Type Description Format

name

String

value

String

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,

scope

String

dataSourceType

String

Enum: SOURCE, TARGET,

2.27. StringList

Field Name Required Type Description Format

string

List of [string]

2.28. StringMap

Field Name Required Type Description Format

stringMapEntry

List of StringMapEntry

2.29. StringMapEntry

Field Name Required Type Description Format

name

String

value

String

2.30. TargetDocument

Field Name Required Type Description Format

body

String

docId

String

2.31. Validation

Field Name Required Type Description Format

message

String

id

String

docId

String

docName

String

scope

String

Enum: ALL, DATA_SOURCE, MAPPING, LOOKUP_TABLE, CONSTANT, PROPERTY,

status

String

Enum: ALL, INFO, WARN, ERROR, NONE,

2.32. Validations

Field Name Required Type Description Format

validation

List of Validation