REST API Reference for TDS Microservice

Get Job Patch Details

patch

/job/{id}

Retrieve the patch details for a given job.

Request

Path Parameters

id(required):

Response

201 Response

The job details were retrieved successfully.

Examples

This example shows how to retrieve a job's path by submitting a PATCH request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X PATCH 'http://hostname:port/user/userpassword/4' -d @sampleJobPath.json

Example of the Request Body

The following is an example of the contents of the sampleJobPath.json file sent as the request body.

{
  "tag": [
    "TODO-job"
  ],
  "scenarioCount": 1,
  "name": "TODO-job",
  "description": "TODO-job",
  "type": "0",
  "executionConfig": {
    "group": [
      {
        "scenarios": [
          "6409a9db6102f60f98d476ec"
        ],
        "name": "",
        "execution": ""
      }
    ],
    "name": "",
    "execution": "serial"
  }
}

Example of the Response Body

If successful, the response code 201 is returned with the following response body.

{
  "_id": 15,
  "tag": [
    "TODO-job"
  ],
  "name": "TODO-job",
  "type": "0",
  "description": "TODO-job",
  "scenarioCount": 1,
  "executionConfig": {
    "name": "",
    "group": [
      {
        "name": "",
        "execution": "",
        "scenarios": [
          {
            "_id": "6409a9db6102f60f98d476ec",
            "name": "null"
          }
        ]
      }
    ],
    "execution": "serial"
  }
}