Endpoint
/api/v2/tenants/{tenantId}/jobs/search
Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant.

Query Parameters
pageNo
integer

pageSize
integer

isDescendingOrder
boolean

sortName
string

queryString
string

Responses

OK

results
array

results.descendingOrder
results.id
results.jobQueued
results.name
results.nextPage
results.orderBy
results.pageNo
results.pageSize
results.previousPageNo
results.script
results.totalPages
results.totalResults
{
  "descendingOrder": true,
  "nextPage": false,
  "orderBy": "job.name",
  "pageNo": 1,
  "pageSize": 10,
  "previousPageNo": 0,
  "results": [
    {
      "id": "8a87f644-0bdc-4d5a-9e41-0ca333b71acd",
      "jobQueued": true,
      "name": "test",
      "schedule": {
        "pattern": {
          "frequency": "recurrence",
          "repeatFrequency": 2,
          "repeatType": "days",
          "type": "daily"
        },
        "startDate": "2016-04-14T10:10:00+0000"
      },
      "script": {
        "approvalType": {
          "alertRequired": true,
          "approvalReason": "for testing",
          "approvalType": 1
        },
        "jobType": "appinstall"
      }
    },
    {
      "id": "cc242a8d-b0b4-430e-a89f-7081bc5e79b0",
      "jobQueued": true,
      "name": "Network Config Backup",
      "schedule": {
        "pattern": {
          "frequency": "recurrence",
          "repeatFrequency": 2,
          "repeatType": "days",
          "type": "daily"
        },
        "startDate": "2016-04-14T10:10:00+0000"
      },
      "script": {
        "configParams": {
          "backUpTrigger": true,
          "runTimeConfigFilesBackUp": true,
          "runtimeConfigAlert": true,
          "startUpConfigFilesBackUp": true,
          "startupConfigAlert": true,
          "versionsSaved": "ALL_VERSIONS"
        },
        "jobType": "networkconfigbackup"
      }
    },
    {
      "id": "ce1088d5-81cc-4262-b515-a75230f0d8e4",
      "jobQueued": true,
      "name": "Job - test script",
      "schedule": {
        "pattern": {
          "frequency": "recurrence",
          "repeatFrequency": 2,
          "repeatType": "days",
          "type": "daily"
        },
        "startDate": "2016-04-14T10:10:00+0000"
      },
      "script": {
        "customScript": {
          "description": "test script",
          "id": "7",
          "name": "test script",
          "platforms": [
            "WINDOWS"
          ]
        },
        "userType": 2
      }
    },
    {
      "id": "4902d87c-b5df-4797-9f45-e807cd871ac9",
      "jobQueued": true,
      "name": "Ad Check List",
      "schedule": {
        "pattern": {
          "frequency": "recurrence",
          "repeatFrequency": 2,
          "repeatType": "days",
          "type": "daily"
        },
        "startDate": "2016-04-14T10:10:00+0000"
      },
      "script": {
        "jobType": "adCheckList"
      }
    }
  ],
  "totalPages": 1,
  "totalResults": 4
}