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
    D s 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 v4.
    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
    {
    
        "reasonsessionId": "JobStarted79276c31-c58c-4e79-ae5e-fed1a25ebca1",
        "sessionIdreason": "5b883530-3920-11e8-a37a-db6dae3c6e43",
    JobStarted",
        "jobGraph": {
            "idvertices": 29
    }
  4. Retain the jobgroupId=29 value for monitoring. 

Example 2 - Dataset with Variable

In the following example, the region variable has been overwritten with the value central to execute the job on orders-central.csv:

  1. Endpointhttp://www.example.com:3005/v4/jobGroupsAuthenticationRequiredMethodPOSTRequest Body Code Block{ "wrangledDataset": {
    [
                21,
                22
            ],
            "
    id
    edges": 
    123
    [
      
    },
      
    "overrides":
     
    {
        
    "execution":
     
    "photon",
      
    "profiler": true,
    {
        
    "writesettings":
     
    [
       
    {
            "
    path
    source": 
    "MyFiles/queryResults/joe@example.com/region-eastern.csv"
    21,
            
    "action":
     
    "create",
           
    "
    format
    target": 
    "csv",
    22
              
    "compression": "none",
      }
            
    "header": false,
    ]
        },
        "
    asSingleFile
    id": 
    false
    29,
        
    }
    "jobs": {
        
    ]
      
    }
      "
    runParameters
    data": 
    {
    [
        
    "overrides":
     
    {
          
    "data":
     
    [
    {
            
    "key": "region",
            "id": 21
                },
                {
                    "
    value
    id": 
    "central"
    22
           
    }
         
    ]
    }
            ]
        }
    }
  2.  In the above example, the job has been launched for recipe 123 to execute on the
    D s 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 v4.
    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:


  4. Retain the jobgroupId=29 value for monitoring. 

Example 2 - Dataset with Variable

In the following example, the region variable has been overwritten with the value central to execute the job on orders-central.csv:


  1. Endpointhttp://www.example.com:3005/v4/jobGroups
    AuthenticationRequired
    MethodPOST
    Request Body


    Code Block
    {
      
    "
    reason
    wrangledDataset": 
    "JobStarted",
    {
        "
    sessionId
    id": 
    "aa0f9f00-391f-11e8-a37a-db6dae3c6e43",
    123
      },
      "
    id
    overrides": 
    27 }
  2. Retain the jobgroupId=27 value for monitoring. 

 

Example 3 - Dataset with pattern parameter

In the following example, the value 02 has been inserted into the pattern to execute the job on POS-r02.csv

Info

NOTE: You cannot apply overrides to these types of datasets with parameters.

  1. Endpointhttp://www.example.com:3005/v4/jobGroups
    AuthenticationRequired
    MethodPOST
    Request Body
    Code Block
    {
      "wrangledDataset": {
        "id": 121
      },
      "overrides": {
        "execution": "photon{
        "execution": "photon",
        "profiler": true,
        "writesettings": [
          {
            "path": "MyFiles/queryResults/joe@example.com/region-eastern.csv",
            "action": "create",
            "format": "csv",
            "compression": "none",
            "profilerheader": false,
            "writesettingsasSingleFile": [false
          {}
        ]
      }
      "pathrunParameters": {
        "overrides"hdfs://hadoop:50070/trifacta/queryResults/admin@example.com/POS-r02.txt",
       : {
          "actiondata": "create",[{
            "formatkey": "csvregion",
            "compressionvalue": "nonecentral",
            "header": false,}
            "asSingleFile": false
          }
        ]
      },
      "runParameters": {}
    }]}
      }
    }



  2.  In the above example, the job has been launched for recipe 121123 to execute on the
    D s 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 v4.
    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:

    { "reason": "JobStarted", "sessionId": "16424a60-3920-11e8-a37a-db6dae3c6e43", "id": 28
    Code Block
    {
        "sessionId": "79276c31-c58c-4e79-ae5e-fed1a25ebca1",
        "reason": "JobStarted",
        "jobGraph": {
            "vertices": [
                21,
                22
            ],
            "edges": [
                {
                    "source": 21,
                    "target": 22
                }
            ]
        },
        "id": 27,
        "jobs": {
            "data": [
                {
                    "id": 21
                },
                {
                    "id": 22
                }
            ]
        }
    }


  4. Retain the jobgroupId=27 value for monitoring. 

 

Example 3 - Dataset with pattern parameter

In the following example, the value 02 has been inserted into the pattern to execute the job on POS-r02.csv

Info

NOTE: You cannot apply overrides to these types of datasets with parameters.


  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@example.com/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
    D s 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 v4.
    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
    {
    
        "sessionId": "79276c31-c58c-4e79-ae5e-fed1a25ebca1",
        "reason": "JobStarted",
        "jobGraph": {
            "vertices": [
                21,
                22
            ],
            "edges": [
                {
                    "source": 21,
                    "target": 22
                }
            ]
        },
        "id": 28,
        "jobs": {
            "data": [
                {
                    "id": 21
                },
                {
                    "id": 22
                }
            ]
        }
    }


  4. Retain the jobgroupId=28 value for monitoring. 

...