Jump to

• Request
• Response

Update an existing rm linkage

put

/rmlinkage/{id}

This endpoint is used to update an existing rm linkage.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string
  key of the rmlinkage Maintenance

Body ()

Request Body that contains data required for updating an existing rmlinkage

Root Schema : LmmTmUserLinkageMasterDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmmTmUserLinkageMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "userId":{
                    "type":"string",
                    "description":"User Login ID",
                    "maxLength":15
                },
                "userName":{
                    "type":"string",
                    "description":"User Name"
                },
                "allCustomers":{
                    "type":"string",
                    "description":"All customers flag",
                    "maxLength":1,
                    "pattern":"[Y,N]"
                },
                "LmmTmUserCustomersDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LmmTmUserCustomersDTO"
                    }
                }
            },
            "required":[
                "userId"
            ]
        }
    ]
}

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

Type: object

Show Source

• allCustomers(optional): string
  Maximum Length: 1

  Pattern: [Y,N]

  All customers flag
• LmmTmUserCustomersDTO(optional): array LmmTmUserCustomersDTO
• userId: string
  Maximum Length: 15

  User Login ID
• userName(optional): string
  User Name

{
    "type":"object",
    "properties":{
        "userId":{
            "type":"string",
            "description":"User Login ID",
            "maxLength":15
        },
        "userName":{
            "type":"string",
            "description":"User Name"
        },
        "allCustomers":{
            "type":"string",
            "description":"All customers flag",
            "maxLength":1,
            "pattern":"[Y,N]"
        },
        "LmmTmUserCustomersDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmUserCustomersDTO"
            }
        }
    },
    "required":[
        "userId"
    ]
}

Nested Schema : LmmTmUserCustomersDTO

Type: array

Show Source

• Array of: object LmmTmUserCustomersDTO

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

Nested Schema : LmmTmUserCustomersDTO

Type: object

Show Source

• customerId: string
  Pattern: [a-zA-Z0-9]{1,20}
• id(optional): string
  Maximum Length: 36
• userLinkageMasterId(optional): string
  Maximum Length: 36

{
    "type":"object",
    "properties":{
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "id":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "userLinkageMasterId":{
            "type":"string",
            "description":"",
            "maxLength":36
        }
    },
    "required":[
        "customerId"
    ]
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns updated rmlinkage

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