v1

latestOpenAPI 3.1.02026-07-242442479.7 KB

Create a Summary Field

post/api/v2/system-field/{objectType}/summary

objectTypeinteger required

Use an object's number here to assign this field to an object.

fieldNamestring required

System field name. Must start with 'pcf' or the field will not be created.

labelstring required

Field name used for system displays.

summarizedObjectTypeinteger required

The number of the object type this field will summarize.

summarizedObjectFieldstring required

The system name of the lookup field which relates the current object to the summarized object.

summarizedFieldstring

The system name of the field to summarize, not applicable for the 'count' summary type.

summaryTypestring required

Selection from: 'max', 'min', 'count', 'sum'.

summarizedUserIdstring required

The GUID of the user who's sharing permissions will be used to determine which records are summarized.

precisioninteger

Number between 0-4 to set the amount of digits after the decimal point.

followboolean

To track all changes made to this field, enter ׳true׳.

200

object required