Update one 'TestCase' entity

PUT 
/testcase/:id

Update a single existing 'TestCase' 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 200 characters)
Example: A Descriptive Title
sort_index number

An integer sort index for natural ordering of this entity or mapping value - value must be in range (-999999999999999,999999999999999)

is_deleted boolean

If the entity has been soft-deleted this value is true

created_at date-time
The creation time for this entity or mapping value
Example: 1970-01-01T00:00:00.000Z
created_by number
The creator user id of this entity or mapping value - or zero if created by the system
Example: 0
modified_at date-time
The last modification time for this entity or mapping value
Example: 1970-01-01T00:00:00.000Z
modified_by number
The id of the user who last modified or undeleted this entity or mapping value - or zero if modified by the system
Example: 0
deleted_at date-time
The soft-deletion time for this entity or mapping value
Example: 1970-01-01T00:00:00.000Z
deleted_by number
The id of the user who deleted this entity or mapping value - or zero if deleted by the system
Example: 0
_etag stringrequired

A tag for detecting conflicting modifications - current value (may be empty) must be passed along in an update (or update must be forced)

project_id integer

The project id this entity or mapping belongs to

owner_user_id integer

The global user id of the test case owner

$owner_name string

The resolved display name of the owner user - read only

type string

Reserved for future use

template string

The template type used for the test case: STEPS or TEXT

precondition_text string
A description of the precondition required for the test case (can be a rich text document)
Example:
content_text string
The test case content - used with template STEPS (can be a rich text document)
Example:
steps_text string
The test case content - used with template TEXT (can be a rich text document)
Example:
expected_result_text string
The test case expected result - used with template TEXT (can be a rich text document)
Example:
priority number
The test case priority (This is a builtin-custom field)
Example: 1
status string
The test case status (This is a builtin-custom field)
Example:
testcase_type string
The test case type (This is a builtin-custom field)
Example:
automation string
The test case automation status (This is a builtin-custom field)
Example:
estimate number
A test case time estimate (This is a builtin-custom field)
Example: 100

Responses

200

Returns a single TestCase

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 200 characters)
Example: A Descriptive Title
sort_index number

An integer sort index for natural ordering of this entity or mapping value - value must be in range (-999999999999999,999999999999999)

is_deleted boolean

If the entity has been soft-deleted this value is true

created_at date-time
The creation time for this entity or mapping value
Example: 1970-01-01T00:00:00.000Z
created_by number
The creator user id of this entity or mapping value - or zero if created by the system
Example: 0
modified_at date-time
The last modification time for this entity or mapping value
Example: 1970-01-01T00:00:00.000Z
modified_by number
The id of the user who last modified or undeleted this entity or mapping value - or zero if modified by the system
Example: 0
deleted_at date-time
The soft-deletion time for this entity or mapping value
Example: 1970-01-01T00:00:00.000Z
deleted_by number
The id of the user who deleted this entity or mapping value - or zero if deleted by the system
Example: 0
_etag stringrequired

A tag for detecting conflicting modifications - current value (may be empty) must be passed along in an update (or update must be forced)

project_id integer

The project id this entity or mapping belongs to

owner_user_id integer

The global user id of the test case owner

$owner_name string

The resolved display name of the owner user - read only

type string

Reserved for future use

template string

The template type used for the test case: STEPS or TEXT

precondition_text string
A description of the precondition required for the test case (can be a rich text document)
Example:
content_text string
The test case content - used with template STEPS (can be a rich text document)
Example:
steps_text string
The test case content - used with template TEXT (can be a rich text document)
Example:
expected_result_text string
The test case expected result - used with template TEXT (can be a rich text document)
Example:
priority number
The test case priority (This is a builtin-custom field)
Example: 1
status string
The test case status (This is a builtin-custom field)
Example:
testcase_type string
The test case type (This is a builtin-custom field)
Example:
automation string
The test case automation status (This is a builtin-custom field)
Example:
estimate number
A test case time estimate (This is a builtin-custom field)
Example: 100

Example (from schema)

{
  "id": 0,
  "title": "A Descriptive Title",
  "sort_index": 0,
  "is_deleted": true,
  "created_at": "1970-01-01T00:00:00.000Z",
  "created_by": 0,
  "modified_at": "1970-01-01T00:00:00.000Z",
  "modified_by": 0,
  "deleted_at": "1970-01-01T00:00:00.000Z",
  "deleted_by": 0,
  "_etag": "string",
  "project_id": 0,
  "owner_user_id": 0,
  "$owner_name": "string",
  "type": "string",
  "template": "string",
  "precondition_text": "",
  "content_text": "",
  "steps_text": "",
  "expected_result_text": "",
  "priority": 1,
  "status": "",
  "testcase_type": "",
  "automation": "",
  "estimate": 100
}

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...