Get Job Details

get

/job

Get details of jobs.

Request

There are no request parameters for this operation.

Back to Top

Response

200 Response

The job details were retrieved successfully.
Back to Top

Examples

The following example shows how to retrieve details of all jobs by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".

curl -X GET "hostname:port/job" -H "accept: */*"

Example of Response Body

If successful, the response code 200 is returned with a response body. For example:

{
  "total": 12,
  "limit": 10,
  "offset": 0,
  "page": 1,
  "pages": 2,
  "docs": [
    {
      "_id": 1,
      "tag": [
        "Publish Automation"
      ],
      "name": "Publish Automation",
      "type": "0",
      "description": "Publish Automation",
      "scenarioCount": 33,
      "environment_id": 1,
      "executionConfig": {
        "name": "Publish Automation",
        "group": [
          {
            "name": "Publish Automation",
            "group": [],
            "execution": "",
            "scenarios": [
              1,
              2,
              3,
              4,
              9,
              10,
              11,
              12,
              13,
              14,
              15,
              16,
              17,
              18,
              19,
              20,
              21,
              22,
              23,
              24,
              25,
              26,
              27,
              28,
              29,
              30,
              31,
              32,
              33,
              5,
              6,
              7,
              8
            ]
          }
        ],
        "execution": "serial"
      },
      "environment_name": "Tdaas"
    },
    {
      "_id": 2,
      "tag": [
        "Publish Automation"
      ],
      "name": "Publish Automation",
      "type": "0",
      "description": "Publish Automation",
      "scenarioCount": 12,
      "environment_id": 2,
      "executionConfig": {
        "name": "Publish Automation",
        "group": [
          {
            "name": "Publish Automation",
            "group": [],
            "execution": "",
            "scenarios": [
              61,
              62,
              63,
              64,
              65,
              66,
              67,
              68,
              69,
              70,
              71,
              72
            ]
          }
        ],
        "execution": "serial"
      },
      "environment_name": "Tdaas"
    },
    {
      "_id": 3,
      "tag": [
        "Publish Automation"
      ],
      "name": "Publish Automation",
      "type": "0",
      "description": "Publish Automation",
      "scenarioCount": 3,
      "environment_id": 2,
      "executionConfig": {
        "name": "Publish Automation",
        "group": [
          {
            "name": "Publish Automation",
            "group": [],
            "execution": "",
            "scenarios": [
              58,
              59,
              60
            ]
          }
        ],
        "execution": "serial"
      },
      "environment_name": "Tdaas"
    },
    {
      "_id": 4,
      "tag": [
        "Publish Automation"
      ],
      "name": "Publish Automation",
      "type": "0",
      "description": "Publish Automation",
      "scenarioCount": 46,
      "environment_id": 2,
      "executionConfig": {
        "name": "Publish Automation",
        "group": [
          {
            "name": "Publish Automation",
            "group": [],
            "execution": "",
            "scenarios": [
              34,
              35,
              36,
              37,
              38,
              39,
              40,
              41,
              42,
              43,
              44,
              45,
              46,
              47,
              48,
              49,
              50,
              51,
              52,
              53,
              54,
              55,
              56,
              57,
              58,
              59,
              60,
              61,
              62,
              63,
              64,
              65,
              66,
              67,
              68,
              69,
              70,
              71,
              72,
              73,
              74,
              75,
              76,
              77,
              78,
              79
            ]
          }
        ],
        "execution": "serial"
      },
      "environment_name": "Tdaas"
    },
    {
      "_id": 6,
      "tag": [
        "Publish Automation"
      ],
      "name": "Publish Automation",
      "type": "0",
      "description": "Publish Automation",
      "scenarioCount": 12,
      "environment_id": 2,
      "executionConfig": {
        "name": "Publish Automation",
        "group": [
          {
            "name": "Publish Automation",
            "group": [],
            "execution": "",
            "scenarios": [
              61,
              62,
              63,
              64,
              65,
              66,
              67,
              68,
              69,
              70,
              71,
              72
            ]
          }
        ],
        "execution": "serial"
      },
      "environment_name": "Tdaas"
    },
    {
      "_id": 7,
      "tag": [
        "Publish Automation"
      ],
      "name": "Publish Automation",
      "type": "0",
      "description": "Publish Automation",
      "scenarioCount": 12,
      "environment_id": 2,
      "executionConfig": {
        "name": "Publish Automation",
        "group": [
          {
            "name": "Publish Automation",
            "group": [],
            "execution": "",
            "scenarios": [
              61,
              62,
              63,
              64,
              65,
              66,
              67,
              68,
              69,
              70,
              71,
              72
            ]
          }
        ],
        "execution": "serial"
      },
      "environment_name": "Tdaas"
    },
    {
      "_id": 8,
      "tag": [
        "Publish Automation"
      ],
      "name": "Publish Automation",
      "type": "0",
      "description": "Publish Automation",
      "scenarioCount": 12,
      "environment_id": 2,
      "executionConfig": {
        "name": "Publish Automation",
        "group": [
          {
            "name": "Publish Automation",
            "group": [],
            "execution": "",
            "scenarios": [
              61,
              62,
              63,
              64,
              65,
              66,
              67,
              68,
              69,
              70,
              71,
              72
            ]
          }
        ],
        "execution": "serial"
      },
      "environment_name": "Tdaas"
    },
    {
      "_id": 9,
      "tag": [
        "Publish Automation"
      ],
      "name": "Publish Automation",
      "type": "0",
      "description": "Publish Automation",
      "scenarioCount": 12,
      "environment_id": 2,
      "executionConfig": {
        "name": "Publish Automation",
        "group": [
          {
            "name": "Publish Automation",
            "group": [],
            "execution": "",
            "scenarios": [
              61,
              62,
              63,
              64,
              65,
              66,
              67,
              68,
              69,
              70,
              71,
              72
            ]
          }
        ],
        "execution": "serial"
      },
      "environment_name": "Tdaas"
    },
    {
      "_id": 10,
      "tag": [
        "test"
      ],
      "name": "test_job_fsm",
      "type": 0,
      "description": "testing",
      "scenarioCount": 1,
      "environment_id": 2,
      "executionConfig": {
        "name": "test_job_fsm",
        "group": [
          {
            "name": "",
            "group": [],
            "execution": "",
            "scenarios": [
              79
            ]
          }
        ],
        "execution": "serial"
      },
      "environment_name": ""
    },
    {
      "_id": 12,
      "tag": [
        "TODO-jobtestinggg"
      ],
      "name": "TODO-jobtestss",
      "type": "0",
      "description": "TODO-jobtestinggg",
      "scenarioCount": 1,
      "executionConfig": {
        "name": "",
        "group": [
          {
            "name": "",
            "execution": "",
            "scenarios": [
              {
                "_id": "6409a9db6102f60f98d476ec",
                "name": "null"
              }
            ]
          }
        ],
        "execution": "serial"
      },
      "environment_name": "environment-100"
    }
  ]
}

If the request fails, the response includes the appropriate HTTP code. For a 4xx/5xx code, the message body also contains a ProblemDetails structure with the cause attribute set to the appropriate application error.

Back to Top