Folio Query Tool API (v1)

https://s3.amazonaws.com/foliodocs/api/folio-query-tool-metadata/s/queryTool.html

descriptionOfPieces

The current endpoint provides the requestor with information about an Entity Type definition.
e.g.

curl --location 'https://folio-dev-firebird-okapi.ci.folio.org:443/entity-types' \
--header 'Cookie: folioAccessToken=******'

[ { "id": "4e09d89a-44ed-418e-a9cc-820dfb27bf3a", "label": "Loans" }, { "id": "0069cf6f-2833-46db-8a51-8934769b8289", "label": "Users" }, { "id": "0cb79a4c-f7eb-4941-a104-745224ae0292", "label": "Items" } ]

Item schemas

Here you can check for the original inventory descriptor of an item record

The values of an Item-entity type column provided by the FQM-instance is received by the request

curl --location 'https://folio-dev-firebird-okapi.ci.folio.org:443/entity-types/0cb79a4c-f7eb-4941-a104-745224ae0292' \
--header 'Cookie: folioAccessToken=******'

the following:

{ "private": false, "id": "0cb79a4c-f7eb-4941-a104-745224ae0292", "name": "drv_item_details", "labelAlias": "Items", "subEntityTypeIds": [ "097a6f96-edd0-11ed-a05b-0242ac120003", "0cb79a4c-f7eb-4941-a104-745224ae0293" ], "columns": [ { "name": "holdings_id", "dataType": { "dataType": "rangedUUIDType" }, "labelAlias": "Holdings ID", "visibleByDefault": false }, { "name": "instance_created_date", "dataType": { "dataType": "dateType" }, "labelAlias": "Instance created date", "visibleByDefault": false }, { "name": "instance_id", "dataType": { "dataType": "rangedUUIDType" }, "labelAlias": "Instance ID", "visibleByDefault": false }, { "name": "instance_primary_contributor", "dataType": { "dataType": "stringType" }, "labelAlias": "Instance primary contributor", "visibleByDefault": false }, { "name": "instance_title", "dataType": { "dataType": "stringType" }, "labelAlias": "Instance title", "visibleByDefault": true }, { "name": "instance_title_searchable", "dataType": { "dataType": "stringType" }, "labelAlias": "Instance title (Searchable)", "visibleByDefault": true }, { "name": "instance_updated_date", "dataType": { "dataType": "dateType" }, "labelAlias": "Instance updated date", "visibleByDefault": false }, { "name": "item_barcode", "dataType": { "dataType": "stringType" }, "labelAlias": "Item barcode", "visibleByDefault": true }, { "name": "item_level_call_number", "dataType": { "dataType": "stringType" }, "labelAlias": "Item call number", "visibleByDefault": false }, { "name": "item_level_call_number_type_name", "dataType": { "dataType": "stringType" }, "labelAlias": "Item call number type name", "visibleByDefault": false, "idColumnName": "item_level_call_number_typeid", "source": { "entityTypeId": "5c8315be-13f5-4df5-ae8b-086bae83484d", "columnName": "call_number_type_name" } }, { "name": "item_level_call_number_typeid", "dataType": { "dataType": "rangedUUIDType" }, "labelAlias": "Item call number type ID", "visibleByDefault": false }, { "name": "item_copy_number", "dataType": { "dataType": "stringType" }, "labelAlias": "Item copy number", "visibleByDefault": true }, { "name": "item_created_date", "dataType": { "dataType": "dateType" }, "labelAlias": "Item created date", "visibleByDefault": false }, { "name": "item_effective_call_number", "dataType": { "dataType": "stringType" }, "labelAlias": "Item effective call number", "visibleByDefault": true }, { "name": "item_effective_call_number_type_name", "dataType": { "dataType": "stringType" }, "labelAlias": "Item effective call number type name", "visibleByDefault": false, "idColumnName": "item_effective_call_number_typeid", "source": { "entityTypeId": "5c8315be-13f5-4df5-ae8b-086bae83484d", "columnName": "call_number_type_name" } }, { "name": "item_effective_call_number_typeid", "dataType": { "dataType": "rangedUUIDType" }, "labelAlias": "Item effective call number type ID", "visibleByDefault": false }, { "name": "item_effective_library_code", "dataType": { "dataType": "stringType" }, "labelAlias": "Item effective library code", "visibleByDefault": false }, { "name": "item_effective_library_id", "dataType": { "dataType": "rangedUUIDType" }, "labelAlias": "Item effective library ID", "visibleByDefault": false }, { "name": "item_effective_library_name", "dataType": { "dataType": "stringType" }, "labelAlias": "Item effective library name", "visibleByDefault": false, "idColumnName": "item_effective_library_id", "source": { "entityTypeId": "cf9f5c11-e943-483c-913b-81d1e338accc", "columnName": "loclibrary_name" } }, { "name": "item_effective_location_id", "dataType": { "dataType": "rangedUUIDType" }, "labelAlias": "Item effective location ID", "visibleByDefault": false }, { "name": "item_effective_location_name", "dataType": { "dataType": "stringType" }, "labelAlias": "Item effective location name", "visibleByDefault": true, "idColumnName": "item_effective_location_id", "source": { "entityTypeId": "a9d6305e-fdb4-4fc4-8a73-4a5f76d8410b", "columnName": "location_name" } }, { "name": "item_hrid", "dataType": { "dataType": "stringType" }, "labelAlias": "Item hrid", "visibleByDefault": false }, { "name": "id", "dataType": { "dataType": "rangedUUIDType" }, "labelAlias": "Item ID", "visibleByDefault": false }, { "name": "item_material_type", "dataType": { "dataType": "stringType" }, "labelAlias": "Item material type", "visibleByDefault": false, "idColumnName": "item_material_type_id", "source": { "entityTypeId": "917ea5c8-cafe-4fa6-a942-e2388a88c6f6", "columnName": "material_type_name" } }, { "name": "item_material_type_id", "dataType": { "dataType": "rangedUUIDType" }, "labelAlias": "Item material ID", "visibleByDefault": false }, { "name": "item_permanent_location_id", "dataType": { "dataType": "rangedUUIDType" }, "labelAlias": "Item permanent ID", "visibleByDefault": false }, { "name": "item_permanent_location_name", "dataType": { "dataType": "stringType" }, "labelAlias": "Item permanent location name", "visibleByDefault": false, "idColumnName": "item_permanent_location_id", "source": { "entityTypeId": "a9d6305e-fdb4-4fc4-8a73-4a5f76d8410b", "columnName": "location_name" } }, { "name": "item_status", "dataType": { "dataType": "stringType" }, "labelAlias": "Item status", "visibleByDefault": false, "source": { "entityTypeId": "a1a37288-1afe-4fa5-ab59-a5bcf5d8ca2d", "columnName": "item_status" } }, { "name": "item_temporary_location_id", "dataType": { "dataType": "rangedUUIDType" }, "labelAlias": "Item temporary ID", "visibleByDefault": false }, { "name": "item_temporary_location_name", "dataType": { "dataType": "stringType" }, "labelAlias": "Item temporary location name", "visibleByDefault": false, "idColumnName": "item_temporary_location_id", "source": { "entityTypeId": "a9d6305e-fdb4-4fc4-8a73-4a5f76d8410b", "columnName": "location_name" } }, { "name": "item_updated_date", "dataType": { "dataType": "dateType" }, "labelAlias": "Item updated date", "visibleByDefault": false } ], "defaultSort": [ { "columnName": "item_effective_location_name", "direction": "ASC" }, { "columnName": "instance_title", "direction": "ASC" }, { "columnName": "instance_primary_contributor", "direction": "ASC" }, { "columnName": "id", "direction": "ASC" } ] }

The original inventory scheme of an Item and fields set, is provided by the FQM below.
(? - means, the reference should be additionally verified by comparing of the exact item-query result)

Inventory	FQM
id	id
_version	-
hrid	item_hrid
holdingsRecordId	holdings_id
formerIds	-
discoverySuppress	-
title	? instance_title
contributorNames	? instance_primary_contributor
callNumber	? item_level_call_number
barcode	item_barcode
effectiveShelvingOrder	-
accessionNumber	-
itemLevelCallNumber	item_level_call_number
itemLevelCallNumberPrefix	-
itemLevelCallNumberSuffix	-
itemLevelCallNumberTypeId	item_level_call_number_typeid
effectiveCallNumberComponents
callNumber	item_effective_call_number
prefix	-
suffix	-
typeId	item_effective_call_number_typeid
volume	-
enumeration	-
chronology	-
yearCaption	-
itemIdentifier	-
copyNumber	item_copy_number
numberOfPieces	-
descriptionOfPieces	-
numberOfMissingPieces	-
missingPieces	-
missingPiecesDate	-
itemDamagedStatusId	-
itemDamagedStatusDate	-
administrativeNotes	-
notes	-
circulationNotes	-
status	item_status
materialType
id	item_material_type_id
name	? item_material_type
isBoundWith	-
boundWithTitles	-
permanentLoanType	-
temporaryLoanType	-
permanentLocation
id	item_permanent_location_id
name	item_permanent_location_name
temporaryLocation
id	item_temporary_location_id
name	item_temporary_location_name
effectiveLocation
id	item_effective_location_id
name	item_effective_location_name
electronicAccess	-
inTransitDestinationServicePointId	-
statisticalCodeIds	-
purchaseOrderLineIdentifier	-
metadata	-
tags	-
lastCheckIn	-
additionalProperties	-
required	-

User schemas

Here you can check for the original inventory descriptor of a user record

The values of an Item-entity type column provided by the FQM-instance is received by the request

curl --location 'https://folio-dev-firebird-okapi.ci.folio.org:443/entity-types/0069cf6f-2833-46db-8a51-8934769b8289' \
--header 'Cookie: folioAccessToken=*******

the following:

{ "private": false, "id": "0069cf6f-2833-46db-8a51-8934769b8289", "name": "drv_user_details", "labelAlias": "Users", "columns": [ { "name": "user_active", "dataType": { "dataType": "booleanType" }, "labelAlias": "User active", "visibleByDefault": true, "values": [ { "value": "true", "label": "True" }, { "value": "false", "label": "False" } ] }, { "name": "user_barcode", "dataType": { "dataType": "stringType" }, "labelAlias": "User barcode", "visibleByDefault": true }, { "name": "user_created_date", "dataType": { "dataType": "dateType" }, "labelAlias": "User created date", "visibleByDefault": false }, { "name": "user_date_of_birth", "dataType": { "dataType": "dateType" }, "labelAlias": "User date of birth", "visibleByDefault": false }, { "name": "user_email", "dataType": { "dataType": "stringType" }, "labelAlias": "User email", "visibleByDefault": false }, { "name": "user_enrollment_date", "dataType": { "dataType": "dateType" }, "labelAlias": "User enrollment date", "visibleByDefault": false }, { "name": "user_expiration_date", "dataType": { "dataType": "dateType" }, "labelAlias": "User expiration date", "visibleByDefault": false }, { "name": "user_external_system_id", "dataType": { "dataType": "stringType" }, "labelAlias": "User external system ID", "visibleByDefault": false }, { "name": "user_first_name", "dataType": { "dataType": "stringType" }, "labelAlias": "User first name", "visibleByDefault": true }, { "name": "id", "dataType": { "dataType": "rangedUUIDType" }, "labelAlias": "User ID", "visibleByDefault": true }, { "name": "user_last_name", "dataType": { "dataType": "stringType" }, "labelAlias": "User last name", "visibleByDefault": true }, { "name": "user_middle_name", "dataType": { "dataType": "stringType" }, "labelAlias": "User middle name", "visibleByDefault": false }, { "name": "user_mobile_phone", "dataType": { "dataType": "stringType" }, "labelAlias": "User mobile phone", "visibleByDefault": false }, { "name": "user_patron_group", "dataType": { "dataType": "stringType" }, "labelAlias": "User patron group", "visibleByDefault": false, "idColumnName": "user_patron_group_id", "source": { "entityTypeId": "e611264d-377e-4d87-a93f-f1ca327d3db0", "columnName": "group" } }, { "name": "user_patron_group_id", "dataType": { "dataType": "rangedUUIDType" }, "labelAlias": "User patron group ID", "visibleByDefault": false }, { "name": "user_phone", "dataType": { "dataType": "stringType" }, "labelAlias": "User phone", "visibleByDefault": true }, { "name": "user_preferred_contact_type", "dataType": { "dataType": "stringType" }, "labelAlias": "User preferred contact type", "visibleByDefault": false, "values": [ { "value": "email", "label": "Email" }, { "value": "mail", "label": "Mail (Primary Address)" }, { "value": "text", "label": "Text Message" } ] }, { "name": "user_preferred_first_name", "dataType": { "dataType": "stringType" }, "labelAlias": "User preferred first name", "visibleByDefault": true }, { "name": "user_primary_address", "dataType": { "dataType": "stringType" }, "labelAlias": "User primary address", "visibleByDefault": false }, { "name": "user_updated_date", "dataType": { "dataType": "dateType" }, "labelAlias": "User updated date", "visibleByDefault": false }, { "name": "username", "dataType": { "dataType": "stringType" }, "labelAlias": "Username", "visibleByDefault": true } ], "defaultSort": [ { "columnName": "id", "direction": "ASC" } ] }

The original user scheme content, and field set, which is provided by the FQM, are below.

mod-users	FQM
username	`username`
id	`id`
externalSystemId	`user_external_system_id`
barcode	`user_barcode`
active	`user_active`
type	`-`
patronGroup	`user_patron_group`
departments	`-`
meta (Deprecated)	`-`
proxyFor (Deprecated)	`-`
personal
lastName	`user_last_name`
`firstName`	`user_first_name`
`middleName`	`user_middle_name`
`preferredFirstName`	`user_preferred_first_name`
`email`	`user_email`
`phone`	`user_phone`
`mobilePhone`	`user_mobile_phone`
`dateOfBirth`	`user_date_of_birth`

`addresses`	`user_primary_address`
`id`	`-`
`countryId`	`-`
`addressLine1`	`-`
`addressLine2`	`-`
`city`	`-`
`region`	`-`
`postalCode`	`-`
`addressTypeId`	`-`
`primaryAddress`	`user_primary_address`

`preferredContactTypeId (the ID)`	`user_preferred_contact_type (the value)`
`profilePictureLink`	`-`

enrollmentDate	`user_enrollment_date`
expirationDate	`user_expiration_date`
createdDate	`user_created_date`
updatedDate	`user_updated_date`
metadata	-
tags	-
customFields	-

Query tool. FQM schemas and users/inventory schemas comparison

Folio Query Tool API (v1)

Item schemas

User schemas