GET api/matrix/data/{id}?sheet={sheet}&version={version}

Retrieves the full contents of a specific metadata matrix, including metadata (sheets, structure, versions) and row data, optionally filtered by sheet and version.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The unique identifier of the matrix to retrieve.	integer	Required
sheet	Optional sheet name to filter the matrix contents.	string	None.
version	Optional version identifier to retrieve a specific version of the matrix.	string	None.

Body Parameters

None.

Response Information

Resource Description

On success: HTTP 200 OK with the full matrix definition and row data. On failure: HTTP 400 Bad Request with a message indicating the error.

MatrixDataFullDTO

Name	Description	Type	Additional information
id	Matrix unique identifier	integer	None.
typeID	Matrix type identifier	integer	None.
name	Matrix name	string	None.
structure	Matrix structure (JSON schema)	string	None.
type	Matrix type (e.g. Discrete, Continuous)	string	None.
sheets	List of matrix sheets with row data (cleaned version for /matrix/data)	Collection of MatrixSheetDataDTO	None.
versions	List of matrix versions	Collection of MatrixVersion	None.

Response Formats

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

Sample:

{
  "id": 1,
  "typeID": 2,
  "name": "sample string 3",
  "structure": "sample string 4",
  "type": "sample string 5",
  "sheets": [
    {
      "name": "sample string 1",
      "guid": "sample string 2"
    },
    {
      "name": "sample string 1",
      "guid": "sample string 2"
    }
  ],
  "versions": [
    {
      "guid": "sample string 1",
      "name": "sample string 2",
      "disabled": true,
      "isDefault": true
    },
    {
      "guid": "sample string 1",
      "name": "sample string 2",
      "disabled": true,
      "isDefault": true
    }
  ]
}