Domain management

Create a specification.

Changed on
put/specification

Request

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

Request body

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

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

groupstring

The API key of the specification group within which to create the specification. If not provided the specification will be created directly under the domain.

domainstring

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

Response

Specification 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