LMS_GetField

POST

https://api.cbf.tcn.com/api/v0alpha/lms/fields/get

LMS

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

metadata

object (api.v0alpha.FieldMetadata)

optional

timeFormat

string

optional

precision

integer

optional

removeCharacters

string

optional

3-10 are Parsing Options
Remove any characters that are in this string
remove_characters will override leave_characters

replaceEmpty

string

optional

If the parsed value is empty
it will be replaced with this value

replaceError

string

optional

If an error is encountered with parsing
then the field will be replaced with this value

removeLetters

boolean

optional

Remove any letters (a-zA-Z) from the field

removeNumbers

boolean

optional

Remove any numbers (digits 0-9) from the field

removeSymbols

boolean

optional

Removes any symbols or punctuation from the field

leaveCharacters

string

optional

Any characters in this string will not be remove
can be overridden by remove_characters

removeString

string

optional

Remove any matches of this entire string

jsonDotPath

string

optional

'json_dot_path' holds the json path that will fetch the value for this field by walking path
over a json object via:
https://github.com/tidwall/gjson
ex: dot_path = a.b.0.firstName
Values must resolve to one thing, not a range of things. If a range is retrieved, the first value is taken
the rest are ignored.
If string is empty, we just use the field name for the path

jsonForceTypeMatch

boolean

optional

If true value retrieved from json must match the field definition, or error.
If true, the value if a string, will be 'parsed' into the correct type.
If false, the value will be used as is, meaning time_strings, number_strings and the like will remain as strings.

startingPosition

integer <int32>

optional

for fixed width files indicates the starting position of the data.
if it is -1, starting position is one character after the previous fields starting position + length.
if this is the first field and it is -1, starting position is 0

fieldLength

integer <int32>

optional

for fixed width files indicates how many characters to the right of starting position we will read.
this field is required to be greater than 0.

name

string

optional

type

integer

optional

dateModified

string <date-time>

optional

description

string

optional

Example

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v0alpha/lms/fields/get' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK

application/json

Body

metadata

object (api.v0alpha.FieldMetadata)

optional

timeFormat

string

optional

precision

integer

optional

removeCharacters

string

optional

3-10 are Parsing Options
Remove any characters that are in this string
remove_characters will override leave_characters

replaceEmpty

string

optional

If the parsed value is empty
it will be replaced with this value

replaceError

string

optional

If an error is encountered with parsing
then the field will be replaced with this value

removeLetters

boolean

optional

Remove any letters (a-zA-Z) from the field

removeNumbers

boolean

optional

Remove any numbers (digits 0-9) from the field

removeSymbols

boolean

optional

Removes any symbols or punctuation from the field

leaveCharacters

string

optional

Any characters in this string will not be remove
can be overridden by remove_characters

removeString

string

optional

Remove any matches of this entire string

jsonDotPath

string

optional

jsonForceTypeMatch

boolean

optional

startingPosition

integer <int32>

optional

fieldLength

integer <int32>

optional

for fixed width files indicates how many characters to the right of starting position we will read.
this field is required to be greater than 0.

name

string

optional

type

integer

optional

dateModified

string <date-time>

optional

description

string

optional

Example

{
  "metadata": {
    "timeFormat": "string",
    "precision": 0,
    "removeCharacters": "string",
    "replaceEmpty": "string",
    "replaceError": "string",
    "removeLetters": true,
    "removeNumbers": true,
    "removeSymbols": true,
    "leaveCharacters": "string",
    "removeString": "string",
    "jsonDotPath": "string",
    "jsonForceTypeMatch": true,
    "startingPosition": 0,
    "fieldLength": 0
  },
  "name": "string",
  "type": 0,
  "dateModified": "2019-08-24T14:15:22Z",
  "description": "string"
}

🔴500Server Error

Modified at 2025-03-22 17:39:34

LMS_DeleteField

LMS_UpdateField