Previous Next JavaScript must be enabled to correctly display this content

## Get all valid external system setup

get

/service/lmx/externalsystemsetup

This endpoint is used to get all valid external system setup maintenance records.

### Request

Supported Media Types

- application/json
- application/xml

Query Parameters

- authStat(optional): string
- externalSystemId(optional): string
- externalSystemName(optional): string
- includecloseandunauth(optional): boolean
  includecloseandunauth need to be set to fetch summary record, defult value is false
- isDda(optional): string
- limit(optional): integer
  limit is maximum no of records to be fetched
- offset(optional): integer
  offset is starting no of records to be fetched
- recordStat(optional): string

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 201 Response

Returns message of succes or failure
Headers

- Location: string

Body ()
Root Schema : LmxTmExternalSystemCollection
Type: `object`
Collection of externalsystem.
Show Source

- data(optional): array data
- paging(optional): object PagingDto

    {
        "description":"Collection of externalsystem.",
        "type":"object",
        "properties":{
            "data":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmxTmExternalSystemDTO"
                }
            },
            "paging":{
                "$ref":"#/definitions/PagingDto"
            }
        }
    }

Nested Schema : data
Type: `array`
Show Source

- Array of: object LmxTmExternalSystemDTO

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

Nested Schema : PagingDto
Type: `object`
Show Source

- totalResults(optional): integer

    {
        "type":"object",
        "properties":{
            "totalResults":{
                "type":"integer"
            }
        }
    }

Nested Schema : LmxTmExternalSystemDTO
Type: `object`
Match All
Show Source

- allOf GenericDto
- object LmxTmExternalSystemDTO-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "externalSystemId":{
                        "type":"string",
                        "description":"",
                        "maxLength":5
                    },
                    "externalSystemName":{
                        "type":"string",
                        "description":"",
                        "maxLength":30
                    },
                    "isDda":{
                        "type":"string",
                        "description":"",
                        "maxLength":1,
                        "pattern":"[Y,N]"
                    },
                    "LmxTmExternalSystemDetailsDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/LmxTmExternalSystemDetailsDTO"
                        }
                    }
                },
                "required":[
                    "externalSystemId",
                    "externalSystemName",
                    "LmxTmExternalSystemDetailsDTO"
                ]
            }
        ]
    }

Nested Schema : GenericDto
Match All
Show Source

- object GenericDto-allOf[0]
  Discriminator: `resource_type`

    {
        "allOf":[
            {
                "type":"object",
                "discriminator":"resource_type"
            }
        ]
    }

Nested Schema : GenericDto-allOf[0]
Type: `object`
Discriminator: `resource_type`
Nested Schema : LmxTmExternalSystemDTO-allOf[1]
Type: `object`
Show Source

- externalSystemId: string
  Maximum Length: `5`
- externalSystemName: string
  Maximum Length: `30`
- isDda(optional): string
  Maximum Length: `1`
  Pattern: `[Y,N]`
- LmxTmExternalSystemDetailsDTO: array LmxTmExternalSystemDetailsDTO

    {
        "type":"object",
        "properties":{
            "externalSystemId":{
                "type":"string",
                "description":"",
                "maxLength":5
            },
            "externalSystemName":{
                "type":"string",
                "description":"",
                "maxLength":30
            },
            "isDda":{
                "type":"string",
                "description":"",
                "maxLength":1,
                "pattern":"[Y,N]"
            },
            "LmxTmExternalSystemDetailsDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmxTmExternalSystemDetailsDTO"
                }
            }
        },
        "required":[
            "externalSystemId",
            "externalSystemName",
            "LmxTmExternalSystemDetailsDTO"
        ]
    }

Nested Schema : LmxTmExternalSystemDetailsDTO
Type: `array`
Show Source

- Array of: object LmxTmExternalSystemDetailsDTO

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

Nested Schema : LmxTmExternalSystemDetailsDTO
Type: `object`
Show Source

- ackNackResponseType(optional): string
- externalSystemId(optional): string
  Maximum Length: `36`
- id(optional): string
  Maximum Length: `36`
- integrationType: string
  Maximum Length: `100`
- messageType: string
  Maximum Length: `20`
- methodName: string
  Maximum Length: `100`
- networkType: string
  Maximum Length: `50`
- serviceDescription(optional): string
  Maximum Length: `100`
- serviceType: string
  Maximum Length: `30`

    {
        "type":"object",
        "properties":{
            "externalSystemId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "id":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "integrationType":{
                "type":"string",
                "description":"",
                "maxLength":100
            },
            "messageType":{
                "type":"string",
                "description":"",
                "maxLength":20
            },
            "methodName":{
                "type":"string",
                "description":"",
                "maxLength":100
            },
            "networkType":{
                "type":"string",
                "description":"",
                "maxLength":50
            },
            "serviceDescription":{
                "type":"string",
                "description":"",
                "maxLength":100
            },
            "serviceType":{
                "type":"string",
                "description":"",
                "maxLength":30
            },
            "ackNackResponseType":{
                "type":"string",
                "description":""
            }
        },
        "required":[
            "methodName",
            "integrationType",
            "messageType",
            "networkType",
            "serviceType"
        ]
    }

#### 400 Response

Malformed syntax.

#### 401 Response

Request does not have sufficient credentials.

#### 403 Response

Request is not authorized.

#### 405 Response

Invalid input

#### 500 Response

Internal error
Back to Top