Add/remove/update mappings between 'TestCase' entities and other entities

POST 
/testcase/mapping/bulk/:otherEntities

Adds/Removes/Updates mappings between entities (e.g. test cases, test runs, etc.) if the mapping is defined. Id values are named by entity e.g. 'testcase_id', 'testrun_id' (see request schema)

Request

Path Parameters

otherEntities stringrequired

The name(s) of the other entities to map to, separated by colon ':'

Query Parameters

op string

Possible values: [add, update, add_or_update, delete]

application/json

Body

required

oneOf
MOD1
Array [
ids object
An object of entity id keys for the member entities
testcase_id integerrequired
testplan_id integerrequired
mapped object
testplan_id integer
The testplan_id property
testcase_id integer
The testcase_id property
testcase_source_query_id integer
The id of the testcase source query if created from a test plan query
testcase_source_folder_id integer
The id of the folder if created in a test plan from a folder
]
MOD2
Array [
ids object
An object of entity id keys for the member entities
testcase_id integerrequired
testrun_id integerrequired
mapped object
created_at date-time
The creation time for this entity or mapping value
created_by number
The creator user id of this entity or mapping value - or zero if created by the system
modified_at date-time
The last modification time for this entity or mapping value
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
deleted_at date-time
The soft-deletion time for this entity or mapping value
deleted_by number
The id of the user who deleted this entity or mapping value - or zero if deleted by the system
testrun_id integer
The associated test run id
testcase_id integer
The associated test case id
testcase_source_query_id integer
The id of the testcase source query if created from a test plan query
testcase_source_folder_id integer
The id of the folder if created in a test plan from a folder
assigned_user_id integer
The global user id of the user assigned to the associated test case in the associated test run if 'assigned_to' is 'USER'
assigned_to string
The assignee of the associated test case in the associated test run - Can be USER,OWNER,ANY
$assignee_name string
The resolved display name of the test case assignee - readonly
result_status string
The result status of the associated test case in the associated test run - allowed values are: NOTRUN,PASSED,FAILED,BLOCKED,SKIPPED
result_per_step string
Result per step as json
result_at date-time
The last modification time for the result status
result_by number
The id of the user who last changed the result status - or zero if modified by the system
$comment_count number
The number of comments associated with this testcase/testrun - readonly
$workitem_count number
The number of work items associated with this testcase/testrun - readonly
]
MOD3
Array [
ids object
An object of entity id keys for the member entities
testcase_id integerrequired
testcase_folder_id integerrequired
mapped object
testcase_folder_id integer
The testcase_folder_id property
testcase_id integer
The testcase_id property
]
MOD4
Array [
ids object
An object of entity id keys for the member entities
comment_id integerrequired
testcase_id integerrequired
mapped object
created_at date-time
The creation time for this entity or mapping value
created_by number
The creator user id of this entity or mapping value - or zero if created by the system
modified_at date-time
The last modification time for this entity or mapping value
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
deleted_at date-time
The soft-deletion time for this entity or mapping value
deleted_by number
The id of the user who deleted this entity or mapping value - or zero if deleted by the system
comment_id integer
The comment_id property
testcase_id integer
The testcase_id property
]
MOD5
Array [
ids object
An object of entity id keys for the member entities
blob_id integerrequired
testcase_id integerrequired
mapped object
created_at date-time
The creation time for this entity or mapping value
created_by number
The creator user id of this entity or mapping value - or zero if created by the system
modified_at date-time
The last modification time for this entity or mapping value
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
deleted_at date-time
The soft-deletion time for this entity or mapping value
deleted_by number
The id of the user who deleted this entity or mapping value - or zero if deleted by the system
blob_id integer
The blob_id property
testcase_id integer
The testcase_id property
]
MOD6
Array [
ids object
An object of entity id keys for the member entities
comment_id integerrequired
testcase_id integerrequired
testrun_id integerrequired
mapped object
created_at date-time
The creation time for this entity or mapping value
created_by number
The creator user id of this entity or mapping value - or zero if created by the system
modified_at date-time
The last modification time for this entity or mapping value
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
deleted_at date-time
The soft-deletion time for this entity or mapping value
deleted_by number
The id of the user who deleted this entity or mapping value - or zero if deleted by the system
comment_id integer
The comment_id property
testrun_id integer
The testrun_id property
testcase_id integer
The testcase_id property
reference string
Reference to location in test case the comment is applied to
]
MOD7
Array [
ids object
An object of entity id keys for the member entities
blob_id integerrequired
testcase_id integerrequired
testrun_id integerrequired
mapped object
created_at date-time
The creation time for this entity or mapping value
created_by number
The creator user id of this entity or mapping value - or zero if created by the system
modified_at date-time
The last modification time for this entity or mapping value
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
deleted_at date-time
The soft-deletion time for this entity or mapping value
deleted_by number
The id of the user who deleted this entity or mapping value - or zero if deleted by the system
blob_id integer
The blob_id property
testrun_id integer
The testrun_id property
testcase_id integer
The testcase_id property
]
MOD8
Array [
ids object
An object of entity id keys for the member entities
agentsession_id integerrequired
testcase_id integerrequired
testrun_id integerrequired
mapped object
created_at date-time
The creation time for this entity or mapping value
created_by number
The creator user id of this entity or mapping value - or zero if created by the system
modified_at date-time
The last modification time for this entity or mapping value
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
deleted_at date-time
The soft-deletion time for this entity or mapping value
deleted_by number
The id of the user who deleted this entity or mapping value - or zero if deleted by the system
agentsession_id integer
The agentsession_id property
testrun_id integer
The testrun_id property
testcase_id integer
The testcase_id property
data object
Session data
]
MOD9
Array [
ids object
An object of entity id keys for the member entities
testcase_id integerrequired
testrun_id integerrequired
workitem_id integerrequired
mapped object
created_at date-time
The creation time for this entity or mapping value
created_by number
The creator user id of this entity or mapping value - or zero if created by the system
modified_at date-time
The last modification time for this entity or mapping value
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
deleted_at date-time
The soft-deletion time for this entity or mapping value
deleted_by number
The id of the user who deleted this entity or mapping value - or zero if deleted by the system
workitem_id integer
The workitem_id property
testcase_id integer
The testcase_id property
testrun_id integer
The testrun_id property
workitem_type string
The workitem_type property
]
MOD10
Array [
ids object
An object of entity id keys for the member entities
testcase_id integerrequired
workitem_id integerrequired
mapped object
created_at date-time
The creation time for this entity or mapping value
created_by number
The creator user id of this entity or mapping value - or zero if created by the system
modified_at date-time
The last modification time for this entity or mapping value
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
deleted_at date-time
The soft-deletion time for this entity or mapping value
deleted_by number
The id of the user who deleted this entity or mapping value - or zero if deleted by the system
workitem_id integer
The workitem_id property
testcase_id integer
The testcase_id property
workitem_type string
The workitem_type property
]

Responses

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.

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.

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