Resources

name path methods description
High Level API
  • /retrieve
  • /update
  • GET POST
  • POST
Convenient API to retrieve and update test run states of structure items
Item States
  • /runs/{runId}/items/{itemId}
  • /runs/{runId}/items/{itemId}/notes
  • /runs/{runId}/items/{itemId}/status
  • GET PUT
  • GET PUT
  • GET PUT
Retrieves and updates item states of a particular test run
Test Runs
  • /runs
  • /runs/{runId}
  • GET POST
  • DELETE GET PUT
Manages test runs

Data Types

JSON

type description
ItemState Represents state of a structure item in a test run.
NewTestRun Values to create a new test run
NewTestStatus Values to create new status
RetrieveItemState The retrieve request of the status of a single item in a test run.
Structure Represents a reference to a structure. This object does not contain any details.
StructureInquiry

Describes structure inquiry. If a field of this object is not defined it is effectively null and is interpreted as "no constraint".

The structure can be referenced by #name either by #id. An inquiry with both #name and #id specified is invalid. If an existing structure is referenced by #id, it will definitely be found. If inquired by name and several structures with the given name exist, then none will be found.

Only one field (id or name) may be set to a non-null value. The others must be left undefined or set to null.

TestRun Represents a test run.
TestRunInquiry

Describes test run inquiry. If a field of this object is not defined it is effectively null and is interpreted as "no constraint".

Usage notes:
  • If ID is known - specify #id field and leave other undefined or null.
  • If ID is unknown, a test run may be inquired by #structure or by #name or by both. Leave #id field null or undefined when search by #name or by #structure.
  • If more than one test run satisfies the inquiry, then none will be found
TestStatus Values of the test status
UpdateItemState This structure serves two purposes:
  • Points to test run and structure item. The test run must be determined uniquely
  • Describes an update of the structure item in the test run