API Creation Endpoints
API Creation Endpoints
You can script the creation of an API using the endpoints and attributes that the
CA Live API CreatorAdmin API (Admin API) provides.
tsattributes are present in all cases except where noted. Required attributes are in
bold. The attributes that
CA Live API Creatordoes not use are in ita
lics. Some endpoints, such as
resources, are non-obvious. To give you guidance, we recommend that you create these endpoints using API Creator and then look at them in the API.
For more information:
For more information about how script the creation of an API, see Import and Export APIs.
The TeamSpace of which your API is a part.
For more information about how to manage TeamSpaces using this endpoint, see The accounts Endpoint.
The connection between auth tokens and roles.
The authentication tokens for an API.
For more information about this endpoint, see The apikeys Endpoint.
The API versions.
For more information about this endpoint, see The apiversion Endpoint.
The authentication providers.
The connection to the database.
The resource event handlers.
The CA API Gateway integration endpoint.
The custom endpoints.
For more information about custom endpoints, see Manage Custom Endpoints.
Defines a connection url for managed databases (creating databases, creating tables, adding fields, and creating relationships).
For more information about managed databases, see Database Creation.
Named filters, created to handle complex queries without risking a SQL injection.
For more information about named filters, see Structured Filters.
Named sorts, created to provide complex sorting without risking a SQL injection.
For more information about named sorts, see Structured Sorts.
The additional data that is attached to roles.
For more information about how to set permissions for roles, see Authorization and Role-Based Endpoint Access.
The options for an API.
The possible types of options.
You cannot alter these types.
The associations between child entity (table or view) and its parent entity (potentially in different databases).
For more information about relationships, see Database Relationships.
The types of resources.
You cannot change the resource types.
An attribute in a table-based resource (resource attribute). By default, resources use the columns from the entity (table or view) and return all base entity columns.
For more information about resource attributes, see Manage Resource Attributes.
roles_to_ancestor: Used to do parent lookups.
is_lookup_key_part: If set to
true, then this lookup is used in a PUT/POST event.
Virtual resource attributes use the following endpoint attributes:
A resource that can be part of a resource tree.
The security roles that are defined as part of an API.
The business logic for an API.
The types of rules.
You cannot change the rule types.
The permissions for a role's table.
The topics for rules.
The API users for the built-in authentication provider.