The CopyDistributionMatrix client API is used to copy a matrix with all its property columns with or without the data.
Argument |
Description |
---|---|
Parameter 1 |
Matrix to MatrixRow RelDef |
Parameter 1 default |
None |
Parameter 1 description |
The unique identification number (UID) of the relationship definition between a matrix and its row (prefixed with + or -). |
Parameter 1 type |
String |
Parameter 2 |
MatrixRow to Recipient RelDef |
Parameter 2 default |
None |
Parameter 2 description |
UID of the relationship definition between a row and the row recipient (prefixed with + or -). |
Parameter 2 type |
String |
Parameter 3 |
Rels to be copied on the recipient |
Parameter 3 default |
None |
Parameter 3 description |
Comma-separated relationship UIDs which need to be copied on to the row recipient. |
Parameter 3 type |
String |
Parameter 4 |
Copy Structure? |
Parameter 4 default |
False |
Parameter 4 description |
Allows you to control the copy mode on the matrix.
|
Parameter 4 type |
Boolean |
Parameter 5 |
AllowableConfigStates (Optional) |
Parameter 5 default |
Active state configuration, if no argument is passed. |
Parameter 5 description |
Indicates the configuration items shown in the Copy Matrix form based on the configuration state UIDs (comma separated) in the method argument. |
Parameter 5 type |
String |