Jump to

• Request
• Response

Get all valid external system setup details

get

/service/lmx/externalsystemsetup/getDetails

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

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

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

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 : LmxTmExternalSystemLOVCollection

Type: object

Collection of externalsystem details.

Show Source

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object LmxTmExternalSystemLOVDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : LmxTmExternalSystemLOVDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmxTmExternalSystemLOVDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "externalSystemId":{
                    "type":"string",
                    "description":""
                },
                "messageType":{
                    "type":"string",
                    "description":""
                },
                "methodName":{
                    "type":"string",
                    "description":""
                },
                "networkType":{
                    "type":"string",
                    "description":""
                },
                "serviceType":{
                    "type":"string",
                    "description":""
                },
                "externalSystemMasterId":{
                    "type":"string",
                    "description":""
                },
                "externalSystemDetailsId":{
                    "type":"string",
                    "description":""
                },
                "externalSystemName":{
                    "type":"string",
                    "description":""
                }
            }
        }
    ]
}

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 : LmxTmExternalSystemLOVDTO-allOf[1]

Type: object

Show Source

• externalSystemDetailsId(optional): string
• externalSystemId(optional): string
• externalSystemMasterId(optional): string
• externalSystemName(optional): string
• messageType(optional): string
• methodName(optional): string
• networkType(optional): string
• serviceType(optional): string

{
    "type":"object",
    "properties":{
        "externalSystemId":{
            "type":"string",
            "description":""
        },
        "messageType":{
            "type":"string",
            "description":""
        },
        "methodName":{
            "type":"string",
            "description":""
        },
        "networkType":{
            "type":"string",
            "description":""
        },
        "serviceType":{
            "type":"string",
            "description":""
        },
        "externalSystemMasterId":{
            "type":"string",
            "description":""
        },
        "externalSystemDetailsId":{
            "type":"string",
            "description":""
        },
        "externalSystemName":{
            "type":"string",
            "description":""
        }
    }
}

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