Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Endpointhttp://www.example.com:3005/v4/jobGroups
    AuthenticationRequired
    MethodPOST
    Request Body
    Code Block
    {
      "wrangledDataset": {
        "id": 127
      },
      "overrides": {
        "execution": "photon",
        "profiler": true,
        "writesettings": [
          {
            "path": "MyFiles/queryResults/joe@example.com/2018-04-03-orders.csv",
            "action": "create",
            "format": "csv",
            "compression": "none",
            "header": false,
            "asSingleFile": false
          }
        ],
        "runParameters": []{}
        }
      }
    }
    
  2.  In the above example, the job has been launched for recipe 127 to execute on the Photon running environment with profiling enabled. 
    1. Output format is CSV to the designated path. For more information on these properties, see API JobGroups Create v3v4.
    2. Output is written as a new file with no overwriting of previous files.
  3. A response code of 201 - Created is returned. The response body should look like the following:

    Code Block
    {
        "reason": "JobStarted",
        "sessionId": "5b883530-3920-11e8-a37a-db6dae3c6e43",
        "id": 29,
        "jobs": {
            "data": [
                {
                    "id": 62
                },
                {
                    "id": 63
                }
            ]
        }
    }
  4. Retain the jobgroupId=29 value for monitoring. 

...

  1. Endpointhttp://www.example.com:3005/v4/jobGroups
    AuthenticationRequired
    MethodPOST
    Request Body
    Code Block
    {
      "wrangledDataset": {
        "id": 123
      },
      "overrides": {
        "execution": "photon",
        "profiler": true,
        "writesettings": [
          {
            "path": "MyFiles/queryResults/joe@example.com/region-eastern.csv",
            "action": "create",
            "format": "csv",
            "compression": "none",
            "header": false,
            "asSingleFile": false
          }
        ]
      }
      "runParameters": {
        "overrides": {
          "data": [{
            "key": "region",
            "value": "central"
          }
        ]}
      }
    }
  2.  In the above example, the job has been launched for recipe 123 to execute on the Photon running environment with profiling enabled. 
    1. Output format is CSV to the designated path. For more information on these properties, see API JobGroups Create v3v4.
    2. Output is written as a new file with no overwriting of previous files.
  3. A response code of 201 - Created is returned. The response body should look like the following:

    Code Block
    {
        "reason": "JobStarted",
        "sessionId": "aa0f9f00-391f-11e8-a37a-db6dae3c6e43",
        "id": 27,
        "jobs": {
            "data": [
                {
                    "id": 58
                },
                {
                    "id": 59
                }
            ]
        }
    }
  4. Retain the jobgroupId=27 value for monitoring. 

...

  1. Endpointhttp://www.example.com:3005/v4/jobGroups
    AuthenticationRequired
    MethodPOST
    Request Body
    Code Block
    {
      "wrangledDataset": {
        "id": 121
      },
      "overrides": {
        "execution": "photon",
        "profiler": false,
        "writesettings": [
          {
            "path": "hdfs://hadoop:50070/trifacta/queryResults/admin@trifacta.local/POS-r02.txt",
            "action": "create",
            "format": "csv",
            "compression": "none",
            "header": false,
            "asSingleFile": false
          }
        ],
        "runParameters": []{}
      }
    }
  2.  In the above example, the job has been launched for recipe 121 to execute on the Photon running environment with profiling enabled. 
    1. Output format is CSV to the designated path. For more information on these properties, see API JobGroups Create v3v4.
    2. Output is written as a new file with no overwriting of previous files.
  3. A response code of 201 - Created is returned. The response body should look like the following:

    Code Block
    {
        "reason": "JobStarted",
        "sessionId": "16424a60-3920-11e8-a37a-db6dae3c6e43",
        "id": 28,
        "jobs": {
            "data": [
                {
                    "id": 60
                },
                {
                    "id": 61
                }
            ]
        }
    }
  4. Retain the jobgroupId=28 value for monitoring. 

...

Endpointhttp://www.example.com:3005/v3v4/jobGroups
AuthenticationRequired
MethodPOST
Request Body
Code Block
{
  "wrangledDataset": {
    "id": 123
  },
  "runParameters": {
    "overrides": {
      "data": [{
        "key": "region",
        "value": "central"
      }
    ]}
  }
}

...