Domain management

Get a specification.

Changed on
get/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 specification.

Response

Specification retrieved.

shortNamestring required

The specification's short name.

fullNamestring required

The specification's full name.

descriptionstring

The specification's description.

reportMetadatastring

The specification's additional metadata for XML reports.

hiddenboolean

Whether the specification should be hidden.

displayOrdernumber

The specification's display order relative to other groups and specifications.

apiKeystring required

The specification's API key.

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

    • 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