Jump to

• Request
• Response
• Examples

Get jobs that match criteria

get

/api/v4/jobresource/jobinstances

Versions Supported:

v4

Request

Query Parameters

• fromdate: string
  Optional. It is used along with toDate to get all the jobs between two dates. This parameter is used to pass the start date. The date should be of the format : YYYYMMDD
• jobid: string
  Optional. ID of the job definition.
• jobmode: string
  Default Value: ALL
• jobtype: string
  Optional. Type of job; for example, EXPORT/ENRICH.
• limit: integer
  Optional. Takes an integer value. Used in pagination of the list page.

  Default Value: 15
• offset: integer
  Optional. Takes an integer value. Used in pagination of the list page.

  Default Value: 0
• searchstring: string
  Optional. To search jobs based on a string, pass the string value.
• sortorder: string
  Optional.Order in which jobs are listed. Accepted values are ASC and DESC which represents Ascending Order and Descending Order respectively.
• sorttype: string
  Optional. Used for sorting the output based on sortType = Job Name, Type, Date, Submitted By, Job Status, JobInstanceId, PartyType, EndTime.

  Default Value: Date
• todate: string
  Optional. It is used along with fromDate to get all the jobs between two dates. This parameter is used to pass the end date. The date should be of the format : YYYYMMDD

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml; charset=UTF-8
• application/json; charset=UTF-8

200 Response

Success

Body ()

Root Schema : schema

Type: object

Show Source

• completedRecordsCount: integer (int64)
• failedRecordsCount: integer (int64)
• jobInstanceList: array jobInstanceList
• jobInstancesList: array jobInstancesList
• totalRecordsCount: integer (int64)

{
    "properties":{
        "completedRecordsCount":{
            "format":"int64",
            "type":"integer"
        },
        "failedRecordsCount":{
            "format":"int64",
            "type":"integer"
        },
        "jobInstancesList":{
            "items":{
            },
            "type":"array"
        },
        "totalRecordsCount":{
            "format":"int64",
            "type":"integer"
        },
        "jobInstanceList":{
            "items":{
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : jobInstanceList

Type: array

Show Source

• Array of:

{
    "items":{
    },
    "type":"array"
}

Nested Schema : jobInstancesList

Type: array

Show Source

• Array of:

{
    "items":{
    },
    "type":"array"
}

404 Response

Requested resource could not be found.

500 Response

An unexpected error occurred during the request.

Back to Top

Examples

Example Request:

/api/v4/jobresource/jobinstances?jobid=123&searchstring=test&sorttype=Date&offset=0&limit=100&jobtype=Export

Example Output:

{
    "jobInstanceList": {
        "completed": "4",
        "createdBy": "daas_user1",
        "createdOn": "2014-03-26 08:20:02.974237",
        "duplicated": "0",
        "failed": "4",
        "fileName": " "test ".csv",
        "jobDefDesc": "Enrichment of data",
        "jobDefId": "10095",
        "jobDefName": " "test "",
        "jobDefSearchType": "COMPANIES",
        "jobDefType": "ENRICH",
        "jobInstanceId": "10095",
        "modifiedBy": "daas_user1",
        "modifiedOn": "2014-03-26 08:20:03.561359",
        "rejected": "2",
        "status": "COMPLETED"
    },
    "totalRecordsCount": "1"
}

Back to Top