fileFieldMetadata

Get all file field metadata

Securityapi_key
Request
query Parameters
file_format_id
integer <int32>

The ID of the file format to get all file field metadata from

record_type_id
integer <int32>

The ID of the record type to get all file field metadata from

field_name
string

The name of the file field, as determined by the associated file format. A wildcard character '*' can be used to represent zero or more characters. To match exact character '*' or '' in the fieldName, escape the character using '' like '\*' and '\\' respectively.

is_masked
boolean

Get only masked file field metadata when this is true and only unmasked file field metadata when this is false

page_number
integer <int64>
Default: 1

The page number for which to get file field metadata. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/file-field-metadata
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create file field metadata

Securityapi_key
Request
Request Body schema: application/json
required

The file filed metadata to create

recordTypeId
integer <int32>

The ID number of the record type that defines this file field. Required in case of Create API

fieldLength
integer <int32>

The length of the file field, in number of characters, as determined by the associated file format. Required in case of Create API

fieldPositionNumber
integer <int32>

The position of the file field with respect to the other file fields, as determined by the associated file format. Required in case of Create API

algorithmName
string <= 500 characters

The name of the algorithm assigned to this file field. File fields that are unmasked should have this property unset, in addition to having 'domainName' unset. If this field is set, then the 'domainName' must also be specified.

algorithmFieldId
integer <int64>

The ID number of the algorithm field that is associated with this column.

algorithmGroupNo
integer <int64>

The group number of algorithm to identify a set of columns associated with one instance of algorithm.

domainName
string <= 20 characters

The name of the domain assigned to this file field. File fields that are left unmasked should have this property unset. If the 'domainName' is set, but the 'algorithmName' is unset, then the default algorithm corresponding to the 'domainName' will be used.

dateFormat
string <= 50 characters

The date format of the date assigned to this column.

isProfilerWritable
required
boolean

This field indicates whether or not a file filed's algorithm or domain assignment may be modified during the execution of a profile job when there is a profiling match.

notes
string <= 500 characters

This field is used to store additional information about the file field.

documentStoreType
string

This field indicates the type of document stored in the file field. Required in case where docStoreFileFormatId is provided. Accepted values: ['JSON','XML']

docStoreFileFormatId
integer <int32>

The ID number of the document store file format. Required in case where documentStoreType is provided.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

post/file-field-metadata
Request samples
application/json
{
  • "recordTypeId": 1,
  • "fieldName": "FooField",
  • "fieldPositionNumber": 6,
  • "fieldLength": 10,
  • "algorithmName": "FirstNameLookup",
  • "domainName": "FIRST_NAME",
  • "isProfilerWritable": false
}
Response samples
application/json
{
  • "recordTypeId": 1,
  • "fieldName": "FooField",
  • "fieldPositionNumber": 6,
  • "fieldLength": 10,
  • "algorithmName": "FirstNameLookup",
  • "domainName": "FIRST_NAME",
  • "isProfilerWritable": false
}

Get file field metadata by ID

Securityapi_key
Request
path Parameters
fileFieldMetadataId
required
integer <int32>

The ID of the file field metadata to get

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/file-field-metadata/{fileFieldMetadataId}
Response samples
application/json
{
  • "recordTypeId": 1,
  • "fieldName": "FooField",
  • "fieldPositionNumber": 6,
  • "fieldLength": 10,
  • "algorithmName": "FirstNameLookup",
  • "domainName": "FIRST_NAME",
  • "isProfilerWritable": false
}

Update file field metadata by ID

Securityapi_key
Request
path Parameters
fileFieldMetadataId
required
integer <int32>

The ID of the file field metadata to update

Request Body schema: application/json
required

The updated file field metadata

recordTypeId
integer <int32>

The ID number of the record type that defines this file field. Required in case of Create API

fieldLength
integer <int32>

The length of the file field, in number of characters, as determined by the associated file format. Required in case of Create API

fieldPositionNumber
integer <int32>

The position of the file field with respect to the other file fields, as determined by the associated file format. Required in case of Create API

algorithmName
string <= 500 characters

The name of the algorithm assigned to this file field. File fields that are unmasked should have this property unset, in addition to having 'domainName' unset. If this field is set, then the 'domainName' must also be specified.

algorithmFieldId
integer <int64>

The ID number of the algorithm field that is associated with this column.

algorithmGroupNo
integer <int64>

The group number of algorithm to identify a set of columns associated with one instance of algorithm.

domainName
string <= 20 characters

The name of the domain assigned to this file field. File fields that are left unmasked should have this property unset. If the 'domainName' is set, but the 'algorithmName' is unset, then the default algorithm corresponding to the 'domainName' will be used.

dateFormat
string <= 50 characters

The date format of the date assigned to this column.

isProfilerWritable
required
boolean

This field indicates whether or not a file filed's algorithm or domain assignment may be modified during the execution of a profile job when there is a profiling match.

notes
string <= 500 characters

This field is used to store additional information about the file field.

documentStoreType
string

This field indicates the type of document stored in the file field. Required in case where docStoreFileFormatId is provided. Accepted values: ['JSON','XML']

docStoreFileFormatId
integer <int32>

The ID number of the document store file format. Required in case where documentStoreType is provided.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

put/file-field-metadata/{fileFieldMetadataId}
Request samples
application/json
{
  • "recordTypeId": 1,
  • "fieldName": "FooField",
  • "fieldPositionNumber": 6,
  • "fieldLength": 10,
  • "algorithmName": "FirstNameLookup",
  • "domainName": "FIRST_NAME",
  • "isProfilerWritable": false
}
Response samples
application/json
{
  • "recordTypeId": 1,
  • "fieldName": "FooField",
  • "fieldPositionNumber": 6,
  • "fieldLength": 10,
  • "algorithmName": "FirstNameLookup",
  • "domainName": "FIRST_NAME",
  • "isProfilerWritable": false
}

Delete file field metadata by ID

Securityapi_key
Request
path Parameters
fileFieldMetadataId
required
integer <int32>

The ID of the file field metadata to delete

Responses
200

Success

403

Forbidden access

404

Not found

delete/file-field-metadata/{fileFieldMetadataId}
➔ Next to fileFormat