Update one 'AutomationTestCase' entity

PUT 
/atm-testcase/:id

Update a single existing 'AutomationTestCase' entity. Returns a full updated entity including (optional) modification metadata.

Request

Path Parameters

id integerrequired

The id tof the object to update

Query Parameters

force boolean

Forces the update even if '_etag' is missing or not matching.

application/json

Body

required

id integer

The unique entity id - must be a positive integer

title string
A descriptive title for this entity or mapping (1 to 1000 characters)
Example: A Descriptive Title
project_id integer

The project id this entity or mapping belongs to

tags string
A list of tags for this entity
Example: important,release,smoketest
atm_source_id integer

The atm_source_id property

atm_key string
A unique key for test case for matching on import
Example: XYZ-123
folder_path string

The folder_path property

steps array

The steps property

description stringnullable
An optional description for the test case (can be a rich text document)
Example:

Responses

200

Returns a single AutomationTestCase

application/json

Schema

Schema

id integer

The unique entity id - must be a positive integer

title string
A descriptive title for this entity or mapping (1 to 1000 characters)
Example: A Descriptive Title
project_id integer

The project id this entity or mapping belongs to

tags string
A list of tags for this entity
Example: important,release,smoketest
atm_source_id integer

The atm_source_id property

atm_key string
A unique key for test case for matching on import
Example: XYZ-123
folder_path string

The folder_path property

steps array

The steps property

description stringnullable
An optional description for the test case (can be a rich text document)
Example:

Example (from schema)

{
  "id": 0,
  "title": "A Descriptive Title",
  "project_id": 0,
  "tags": "important,release,smoketest",
  "atm_source_id": 0,
  "atm_key": "XYZ-123",
  "folder_path": "string",
  "steps": [
    null
  ],
  "description": ""
}

4XX

The request failed because invalid request parameters or data were supplied or access was denied.

application/json

Schema

Schema

code string
The error code describing the general error category.
Example: API_INVALID_INPUT_DATA
status integer

The HTTP status code.

message stringrequired

The actual error message describing the error in more detail.

reqid string

The request id for following up on specific errors.

Example (from schema)

{
  "code": "API_INVALID_INPUT_DATA",
  "status": 0,
  "message": "string",
  "reqid": "string"
}

5XX

The request failed because an error occurred during processing of the request.

application/json

Schema

Schema

code string
The error code describing the general error category.
Example: API_INVALID_INPUT_DATA
status integer

The HTTP status code.

message stringrequired

The actual error message describing the error in more detail.

reqid string

The request id for following up on specific errors.

Example (from schema)

{
  "code": "API_INVALID_INPUT_DATA",
  "status": 0,
  "message": "string",
  "reqid": "string"
}

Loading...