# List module metadata List the module metadata from the module registry Endpoint: GET /iacm/api/modules/{module_id}/metadata Version: 1.0 Security: x-api-key ## Query parameters: - `version` (string, required) version of the module Example: "Facere repudiandae et rerum et aut officiis." - `submodule` (string) submodule name Example: "Non pariatur quia est veritatis." ## Path parameters: - `module_id` (string, required) module id Example: "Ipsam atque et voluptatem atque ea unde." ## Header parameters: - `Harness-Account` (string, required) account name Example: "Sed est voluptates ut commodi." ## Response 200 fields (application/json): - `account` (string, required) account name Example: "Illo commodi." - `dependencies` (array) Dependencies of the module Example: [{"dependency_name":"Quo enim earum iste ex quia nobis.","dependency_source":"Voluptates qui.","dependency_version":"Molestiae consequatur rerum qui aut qui."},{"dependency_name":"Quo enim earum iste ex quia nobis.","dependency_source":"Voluptates qui.","dependency_version":"Molestiae consequatur rerum qui aut qui."},{"dependency_name":"Quo enim earum iste ex quia nobis.","dependency_source":"Voluptates qui.","dependency_version":"Molestiae consequatur rerum qui aut qui."}] - `dependencies.dependency_name` (string) Dependency name Example: "Dolor quia corporis quam soluta repudiandae aut." - `dependencies.dependency_source` (string) Dependency source Example: "Distinctio perspiciatis nam esse voluptatem." - `dependencies.dependency_version` (string) Dependency version Example: "Dolores velit odit impedit blanditiis." - `metadata_error` (string) error while retrieving the module Example: "Aut beatae sed." - `module_version` (string, required) module version Example: "Inventore minima amet soluta corrupti occaecati praesentium." - `name` (string, required) module name Example: "Dolores deserunt veniam ut libero sunt." - `outputs` (array, required) Outputs of the module Example: [{"output_description":"Repellat quia ab at et nobis.","output_name":"Incidunt commodi sed quia.","output_sensitive":true},{"output_description":"Repellat quia ab at et nobis.","output_name":"Incidunt commodi sed quia.","output_sensitive":true},{"output_description":"Repellat quia ab at et nobis.","output_name":"Incidunt commodi sed quia.","output_sensitive":true},{"output_description":"Repellat quia ab at et nobis.","output_name":"Incidunt commodi sed quia.","output_sensitive":true}] - `outputs.output_description` (string) Output description Example: "Aspernatur cumque ratione laudantium." - `outputs.output_name` (string) Output name Example: "Ea dolore consequatur fuga similique sit sunt." - `outputs.output_sensitive` (boolean) Output sensitivity Example: true - `providers` (array, required) Providers of the module Example: [{"provider_name":"Impedit expedita et esse.","provider_source":"Maiores consectetur dolore.","provider_version":"Rerum laboriosam."},{"provider_name":"Impedit expedita et esse.","provider_source":"Maiores consectetur dolore.","provider_version":"Rerum laboriosam."},{"provider_name":"Impedit expedita et esse.","provider_source":"Maiores consectetur dolore.","provider_version":"Rerum laboriosam."},{"provider_name":"Impedit expedita et esse.","provider_source":"Maiores consectetur dolore.","provider_version":"Rerum laboriosam."}] - `providers.provider_name` (string) Provider name Example: "Odit excepturi aliquam rerum provident est voluptatem." - `providers.provider_source` (string) Provider source Example: "Aut veritatis dolorem." - `providers.provider_version` (string) Provider version Example: "Ratione eos rerum ab." - `resources` (array, required) Resources of the module Example: [{"resource_name":"Sed iusto consequuntur officia repellendus veniam.","resource_type":"Rerum recusandae deserunt enim."},{"resource_name":"Sed iusto consequuntur officia repellendus veniam.","resource_type":"Rerum recusandae deserunt enim."},{"resource_name":"Sed iusto consequuntur officia repellendus veniam.","resource_type":"Rerum recusandae deserunt enim."}] - `resources.resource_name` (string) Resource name Example: "Aut dolore molestiae enim ut et." - `resources.resource_type` (string) Resource type Example: "Quia nulla similique nobis quia." - `submodule` (array) Submodules of the module Example: ["Mollitia quidem expedita mollitia quae.","Impedit hic necessitatibus et est blanditiis.","Animi porro omnis laborum ducimus facilis voluptatem."] - `system` (string, required) system name Example: "Ab quod nesciunt voluptate dolores dolor mollitia." - `variables` (array, required) Variables of the module Example: [{"variable_default":"Ipsa rerum eos quas accusamus qui.","variable_description":"Facilis expedita.","variable_name":"Occaecati aut quidem libero mollitia culpa.","variable_required":true,"variable_sensitive":true,"variable_type":"Minima unde necessitatibus non natus animi eius."},{"variable_default":"Ipsa rerum eos quas accusamus qui.","variable_description":"Facilis expedita.","variable_name":"Occaecati aut quidem libero mollitia culpa.","variable_required":true,"variable_sensitive":true,"variable_type":"Minima unde necessitatibus non natus animi eius."},{"variable_default":"Ipsa rerum eos quas accusamus qui.","variable_description":"Facilis expedita.","variable_name":"Occaecati aut quidem libero mollitia culpa.","variable_required":true,"variable_sensitive":true,"variable_type":"Minima unde necessitatibus non natus animi eius."},{"variable_default":"Ipsa rerum eos quas accusamus qui.","variable_description":"Facilis expedita.","variable_name":"Occaecati aut quidem libero mollitia culpa.","variable_required":true,"variable_sensitive":true,"variable_type":"Minima unde necessitatibus non natus animi eius."}] - `variables.variable_default` (string) Variable default value Example: "Aspernatur iusto." - `variables.variable_description` (string) Variable description Example: "Atque et quis explicabo est." - `variables.variable_name` (string) Variable name Example: "Qui facilis et hic iste." - `variables.variable_required` (boolean) Is variable required Example: true - `variables.variable_sensitive` (boolean) Is variable sensitive - `variables.variable_type` (string) Variable type Example: "Ut dolor." ## Response 400 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? - `timeout` (boolean, required) Is the error a timeout? Example: true ## Response 401 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? - `timeout` (boolean, required) Is the error a timeout? Example: true ## Response 403 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? - `timeout` (boolean, required) Is the error a timeout? Example: true ## Response 404 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? - `timeout` (boolean, required) Is the error a timeout? Example: true ## Response 408 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? - `timeout` (boolean, required) Is the error a timeout? Example: true ## Response 409 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? - `timeout` (boolean, required) Is the error a timeout? Example: true ## Response 423 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? - `timeout` (boolean, required) Is the error a timeout? Example: true ## Response 499 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? - `timeout` (boolean, required) Is the error a timeout? Example: true ## Response 500 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? - `timeout` (boolean, required) Is the error a timeout? Example: true ## Response 502 fields (application/vnd.goa.error): - `fault` (boolean, required) Is the error a server-side fault? - `id` (string, required) ID is a unique identifier for this particular occurrence of the problem. Example: "123abc" - `message` (string, required) Message is a human-readable explanation specific to this occurrence of the problem. Example: "parameter 'p' must be an integer" - `name` (string, required) Name is the name of this class of errors. Example: "bad_request" - `temporary` (boolean, required) Is the error temporary? - `timeout` (boolean, required) Is the error a timeout? Example: true