Jump to

• Request
• Response

Get module names by channel

get

/apis/spark-v1/v2/modules/{channel}/names

Returns a list of modules by channel which represents the module id to name and description binding for any version of modules. If no modules were found, the server will return an empty list.

Request

Supported Media Types

• application/json

Path Parameters

• channel(required): string
  The channel to lookup for the modules.

  Allowed Values: [ "EMAIL", "PRINT", "SMS", "IVR" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Found modules matching the given channel.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ModuleIdToName

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ModuleIdToName"
    }
}

Nested Schema : ModuleIdToName

Type: object

Show Source

• modules: array modules
  A list of modules and their meta data

{
    "type":"object",
    "properties":{
        "modules":{
            "description":"A list of modules and their meta data",
            "type":"array",
            "example":{
                "id":"accf7256-66c8-11e9-a923-1681be663d3e",
                "name":"Tips Images V2",
                "moduleDescription":""
            },
            "items":{
                "$ref":"#/definitions/ModuleInfo"
            }
        }
    },
    "required":[
        "id",
        "name",
        "moduleDescription"
    ]
}

Nested Schema : modules

Type: array

A list of modules and their meta data

Show Source

• Array of: object ModuleInfo

{
    "description":"A list of modules and their meta data",
    "type":"array",
    "example":{
        "id":"accf7256-66c8-11e9-a923-1681be663d3e",
        "name":"Tips Images V2",
        "moduleDescription":""
    },
    "items":{
        "$ref":"#/definitions/ModuleInfo"
    }
}

Example:

{
    "id":"accf7256-66c8-11e9-a923-1681be663d3e",
    "name":"Tips Images V2",
    "moduleDescription":""
}

Nested Schema : ModuleInfo

Type: object

Show Source

• id(required): string
• moduleDescription: string
• name(required): string

{
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "moduleDescription":{
            "type":"string"
        }
    },
    "required":[
        "id",
        "name",
        "module"
    ]
}

Back to Top