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
Getting resources "as of" a certain date
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
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: Accounts
Creating accounts
Creating an account
The account holder
The primary location
The producer code
Creating an account example payload
Name clearance and account status
Child objects for an account
Creating accounts as an anonymous user
Managing accounts
Querying for accounts
Searching for accounts
Modifying accounts
Account contacts
Querying for account contacts
Creating account contacts
Modifying account contacts
Account locations
Querying for account locations
Creating account locations
Modifying account locations
Account jobs and policies
Managing bound policies
Querying for policies
Searching for policies
Moving policies between accounts
Policy producers
Policy jobs
Policy contacts
Policy locations
Policy questions
Additional actions for bound policies
Business flows: Job types
Policy transactions
Initiating the policy transaction
Modifying the job
Quoting the job
Completing the policy transaction
LOB-specific endpoints
Submissions
Initiating a submission
Modifying the submission
Quoting the submission
Completing the submission
Binding and issuing a submission at the same time
Binding a submission without issuing
Issuing a previously bound policy
Withdrawing and rejecting submissions
Copying submissions
Additional features for submissions
Renewal
Renew the policy
Policy change
Change the policy
Preemptions
Identifying that a job has been preempted
Viewing preemption information
Preemption payload example
Handling preemptions
Example of handling preemptions
Applying changes to a renewal
Cancellation
Cancel the policy
Reinstatement
Reinstate the policy
Rewrite and Rewrite New Account
Rewrite transaction
Rewrite new account transaction
Business flows: Job policies
Overview of modifying jobs
Lines of business
Overview of lines of business
Lines
Additional LOB-specific endpoints
Contrasting job, policy, product, and line of business
Coverables and coverages
Overview of coverables
Adding coverables
Overview of coverages
Adding coverages
Coverage terms
Coverage validation
Modifiers
Overview of modifiers
Specifying modifiers
Modifier validation
Questions
Overview of questions
Answering questions
Specifying answers
Question validation
Exposures, exclusions, and conditions
Overview of exposures, exclusions, and conditions
Adding exposures, exclusions, and conditions
Synchronization and deferred validation
Out-of-sync policy data
The /sync endpoints
The /sync-coverages endpoints
The /sync-fields endpoints
The /sync-modifiers endpoints
The /sync-questions endpoints
When to call a /sync endpoint
Deferring validation
The deferValidation query parameter
Authorization to defer validation
Limitations to deferred validation
The createDefaultCoverages query parameter
Policy contacts
Overview of policy contacts
Working with all policy contacts on a job
Querying for all policy contacts on a job
Adding an account contact to a job
PATCHing and DELETEing policy contacts
Primary named insured contacts
Additional named insured contacts
Querying for additional named insureds
Adding additional named insureds
PATCHing and DELETEing additional named insureds
Policy locations
Overview of policy locations
Querying for a policy's locations
Creating policy locations
PATCHing policy locations
DELETEing policy locations
Job user role assignment
Overview of job role assignment
Retrieving job user roles
Assigning job user roles
PATCHing job roles
Working with product definitions
PATCHing jobs
Read-only fields
Fields you can modify using PATCH /{jobId}
Fields you can modify using specific endpoints
Business flows: Job support
Comparing jobs
Comparing a job to its base policy
Structure of the JobReviewDiffs resource
Example of a /review-diffs response
Comparing two jobs on the same policy
Structure of the CompareJobAttributes resource
Contingencies
Querying for contingencies
Creating contingencies
Closing contingencies
Policy and job search
Out-of-sequence conflicts
Identifying out-of-sequence conflicts
Resolving out-of-sequence conflicts
Example: Identifying and resolving out-of-sequence conflicts
Quoting
Multi-version quoting
Job version properties
Creating a new job version
Selecting a job version
Working with job versions
Rating overrides
Rating overrides in Cloud API
Underwriting issues
Underwriting issues in PolicyCenter
Querying for underwriting issues
Creating underwriting issues
Minimum creation criteria
Examples of creating an underwriting issue
Managing underwriting issue approval
Approval underwriting issues
Rejecting underwriting issues
Reopening underwriting issues
Job locks
Locking jobs
Releasing locks
Requesting approval
Requesting approval through Cloud API
Referral reasons
Querying for referral reasons
Creating referral reasons
Closing and reopening referral reasons
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 account, job, and policy 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 profiles
Retrieving information about underwriting authority profiles
Assigning authority profiles to users
Creating authority profiles
Modifying authority profiles
Authority profile grants
Querying for grants
Creating grants
c_modifying-grants
Organizations
Querying for organizations
Creating organizations
Updating organizations
Producer codes
Querying for producer codes
Creating producer codes
Updating producer codes
Managing a user's producer codes
Querying for a user's producer codes
Associating producer codes with users
Exposing producer codes to external users
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
APIs for lines of business
Generating and installing LOB-specific APIs
Generating LOB-specific APIs through APD
Generate LOB-specific APIs
Generating templates from a finalized product
Generate a template using the reverse template generator
Installing LOB-specific APIs without installing other artifacts
API codegen configuration
Applying API codegen overrides
API codegen configuration syntax
Disabling product artifacts during testing
Determining which product artifacts to use
Disable a product's visualized artifacts
Enable a product's visualized artifacts
Disable a product's installed artifacts
Managing LOB-specific APIs for testing and integration
Importing a product template through the API
Querying for product templates
Toggling the active state of a visualized product
Generating code from a visualized product
Deleting a product template
Generating endpoints for specific products
The base configuration Personal Auto product
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