Cloud API Business Flows Guide
Consuming the 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 Cloud API information
Swagger UI
View a system API using Swagger UI
Organization of API information in Swagger UI
The metadata endpoints and Postman
View a system API using Postman
Organization of information in metadata endpoint output
Beta APIs
Published APIs and endpoints
Beta APIs and endpoints
Beta APIs for this release
Additional metadata endpoint functionality
Functionality for alternate API tools
The /typelists endpoints
Tutorial: Query for typelist metadata
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
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
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
Request inclusion
Syntax for simple parent/child relationships
Syntax for named relationships
Additional request inclusion behaviors
Batch requests
Optional subrequest attributes
Batch request syntax
Simple batch requests
Batch requests with query parameters
Batch requests with request payloads
Batch requests with distinct operations
Specifying subrequest headers
Specifying onFail behavior
Composite requests
Constructing composite request calls
The requests section
Using variables to share information across subrequests
Responses to the subrequests
The selections section
Error handling
Composite request limitations
Complete composite request syntax
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
PolicyCenter business flows
Accounts
Creating an account
Account holder
Primary location
Producer code
Example: Creating an account
Account search
Policy transactions
Initiating the policy transaction
Modifying the job
Quoting the job
Completing the policy transaction
LOB-specific endpoints
Submission
Initiating the submission policy transaction
Modifying the submission job
Generating a quote
Completing the submission
Tutorial: Submission policy transaction
Issuance
Issue the policy
Renewal
Renew the policy
Cancellation
Cancel the policy
Policy change
Change the policy
Reinstatement
Reinstate the policy
Rewrite and Rewrite New Account
Rewrite transaction
Rewrite new account transaction
Out-of-sequence conflicts
Identifying out-of-sequence conflicts
Resolving out-of-sequence conflicts
Example: Identifying and resolving out-of-sequence conflicts
Policy and job search
Multi-version quoting
Job version properties
Creating a new job version
Selecting a job version
Working with job versions
Working with activities
Querying for activities
Creating activities
Assigning activities
Assignment options
Assignment examples
Retrieving recommended assignees
Closing activities
Additional activity functionality
Working with 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
Working with notes
Querying for notes
Creating account, job, and policy notes
Additional notes functionality
Working with organizations
Querying for organizations
Creating organizations
Updating organizations
Working with producer codes
Querying for producer codes
Creating producer codes
Updating producer codes
Exposing producer codes to external users
Working with product definitions
Working with underwriting issues
Underwriting issue resources
Getting underwriting issues
Getting underwriting history
Creating underwriting issues
Approving underwriting issues
Rejecting underwriting issues
Reopening underwriting issues
Locking jobs for underwriting review
Working with users
Querying for users
Creating users
Updating users
Configuring the Cloud API
Extending system API resources
Schema organization
Extending schema definitions
Schema definition extension syntax
Extending mappers
Mapper extension syntax
Extending updaters
Updater extension syntax
Tutorial: Create a resource extension
Providing feedback
Obfuscating Personally Identifiable Information (PII)
Nullifying PII
Masking PII
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