Community management

Update a system.

Changed on
post/system/{system}

Request

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

Path parameters

systemstring required

The key identifying the target system.

Request body

shortNamestring

The system's short name. Skip this if no update should be made.

fullNamestring

The system's full name. Skip this if no update should be made.

descriptionstring

The system's description. Skip this if no update should be made or provide as an empty string to remove the current value.

versionstring

The system's version information. Skip this if no update should be made or provide as an empty string to remove the current value.

Response

System updated.

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