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

1. Endpoints

1.1. Default

1.1.1. getClass

GET /json/inspect

Inspect JSON via URI

Description

NOT IMPLEMENTED Inspect a JSON schema or instance located at specified URI and return a Document object

Parameters
Body Parameter
Name Description Required Default Pattern

body

Inspection type, one of `instance` or `Schema` [string]

-

Query Parameters
Name Description Required Default Pattern

uri

URI for JSON schema or instance

-

null

type

-

null

Return Type
Content Type
  • application/json

Responses
Table 1. http response codes
Code Message Datatype

200

Return a Document object represented by JsonDocument

JsonDocument

Samples

1.1.2. inspectClass

POST /json/inspect

Inspect JSON

Description

Inspect a JSON schema or instance and return a Document object

Parameters
Body Parameter
Name Description Required Default Pattern

JsonInspectionRequest

JsonInspectionRequest object JsonInspectionRequest

-

Content Type
  • application/json

Responses
Table 2. http response codes
Code Message Datatype

200

Return a Document object represented by JsonDocument

JsonInspectionResponse

Samples

1.1.3. simpleHelloWorld

GET /json/simple

Simple

Description

Simple hello service

Parameters
Query Parameters
Name Description Required Default Pattern

from

From

-

null

Return Type
Content Type
  • text/plain

Responses
Table 3. http response codes
Code Message Datatype

200

Return a response

[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, BLACK_LIST,

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.3. Fields

Field Name Required Type Description Format

field

List of Field

2.4. JsonDocument

Field Name Required Type Description Format

fields

Fields

jsonType

X

String

2.5. JsonInspectionRequest

Field Name Required Type Description Format

fieldNameBlacklist

StringList

typeNameBlacklist

StringList

namespaceBlacklist

StringList

jsonData

String

uri

String

type

String

Enum: ALL, INSTANCE, SCHEMA, NONE,

jsonType

X

String

2.6. JsonInspectionResponse

Field Name Required Type Description Format

jsonDocument

JsonDocument

errorMessage

String

executionTime

Long

int64

jsonType

X

String

2.7. StringList

Field Name Required Type Description Format

string

List of [string]