Web API Edition | ComponentOne
Services / Data Engine Services / Detail Data
In This Topic
    Detail Data
    In This Topic

    Detail Data service provides API to get a list of objects in the raw data source that define the content of a specific cell in the output. This service is not supported when you are connected to cube data. Your client application sends an HTTP request to the service application for using the Detail Data API to get the detail data of the specified cell.

    Detail Data Service Request Schema

    To view detail data from a data source, you need to use POST method. Data source information specified in the request URL, as:

    POST:http://<host>[:port]/api/dataengine/{datasourcekey}

    Data source information can be specified in the request URL, as follows

    URL Parameters

    Raw Data service includes the following parameters.

    Parameter Description
    datasourcekey Used to specify the data source from where you want to get the field information.
    View Definition Used to specify the view definition. Type is IViewDefinition. For example:
    {
      fields:[
       {"binding":"Active","dataType":3},
       {"binding":"Country","dataType":1},
       {"binding":"Date","dataType":4},
       {"binding":"Discount","dataType":2},
       {"binding":"Downloads","dataType":2},
       {"binding":"ID","dataType":2},
       {"binding":"Product","dataType":1},
       {"binding":"Sales","dataType":2}
      ],
      rowFields:{items:["Product"]},
      columnFields:{

    items:["Country"]},
      valueFields:{items:["Sales"]}
    }
    Key Used to specify the cell using the corresponding value. It is an array object. Firstly, you need add the values of the fields in rowFields in order into keys. Then add the values of the fields in columnFields in order. If some field value is null, JUST add null into array and DO NOT remove it. You should keep the count of the keys array same as the count of the fields in rowFields and columnFields.
    For example:
    ["Aoba", "China"]
    Skip A positive integer value to specify the start index of the whole raw data. If not set, then returns the entries from the first one.
    Top A positive integer value to specify the count of the returned raw data. If not set, then returns all entries starting with the skip value.

    Response Messages

    HTTP Status Code Reason
    200 An IRawData object is returned to specify the detail result information. It includes two parts: an array for the raw data of the cell and the total count of the raw data without paging.
    404 {datasource} is invalid.

    For more information on Data Engine Services, see WebApiExplorer demo.