recordTypeQualifier

Get all record type qualifiers

Securityapi_key
Request
query Parameters
record_type_id
integer <int32>

The ID of the record type whose record type qualifiers to get.

page_number
integer <int64>
Default: 1

The page number for which to get record type qualifiers. 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

403

Forbidden access

get/record-type-qualifiers
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create record type qualifier

Securityapi_key
Request
Request Body schema: application/json
required

The record type qualifier to create

recordTypeId
integer <int32>

The ID number of the record type that the record type qualifier refers to.

pattern
string <= 255 characters

The pattern to match against the record type field.

fileFieldMetadataId
integer <int32>

The ID of the record type field the record type qualifier refers to.

Responses
201

Success

403

Forbidden access

409

Conflict

post/record-type-qualifiers
Request samples
application/json
{
  • "recordTypeQualifierId": "3",
  • "recordTypeId": "1",
  • "pattern": "SSN",
  • "fileFieldMetadataId": "1"
}
Response samples
application/json
{
  • "recordTypeQualifierId": "3",
  • "recordTypeId": "1",
  • "pattern": "SSN",
  • "fileFieldMetadataId": "1"
}

Get record type qualifier by ID

Securityapi_key
Request
path Parameters
recordTypeQualifierId
required
integer <int32>

The ID of the record type qualifier to get

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/record-type-qualifiers/{recordTypeQualifierId}
Response samples
application/json
{
  • "recordTypeQualifierId": "3",
  • "recordTypeId": "1",
  • "pattern": "SSN",
  • "fileFieldMetadataId": "1"
}

Update record type qualifier by ID

Securityapi_key
Request
path Parameters
recordTypeQualifierId
required
integer <int32>

The ID of the record type qualifier to update

Request Body schema: application/json
required

The record type qualifier body to update

recordTypeId
integer <int32>

The ID number of the record type that the record type qualifier refers to.

pattern
string <= 255 characters

The pattern to match against the record type field.

fileFieldMetadataId
integer <int32>

The ID of the record type field the record type qualifier refers to.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

put/record-type-qualifiers/{recordTypeQualifierId}
Request samples
application/json
{
  • "recordTypeQualifierId": "3",
  • "recordTypeId": "1",
  • "pattern": "SSN",
  • "fileFieldMetadataId": "1"
}
Response samples
application/json
{
  • "recordTypeQualifierId": "3",
  • "recordTypeId": "1",
  • "pattern": "SSN",
  • "fileFieldMetadataId": "1"
}

Delete record type qualifier by ID

Securityapi_key
Request
path Parameters
recordTypeQualifierId
required
integer <int32>

The ID of the record type qualifier to delete

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

delete/record-type-qualifiers/{recordTypeQualifierId}
➔ Next to reidentificationJob