Jump to

• Request
• Response

Update an existing event

put

/event/{id}

This endpoint is used to update an existing event.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string
  key of the event Maintenance

Body ()

Request Body that contains data required for updating an existing event

Root Schema : LmmTmEventsDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmmTmEventsDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "evtCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":50
                },
                "evtCategory":{
                    "type":"string",
                    "description":"",
                    "maxLength":20
                },
                "evtDesc":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "evtTopic":{
                    "type":"string",
                    "description":"",
                    "maxLength":50
                },
                "evtIsEnabled":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                }
            },
            "required":[
                "id",
                "evtCode"
            ]
        }
    ]
}

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

Type: object

Show Source

• evtCategory(optional): string
  Maximum Length: 20
• evtCode: string
  Maximum Length: 50
• evtDesc(optional): string
  Maximum Length: 100
• evtIsEnabled(optional): string
  Maximum Length: 1
• evtTopic(optional): string
  Maximum Length: 50

{
    "type":"object",
    "properties":{
        "evtCode":{
            "type":"string",
            "description":"",
            "maxLength":50
        },
        "evtCategory":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "evtDesc":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "evtTopic":{
            "type":"string",
            "description":"",
            "maxLength":50
        },
        "evtIsEnabled":{
            "type":"string",
            "description":"",
            "maxLength":1
        }
    },
    "required":[
        "id",
        "evtCode"
    ]
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns updated event

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