Domain management

Update a specification.

Changed on
post/specification/{specification}

Request

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

Path parameters

specificationstring required

The key identifying the target specification.

Request body

shortNamestring

The specification's short name. Skip this if no update should be made.

fullNamestring

The specification's full name. Skip this if no update should be made.

descriptionstring

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

reportMetadatastring

The specification's additional metadata for XML reports.

hiddenboolean

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

displayOrdernumber

The specification's display order relative to other groups and specifications. Skip this if no update should be made or set to a negative value to remove the ordering altogether.

groupstring

The API key of the specification group within which to move the specification. Skip this if no update should be made or provide as an empty string to remove the specification from its current group.

Response

Specification 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