Sign in

v1

latestOpenAPI 3.0.12026-07-177473205.1 KB
Domain management

Search for actors under a given specification.

get/specification/{specification}/actors

Path parameters

specificationstring required

The key identifying the specification within which to search.

Query parameters

namestring

An optional value to filter actors with based on their identifiers and names. The value is checked in a case-insensitive manner and using wildcard matching.

Response

Actors retrieved.

identifierstring required

The actor's unique identifier in the specification, used to refer to it from test cases.

namestring required

The actor's display name.

descriptionstring

The actor's description.

reportMetadatastring

The actor's additional metadata for XML reports.

defaultboolean

Whether the actor should be considered as the default choice for new conformance statements within its specification.

hiddenboolean

Whether the actor should be hidden.

displayOrdernumber

The actor's display order relative to other actors when presented in test execution diagrams.

apiKeystring required

The actor's API key.