GET api/meta/{id}/tree?mode={mode}

Retrieves a hierarchical metadata structure for a given asset or item.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The unique identifier of the item or asset for which metadata is requested.	integer	Required
mode	The mode of metadata retrieval. Default is "asset".	string	Default value is asset

Body Parameters

None.

Response Information

Resource Description

On success: HTTP 200 OK with a hierarchical list of metadata elements. On failure: HTTP 400 Bad Request with a message indicating access issues or missing data.

Collection of MetaElement

Name	Description	Type	Additional information
label	Field label (note a form may have the same label repeated so GUID is the only safe unique identifier)	string	None.
type	The type of element	string	None.
GUID	unique GUID for this field	string	None.
iteration	The iteration (index of parent element)	integer	None.
index	The groupIndex (zero-based row index) of this value	integer	None.
entryGUID	Entry/row GUID for this field	string	None.
values	Array of values, most fields will have a single value here but certain fields like checkboxes may have multiple values	Collection of MetaValue	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "label": "sample string 1",
    "type": "sample string 2",
    "GUID": "sample string 3",
    "iteration": 4,
    "index": 5,
    "entryGUID": "sample string 6",
    "children": [],
    "rows": [
      [],
      []
    ],
    "values": [
      {
        "value": "sample string 1",
        "attributeid": 2,
        "fileID": 3,
        "userID": 4,
        "userGroupID": 5,
        "associatedItemID": 6,
        "other": true,
        "roleID": 8,
        "matrixID": 9,
        "matrixVersion": "sample string 10",
        "matrixName": "sample string 11",
        "tableGUID": "sample string 12",
        "matrixDisplayName": "sample string 13",
        "groupIdx": 14
      },
      {
        "value": "sample string 1",
        "attributeid": 2,
        "fileID": 3,
        "userID": 4,
        "userGroupID": 5,
        "associatedItemID": 6,
        "other": true,
        "roleID": 8,
        "matrixID": 9,
        "matrixVersion": "sample string 10",
        "matrixName": "sample string 11",
        "tableGUID": "sample string 12",
        "matrixDisplayName": "sample string 13",
        "groupIdx": 14
      }
    ]
  },
  {
    "label": "sample string 1",
    "type": "sample string 2",
    "GUID": "sample string 3",
    "iteration": 4,
    "index": 5,
    "entryGUID": "sample string 6",
    "children": [],
    "rows": [
      [],
      []
    ],
    "values": [
      {
        "value": "sample string 1",
        "attributeid": 2,
        "fileID": 3,
        "userID": 4,
        "userGroupID": 5,
        "associatedItemID": 6,
        "other": true,
        "roleID": 8,
        "matrixID": 9,
        "matrixVersion": "sample string 10",
        "matrixName": "sample string 11",
        "tableGUID": "sample string 12",
        "matrixDisplayName": "sample string 13",
        "groupIdx": 14
      },
      {
        "value": "sample string 1",
        "attributeid": 2,
        "fileID": 3,
        "userID": 4,
        "userGroupID": 5,
        "associatedItemID": 6,
        "other": true,
        "roleID": 8,
        "matrixID": 9,
        "matrixVersion": "sample string 10",
        "matrixName": "sample string 11",
        "tableGUID": "sample string 12",
        "matrixDisplayName": "sample string 13",
        "groupIdx": 14
      }
    ]
  }
]

application/scim+json

Sample:

An exception has occurred while using the formatter 'SCIMMediaTypeFormatter' to generate sample for media type 'application/scim+json'. Exception message: Self referencing loop detected with type 'SDAPI.MetaElement'. Path '[0].children'.