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

POST 
https://app.testiny.io/api/v1/comment/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

comment_id integerrequired

testcase_id integerrequired

mapped

object

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

comment_id integer

The comment_id property

testcase_id integer

The testcase_id property

]

MOD2

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

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

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

Example: [ { "type": "STEP", "rid": "fhuz", "rowNum": "0" } ]

]

MOD3

Array [

ids

object

An object of entity id keys for the member entities

blob_id integerrequired

comment_id integerrequired

mapped

object

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

blob_id integer

The blob_id property

comment_id integer

The comment_id property

]

MOD4

Array [

ids

object

An object of entity id keys for the member entities

atm_result_id integerrequired

comment_id integerrequired

mapped

object

comment_id integer

The comment_id property

atm_result_id integer

The atm_result_id 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.
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"
}

Authorization: X-Api-Key

name: X-Api-Keytype: apiKeyin: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

Request Collapse all

Base URL

https://app.testiny.io/api/v1

Auth

ApiKeyAuth

Parameters

otherEntities — pathrequired

op — query

---addupdateadd_or_updatedelete

Body required

[
  {
    "ids": {
      "comment_id": 0,
      "testcase_id": 0
    },
    "mapped": {
      "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,
      "comment_id": 0,
      "testcase_id": 0
    }
  }
]

ResponseClear

Click the Send API Request button above and see the response here!