Jump to

• Request
• Response

Get optional modules

get

<servername>/fscmUI/applcoreApi/v2/csm/module/optional

Retrieve a list of optional modules.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Optional modules retrieved.

Body ()

Root Schema : ModuleResponse

Type: object

Show Source

• modules: array ModuleList

{
    "type":"object",
    "properties":{
        "modules":{
            "$ref":"#/components/schemas/ModuleList"
        }
    }
}

Nested Schema : ModuleList

Type: array

Show Source

• Array of: object Module

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Module"
    }
}

Nested Schema : Module

Type: object

Show Source

• description: string
  Short description of the module.
• displayName: string
  Full name of the module.
• name: string
  Abbreviated name of the module used in API requests and responses.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Abbreviated name of the module used in API requests and responses."
        },
        "displayName":{
            "type":"string",
            "description":"Full name of the module."
        },
        "description":{
            "type":"string",
            "description":"Short description of the module."
        }
    }
}

Back to Top