Domain management

Search for specification groups under a given domain.

Changed on
get/domain/{domain}/groups

Request

  • Base URL: ${apiUrl} (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ${apiUrl}/domain/{domain}/groups
  • 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 specification groups with based on their short and long names. The value is checked in a case-insensitive manner and using wildcard matching.

Response

Specification groups retrieved.

shortNamestring required

The group's short name.

fullNamestring required

The group's full name.

descriptionstring

The group's description.

reportMetadatastring

The group's additional metadata for XML reports.

displayOrdernumber

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

apiKeystring required

The group'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