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": {
                "elements": {
                    "key": {
                        "type": "enum"
                    }
                }
            }
        },
        "name": "string",
        "packages": {
            "key": {
                "documentation": "string",
                "enumerations": {
                    "key": {
                        "documentation": "string",
                        "metadata": {
                            "key": {
                                "elements": {
                                    "key": {
                                        "type": "enum"
                                    }
                                }
                            }
                        },
                        "name": "string",
                        "values": [
                            {
                                "documentation": "string",
                                "metadata": {
                                    "key": {
                                        "elements": {
                                            "key": {
                                                "type": "enum"
                                            }
                                        }
                                    }
                                },
                                "value": "string"
                            }
                        ]
                    }
                },
                "metadata": {
                    "key": {
                        "elements": {
                            "key": {
                                "type": "enum"
                            }
                        }
                    }
                },
                "name": "string",
                "services": {
                    "key": {
                        "constants": {
                            "key": {
                                "documentation": "string",
                                "type": {
                                    "category": "enum"
                                },
                                "value": {
                                    "category": "enum"
                                }
                            }
                        },
                        "documentation": "string",
                        "enumerations": {
                            "key": {
                                "documentation": "string",
                                "metadata": {
                                    "key": {
                                        "elements": {
                                            "key": {
                                                "type": "enum"
                                            }
                                        }
                                    }
                                },
                                "name": "string",
                                "values": [
                                    {
                                        "documentation": "string",
                                        "metadata": {
                                            "key": {
                                                "elements": {
                                                    "key": {
                                                        "type": "enum"
                                                    }
                                                }
                                            }
                                        },
                                        "value": "string"
                                    }
                                ]
                            }
                        },
                        "metadata": {
                            "key": {
                                "elements": {
                                    "key": {
                                        "type": "enum"
                                    }
                                }
                            }
                        },
                        "name": "string",
                        "operations": {
                            "key": {
                                "documentation": "string",
                                "errors": [
                                    {
                                        "documentation": "string",
                                        "structure_id": "string"
                                    }
                                ],
                                "metadata": {
                                    "key": {
                                        "elements": {
                                            "key": {
                                                "type": "enum"
                                            }
                                        }
                                    }
                                },
                                "name": "string",
                                "output": {
                                    "documentation": "string",
                                    "metadata": {
                                        "key": {
                                            "elements": {
                                                "key": {
                                                    "type": "enum"
                                                }
                                            }
                                        }
                                    },
                                    "type": {
                                        "category": "enum"
                                    }
                                },
                                "params": [
                                    {
                                        "documentation": "string",
                                        "metadata": {
                                            "key": {
                                                "elements": {
                                                    "key": {
                                                        "type": "enum"
                                                    }
                                                }
                                            }
                                        },
                                        "name": "string",
                                        "type": {
                                            "category": "enum"
                                        }
                                    }
                                ]
                            }
                        },
                        "structures": {
                            "key": {
                                "constants": {
                                    "key": {
                                        "documentation": "string",
                                        "type": {
                                            "category": "enum"
                                        },
                                        "value": {
                                            "category": "enum"
                                        }
                                    }
                                },
                                "documentation": "string",
                                "enumerations": {
                                    "key": {
                                        "documentation": "string",
                                        "metadata": {
                                            "key": {
                                                "elements": {
                                                    "key": {
                                                        "type": "enum"
                                                    }
                                                }
                                            }
                                        },
                                        "name": "string",
                                        "values": [
                                            {
                                                "documentation": "string",
                                                "metadata": {
                                                    "key": {
                                                        "elements": {
                                                            "key": {
                                                                "Metadata_Metamodel_ElementValue": "Too large to render past this point..."
                                                            }
                                                        }
                                                    }
                                                },
                                                "value": "string"
                                            }
                                        ]
                                    }
                                },
                                "fields": [
                                    {
                                        "documentation": "string",
                                        "metadata": {
                                            "key": {
                                                "elements": {
                                                    "key": {
                                                        "type": "enum"
                                                    }
                                                }
                                            }
                                        },
                                        "name": "string",
                                        "type": {
                                            "category": "enum"
                                        }
                                    }
                                ],
                                "metadata": {
                                    "key": {
                                        "elements": {
                                            "key": {
                                                "type": "enum"
                                            }
                                        }
                                    }
                                },
                                "name": "string",
                                "type": "enum"
                            }
                        }
                    }
                },
                "structures": {
                    "key": {
                        "constants": {
                            "key": {
                                "documentation": "string",
                                "type": {
                                    "category": "enum"
                                },
                                "value": {
                                    "category": "enum"
                                }
                            }
                        },
                        "documentation": "string",
                        "enumerations": {
                            "key": {
                                "documentation": "string",
                                "metadata": {
                                    "key": {
                                        "elements": {
                                            "key": {
                                                "type": "enum"
                                            }
                                        }
                                    }
                                },
                                "name": "string",
                                "values": [
                                    {
                                        "documentation": "string",
                                        "metadata": {
                                            "key": {
                                                "elements": {
                                                    "key": {
                                                        "type": "enum"
                                                    }
                                                }
                                            }
                                        },
                                        "value": "string"
                                    }
                                ]
                            }
                        },
                        "fields": [
                            {
                                "documentation": "string",
                                "metadata": {
                                    "key": {
                                        "elements": {
                                            "key": {
                                                "type": "enum"
                                            }
                                        }
                                    }
                                },
                                "name": "string",
                                "type": {
                                    "category": "enum"
                                }
                            }
                        ],
                        "metadata": {
                            "key": {
                                "elements": {
                                    "key": {
                                        "type": "enum"
                                    }
                                }
                            }
                        },
                        "name": "string",
                        "type": "enum"
                    }
                }
            }
        }
    }
}
Feedback

Was this page helpful?