Retrieve a list of historic values for the specified mapping.

POST 
/history/mapping/:mapping

Retrieves a list of historic values for mappings specified with the given id values. Id values are named by entity (e.g. 'testcase_id', 'testrun_id'). The entity type needs to support history tracking.

Request

Path Parameters

mapping stringrequired

The name of the mapping or colon-separated entity names

application/json

Body

required

id

object

Entity ids for mapped entities, e.g. testcase_id

property name* integer
ids object[]

Responses

200

Returns 'MappingHistoryResult'

application/json

Schema

Schema

from date-time

Timestamp of first historic entry

to date-time

Timestamp of last historic entry

data

object[]

required

List of requested entity ids and a list of historical values (for each entity)

Array [

ids object

The entity ids of the mapping

values object[]

The list of historical mapping values, one for each step, with 'valid_from' and 'valid_to' interval properties

]

Example (from schema)

{
  "from": "2024-07-29T15:51:28.071Z",
  "to": "2024-07-29T15:51:28.071Z",
  "data": [
    {
      "ids": {},
      "values": [
        {}
      ]
    }
  ]
}

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