MetadataMetamodelComponentData

The ComponentData structure contains the metamodel metadata information of a component element along with its fingerprint.


Properties

string
fingerprint Required

Fingerprint of the metamodel metadata of the component component. Metamodel information could change when there is an infrastructure update and new functionality is added to an existing component.

Since the data present in ComponentData.info could be quite large, ComponentData.fingerprint provides a convenient way to check if the data for a particular component is updated.

You should store the fingerprint associated with a component. After an update, by invoking the Component.fingerprint operation, you can retrieve the new fingerprint for the component. If the new fingerprint and the previously stored fingerprint do not match, clients can use the Component.get to retrieve the new metamodel information for the component.


info Required

Metamodel information of the component element. This includes information about all the package elements contained in this component element. The metamodel information about a component could be quite large if there are a lot of package elements contained in this component.

JSON Example

{
	"fingerprint": "string",
	"info": {
		"documentation": "string",
		"metadata": [
			{
				"key": "key1",
				"value": {
					"elements": [
						{
							"key": "key1",
							"value": {
								"type": "LONG"
							}
						}
					]
				}
			}
		],
		"name": "string",
		"packages": [
			{
				"key": "key1",
				"value": {
					"documentation": "string",
					"enumerations": [
						{
							"key": "key1",
							"value": {
								"documentation": "string",
								"metadata": [
									{
										"key": "key1",
										"value": {
											"elements": [
												{
													"key": "key1",
													"value": {
														"type": "LONG"
													}
												}
											]
										}
									}
								],
								"name": "string",
								"values": [
									{
										"documentation": "string",
										"metadata": [
											{
												"key": "key1",
												"value": {
													"elements": [
														{
															"key": "key1",
															"value": {
																"type": "LONG"
															}
														}
													]
												}
											}
										],
										"value": "string"
									}
								]
							}
						}
					],
					"metadata": [
						{
							"key": "key1",
							"value": {
								"elements": [
									{
										"key": "key1",
										"value": {
											"type": "LONG"
										}
									}
								]
							}
						}
					],
					"name": "string",
					"services": [
						{
							"key": "key1",
							"value": {
								"constants": [
									{
										"key": "key1",
										"value": {
											"documentation": "string",
											"type": {
												"category": "BUILTIN"
											},
											"value": {
												"category": "PRIMITIVE"
											}
										}
									}
								],
								"documentation": "string",
								"enumerations": [
									{
										"key": "key1",
										"value": {
											"documentation": "string",
											"metadata": [
												{
													"key": "key1",
													"value": {
														"elements": [
															{
																"key": "key1",
																"value": {
																	"type": "LONG"
																}
															}
														]
													}
												}
											],
											"name": "string",
											"values": [
												{
													"documentation": "string",
													"metadata": [
														{
															"key": "key1",
															"value": {
																"elements": [
																	{
																		"key": "key1",
																		"value": {
																			"type": "LONG"
																		}
																	}
																]
															}
														}
													],
													"value": "string"
												}
											]
										}
									}
								],
								"metadata": [
									{
										"key": "key1",
										"value": {
											"elements": [
												{
													"key": "key1",
													"value": {
														"type": "LONG"
													}
												}
											]
										}
									}
								],
								"name": "string",
								"operations": [
									{
										"key": "key1",
										"value": {
											"documentation": "string",
											"errors": [
												{
													"documentation": "string",
													"structure_id": "string"
												}
											],
											"metadata": [
												{
													"key": "key1",
													"value": {
														"elements": [
															{
																"key": "key1",
																"value": {
																	"type": "LONG"
																}
															}
														]
													}
												}
											],
											"name": "string",
											"output": {
												"documentation": "string",
												"metadata": [
													{
														"key": "key1",
														"value": {
															"elements": [
																{
																	"key": "key1",
																	"value": {
																		"type": "LONG"
																	}
																}
															]
														}
													}
												],
												"type": {
													"category": "BUILTIN"
												}
											},
											"params": [
												{
													"documentation": "string",
													"metadata": [
														{
															"key": "key1",
															"value": {
																"elements": [
																	{
																		"key": "key1",
																		"value": {
																			"type": "LONG"
																		}
																	}
																]
															}
														}
													],
													"name": "string",
													"type": {
														"category": "BUILTIN"
													}
												}
											]
										}
									}
								],
								"structures": [
									{
										"key": "key1",
										"value": {
											"constants": [
												{
													"key": "key1",
													"value": {
														"documentation": "string",
														"type": {
															"category": "BUILTIN"
														},
														"value": {
															"category": "PRIMITIVE"
														}
													}
												}
											],
											"documentation": "string",
											"enumerations": [
												{
													"key": "key1",
													"value": {
														"documentation": "string",
														"metadata": [
															{
																"key": "key1",
																"value": {
																	"elements": [
																		{
																			"key": "key1",
																			"value": {
																				"type": "LONG"
																			}
																		}
																	]
																}
															}
														],
														"name": "string",
														"values": [
															{
																"documentation": "string",
																"metadata": [
																	{
																		"key": "key1",
																		"value": {
																			"elements": [
																				{
																					"key": "key1",
																					"value": {
																						"Metadata_Metamodel_ElementValue": "Too large to render past this point..."
																					}
																				}
																			]
																		}
																	}
																],
																"value": "string"
															}
														]
													}
												}
											],
											"fields": [
												{
													"documentation": "string",
													"metadata": [
														{
															"key": "key1",
															"value": {
																"elements": [
																	{
																		"key": "key1",
																		"value": {
																			"type": "LONG"
																		}
																	}
																]
															}
														}
													],
													"name": "string",
													"type": {
														"category": "BUILTIN"
													}
												}
											],
											"metadata": [
												{
													"key": "key1",
													"value": {
														"elements": [
															{
																"key": "key1",
																"value": {
																	"type": "LONG"
																}
															}
														]
													}
												}
											],
											"name": "string",
											"type": "STRUCTURE"
										}
									}
								]
							}
						}
					],
					"structures": [
						{
							"key": "key1",
							"value": {
								"constants": [
									{
										"key": "key1",
										"value": {
											"documentation": "string",
											"type": {
												"category": "BUILTIN"
											},
											"value": {
												"category": "PRIMITIVE"
											}
										}
									}
								],
								"documentation": "string",
								"enumerations": [
									{
										"key": "key1",
										"value": {
											"documentation": "string",
											"metadata": [
												{
													"key": "key1",
													"value": {
														"elements": [
															{
																"key": "key1",
																"value": {
																	"type": "LONG"
																}
															}
														]
													}
												}
											],
											"name": "string",
											"values": [
												{
													"documentation": "string",
													"metadata": [
														{
															"key": "key1",
															"value": {
																"elements": [
																	{
																		"key": "key1",
																		"value": {
																			"type": "LONG"
																		}
																	}
																]
															}
														}
													],
													"value": "string"
												}
											]
										}
									}
								],
								"fields": [
									{
										"documentation": "string",
										"metadata": [
											{
												"key": "key1",
												"value": {
													"elements": [
														{
															"key": "key1",
															"value": {
																"type": "LONG"
															}
														}
													]
												}
											}
										],
										"name": "string",
										"type": {
											"category": "BUILTIN"
										}
									}
								],
								"metadata": [
									{
										"key": "key1",
										"value": {
											"elements": [
												{
													"key": "key1",
													"value": {
														"type": "LONG"
													}
												}
											]
										}
									}
								],
								"name": "string",
								"type": "STRUCTURE"
							}
						}
					]
				}
			}
		]
	}
}

Feedback

Was this page helpful?