Domain management

Search for specifications under a given domain that are not defined within a group.

Changed on
get/domain/{domain}/specifications

Request

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

Path parameters

domainstring required

The key identifying the domain within which to search.

Query parameters

namestring

An optional value to filter specifications with based on their short and long names. The value is checked in a case-insensitive manner and using wildcard matching.

Response

Specifications 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

  • 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