OEStructureMetadataToJson

Attention

This API is currently available in C++ and Python.

std::string OEStructureMetadataToJson(const OEStructureMetadata& metadata,
                                      const bool prettyPrint = true)

Serializes an OEStructureMetadata object to a JSON-formatted string. The resulting JSON object contains the following top-level fields:

Field	Type	Description
`StructureID`	string	Identifier for the structure (e.g. PDB accession code).
`Author`	string	Name of the structure’s depositing author.
`Keywords`	array of strings	Keywords describing the structure.
`RevisionDate`	string	Date of the most recent revision.
`Revision`	string	Revision version label.
`ExperimentDate`	string	Date the experiment was performed.
`ExperimentType`	string	Experiment method name, as returned by `OEGetExperimentTypeName`.
`IridiumData`	object	Nested object containing Iridium quality assessment data.
`SequenceMetadata`	array of objects	Array of sequence segment objects, each with the fields documented in `OESequenceMetadataToJson`.
`HeterogenMetadata`	array of objects	Array of heterogen objects, each with the fields documented in `OEHeterogenMetadataToJson`.

The prettyPrint argument controls formatting: when true (the default) the JSON is indented for readability; when false a compact single-line representation is produced.

Code Example

Creating OEDesignUnits Using Provided Metadata example