[Index]

Model: data/Patch

A Patch represents an update to one or more models in a bundle. The patch tracks the version of the models and packages updated, the source code files that were modified, and the reason.

Model Details: data/Patch

Title Description Details
base Group Assigned by FDP
  • Field Name: base
  • Type: Object
Name * The unique name of the patch.
  • Field Name: base.name
  • Type: String
  • MaxLength: 1024
Description Description of the patch.
  • Field Name: base.description
  • Type: String
  • MaxLength: 1024
Patch Version The version of the patch.
  • Field Name: base.version
  • Type: String
  • MaxLength: 1024
Notes A description of any side-effects resulting from applying this patch, such as migration of existing data.
  • Field Name: base.notes
  • Type: String
  • MaxLength: 1024
Releases The HCS release to which this patch applies.
  • Field Name: releases.[n]
  • Type: Array
Models
  • Field Name: models.[n]
  • Type: Array
Type The type of model included in the patch.
  • Field Name: base.models.[n].model_type
  • Type: String
  • MaxLength: 1024
Instances
  • Field Name: model_instances.[n]
  • Type: Array
Instance The business key of the model included in the patch.
  • Field Name: base.models.[n].model_instances.[n].model_instance
  • Type: String
  • MaxLength: 1024
Version The new version of the patched model.
  • Field Name: base.models.[n].model_instances.[n].model_version
  • Type: String
  • MaxLength: 1024
Defect IDs A list defects that are fixed by this patch.
  • Field Name: defect_ids.[n]
  • Type: Array