Domain management

Create a specification group.

Changed on
put/group

Request

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

Request body

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

The API key to set for the group. If this key is already assigned, a new one will be generated.

domainstring

The API key of the domain within which to create the group. This can be omitted if the community identified by the community API key used for authorisation is linked to a specific domain.

Response

Specification group created.

apiKeystring required

The API key value.

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