Domain management

Search for actors under a given specification.

Changed on
get/specification/{specification}/actors

Request

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

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.

Changes

  • 26fb91f21fa6Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 433b3c0ae6d4Revision changes
    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status