Skip to main content
Matrix42 Self-Service Help Center

Fragments Data Service: Get a list of Fragment Relations


Retrieves a list of fragment's relations with a defined list of columns which match the specified search criteria and are sorted in the defined order.



The URL which returns only the requested relations data has the following format

GET  http(s)://{server}/M42Services/api/data/fragments/{ddname}/{fragmentid}/{relationname}?

In case the additional  schema meta-data about the selected attributes  has to be included in the response, like data type of attributes, then the following link needs to be used 

GET  http(s)://{server}/M42Services/api/data/fragments/{ddname}/{fragmentid}/{relationname}/schema-info?

In c

URL Attributes and Query Parameters

Element Description Type Required
ddName The technical name of the Data Definition (e.g. SPSActivityClassBase) string Required
fragmentId Id of the specified Data Definition's fragment. GUID Required
relationName Technical name of the relation (e.g. AttachedUsers). string Required
where A-SQL Where Expression.  If no filtering expression is specified, the Service returns all fragment's relations of the specified Data Definition which are allowed for the caller.
More information see ASQL page.
string Optional
columns A-SQL Column expression defines the columns in the result set, separated by Comma. If no Columns defines, then the Operation returns only Fragment's Relation Ids. 
Example: Name, Parent.Name as ParentName
string Optional


Sets the number of records (fragments) returned by Operation. Used in combination with the PageNumber parameter

integer Optional
pageNumber Sets the Number of the page. Used in combination with PageSize property. integer Optional
Sort Defines the sorting in the result. Example: "Name ASC, CreatedDate DESC" string Optional
includelocalizations Specifies whether the Localization table should be included in the result.  The parameter works ONLY with the request with "schema-info" directive.  boolean Optional


For a list of available HTTP request headers see Web Services: REST API integration.



Response without Schema meta-information

    "DisplayString":"{Fragment Display String}",
    "Column1": value


Response with Schema meta-information

    Result: [{
        "DisplayString":"{Fragment Display String}",       
        "Column1": value
    Schema: [{
        "ColumnType": {StringType | DateType | IntergerType | ...},
        "Localizable": {true | false}
    ResultLocalization: [{
        "ID": value,
        "Owner": <fragmentID>
        "LCID": value,
        "Column1": "Column1 localization value"

Status Codes and Errors

The following table lists the returned HTTP status codes.

Code Description



  • Was this article helpful?