Community management

Create a system.

Changed on
put/system

Request

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

Request body

shortNamestring required

The system's short name.

fullNamestring required

The system's full name.

descriptionstring

The system's description.

versionstring

The system's version information.

apiKeystring

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

organisationstring required

The API key identifying the organisation in which to create the system.

Response

System created.

apiKeystring required

The API key value.

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