modicio/modic.io.controller/MetadataController

MetadataController

@RestController
class MetadataController(val metadataService: MetadataService)

Constructors

Link copied to clipboard
constructor(metadataService: MetadataService)

Properties

Link copied to clipboard

Functions

Link copied to clipboard
@GetMapping(value = ["model/metadata/variant"], produces = ["application/xml"])
fun getVariantMetadata(@RequestParam(required = false, name = "variant_timestamp") timestamp: String?, @RequestParam(required = false, name = "variant_UUID") variantUID: String?, @RequestParam(required = false, name = "variant_name") name: String?, @RequestParam(required = false, name = "limit") limit: Int = 1, @RequestParam(required = false, name = "closed_only") closedOnly: Boolean = true): List<MetaData>

Get the complete metadata of a variant. At least one of the URL params must be provided. If the URL params are not sufficient to determine a variant, an error is thrown. This returns the first variants that are found matching one of the parameters in order. Please look at the behaviour of MetadataService.getVariantMetadata for more details.

Link copied to clipboard
@GetMapping(value = ["model/metadata/variants"], produces = ["application/json"])
fun getVariantsMetadata(@RequestParam(required = false, name = "delimiter") delimiter: Int = 1000, @RequestParam(required = false, name = "closed_only") closedOnly: Boolean = true): List<MetaData>

Get the metadata of all known variants. The result size can be delimited to the k most recently created variants. The default value for delimiter is set to 1000

Link copied to clipboard
@GetMapping(value = ["model/metadata/variant/versions"], produces = ["application/xml"])
fun getVersionsOfVariantMetadata(@RequestParam(required = true, name = "variant_UUID") variantID: String, @RequestParam(required = false, name = "delimiter") delimiter: Int = 1000, @RequestParam(required = false, name = "closed_only") closedOnly: Boolean = true): List<MetaData>

Get the metadata of all known running versions of the specified variant. The response size can be delimited to the k most recent versions. The default value for delimiter is set to 1000