# 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: "Ab voluptas."

  - `submodule` (string)
    submodule name
    Example: "Nemo suscipit."

  - `scope_org` (string)
    org name
    Example: "Sed dolorem eos ut perferendis."

  - `scope_project` (string)
    project name
    Example: "Qui eum et aperiam eveniet."

## Path parameters:

  - `module_id` (string, required)
    module id
    Example: "Saepe libero."

## Header parameters:

  - `Harness-Account` (string, required)
    account name
    Example: "Et similique."

## Response 200 fields (application/json):

  - `account` (string, required)
    account name
    Example: "In accusamus animi."

  - `dependencies` (array)
    Dependencies of the module
    Example: [{"dependency_name":"Deleniti hic sapiente dolor commodi nesciunt.","dependency_source":"Et aut qui id.","dependency_version":"Modi quo quis."},{"dependency_name":"Deleniti hic sapiente dolor commodi nesciunt.","dependency_source":"Et aut qui id.","dependency_version":"Modi quo quis."},{"dependency_name":"Deleniti hic sapiente dolor commodi nesciunt.","dependency_source":"Et aut qui id.","dependency_version":"Modi quo quis."},{"dependency_name":"Deleniti hic sapiente dolor commodi nesciunt.","dependency_source":"Et aut qui id.","dependency_version":"Modi quo quis."}]

  - `dependencies.dependency_name` (string)
    Dependency name
    Example: "Ex possimus et aut."

  - `dependencies.dependency_source` (string)
    Dependency source
    Example: "Dolor omnis odit autem voluptate voluptatem iusto."

  - `dependencies.dependency_version` (string)
    Dependency version
    Example: "Quos voluptatem dolorem quia dolor."

  - `examples_paths` (array)
    Example directories discovered for this module version
    Example: ["Tempora fugit.","Molestias in velit nesciunt non debitis harum.","Voluptatibus assumenda maiores."]

  - `metadata_error` (string)
    error while retrieving the module
    Example: "A aspernatur asperiores."

  - `module_version` (string, required)
    module version
    Example: "Enim voluptatem at fugiat excepturi."

  - `name` (string, required)
    module name
    Example: "A dolorem."

  - `outputs` (array, required)
    Outputs of the module
    Example: [{"output_description":"Sint aliquam id sed.","output_name":"Illum eligendi nesciunt labore aut magnam saepe.","output_sensitive":true},{"output_description":"Sint aliquam id sed.","output_name":"Illum eligendi nesciunt labore aut magnam saepe.","output_sensitive":true},{"output_description":"Sint aliquam id sed.","output_name":"Illum eligendi nesciunt labore aut magnam saepe.","output_sensitive":true},{"output_description":"Sint aliquam id sed.","output_name":"Illum eligendi nesciunt labore aut magnam saepe.","output_sensitive":true}]

  - `outputs.output_description` (string)
    Output description
    Example: "Dolores officiis."

  - `outputs.output_name` (string)
    Output name
    Example: "Quo accusantium vitae quos ipsum sint voluptas."

  - `outputs.output_sensitive` (boolean)
    Output sensitivity
    Example: true

  - `providers` (array, required)
    Providers of the module
    Example: [{"provider_name":"Quisquam culpa.","provider_source":"Aliquid autem quam consequatur.","provider_version":"Reiciendis repellat consequatur."},{"provider_name":"Quisquam culpa.","provider_source":"Aliquid autem quam consequatur.","provider_version":"Reiciendis repellat consequatur."}]

  - `providers.provider_name` (string)
    Provider name
    Example: "Qui quos qui."

  - `providers.provider_source` (string)
    Provider source
    Example: "Nisi occaecati corrupti dolore soluta."

  - `providers.provider_version` (string)
    Provider version
    Example: "Est et."

  - `resources` (array, required)
    Resources of the module
    Example: [{"resource_name":"Doloribus omnis eum.","resource_type":"Id suscipit vel praesentium velit."},{"resource_name":"Doloribus omnis eum.","resource_type":"Id suscipit vel praesentium velit."},{"resource_name":"Doloribus omnis eum.","resource_type":"Id suscipit vel praesentium velit."}]

  - `resources.resource_name` (string)
    Resource name
    Example: "Inventore minima amet soluta corrupti occaecati praesentium."

  - `resources.resource_type` (string)
    Resource type
    Example: "Ab quod nesciunt voluptate dolores dolor mollitia."

  - `scope_org` (string)
    org name
    Example: "Repellendus et est."

  - `scope_project` (string)
    project name
    Example: "Sint facilis odio aut."

  - `submodule` (array)
    Submodules of the module
    Example: ["Nesciunt nulla perferendis.","Excepturi officiis provident ea inventore corporis.","Dolorem sint ut quos."]

  - `system` (string, required)
    system name
    Example: "Et eius sit consequuntur commodi iste."

  - `variables` (array, required)
    Variables of the module
    Example: [{"variable_default":"Quae totam enim.","variable_description":"Placeat corporis.","variable_name":"Repellat voluptatum rerum pariatur nisi consequuntur.","variable_required":true,"variable_sensitive":false,"variable_type":"Vitae minus."},{"variable_default":"Quae totam enim.","variable_description":"Placeat corporis.","variable_name":"Repellat voluptatum rerum pariatur nisi consequuntur.","variable_required":true,"variable_sensitive":false,"variable_type":"Vitae minus."},{"variable_default":"Quae totam enim.","variable_description":"Placeat corporis.","variable_name":"Repellat voluptatum rerum pariatur nisi consequuntur.","variable_required":true,"variable_sensitive":false,"variable_type":"Vitae minus."},{"variable_default":"Quae totam enim.","variable_description":"Placeat corporis.","variable_name":"Repellat voluptatum rerum pariatur nisi consequuntur.","variable_required":true,"variable_sensitive":false,"variable_type":"Vitae minus."}]

  - `variables.variable_default` (string)
    Variable default value
    Example: "Architecto corporis."

  - `variables.variable_description` (string)
    Variable description
    Example: "Sed dolor vero ab non sit."

  - `variables.variable_name` (string)
    Variable name
    Example: "Omnis laborum ducimus."

  - `variables.variable_required` (boolean)
    Is variable required
    Example: true

  - `variables.variable_sensitive` (boolean)
    Is variable sensitive
    Example: true

  - `variables.variable_type` (string)
    Variable type
    Example: "Voluptatem voluptatem aut."

## 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