• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
  • Service Layer Architecture
  • Authentication and Authorization
    • Role Based Access Control
    • Users and SecurityGroups
  • Support Matrix
  • Send Requests
  • Use cURL
  • Query Parameters
    • Query Parameters - Schema
    • Status Codes
  • Error Summary
• REST APIs for OIPA SOAP Web Services
  • FileReceived
  • Exposed Computation
  • Process Policy
• Downstream Message Push
  • Downstream Message Push using REST
  • Outbound Application Parameters

Tasks

• Calendars
  • Get a specific calendar by calendar code
  • Get list of calendars
• Cases
  • Create Case
  • Get a specific case by case Id
  • Get list of cases
  • Get the list of policies for a specific case by case Id
  • Partially update a specific case by case Id
  • Update a specific case by case Id
• Clients
  • Create client phones
  • Create clients
  • Create clients addresses
  • Create requirements for a client by client Id
  • Delete a specific requirement from a client by client Id and requirement Id
  • Get a specific address for a specific client by client Id and address Id
  • Get a specific client by client Id
  • Get a specific phone for a specific client by client Id and phone Id
  • Get a specific requirement for a specific client by client Id and requirement Id
  • Get list of clients
  • Get list of requirements for a specific client by client Id
  • Get the list of addresses for a specific client by client Id
  • Get the list of client relationships for a specific client by client Id
  • Get the list of phones for a specific client by client Id
  • Get the list of roles for a specific client by client Id
  • Partially update a specific client address for a specific client by client Id and address Id
  • Partially update a specific client phone for a specific client by client Id and phone Id
  • Partially update a specific requirement for a specific client by client Id and requirement Id
  • Update a specific client address for a specific client by client Id and address Id
  • Update a specific client by client Id
  • Update a specific client by client Id
  • Update a specific client phone for a specific client by client Id and phone Id
  • Update a specific requirement for a specific client by client Id and requirement Id
• Codes
  • Get the list of code details for a specific code name
• Companies
  • Get a specific company by company Id
  • Get list of companies
  • Get the list of plans for a company by company Id
  • Get the list of products for a company by company Id
• Domains
  • Create a domain
  • Delete a specific domain by domain Id
  • Get all domains
  • Gets a specific domain by domain Id
  • Partially update a specific domain by domain Id
  • Update a specific domain by domain Id
• ExposedComputation
  • Process exposed computation
• FileReceived
  • Create FileReceived
• Generic
  • Encrypt the string
• GroupCustomers
  • Create group customer
  • Get a specific address for a specific group customer by groupCustomer Id and address Id
  • Get a specific group customer by groupCustomerId
  • Get list of addresses for a specific group customer by groupCustomer Id
  • Get the list of groupCustomers
  • Partially update a specific group customer by group customer Id
  • Update a specific group customer by groupCustomerId
• Health
  • Get health of PASJava/PASService/CycleService
• Liveness
  • Get liveness of PASJava/PASService/CycleService
• OutboundApplications
  • Create only security details for an existing application Id
  • Create the security details of downstream application
  • Delete outbound application security details
  • Deletes outbound application and corresponding security details
  • Get details of 100 latest records of outboundApplication
  • Get details of given application id and its corresponding security
  • Get specific security details of given application Id
  • Partially update outbound application
  • Partially update outbound application security
  • Update outbound application
  • Update outbound application security
• Plans
  • Get a specific plan by plan Id
  • Get a specific plan slice by plan Id and plan slice Id
  • Get list of plan slices by plan Id
  • Get list of plans
• Policies
  • Create policy
  • Create requirements for a policy by policy Id
  • Create roles for a policy by policy Id
  • Create segments for a policy by policy Id
  • Create withholdings for a policy by policy Id
  • Get a specific impairment for a specific policy by policy Id and impairment Id
  • Get a specific policy by policy Id
  • Get a specific requirement for a specific policy by policy Id and requirement Id
  • Get a specific role for a specific policy by policy Id and role Id
  • Get a specific segment for a specific policy by policy Id and segment Id
  • Get list of impairments for a specific policy by policy Id
  • Get list of policies
  • Get list of requirements for a specific policy by policy Id
  • Get list of roles for a specific policy by policy Id
  • Get list of roles for a specific segment by policy Id and segment Id
  • Get list of segments for a specific policy by policy Id
  • Get list of withholdings for a specific policy by policy Id
  • Get withholding for a specific policy by withholding Id
  • Partially update a segment for a specific policy by policy Id and segment Id
  • Partially update a specific requirement for a specific policy by policy Id and requirement Id
  • Partially update a specific role for a specific policy by policy Id and role Id
  • Update a segment for a specific policy by policy Id and segment Id
  • Update a specific policy by policy Id
  • Update a specific policy by policy Id
  • Update a specific requirement for a specific policy by policy Id and requirement Id
  • Update a specific role for a specific policy by policy Id and role Id
  • Update a specific withholding partially by withholding Id
  • Update withholding for a policy by policy Id and withholding Id
• ProcessPolicy
  • Process policy
• Products
  • Get a specific plan for a product by product Id and plan Id
  • Get a specific product by product Id
  • Get list of plans for a product by product Id
  • Get list of products
• Queries
  • Execute a saved SQL query by query name
  • Post SQL query to OIPA
• RateGroups
  • Create rateGroup
  • Create rateGroupRelationships for a rateGroup by rateGroup Id
  • Create rates for a rateGroup by rateGroup Id
  • Delete a specific rate from a rate group by rate Id and rate group Id
  • Delete a specific rate group relationship by rate group relationship Id and rate group Id
  • Exports rates for a specific rate group
  • Get a specific rate for a specific rateGroup by rateGroup Id and rate Id
  • Get a specific rateGroup by rateGroup Id
  • Get a specific rateGroupRelationship for a specific rateGroup by rateGroup Id and rateGroupRelationship Id
  • Get list of rateGroupRelationships for a specific rateGroup by rateGroup Id
  • Get list of rateGroups
  • Get list of rates for a specific rateGroup by rateGroup Id
  • Partially update a rate for a specific rateGroup by rateGroup Id and rate Id
  • Partially update a specific rateGroup by rateGroup Id
  • Partially update a specific rateGroupRelationship for a specific rateGroup by rateGroup Id and rateGroupRelationship Id
  • Update a rate for a specific rateGroup by rateGroup Id and rate Id
  • Update a rateGroupRelationship for a specific rateGroup by rateGroup Id and rateGroupRelationship Id
  • Update a specific rateGroup by rateGroup Id
  • Uploads a file containing rates and processes it to the database
• Readiness
  • Get readiness of PASJava/PASService/CycleService
• RequirementResults
  • Create requirementResult
  • Get a specific requirementresult by requirementresult Id
  • Get list of requirement results
  • Partially update a specific requirementResult by requirementResult Id
  • Update a specific requirementResult by requirementResult Id
• Schemas
  • Get a specific schema definition by entity
  • Get all entity schema definition links
• Segments
  • Create segment roles by segment Id
  • Get a specific segment by segment Id
  • Get list of roles for a specific segment by segment Id
  • Partially update a specific role for a specific segment by segment Id and role Id
  • Update a specific segment role for a specific segment by segment Id and role Id
• Suspenses
  • Create suspenses
  • Get a specific suspense by suspense Id
  • Get list of child suspenses for a specific suspense by suspense Id
  • Get list of suspenses
  • Update a specific suspense by suspense Id
  • Update a specific suspense by suspense Id
• Users and Security Group(s)
  • Create one or more security groups
  • Create user
  • Delete a specific security group by security group name
  • Delete a specific security group for a user by login name and security group name
  • Delete a specific user by login name
  • Delete all the security groups for a specific user by login name
  • Get a specific security group by security group name
  • Get a specific user by login name
  • Get all security groups
  • Get all users
  • Get list of security groups for a specific user by login name
  • Get list of users for a specific security group by security group name
  • Partially update a specific user by login name
  • Update a specific user by login name
• WorkflowTasks
  • Create workflowTask
  • Get a specific workflowTask by workflowTask Id
  • Get a specific workflowTaskDefinition by workflowTaskDefinition Id
  • Get list of workflowTasks
  • Partially Update a specific workflowTask by workflowTask Id
  • Update a specific workflowTask by workflowTask Id