Update system

Update an existing system definition. Only the fields provided in the request body will be updated. If a field is provided, the new content will replace the existing content. If a field is not provided, the existing content will remain unchanged.

When updating schemas:

  • The system will accept your changes regardless of compatibility with existing configurations
  • Schema updates won't invalidate existing evaluations or configurations
  • For significant redesigns, creating a new system definition provides a cleaner separation
patch/systems/{systemId}

Path parameters

systemIdstring uuid required
Example:12345678-0a8b-4f66-b6f3-2ddcfa097257

The ID of the system to update.

Request body

namestring

The name of the system.

descriptionstring

The description of the system.

inputSchemaobject

The schema of the system's inputs.

outputSchemaobject

The schema of the system's outputs.

configSchemaobject

The schema of the system's configuration.

Response

System updated successfully

idstring uuid required

The ID of the system.

namestring required

The name of the system.

descriptionstring required

The description of the system.

inputSchemaobject required

The schema of the system's inputs.

outputSchemaobject required

The schema of the system's outputs.

configSchemaobject required

The schema of the system's configuration.

Changes