Retrieving data detail

Retrieve the details of the reference data.

About this task

Complete the following steps:

Procedure

  1. In a REST client platform, add the authentication details of the tenant from where you want to get the details of the reference data.
    
    //In case of Instance API key 
    Headers:
    {
    "x-instance-api-key": "instance_api_key"
    }
     
    // In case of MCSP or ISV token
    Headers:
    {
    "Authorization": "mcsp_or_isv_token"
    }
    Note: Accept is an optional field and the supported values are "", "application/json", and "plain/text".
  2. Make a GET request at the URL of the project.

    URL syntax: <domain>apis/v1/rest/projects/<project_name>/referencedata/<referencedata_name>

    In this URL request, <project_name> is the name or UID of the project from where you want to get a reference data and <referencedata_name> is the name of the reference data you want to get the details of.

    Method: GET

    If the request is successful, you receive the response code for success.

    Output when the value of Accept is "application/json":

    {
        "output": {
            "name": "<name>",
            "description": "<description>",
            "columnDelimiter": "<columnDelimiter>",
            "releaseCharacter": "<releaseCharacter>",
            "columnNames": [<columnNames>],
            "dataRecords": [<dataRecords>],
            "revisionData": "<revisionData>",
            "encodingType": "<encodingType>",
            "version": "<version>"
        }
    }
    

    Output when the value of Accept is "plain/text":

    Raw CSV of reference data. For example,

    data11,data12,data13
    data21,data22,data23
    data31,data32,data33