Domain management

Get an actor.

get/actor/{actor}

Request

Base URL: ${apiUrl} (relative, and the document was published on a file host, not at the API’s origin)
URL: ${apiUrl}/actor/{actor}
Auth: API key in header ITB_API_KEY

actorstring required

The key identifying the actor.

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