Previous Next JavaScript must be enabled to correctly display this content

## All REST Endpoints

Sort by
Task Path Method
Group by API
Calendars
Calendars

Get a specific calendar by calendar code
  Method: get
  Path: `/PASService/rest/services/v1/calendars/{calendarCode}`
Get list of calendars
  Method: get
  Path: `/PASService/rest/services/v1/calendars`

Cases
Cases

Create Case
  Method: post
  Path: `/PASService/rest/services/v1/cases`
Get a specific case by case Id
  Method: get
  Path: `/PASService/rest/services/v1/cases/{caseId}`
Get list of cases
  Method: get
  Path: `/PASService/rest/services/v1/cases`
Get the list of policies for a specific case by case Id
  Method: get
  Path: `/PASService/rest/services/v1/cases/{caseId}/policies`
Partially update a specific case by case Id
  Method: patch
  Path: `/PASService/rest/services/v1/cases/{caseId}`
Update a specific case by case Id
  Method: put
  Path: `/PASService/rest/services/v1/cases/{caseId}`

Clients
Clients

Create client phones
  Method: post
  Path: `/PASService/rest/services/v1/clients/{clientId}/phones`
Create clients
  Method: post
  Path: `/PASService/rest/services/v1/clients`
Create clients addresses
  Method: post
  Path: `/PASService/rest/services/v1/clients/{clientId}/addresses`
Create requirements for a client by client Id
  Method: post
  Path: `/PASService/rest/services/v1/clients/{clientId}/requirements`
Delete a specific requirement from a client by client Id and requirement Id
  Method: delete
  Path: `/PASService/rest/services/v1/clients/{clientId}/requirements/{requirementId}`
Get a specific address for a specific client by client Id and address Id
  Method: get
  Path: `/PASService/rest/services/v1/clients/{clientId}/addresses/{addressId}`
Get a specific client by client Id
  Method: get
  Path: `/PASService/rest/services/v1/clients/{clientId}`
Get a specific phone for a specific client by client Id and phone Id
  Method: get
  Path: `/PASService/rest/services/v1/clients/{clientId}/phones/{phoneId}`
Get a specific requirement for a specific client by client Id and requirement Id
  Method: get
  Path: `/PASService/rest/services/v1/clients/{clientId}/requirements/{requirementId}`
Get list of clients
  Method: get
  Path: `/PASService/rest/services/v1/clients`
Get list of requirements for a specific client by client Id
  Method: get
  Path: `/PASService/rest/services/v1/clients/{clientId}/requirements`
Get the list of addresses for a specific client by client Id
  Method: get
  Path: `/PASService/rest/services/v1/clients/{clientId}/addresses`
Get the list of client relationships for a specific client by client Id
  Method: get
  Path: `/PASService/rest/services/v1/clients/{clientId}/clientRelationships`
Get the list of phones for a specific client by client Id
  Method: get
  Path: `/PASService/rest/services/v1/clients/{clientId}/phones`
Get the list of roles for a specific client by client Id
  Method: get
  Path: `/PASService/rest/services/v1/clients/{clientId}/clientRoles`
Partially update a specific client address for a specific client by client Id and address Id
  Method: patch
  Path: `/PASService/rest/services/v1/clients/{clientId}/addresses/{addressId}`
Partially update a specific client phone for a specific client by client Id and phone Id
  Method: patch
  Path: `/PASService/rest/services/v1/clients/{clientId}/phones/{phoneId}`
Partially update a specific requirement for a specific client by client Id and requirement Id
  Method: patch
  Path: `/PASService/rest/services/v1/clients/{clientId}/requirements/{requirementId}`
Update a specific client address for a specific client by client Id and address Id
  Method: put
  Path: `/PASService/rest/services/v1/clients/{clientId}/addresses/{addressId}`
Update a specific client by client Id
  Method: patch
  Path: `/PASService/rest/services/v1/clients/{clientId}`
Update a specific client by client Id
  Method: put
  Path: `/PASService/rest/services/v1/clients/{clientId}`
Update a specific client phone for a specific client by client Id and phone Id
  Method: put
  Path: `/PASService/rest/services/v1/clients/{clientId}/phones/{phoneId}`
Update a specific requirement for a specific client by client Id and requirement Id
  Method: put
  Path: `/PASService/rest/services/v1/clients/{clientId}/requirements/{requirementId}`

Codes
Codes

Get the list of code details for a specific code name
  Method: get
  Path: `/PASService/rest/services/v1/codes`

Companies
Companies

Get a specific company by company Id
  Method: get
  Path: `/PASService/rest/services/v1/companies/{companyId}`
Get list of companies
  Method: get
  Path: `/PASService/rest/services/v1/companies`
Get the list of plans for a company by company Id
  Method: get
  Path: `/PASService/rest/services/v1/companies/{companyId}/plans`
Get the list of products for a company by company Id
  Method: get
  Path: `/PASService/rest/services/v1/companies/{companyId}/products`

Domains
Domains

Create a domain
  Method: post
  Path: `/PASService/rest/services/v1/url/domains`
Delete a specific domain by domain Id
  Method: delete
  Path: `/PASService/rest/services/v1/url/domains/{domainId}`
Get all domains
  Method: get
  Path: `/PASService/rest/services/v1/url/domains`
Gets a specific domain by domain Id
  Method: get
  Path: `/PASService/rest/services/v1/url/domains/{domainId}`
Partially update a specific domain by domain Id
  Method: patch
  Path: `/PASService/rest/services/v1/url/domains/{domainId}`
Update a specific domain by domain Id
  Method: put
  Path: `/PASService/rest/services/v1/url/domains/{domainId}`

ExposedComputation
ExposedComputation

Process exposed computation
  Method: post
  Path: `/PASService/rest/services/v1/exposedComputation`

FileReceived
FileReceived

Create FileReceived
  Method: post
  Path: `/PASService/rest/services/v1/fileReceived`

Generic
Generic

Encrypt the string
  Method: get
  Path: `/PASService/rest/services/v1/encryptionService`

GroupCustomers
GroupCustomers

Create group customer
  Method: post
  Path: `/PASService/rest/services/v1/groupCustomers`
Get a specific address for a specific group customer by groupCustomer Id and address Id
  Method: get
  Path: `/PASService/rest/services/v1/groupCustomers/{groupCustomerId}/addresses/{addressId}`
Get a specific group customer by groupCustomerId
  Method: get
  Path: `/PASService/rest/services/v1/groupCustomers/{groupCustomerId}`
Get list of addresses for a specific group customer by groupCustomer Id
  Method: get
  Path: `/PASService/rest/services/v1/groupCustomers/{groupCustomerId}/addresses`
Get the list of groupCustomers
  Method: get
  Path: `/PASService/rest/services/v1/groupCustomers`
Partially update a specific group customer by group customer Id
  Method: patch
  Path: `/PASService/rest/services/v1/groupCustomers/{groupCustomerId}`
Update a specific group customer by groupCustomerId
  Method: put
  Path: `/PASService/rest/services/v1/groupCustomers/{groupCustomerId}`

Health
Health

Get health of PASJava/PASService/CycleService
  Method: get
  Path: `/PASService/rest/services/v1/health`

Liveness
The operations from the Liveness category.

Get liveness of PASJava/PASService/CycleService
  Method: get
  Path: `/PASService/rest/services/v1/health/liveness`

OutboundApplications
OutboundApplications

Create only security details for an existing application Id
  Method: post
  Path: `/PASService/rest/services/v1/outboundApplications/{outboundApplicationId}/outboundSecurities`
Create the security details of downstream application
  Method: post
  Path: `/PASService/rest/services/v1/outboundApplications`
Delete outbound application security details
  Method: delete
  Path: `/PASService/rest/services/v1/outboundApplications/{outboundApplicationId}/outboundSecurities`
Deletes outbound application and corresponding security details
  Method: delete
  Path: `/PASService/rest/services/v1/outboundApplications/{id}`
Get details of 100 latest records of outboundApplication
  Method: get
  Path: `/PASService/rest/services/v1/outboundApplications`
Get details of given application id and its corresponding security
  Method: get
  Path: `/PASService/rest/services/v1/outboundApplications/{id}`
Get specific security details of given application Id
  Method: get
  Path: `/PASService/rest/services/v1/outboundApplications/{outboundApplicationId}/outboundSecurities`
Partially update outbound application
  Method: patch
  Path: `/PASService/rest/services/v1/outboundApplications/{outboundApplicationId}`
Partially update outbound application security
  Method: patch
  Path: `/PASService/rest/services/v1/outboundApplications/{outboundApplicationId}/outboundSecurities/{securityId}`
Update outbound application
  Method: put
  Path: `/PASService/rest/services/v1/outboundApplications/{id}`
Update outbound application security
  Method: put
  Path: `/PASService/rest/services/v1/outboundApplications/{outboundApplicationId}/outboundSecurities/{securityId}`

Plans
Plans

Get a specific plan by plan Id
  Method: get
  Path: `/PASService/rest/services/v1/plans/{planId}`
Get a specific plan slice by plan Id and plan slice Id
  Method: get
  Path: `/PASService/rest/services/v1/plans/{planId}/planslices/{plansliceId}`
Get list of plan slices by plan Id
  Method: get
  Path: `/PASService/rest/services/v1/plans/{planId}/planslices`
Get list of plans
  Method: get
  Path: `/PASService/rest/services/v1/plans`

Policies
Policies

Create policy
  Method: post
  Path: `/PASService/rest/services/v1/policies`
Create requirements for a policy by policy Id
  Method: post
  Path: `/PASService/rest/services/v1/policies/{policyId}/requirements`
Create roles for a policy by policy Id
  Method: post
  Path: `/PASService/rest/services/v1/policies/{policyId}/roles`
Create segments for a policy by policy Id
  Method: post
  Path: `/PASService/rest/services/v1/policies/{policyId}/segments`
Create withholdings for a policy by policy Id
  Method: post
  Path: `/PASService/rest/services/v1/policies/{policyId}/withholdings`
Get a specific impairment for a specific policy by policy Id and impairment Id
  Method: get
  Path: `/PASService/rest/services/v1/policies/{policyId}/impairments/{impairmentId}`
Get a specific policy by policy Id
  Method: get
  Path: `/PASService/rest/services/v1/policies/{policyId}`
Get a specific requirement for a specific policy by policy Id and requirement Id
  Method: get
  Path: `/PASService/rest/services/v1/policies/{policyId}/requirements/{requirementId}`
Get a specific role for a specific policy by policy Id and role Id
  Method: get
  Path: `/PASService/rest/services/v1/policies/{policyId}/roles/{roleId}`
Get a specific segment for a specific policy by policy Id and segment Id
  Method: get
  Path: `/PASService/rest/services/v1/policies/{policyId}/segments/{segmentId}`
Get list of impairments for a specific policy by policy Id
  Method: get
  Path: `/PASService/rest/services/v1/policies/{policyId}/impairments`
Get list of policies
  Method: get
  Path: `/PASService/rest/services/v1/policies`
Get list of requirements for a specific policy by policy Id
  Method: get
  Path: `/PASService/rest/services/v1/policies/{policyId}/requirements`
Get list of roles for a specific policy by policy Id
  Method: get
  Path: `/PASService/rest/services/v1/policies/{policyId}/roles`
Get list of roles for a specific segment by policy Id and segment Id
  Method: get
  Path: `/PASService/rest/services/v1/policies/{policyId}/segments/{segmentId}/roles`
Get list of segments for a specific policy by policy Id
  Method: get
  Path: `/PASService/rest/services/v1/policies/{policyId}/segments`
Get list of withholdings for a specific policy by policy Id
  Method: get
  Path: `/PASService/rest/services/v1/policies/{policyId}/withholdings`
Get withholding for a specific policy by withholding Id
  Method: get
  Path: `/PASService/rest/services/v1/policies/{policyId}/withholdings/{withholdingId}`
Partially update a segment for a specific policy by policy Id and segment Id
  Method: patch
  Path: `/PASService/rest/services/v1/policies/{policyId}/segments/{segmentId}`
Partially update a specific requirement for a specific policy by policy Id and requirement Id
  Method: patch
  Path: `/PASService/rest/services/v1/policies/{policyId}/requirements/{requirementId}`
Partially update a specific role for a specific policy by policy Id and role Id
  Method: patch
  Path: `/PASService/rest/services/v1/policies/{policyId}/roles/{roleId}`
Update a segment for a specific policy by policy Id and segment Id
  Method: put
  Path: `/PASService/rest/services/v1/policies/{policyId}/segments/{segmentId}`
Update a specific policy by policy Id
  Method: patch
  Path: `/PASService/rest/services/v1/policies/{policyId}`
Update a specific policy by policy Id
  Method: put
  Path: `/PASService/rest/services/v1/policies/{policyId}`
Update a specific requirement for a specific policy by policy Id and requirement Id
  Method: put
  Path: `/PASService/rest/services/v1/policies/{policyId}/requirements/{requirementId}`
Update a specific role for a specific policy by policy Id and role Id
  Method: put
  Path: `/PASService/rest/services/v1/policies/{policyId}/roles/{roleId}`
Update a specific withholding partially by withholding Id
  Method: patch
  Path: `/PASService/rest/services/v1/policies/{policyId}/withholdings/{withholdingId}`
Update withholding for a policy by policy Id and withholding Id
  Method: put
  Path: `/PASService/rest/services/v1/policies/{policyId}/withholdings/{withholdingId}`

ProcessPolicy
ProcessPolicy

Process policy
  Method: put
  Path: `/PASService/rest/services/v1/processPolicy`

Products
Products

Get a specific plan for a product by product Id and plan Id
  Method: get
  Path: `/PASService/rest/services/v1/products/{productId}/plans/{planId}`
Get a specific product by product Id
  Method: get
  Path: `/PASService/rest/services/v1/products/{productId}`
Get list of plans for a product by product Id
  Method: get
  Path: `/PASService/rest/services/v1/products/{productId}/plans`
Get list of products
  Method: get
  Path: `/PASService/rest/services/v1/products`

Queries
Queries

Execute a saved SQL query by query name
  Method: get
  Path: `/PASService/rest/services/v1/queries/{queryname}`
Post SQL query to OIPA
  Method: post
  Path: `/PASService/rest/services/v1/queries`

RateGroups
RateGroups

Create rateGroup
  Method: post
  Path: `/PASService/rest/services/v1/rateGroups`
Create rateGroupRelationships for a rateGroup by rateGroup Id
  Method: post
  Path: `/PASService/rest/services/v1/rateGroups/{rateGroupId}/rateGroupRelationships`
Create rates for a rateGroup by rateGroup Id
  Method: post
  Path: `/PASService/rest/services/v1/rateGroups/{rateGroupId}/rates`
Delete a specific rate from a rate group by rate Id and rate group Id
  Method: delete
  Path: `/PASService/rest/services/v1/rateGroups/{rateGroupId}/rates/{rateId}`
Delete a specific rate group relationship by rate group relationship Id and rate group Id
  Method: delete
  Path: `/PASService/rest/services/v1/rateGroups/{rateGroupId}/rateGroupRelationships/{rateGroupRelationshipId}`
Exports rates for a specific rate group
  Method: get
  Path: `/PASService/rest/services/v1/rateGroups/{rateGroupId}/export`
Get a specific rate for a specific rateGroup by rateGroup Id and rate Id
  Method: get
  Path: `/PASService/rest/services/v1/rateGroups/{rateGroupId}/rates/{rateId}`
Get a specific rateGroup by rateGroup Id
  Method: get
  Path: `/PASService/rest/services/v1/rateGroups/{rateGroupId}`
Get a specific rateGroupRelationship for a specific rateGroup by rateGroup Id and rateGroupRelationship Id
  Method: get
  Path: `/PASService/rest/services/v1/rateGroups/{rateGroupId}/rateGroupRelationships/{rateGroupRelationshipId}`
Get list of rateGroupRelationships for a specific rateGroup by rateGroup Id
  Method: get
  Path: `/PASService/rest/services/v1/rateGroups/{rateGroupId}/rateGroupRelationships`
Get list of rateGroups
  Method: get
  Path: `/PASService/rest/services/v1/rateGroups`
Get list of rates for a specific rateGroup by rateGroup Id
  Method: get
  Path: `/PASService/rest/services/v1/rateGroups/{rateGroupId}/rates`
Partially update a rate for a specific rateGroup by rateGroup Id and rate Id
  Method: patch
  Path: `/PASService/rest/services/v1/rateGroups/{rateGroupId}/rates/{rateId}`
Partially update a specific rateGroup by rateGroup Id
  Method: patch
  Path: `/PASService/rest/services/v1/rateGroups/{rateGroupId}`
Partially update a specific rateGroupRelationship for a specific rateGroup by rateGroup Id and rateGroupRelationship Id
  Method: patch
  Path: `/PASService/rest/services/v1/rateGroups/{rateGroupId}/rateGroupRelationships/{rateGroupRelationshipId}`
Update a rate for a specific rateGroup by rateGroup Id and rate Id
  Method: put
  Path: `/PASService/rest/services/v1/rateGroups/{rateGroupId}/rates/{rateId}`
Update a rateGroupRelationship for a specific rateGroup by rateGroup Id and rateGroupRelationship Id
  Method: put
  Path: `/PASService/rest/services/v1/rateGroups/{rateGroupId}/rateGroupRelationships/{rateGroupRelationshipId}`
Update a specific rateGroup by rateGroup Id
  Method: put
  Path: `/PASService/rest/services/v1/rateGroups/{rateGroupId}`
Uploads a file containing rates and processes it to the database
  Method: post
  Path: `/PASService/rest/services/v1/rateGroups/import`

Readiness
The operations from the Readiness category.

Get readiness of PASJava/PASService/CycleService
  Method: get
  Path: `/PASService/rest/services/v1/health/readiness`

RequirementResults
RequirementResults

Create requirementResult
  Method: post
  Path: `/PASService/rest/services/v1/requirementResults`
Get a specific requirementresult by requirementresult Id
  Method: get
  Path: `/PASService/rest/services/v1/requirementResults/{requirementResultId}`
Get list of requirement results
  Method: get
  Path: `/PASService/rest/services/v1/requirementResults`
Partially update a specific requirementResult by requirementResult Id
  Method: patch
  Path: `/PASService/rest/services/v1/requirementResults/{requirementResultsId}`
Update a specific requirementResult by requirementResult Id
  Method: put
  Path: `/PASService/rest/services/v1/requirementResults/{requirementResultsId}`

Schemas
Schemas

Get a specific schema definition by entity
  Method: get
  Path: `/PASService/rest/services/v1/schema/{entity}`
Get all entity schema definition links
  Method: get
  Path: `/PASService/rest/services/v1/schemas`

Segments
Segments

Create segment roles by segment Id
  Method: post
  Path: `/PASService/rest/services/v1/segments/{segmentId}/roles`
Get a specific segment by segment Id
  Method: get
  Path: `/PASService/rest/services/v1/segments/{segmentId}`
Get list of roles for a specific segment by segment Id
  Method: get
  Path: `/PASService/rest/services/v1/segments/{segmentId}/roles`
Partially update a specific role for a specific segment by segment Id and role Id
  Method: patch
  Path: `/PASService/rest/services/v1/segments/{segmentId}/roles/{roleId}`
Update a specific segment role for a specific segment by segment Id and role Id
  Method: put
  Path: `/PASService/rest/services/v1/segments/{segmentId}/roles/{roleId}`

Suspenses
The operations from the Suspenses category.

Create suspenses
  Method: post
  Path: `/PASService/rest/services/v1/suspenses`
Get a specific suspense by suspense Id
  Method: get
  Path: `/PASService/rest/services/v1/suspenses/{suspenseId}`
Get list of child suspenses for a specific suspense by suspense Id
  Method: get
  Path: `/PASService/rest/services/v1/suspenses/{suspenseId}/childSuspenses`
Get list of suspenses
  Method: get
  Path: `/PASService/rest/services/v1/suspenses`
Update a specific suspense by suspense Id
  Method: patch
  Path: `/PASService/rest/services/v1/suspenses/{suspenseId}`
Update a specific suspense by suspense Id
  Method: put
  Path: `/PASService/rest/services/v1/suspenses/{suspenseId}`

Users and Security Group(s)
Users and Security Group(s)

Create one or more security groups
  Method: post
  Path: `/PASService/rest/services/v1/securityGroups`
Create user
  Method: post
  Path: `/PASService/rest/services/v1/users`
Delete a specific security group by security group name
  Method: delete
  Path: `/PASService/rest/services/v1/securityGroups/{securityGroupName}`
Delete a specific security group for a user by login name and security group name
  Method: delete
  Path: `/PASService/rest/services/v1/users/{loginName}/securityGroups/{securityGroupName}`
Delete a specific user by login name
  Method: delete
  Path: `/PASService/rest/services/v1/users/{loginName}`
Delete all the security groups for a specific user by login name
  Method: delete
  Path: `/PASService/rest/services/v1/users/{loginName}/securityGroups`
Get a specific security group by security group name
  Method: get
  Path: `/PASService/rest/services/v1/securityGroups/{securityGroupName}`
Get a specific user by login name
  Method: get
  Path: `/PASService/rest/services/v1/users/{loginName}`
Get all security groups
  Method: get
  Path: `/PASService/rest/services/v1/securityGroups`
Get all users
  Method: get
  Path: `/PASService/rest/services/v1/users`
Get list of security groups for a specific user by login name
  Method: get
  Path: `/PASService/rest/services/v1/users/{loginName}/securityGroups`
Get list of users for a specific security group by security group name
  Method: get
  Path: `/PASService/rest/services/v1/securityGroups/{securityGroupName}/users`
Partially update a specific user by login name
  Method: patch
  Path: `/PASService/rest/services/v1/users/{loginName}`
Update a specific user by login name
  Method: put
  Path: `/PASService/rest/services/v1/users/{loginName}`

WorkflowTasks
WorkflowTasks

Create workflowTask
  Method: post
  Path: `/PASService/rest/services/v1/workflowTasks`
Get a specific workflowTask by workflowTask Id
  Method: get
  Path: `/PASService/rest/services/v1/workflowTasks/{workflowTaskId}`
Get a specific workflowTaskDefinition by workflowTaskDefinition Id
  Method: get
  Path: `/PASService/rest/services/v1/workflowTaskDefinitions/{workflowTaskDefinitionId}`
Get list of workflowTasks
  Method: get
  Path: `/PASService/rest/services/v1/workflowTasks`
Partially Update a specific workflowTask by workflowTask Id
  Method: patch
  Path: `/PASService/rest/services/v1/workflowTasks/{workflowTaskId}`
Update a specific workflowTask by workflowTask Id
  Method: put
  Path: `/PASService/rest/services/v1/workflowTasks/{workflowTaskId}`