Jump to

• Request
• Response
• Examples

Get the job run information of a given jobId for a sequence

get

/api/20210901/catalog/sequences/{sequenceId}/history/{jobId}

Get the job run information of a given jobId for a sequence

Request

Path Parameters

• jobId(required): string(byte)
• sequenceId(required): string(byte)
  The object ID of the sequence with Base64 encoding. For example, if your sequence has the object ID 'User1'.'sequence1', enter the Base64 encoded value, J1VzZXIxJy4nc2VxdWVuY2UxJw==.

Query Parameters

• includeTasks: boolean(byte)
  possible values:\ true or false. Default value is true. If true, all task histories will be included in job histories. If false, only job histories will be returned.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object JobInformation

{
    "items":{
        "type":"array",
        "$ref":"#/components/schemas/JobInformation"
    }
}

Nested Schema : JobInformation

Type: object

Show Source

• jobEndTimestamp: string
  time when job finishes running
• jobExecutionTimestamp": string
  time when job starts running
• jobIdentifier: string
  job run identifier
• jobName: string
  job run name
• jobNumberOfTasks: number
  number of tasks in this job
• jobOriginOfRequest: string
  source where job is requested from Manual, or Schedule
• jobQueuedDuration: string
  time the job stayed in queue
• jobRunDuration: string
  time takes for job to run
• jobRunType: string
  type of job
• jobStartTimestamp: string
  time when job is requested
• jobStatus: string
  status of job
• jobTasks: jobTasks

{
    "properties":{
        "jobName":{
            "type":"string",
            "description":"job run name"
        },
        "jobIdentifier":{
            "type":"string",
            "description":"job run identifier"
        },
        "jobRunType":{
            "type":"string",
            "description":"type of job"
        },
        "jobStatus":{
            "type":"string",
            "description":"status of job"
        },
        "jobStartTimestamp":{
            "type":"string",
            "description":"time when job is requested"
        },
        "jobExecutionTimestamp\"":{
            "type":"string",
            "description":"time when job starts running"
        },
        "jobEndTimestamp":{
            "type":"string",
            "description":"time when job finishes running"
        },
        "jobQueuedDuration":{
            "type":"string",
            "description":"time the job stayed in queue"
        },
        "jobRunDuration":{
            "type":"string",
            "description":"time takes for job to run"
        },
        "jobOriginOfRequest":{
            "type":"string",
            "description":"source where job is requested from Manual, or Schedule"
        },
        "jobNumberOfTasks":{
            "type":"number",
            "description":"number of tasks in this job"
        },
        "jobTasks":{
            "items":{
                "type":"array",
                "$ref":"#/components/schemas/TaskInformation"
            }
        }
    }
}

Nested Schema : jobTasks

Type: array

Show Source

• Array of: object TaskInformation

{
    "items":{
        "type":"array",
        "$ref":"#/components/schemas/TaskInformation"
    }
}

Nested Schema : TaskInformation

Type: object

Show Source

• taskAverageReadThroughput: number
  average read throughput for task
• taskDataSizeInBytes: number
  total data processed by task in bytes
• taskEndTimestamp: string
  task end time
• taskName: string
  task run name
• taskNumberOfSuccessfulRows: number
  number of successful rows processed in this task
• taskRunDuration: string
  time takes for task to run
• taskSourceName: string
  source connection name
• taskStartTimestamp": string
  task start time
• taskStatus: string
  status of task
• taskTargetName: string
  target connection name

{
    "properties":{
        "taskName":{
            "type":"string",
            "description":"task run name"
        },
        "taskSourceName":{
            "type":"string",
            "description":"source connection name"
        },
        "taskTargetName":{
            "type":"string",
            "description":"target connection name"
        },
        "taskStatus":{
            "type":"string",
            "description":"status of task"
        },
        "taskDataSizeInBytes":{
            "type":"number",
            "description":"total data processed by task in bytes"
        },
        "taskStartTimestamp\"":{
            "type":"string",
            "description":"task start time"
        },
        "taskEndTimestamp":{
            "type":"string",
            "description":"task end time"
        },
        "taskAverageReadThroughput":{
            "type":"number",
            "description":"average read throughput for task"
        },
        "taskRunDuration":{
            "type":"string",
            "description":"time takes for task to run"
        },
        "taskNumberOfSuccessfulRows":{
            "type":"number",
            "description":"number of successful rows processed in this task"
        }
    }
}

403 Response

Forbidden (missing permissions for operation, request denied for unspecified reason, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

404 Response

Not Found. The requested resource was not found.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

Back to Top

Examples

In this example, you return the detailed history of a specific job run for the ID 1234ABCD5678EFGH9012IJKL3456MNOP and a given sequenceID. The object ID of the data set is '[e-mail]'.'MySalesSequences' which has the Base64URL-safe encoded sequenceID value: J2pvaG4uc21pdGhAbXljb21wYW55LmNvbScuJ015U2FsZXNTZXF1ZW5jZXMn.

cURL Example:

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request GET 'https://<hostname>/api/20210901/catalog/sequences/J2pvaG4uc21pdGhAbXljb21wYW55LmNvbScuJ015U2FsZXNTZXF1ZW5jZXMn/history/1234ABCD5678EFGH9012IJKL3456MNOP' \

This example returns both job and task history for a specific job.

Example of Request Body

Not applicable.

Example of Response Body

[
    {
    "jobName":"'[e-mail]'.'MySalesSequence: Enrich MySales Report'",
    "jobIdentifier":"1234ABCD5678EFGH9012IJKL3456MNOP",
    "jobStartTimestamp":"2024-06-06T21:23:47.0+0000",
    "jobExecutionStartTimestamp":"2024-06-06T21:24:02.0+0000",
    "jobStatus":"IN_PROGRESS",
    "jobRunType":"SEQUENCE",
    "jobQueuedDuration":"PT34.691S",
    "jobRunDuration":"PT19.691S",
    "jobOriginOfRequest":"Manual",
    "jobNumberOfTasks":"3",
    "jobTasks":[
        {"taskName":"DFLW : MySalesDataFlow: Enrich MySales Report",
        "taskStartTimestamp":"2024-06-06T21:24:09.0+0000",
        "taskEndTimestamp":"2024-06-06T21:24:14.0+0000",
        "taskStatus":"SUCCEEDED",
        "taskDuration":"PT5S"},

        {"taskName":"DSET : MySalesDataSet 1",
        "taskStartTimestamp":"2024-06-06T21:24:14.0+0000",
        "taskStatus":"IN_PROGRESS",
        "taskSourceName":"'[e-mail]'.'MySalesDataSet - Set 1'",
        "taskTargetName":"Data Set Storage",
        "taskAverageReadThroughput":"1220",
        "taskDuration":"PT7.691S"},

        {"taskName":"DSET : MySalesDataSet 2",
        "taskStatus":"ACCEPTED",
        "taskSourceName":"Internal Data Set Storage",
        "taskTargetName":"Data Set Storage",
        "taskDuration":"PT477141H24M21.691S"}]
    }
]

cURL Example with Parameters:

If you want to exclude task history, apply the query parameter includeTasks=false.

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request GET 'https://<hostname>/api/20210901/catalog/sequences/J2pvaG4uc21pdGhAbXljb21wYW55LmNvbScuJ015U2FsZXNTZXF1ZW5jZXMn/history/1234ABCD5678EFGH9012IJKL3456MNOP?includeTasks=false' \

Back to Top