Jump to

• Request
• Response

Add new data for sweep master

post

/sweepmaster

This endpoint is used to add a new sweep master.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Request Body that contains data required for creating a new sweepmaster monitor

Root Schema : LmsTbSweepMasterDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmsTbSweepMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "executionId":{
                    "type":"string",
                    "description":"",
                    "maxLength":30
                },
                "structureId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[0-9a-fA-Z-]{1,36}"
                },
                "customerId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "executionTime":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "status":{
                    "type":"string",
                    "description":""
                },
                "statusMessage":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "valueDate":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "errorReference":{
                    "type":"string",
                    "description":"",
                    "maxLength":36
                },
                "isBvt":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                },
                "bvtId":{
                    "type":"string",
                    "description":"",
                    "maxLength":36
                },
                "isSimulate":{
                    "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 : LmsTbSweepMasterDTO-allOf[1]

Type: object

Show Source

• bvtId(optional): string
  Maximum Length: 36
• customerId(optional): string
  Pattern: [a-zA-Z0-9]{1,20}
• errorReference(optional): string
  Maximum Length: 36
• executionId(optional): string
  Maximum Length: 30
• executionTime(optional): string(date)
• isBvt(optional): string
  Maximum Length: 1
• isSimulate(optional): string
• status(optional): string
• statusMessage(optional): string
  Maximum Length: 100
• structureId(optional): string
  Pattern: [0-9a-fA-Z-]{1,36}
• valueDate(optional): string(date)

{
    "type":"object",
    "properties":{
        "executionId":{
            "type":"string",
            "description":"",
            "maxLength":30
        },
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[0-9a-fA-Z-]{1,36}"
        },
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "executionTime":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "status":{
            "type":"string",
            "description":""
        },
        "statusMessage":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "valueDate":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "errorReference":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "isBvt":{
            "type":"string",
            "description":"",
            "maxLength":1
        },
        "bvtId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "isSimulate":{
            "type":"string",
            "description":""
        }
    }
}

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 sweepmaster data

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