Cloud API Business Flows and Configuration Guide
Consuming Cloud API
REST API fundamentals in Cloud API
The InsuranceSuite Cloud API
Resources
Endpoints
Root resources
Child resources
Operations
Paths
Requests and responses
Testing requests and responses
Tutorial: Set up your Postman environment
Overview of the system APIs in Cloud API
The base configuration system APIs
Cloud API versions
Viewing API definitions
Swagger UI
View an API definition using Swagger UI
Organization of API information in Swagger UI
The API definition endpoints and Postman
View an API definition using Postman
Organization of information in the output of API definition endpoints
Beta APIs
Published APIs and endpoints
Beta APIs and endpoints
Beta APIs for this release
Routing related API calls in clustered environments
GETs and response payload structures
Overview of GETs
Standardizing payload structures
Viewing response schemas
View a response schema in Swagger UI
Sending GETs
Send a GET using Postman
Tutorial: Send a basic Postman request
Payload structure for a basic response
Structure of a basic response
The count property
The data section
The attributes section
The checksum field
The links subsection (for an element)
The collection-level links section
Payload structure for a response with included resources
Tutorial: Send a Postman request with included resources
Structure of a response with included resources
The related section (for a resource)
The included section (for a response)
Including either a collection or a specific resource
Determining which resources can be included
Refining response payloads using query parameters
Overview of query parameters
Viewing query parameter documentation in Swagger UI
Query parameter error messages
Specifying the resources and fields to return
Filtering GETs
Tutorial: Send a GET with the filter parameters
Specifying which fields to GET
Tutorial: Send a GET with the fields parameter
Sorting the result set
Tutorial: Send a GET with the sort query parameter
Controlling pagination
Limiting the number of resources per payload
Selecting a single resource in a collection
Paging through resources
Retrieving the total number of resources
Tutorial: Send a GET with the pageSize and totalCount parameters
Using query parameters on included resources
Specifying query parameters that apply to an included resource
Summary of query parameters for included resources
Tutorial: Send a GET with query parameters for included resources
POSTs and request payload structures
Overview of POSTs
Standardizing payload structures
Viewing request schemas
View a request schema in Swagger UI
Designing a request payload
Determining the required, optional, and write-only fields
Request payload structure
Specifying scalar values in a request payload
Specifying objects in a request payload
Setting values and objects to null
Sending POSTs
Send a POST using Postman
Tutorial: Create a new note that specifies required fields only
Tutorial: Create a new note that specifies optional fields
Responses to a POST
Postman behavior with redirects
Business action POSTs
Improving POST performance
PATCHes
Overview of PATCHes
The PATCH payload structure
Designing a request payload
PATCHes and arrays
Sending PATCHes
Send a PATCH using Postman
Tutorial: PATCH an activity
Responses to a PATCH
PATCHes and lost updates
Postman behavior with redirects
DELETEs
Overview of DELETEs
Tutorial: DELETE a note
DELETEs and lost updates
Reducing the number of calls
Features that execute multiple requests at once
Comparing features that execute multiple requests
Determining which feature to use
Composite requests
Constructing composite requests
The requests section
Using variables to share information across subrequests
Responses to the subrequests
The selections section
Composite request limitations
Composite request examples
Administering composite requests
Error handling
Logging
Configuring the maximum number of subrequests
Complete composite request syntax
Request inclusion
Syntax for simple parent/child relationships
Syntax for named relationships
Additional request inclusion behaviors
Batch requests
Batch request syntax
Optional subrequest attributes
Batch request examples
Simple batch requests
Batch requests with query parameters
Batch requests with request payloads
Batch requests with distinct operations
Administering batch requests
Specifying subrequest headers
Specifying onFail behavior
Configuring the maximum number of subrequests
Lost updates and checksums
Lost updates
Checksums
Checksums for PATCHes and business action POSTs
Tutorial: PATCH an activity using checksums
Tutorial: Assign an activity using checksums
Checksums for DELETEs
Send a checksum in a request header using Postman
Tutorial: DELETE a note using checksums
Cloud API headers
HTTP headers
Overview of Cloud API headers
Send a request with a Cloud API header using Postman
Preventing duplicate database transactions
Warming up an endpoint
Handling a call with unknown elements
Validating response payloads against additional constraints
Globalization
Specifying language and locale in API requests
Addresses and locales
Address locale configuration
Business flows: FNOL and adjudication
Executing FNOL
Overview of the FNOL process
Draft claims and open claims
Verified and unverified policies
Overview of the FNOL process in Cloud API
The Cloud API FNOL process
FNOL use cases by policy state
Composite request limitations with claims
Canceling claims
Claim modes
The Test Util API
Viewing Test Util API information
Set the ClaimCenter environment in Studio
View the Test Util API in Swagger UI
Creating test policy data
Tutorial: Creating a policy using the Test Util API
Creating test data for related objects
POSTing a minimal draft claim
Tutorial: POSTing a minimal draft claim for personal auto
PATCHing a draft claim
Tutorial: PATCHing a draft claim for personal auto
POSTing a typical draft claim
Tutorial: POSTing a typical draft claim for personal auto
Creating claims with unverified policies
Minimum criteria for an unverified policy and claim
Contacts on an unverified policy
Locations on an unverified policy
Risk units on an unverified policy
Coverages on unverified policies
PATCH an unverified policy
Retrieving information about an unverified policy
Submitting a draft claim
Minimum criteria for submitting a claim with an unverified policy
Tutorial: Submitting a draft claim
Canceling a draft claim
Sample payload addendum
Sample policy payload
Sample draft claim payload
Sample composite claim payload
Sample composite first-and-final
Claims
Querying for claims associated with you
Querying for a claim by claim ID
Searching for active and archived claims
Request payload for a claim search
Response payload for a claim search
Retrieving policy information
Summary of the policy endpoints
Assigning claims
Validating claims
ClaimCenter validation levels
Validating a claim through the system APIs
Retrieving claims from archive
ClaimContacts
Overview of ClaimContacts in ClaimCenter
Overview of ClaimContacts in Cloud API
Modifying ClaimContact roles
Setting reserved roles
Setting non-reserved roles
Identifying the ClaimContact
Creating a new ClaimContact and specifying its role
Specifying a role for a ClaimContact that is already on the claim
Specifying a role for a contact that is on the policy
ClaimContact role constraints
Incidents
Overview of incidents in ClaimCenter
Overview of incidents in Cloud API
Creating incidents
Dwelling incidents
Fixed property incidents
Property contents Incidents
Injury incidents
Living expenses incidents
Vehicle incidents
Other structure incidents
Summary of incident types
Exposures
Overview of exposures in ClaimCenter
Creating exposures
Minimum creation criteria
Building an exposure payload
Step 1: Identify the coverage type
Step 2: Identify the coverage subtype
Step 3: Create or identify the claimant
Step 4: Create or identify the incident
Step 5: Identify the coverage
Querying for and modifying exposures
Assigning exposures
Additional exposure endpoints
Deleting draft exposures
Validating exposures
Closing exposures
Service requests
Overview of service requests in ClaimCenter
Service request kinds
The service request lifecycle
Invoices for service request
Overview of service requests in the Cloud API
Service request APIs and vendor portals
Required service request data model
Service request numbers
Support for each service request kind
Composite request limitations with service requests
Querying for service requests
Creating service requests
Minimum creation criteria
Modifying existing service requests
PATCHing service requests
Assigning service requests to users
Advancing a service request in its lifecycle
Submitting, accepting, and declining service requests
Completing and canceling service requests
Service request quotes
Service request invoices
Querying for invoices
Creating invoices for service requests
Approving service request invoices
Marking invoices as paid
Withdrawing service request invoices
Business flows: Financials
Reserves
Overview of reserves in ClaimCenter
Querying for reserves
Creating reserves
Example of creating reserves
Example of adding to reserves
Acknowledging reserve transactions
Creating checks
Overview of checks in ClaimCenter
Payments
Checks
Check sets
Querying for check sets and checks
POSTing checks
Check creation in ClaimCenter
Check creation through Cloud API
Example of creating a minimal check set
Recurrences
Recurrences in ClaimCenter
Recurrences in Cloud API
Sending checks every X months on the Nth day
Sending checks every X months on the Nth dayOfWeek
Sending checks every X weeks on dayOfWeek
Deductible handling
Deductible handling in ClaimCenter
Deductible handling in Cloud API
Underpaying and overpaying deductibles
PATCHing checks
DELETEing checks
Managing the check life cycle
The check life cycle prior to submission
Advancing a check to submission through Cloud API
The check life cycle after submission
Advancing a check beyond submission through Cloud API
Acknowledging payment transactions
Recoveries and recovery reserves
Querying for recoveries and recovery reserves
Creating recoveries and recovery reserves
Creating a recovery reserve
Creating a recovery reserve set
Acknowledging a recovery reserve
Creating a recovery
Multicurrency
Multicurrency overview
Multicurrency in ClaimCenter
Multicurrency in Cloud API
Retrieving multicurrency information
Multicurrency reserves
Multicurrency checks
POSTing multicurrency information
POSTing a reserve with multiple currencies
POSTing a reserve with a custom exchange rate
POSTing a check set with multiple currencies
POSTing a check set with a custom exchange rate
Specifying multicurrency line items
Additional exchange rate schema fields
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
Creating claim 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
Authority limit profiles
Retrieving information about authority limit profiles
Creating authority limit profiles
Adding limits to the profile
Updating authority limit profiles
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