Docs‎ > ‎API Creator‎ > ‎Create your API Project‎ > ‎

API Properties

As an administrator, you can control the API project by setting the following:

  • The URL fragment (used in the API url).
  • The API project name (internal).
  • Setting the authentication provider, the internal libraries, and the attribute settings.

Enable API Projects

Enabled API projects can accept incoming requests. Disable the API by clearing the API is enabled checkbox on the Create, API Properties, Details tab. Disabled APIs are blocked incoming requests.

Change API Project Attributes

You can change individual API project attributes using the attributes on the Create, API Properties, Settings tab. The following image shows the Create, API Properties, Settings tab:
For more information about the settings on this tab:

Define the Available Libraries

API Creator includes a standard set of libraries. To make these libraries available to JavaScript event programming, on the Create, API Properties, Libraries, System Libraries tab, select the Used checkbox for the library you want to make available.

The following image shows the Create, API Properties, Libraries, System Libraries tab:

Add a JavaScript Library for your API Project

To add a JavaScript library or Java JAR file, select Create, API Properties, Libraries, Your libraries, Create New LibraryEnter the name and file from the file chooser (select the correct Library type, JavaScript or Java JAR file type).

The following image shows the Logic library window:
  
For more information about managing your API project, including selecting Java and JavaScript libraries for your API project, see Manage your API Project.

Manage the Topics that are used to Define Groups of Rules

You can add/edit or remove topics which are used to define groups of rules on the Create, API Properties, Topics tab. Topics can include links to external documents and represent use cases (or Stories) that group together one or more business rules.

The following image shows the Create, API Properties, Topics tab:
For more information about topics, see Topics.

Add User Filters or Named Structures

You can add a user filter or named structures that mask or hide the internal SQL and prevent using free-form filters (to prevent SQL Injection) on the Create, API Properties, Filters tab. You can also disallow free-form filters. For more information about disallowing free-form filters, see Manage your API Project.

The following image shows the Create, API Properties, Filters tab:

For more information about using user filters, including named filters, see Structured filters

Add Custom-Named Sort Objects

You can add custom-named sort objects that can be exposed as part of the resource or table and mask internal SQL data on the Create, API Properties, Sorts tab.

The following image shows the Create, API Properties, Sorts tab:

For more information about the Sorts tab, see Structured Sorts.

View the Audit Trail of Changes

As changes are applied to the API project itself, the audit trail of changes is shown on the Create, API Properties, Latest changes tab. The following image shows the Create, API Properties, Latest Changes tab: