Jump to

• Request
• Response

Adds a new external system setup

post

/externalsystemsetup

This endpoint is used to add a new external system setup.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Request Body that contains data required for creating a new externalsystemsetup

Root 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"
    ]
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created externalsystemsetup

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): object ResponseResourceSupport
• messages(optional): object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

• arg(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

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