Cloud API Business Flows and Configuration Guide
Business flows: BillingCenter
Plans
Cloud API functionality common to all plans
Plan order
Endpoints for testing
Multicurrency plans
Billing plans
Querying for billing plans
Creating billing plans
Modifying billing plans
Delinquency plans
Querying for delinquency plans
Creating delinquency plans
Modifying delinquency plans
Plans and multicurrency
Currencies at the plan level
Currencies at the fee/threshold level
Business flows: Framework APIs
Activities
Querying for activities
Creating activities
Assigning activities
Assignment options
Assignment examples
Retrieving recommended assignees
Closing activities
Additional activity functionality
Documents
Overview of documents
Querying for document information
Querying for document metadata
Querying for document content
POSTing documents
POSTing documents using Postman
PATCHing documents
DELETEing documents
Notes
Querying for notes
Additional notes functionality
Users and groups
Users
Querying for users
Creating users
Updating users
Groups
Querying for groups
Assigning users to groups
User roles
Querying for user roles
Creating user roles
Updating user roles
Configuring Cloud API
Configuring schemas
Overview of resource definition files
Resource definition file architecture
Reasons to modify resource definition files
Syntax for resource definition files
Schema file syntax
Mapping file syntax
Updater file syntax
Extension files
Data mapping for new properties
Data mapping for scalars
Data mapping for new compound values
Tutorial: Data mapping for new properties
Additional behaviors for properties
Read-only properties
Properties required by the database
Properties writeable at creation only
Sortable properties
Filterable properties
Additional metadata for properties
Summary of property attributes
Collection-level behaviors
Sorting a collection
Filtering a collection
Swagger files
Apiconfig files
Tutorial: Extending a data model entity and its API resource
Obfuscating Personally Identifiable Information (PII)
Nullifying PII
Masking PII
Localizing schemas
Architecture of localized text
Associating display keys with API elements
Localization key prefixes
Display key patterns for schema.json-files
Display key patterns for swagger.yaml files
Providing locale specific content for a given locale
Adding localized text for existing API elements
Adding localized text for new API elements
Adding a new locale
Generating endpoints for custom entities
The REST endpoint generator
REST endpoint generator overview
Architecture of custom CRUD endpoints
REST endpoint generator restrictions
Process for generating CRUD endpoints for a custom entity
Special use cases
Running the REST endpoint generator
Issues to consider before running the generator
The API for the new endpoints
The parent of the custom resource
Populating collections
Additional considerations
Running the REST endpoint generator
Running the REST endpoint generator from Studio
Create a run configuration for the REST endpoint generator
Use the run configuration to run the REST endpoint generator
Running the REST endpoint generator from the command prompt
The REST endpoint generator prompts
Completion of the script
Completing the configuration
Configuring the resource definition files
The resource definition files
Configuring the schema file for generated endpoints
Overview of schema file syntax
Modifications made to the schema file
Syntax for property types
Additional properties
Configuring the mapping file for generated endpoints
Overview of mapping file syntax
Modifications made to the mapping file
Mapping syntax for property paths
Configuring the updater file for generated endpoints
Overview of updater file syntax
Modifications made to the updater file
Updater syntax for property paths
Configuring the swagger file for generated endpoints
Overview of swagger file syntax
Modifications made to the swagger file
Completing the configuration
Configuring glue and impl classes for generated endpoints
The glue and impl classes for generated endpoints
Configuring the apiconfig file
Configuring the element resource file
Configuring the collection resource file
Completing the configuration
Configuring authorization for generated endpoints
Configuring endpoint access for generated endpoints
Code generated in role.yaml files
Configuring code in role.yaml files
Configuring resource access for generated endpoints
Code generated in access.yaml files
Generated resource access code for internal users
Generated resource access code for external users
Generated resource access code for services
Generated resource access code for special use cases
Configuring generated resource access code
Configuring generated resource access code
Completing the configuration
Generating endpoints for ClaimCenter Policy graph entities
Creating Policy descendant endpoints
Policy as a parent to the custom resource
REST endpoint generator variances for Policy endpoints
Configuring variances for glue and impl classes for Policy endpoints
Configuring variances for the apiconfig file
Configuring variance for Policy resource files
Creating custom risk units
Risk unit criteria
REST endpoint generator variances for custom risk units
Configuring variances for glue and impl classes for risk units
Configuring variances for risk unit resource files
Inline damageables
Additional considerations for generated endpoints
Integration graphs
The graph schema file
The graph mapper file
The apiconfig mapping