Domain management

Update an actor.

Changed on
post/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

Path parameters

actorstring required

The key identifying the target actor.

Request body

identifierstring

The actor's unique identifier in the specification, used to refer to it from test cases. Skip this if no update should be made.

namestring

The actor's display name. Skip this if no update should be made.

descriptionstring

The actor's description. Skip this if no update should be made or provide as an empty string to remove the current value.

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. Skip this if no update should be made.

hiddenboolean

Whether the actor should be hidden. Skip this if no update should be made.

displayOrdernumber

The actor's display order relative to other actors when presented in test execution diagrams. Skip this if no update should be made or set to a negative value to remove the ordering altogether.

Response

Actor updated.

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