Updating reference data

Update the reference data.

Before you begin

  • Admin access is required. Only admins have the necessary permissions for this activity.
  • If you do not have admin access but hold a custom role, ensure that you have the write access specifically for the project where you intend to update the reference data.

Procedure

  1. In a REST client platform, add the authentication details of the tenant where you want to update 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"
    }
    Body: 
    {    
            "name": "<name>*",
            "description": "<description>",
            "file": "<file>",
            "file_encoding": "<file_encoding>*", //Only following file encoding formats are suppported: IBM437, windows-1252, IBM00858, IBM775, IBM850, IBM852, IBM855, IBM857, IBM862, IBM866, ISO-8859-1, ISO-8859-2, ISO-8859-4, ISO-8859-5, ISO-8859-7, ISO-8859-9, ISO-8859-13, ISO-8859-15, KOI8-R, KOI8-U, US-ASCII, UTF-8, UTF-16, UTF-16BE, UTF-16LE, UTF-32, UTF-32BE, UTF-32LE, x-UTF-32BE-BOM, x-UTF-32LE-BOM, windows-1250, windows-1251, windows-1253, windows-1254, windows-1257, x-IBM737, x-IBM874, and x-UTF-16LE-BOM
            "field_separator": "<field_separator>*",
            "text_qualifier": <text_qualifier> *        
    }
    Note: The fields marked as * are required.
  2. Make a PUT 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 in which you want to update a reference data and <referencedata_name> is the name of the reference data you want to update.

    Method: PUT

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

    {
        "output": {
            "response": "<update_success_message>"
        }
    }