SCscorecard-ai

Update system

Changed on

Update an existing system. 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.

patch/systems/{systemId}

Request

  • Base URL
    https://api2.scorecard.io/api/v2
  • Auth
    HTTP bearer

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. Unique within the project.

descriptionstring

The description of the system.

productionVersionIdstring uuid

The ID of the production version of the system.

Response

System updated successfully

idstring uuid required

The ID of the system.

namestring required

The name of the system. Unique within the project.

descriptionstring required

The description of the system.

Changes

  • 013895a80cfeRevision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      the request property default value was added

    • info

      the response's property default value was added for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status