POST api/matrix/clone

Clones an existing matrix or rate card, optionally updating its tags and optionally retaining the existing data.

Request Information

URI Parameters

None.

Body Parameters

The source matrix to clone, the new matrix's title and tags, and whether to copy the source data.

CloneMatrixOptions
NameDescriptionTypeAdditional information
sourceId

integer

None.

sourceName

string

None.

cloneName

string

None.

newValuesForClone

Collection of Collection of string

None.

cloneMatrixData

boolean

None.

cloneTags

Dictionary of string [key] and string [value]

None.

Request Formats

application/json, text/json, application/scim+json

Sample:
{
  "sourceId": 1,
  "sourceName": "sample string 2",
  "cloneName": "sample string 3",
  "newValuesForClone": [
    [
      "sample string 1",
      "sample string 2"
    ],
    [
      "sample string 1",
      "sample string 2"
    ]
  ],
  "cloneMatrixData": true,
  "cloneTags": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CloneMatrixOptions'.

Response Information

Resource Description

On success: HTTP 200 OK with the new matrix ID in the response body. On failure: HTTP 400 Bad Request with a message indicating the error.

IHttpActionResult

None.

Response Formats

application/json, text/json, application/scim+json

Sample:

Sample not available.