GET api/matrix?filter={filter}
Retrieves a list of metadata attribute matrices, optionally filtered by title.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| filter |
Optional filter string to match matrix titles. |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
On success: HTTP 200 OK with a list of matrices and their children. On failure: HTTP 400 Bad Request with a message indicating the error.
Collection of MatrixListDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Unique Matrix ID |
integer |
None. |
| title |
Matrix title |
string |
None. |
| type |
Matrix type, used for referenceing matrix in forms |
string |
None. |
| tags |
Matrix Tag information |
Collection of Tag |
None. |
| children |
List of child or sub matrices, these matrices inherit data from the parent |
Collection of MatrixListDTO |
None. |
Response Formats
application/json, text/json, application/scim+json
Sample:
Sample not available.