Schema for VLR

This section provides an overview of the schemas related to the Virtual Library Resource (VLR). Each schema details the structure and fields required for the VLR-related requests and responses.

NOTE

When making an API request using the Virtual Library Resource (VLR) schema, it is crucial to include the correct schema identifier. The schema parameter must be set to "resource" to ensure that the request is processed correctly and targets the appropriate data structure. Failure to provide the correct schema may result in an error or unexpected behavior in the response.

Title	Field	Mandatory	Type	Example
	header		Eheader	{ "identifier": "38555401-8018-6255-B396-CB427060D564", "schema": "resource", "languages": ["en"] }
Title	title	True	lstring	{ "en": "Test Title" }
Type of resource	resourceTypes	True	Eterm[]	[{ "identifier": "7BBF86FE-68E5-4ED8-8174-7DD8D302C583" }, { "identifier": "AA04CE23-471C-40E4-A0CC-53C9F49DABD4" }]
Author name(s)	authors	True	lstring	{ "en": "Test Author" }
Reference to the authoring organization(s)	organizations	True	Ereference[]	[{ "identifier": "1767A775-F4F9-B597-41AC-CE56536F28F5@2" }]
Publisher	publisher		lstring	{ "en": "Test Publisher" }
Source	source		lstring	{ "en": "Test source" }
Publication Date	publicationDate	True	lstring	2024-12
Rights	rights		lstring	{ "en": "Test rights" }
Link to the resource(s)	resourceLinks	True	Elink[]	[{ "url": "https://www.google.com", "name": "Google", "language": "en" }]
Cover image(s)	covers		Elink[]	[{ "url": "/api/v2013/documents/38555401-8018-6255-B396-CB427060D564/attachments/616105/2738672-temp.jpg", "name": "2738672-temp.jpg", "tag": "Test Tags", "language": "en" }]
Summary, abstract or table of contents (max 300 words)	summary	True	lstring	{ "en": "Test Summary" }
Geographical or political/economic group(s)	countryRegions		Eterm[]	[{ "identifier": "ao" }, { "identifier": "A23DD6C0-44C5-418D-83B5-461D79D2721A" }]
Kunming-Montreal Global Biodiversity Framework Target(s)	gbfTargets		Eterm[]	[{ "identifier": "GBF-TARGET-01" }, { "identifier": "GBF-TARGET-17" }]
Aichi Targets	aichiTargets		Eterm[]
CBD Subject Areas	cbdSubjects	True	Eterm[]	[{ "identifier": "CBD-SUBJECT-AGR" }, { "identifier": "CBD-SUBJECT-CPB-HTPI" }]
Please select the relevant keywords for describing the content of the code of conduct, guidelines, best practices, and/or standards being submitted	nagoya.mccKeywords		Eterm[]
ABS Thematic Areas	nagoya.subjects		Eterm[]	[{"identifier": "99FCE39007594FCD862564EC8D6E304F"}]
Key areas and strategic measures for capacity-building and development addressed by the resource	nagoya.keyAreas		Eterm[]	[{"identifier": "14E5882E-B433-4877-AA6B-B47F602C4BA6"}]
	nagoya		Nagoya
Biosafety Thematic Areas	biosafety.subjects		Eterm[]	[{"identifier": "E3E3E362-4E46-4C4A-A2A3-EABBDDAA2DEE"}]
Does this resource address one or more specific LMOs?	biosafety.addressModifiedOrganisms		bool	True
LMO(s) identification	biosafety.modifiedOrganisms		Ereference[]	[{"identifier": "E5DF7EF2-B902-9D55-517E-D400964CB478@8"}]
Organism(s) identification	biosafety.organisms		Ereference[]	[{"identifier": "A4380B39-C757-301E-5C43-0F943B021A3C@1"}]
Does this resource address one or more specific organisms?	biosafety.addressOrganisms		bool	True
Does this resource address one or more specific genetic elements?	biosafety.addressGenes		bool	True
Genetic element(s) identification	biosafety.genes		Ereference[]	[{"identifier": "FE2DAF79-6F81-4040-74C6-BA2057E0BB0C@3"}]
Biosafety	biosafety		Biosafety	{"subjects": [{"identifier": "E3E3E362-4E46-4C4A-A2A3-EABBDDAA2DEE"}], "modifiedOrganisms": [{"identifier": "E5DF7EF2-B902-9D55-517E-D400964CB478@8"}], "organisms": [{"identifier": "A4380B39-C757-301E-5C43-0F943B021A3C@1"}], "genes": [{"identifier": "FE2DAF79-6F81-4040-74C6-BA2057E0BB0C@3"}], "addressModifiedOrganisms": True, "addressOrganisms": True, "addressGenes": True}
	tags		lstring[]
	adminTags		string[]
Any other relevant information	relevantInformation		lstring	{"en": " Test Info "}
Any other relevant documents	relevantDocuments		Elink[]	[{"url": "https://www.google.com", "name": "Google", "language": "en"}]