recordType

Get all record type

Securityapi_key
Request
query Parameters
file_format_id
integer <int32>

The ID of the file format whose record types to get.

page_number
integer <int64>
Default: 1

The page number for which to get record type. 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-types
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create record type

Securityapi_key
Request
query Parameters
file_reference_id
required
string

The reference URI of the uploaded file to be installed. This file should have been uploaded via the /fileUpload endpoint.

Request Body schema: application/json
required

The record type to create

recordTypeName
string <= 255 characters

The name of the record type.

fileFormatId
integer <int32>

The ID number of the file format that the record type refers to.

Responses
201

Success

403

Forbidden access

409

Conflict

post/record-types
Request samples
application/json
{
  • "recordTypeId": "3",
  • "recordTypeName": "Record1",
  • "fileFormatId": "1"
}
Response samples
application/json
{
  • "recordTypeId": "3",
  • "recordTypeName": "Record1",
  • "fileFormatId": "1"
}

Get record type by ID

Securityapi_key
Request
path Parameters
recordTypeId
required
integer <int32>

The ID of the record type to get

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/record-types/{recordTypeId}
Response samples
application/json
{
  • "recordTypeId": "3",
  • "recordTypeName": "Record1",
  • "fileFormatId": "1"
}

Update record type

Securityapi_key
Request
path Parameters
recordTypeId
required
integer <int32>

The ID of the record type

Request Body schema: application/json
required

The record type to update

recordTypeName
string <= 255 characters

The name of the record type.

fileFormatId
integer <int32>

The ID number of the file format that the record type refers to.

Responses
200

Success

403

Forbidden access

put/record-types/{recordTypeId}
Request samples
application/json
{
  • "recordTypeId": "3",
  • "recordTypeName": "Record1",
  • "fileFormatId": "1"
}
Response samples
application/json
{
  • "recordTypeId": "3",
  • "recordTypeName": "Record1",
  • "fileFormatId": "1"
}

Delete record type by ID

Securityapi_key
Request
path Parameters
recordTypeId
required
integer <int32>

The ID of the record type to delete

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

delete/record-types/{recordTypeId}
➔ Next to recordTypeQualifier