Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DEV and version r0681

D s api version

D toc

Get information on the specified job group. A job group is a job that is executed from a specific node in a flow. The job group may contain:

  • Wrangling job on the dataset associated with the node
  • Jobs on all datasets on which the selected job may depend
  • A profiling job for the job group

Version:  v4

Required Permissions

D s api auth

Request

Request Type: GET

Endpoint:

Code Block
/v4/jobGroups/<id>

where:

ParameterDescription
<id>Internal identifier for the job group


Endpoint with embedded references:

Use the following endpoint to embed additional information:

Embed ParameterDescription
jobsEmbed information about the child jobs within the job group. Array includes information on transformation, profiling, and publishing jobs that are part of the job group.
wrangledDatasetThis field contains the internal identifier for the dataset on which the job was run.
Code Block
/v4/jobGroups/<id>?embed=jobs,wrangledDataset

Query parameter reference:

The following query parameters can be submitted with this endpoint:

Excerpt Include
API Query Parameters Get v4
API Query Parameters Get v4
nopaneltrue

For more information, see API Common Query Parameters v4.

Request URI - Example:

Code Block
/v4/jobGroups/8

Request Body:

Empty.

Response

Response Status Code - Success:  200 - OK

Response Body Example:

Code Block
{
    "id": 8,
    "name": null,
    "description": null,
    "ranfrom": "ui",
    "ranfor": "recipe",
    "status": "Complete",
    "profilingEnabled": true,
    "runParameterReferenceDate": "2018-01-25T18:01:15.000Z",
    "createdAt": "2018-01-25T18:01:16.456Z",
    "updatedAt": "2018-01-25T18:01:21.082Z",
    "workspace": {
        "id": 1
    },
    "creator": {
        "id": 1
    },
    "updater": {
        "id": 1
    },
    "snapshot": {
        "id": 8
    },
    "wrangledDataset": {
        "id": 12
    },
    "flowRun": null
}
 

Response Body Example with embedded reference:

The following example response includes embedded information on jobs and the recipe (wrangledDataset) associated with it.

Code Block
{
    "id": 8,
    "name": null,
    "description": null,
    "ranfrom": "ui",
    "ranfor": "recipe",
    "status": "Complete",
    "profilingEnabled": true,
    "runParameterReferenceDate": "2018-01-25T18:01:15.000Z",
    "createdAt": "2018-01-25T18:01:16.456Z",
    "updatedAt": "2018-01-25T18:01:21.082Z",
    "jobs": {
        "data": [
            {
                "id": 2,
                "createdAt": "2018-01-25T18:01:16.687Z",
                "updatedAt": "2018-01-25T18:01:21.071Z",
                "status": "Complete",
                "jobType": "filewriter",
                "sampleSize": 100,
                "percentComplete": 100,
                "creator": {
                    "id": 1
                },
                "jobGroup": {
                    "id": 1
                },
                "errorMessage": null,
                "scriptResult": {
                    "id": 1
                },
                "writeSetting": {
                    "id": 2
                }
            },
            {
                "id": 1,
                "executionLanguage": "<running_environment_name>",
                "cpJobId": null,
                "templateLocation": null,
                "createdAt": "2018-01-25T18:01:16.652Z",
                "updatedAt": "2018-01-25T18:01:19.558Z",
                "status": "Complete",
                "jobType": "wrangle",
                "sampleSize": 100,
                "percentComplete": 100,
                "creator": {
                    "id": 1
                },
                "jobGroup": {
                    "id": 1
                },
                "errorMessage": null,
                "wrangleScript": {
                    "id": 9
                }
            }
        ]
    },
    "wrangledDataset": {
        "id": 12,
        "wrangled": true,
        "referenceName": null,
        "referenceDescription": null,
        "createdAt": "2018-01-25T17:53:54.703Z",
        "updatedAt": "2018-01-25T17:53:54.741Z",
        "activeSample": {
            "id": 12
        },
        "creator": {
            "id": 1
        },
        "updater": {
            "id": 1
        },
        "recipe": {
            "id": 12
        },
        "flow": {
            "id": 4
        }
    },
    "workspace": {
        "id": 1
    },
    "creator": {
        "id": 1
    },
    "updater": {
        "id": 1
    },
    "snapshot": {
        "id": 8
    },
    "flowRun": null
} 

Reference

PropertyDescription
idInternal identifier for the job group
nameInternal name of the job group
descriptionUser-friendly description for the job group
ranfrom

Where the job group was executed from:

ui -

D s webapp

ranfor

Description of the object for which the job was run:

  • recipe - Recipe in a flow
  • sampling - Sampling job for a dataset
  • pendingDatasource - Job that is subjected to conversion, such as importing a Microsoft Excel workbook.
status

Current status of the job group:

Tip

Tip: Monitor the value in this field to get status on the specific jobGroup in progress.


  • Created - job group has been created based on the current action.
  • Pending - job group is queued for execution.
  • InProgress - job group is currently running.
  • Complete - job group has completed successfully.
  • Failed - job group has failed.
  • Canceled - job group was canceled by user action.
profilingEnabledWhen true, a profiling job was executed as part of this job group.
runParameterReferenceDateWhen a recipe is executed with dynamic parameters, this parameter is stored with the timestamp at the time of execution. It can be used in debugging execution issues. Do not modify this value.
createdAtTimestamp for when the job group was launched
updatedAtTimestamp for when the job group was last updated
jobs

A list of all jobs that were launched based on this job group.For more information, see API JobGroups Get Jobs v4.

wrangledDataset

Internal identifier of the object from where the job group was executed.For more information, see API WrangledDatasets Get v4.

workspace.idInternal identifier for the workspace where the job was executed
creator.idInternal identifier for the user who created the job group
updater.idInternal identifier for the user who last updated the job group
snapshot.idInternal identifier of the data snapshot for the job group
flowRun
Info

NOTE: This parameter is used for internal platform purposes. Do not modify.