All REST Endpoints

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
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
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 list of clients
Method: get
Path: /PASService/rest/services/v1/clients
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
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: 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}
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}
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
Update a specific group customer by groupCustomerId
Method: put
Path: /PASService/rest/services/v1/groupCustomers/{groupCustomerId}
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 and corresponding security details
Method: delete
Path: /PASService/rest/services/v1/outboundApplications/{outboundApplicationId}
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/{outboundApplicationId}
Get specific security details of given application Id
Method: get
Path: /PASService/rest/services/v1/outboundApplications/{outboundApplicationId}/outboundSecurities
Update outbound application
Method: put
Path: /PASService/rest/services/v1/outboundApplications/{outboundApplicationId}
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
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
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: 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}
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
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
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}
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
Update a specific user by login name
Method: put
Path: /PASService/rest/services/v1/users/{loginName}