Settings Section of the API Script

The settings that affect all API processes are defined in the Settings section of the API script.

The following can be specified in the Settings section:

Setting	Description	Example
LogComment	You can specify a default log comment for all API processes in the API script that cause changes to the project audit log.	\[Settings\] LogComment=This is a sample log comment
ChangeNumber	Use this setting to set the change number for any API process that requires a project audit log entry.	\[Settings\] ChangeNumber=123
Significant	Use this setting to designate any baseline changes which occur in the batch as significant. A value of 1 indicates that the baseline change is significant, while a value of 0 indicates that the baseline change is non-significant.	\[Settings\] Significant=1

Setting

Description

Example

LogComment

You can specify a default log comment for all API processes in the API script that cause changes to the project audit log.

\[Settings\]

LogComment=This is a sample log comment

ChangeNumber

Use this setting to set the change number for any API process that requires a project audit log entry.

\[Settings\]

ChangeNumber=123

Significant

Use this setting to designate any baseline changes which occur in the batch as significant.

A value of 1 indicates that the baseline change is significant, while a value of 0 indicates that the baseline change is non-significant.

\[Settings\]

Significant=1

How to...

Run the API Script

Learn more about...

Project Template Creation