Jump to

• Request
• Response

Simulate pool for a structure

post

/pool/simulate

This endpoint is used to simulate pool for a structure.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Request Body that contains data required for invoking a pool batch for structure

Root Schema : LmmTmPoolStructureDTO

Type: object

Show Source

• headerSimAccount(optional): string
• jobSchedulerId(optional): string
• simulate(optional): string
• simulateExecDt(optional): string(date)
• simulateFromDt(optional): string(date)
• simulateToDt(optional): string(date)
• structureId(optional): string
  Pattern: [0-9a-fA-Z-]{1,36}

{
    "type":"object",
    "properties":{
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[0-9a-fA-Z-]{1,36}"
        },
        "jobSchedulerId":{
            "type":"string",
            "description":""
        },
        "simulate":{
            "type":"string",
            "description":""
        },
        "simulateFromDt":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "simulateToDt":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "simulateExecDt":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "headerSimAccount":{
            "type":"string",
            "description":""
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Headers

• Location: string

Body ()

Root Schema : PoolSimulateReportDTOCollection

Type: object

Collection of report output.

Show Source

• data(optional): object ReportResponse
  Report Response
• messages(optional): object ResponseDto

{
    "description":"Collection of report output.",
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/ReportResponse"
        },
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        }
    }
}

Nested Schema : ReportResponse

Type: object

Report Response

Show Source

• documentId(optional): string
  Document Id for the document
• documentInbase64(optional): string
  Document in Base64
• reportContentType(optional): string
  Report Content Type for the document

{
    "description":"Report Response",
    "type":"object",
    "properties":{
        "documentId":{
            "description":"Document Id for the document",
            "type":"string"
        },
        "documentInbase64":{
            "description":"Document in Base64",
            "type":"string"
        },
        "reportContentType":{
            "description":"Report Content Type for the document",
            "type":"string"
        }
    }
}

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