GMUS API - Add Dynamic File Configuration Name to Receiver

Description

This method can be used with any Receiver that has the Dynamic File Configuration available as part of its configuration. You can use it to add the Dynamic File Configuration Name when using the Receiver with the GMUS API.

URL: http://<ipAddress>:8070/rest/scenarios

Method Type: POST

Method Name: receiverAddDynamicFileNameConfig

Parameters

• domainName - name of the Domain the Receiver is assigned to.
• receiverName - name of the Receiver that the File Name config needs to be added to.
• fileNameConfigs - configuration details for the file name.
  • Constant - used to define each portion of the dynamic file name

Parameters with Example Values

This example is for the JSONFileMaskReceiver. The file name format will be masked_sample_1.json.

{
  "clientAppId" : "XXXXXXXX-1e47-abcd-ba66-XXXXXXXXXXXX",
  "clientUserId": "XXXXXXXX-abcd-4284-aa45-XXXXXXXXXXXX",
  "username"    : "jane.doe@gmail.com",
  "scenario"    : "UserScenario.grs",
  "scenarioPath": "/home/jDoe/Download/output",
  "debug": "true",
  "api": [
    {
        "methodName": "receiverAddDynamicFileNameConfig",
        "parameters": {
        "domainName": "Test",
        "receiverName": "JSONFileMaskReceiver",
        "fileNameConfigs": [
    {
        "Constant": "masked_sample"
    },
    {
        "Constant": "_"
    },
    {
        "Counter": "1"
    },
    {
        "Constant": ".json"
    }
    ]
   }
  }
 ]
}