All REST Endpoints
Calendars
Calendars
- Get a specific calendar by calendar code
- Method: getPath:
/PASService/rest/services/v1/calendars/{calendarCode}
- Get list of calendars
- Method: getPath:
/PASService/rest/services/v1/calendars
Cases
Cases
- Create Case
- Method: postPath:
/PASService/rest/services/v1/cases
- Get a specific case by case Id
- Method: getPath:
/PASService/rest/services/v1/cases/{caseId}
- Get list of cases
- Method: getPath:
/PASService/rest/services/v1/cases
- Get the list of policies for a specific case by case Id
- Method: getPath:
/PASService/rest/services/v1/cases/{caseId}/policies
- Update a specific case by case Id
- Method: putPath:
/PASService/rest/services/v1/cases/{caseId}
Clients
Clients
- Create client phones
- Method: postPath:
/PASService/rest/services/v1/clients/{clientId}/phones
- Create clients
- Method: postPath:
/PASService/rest/services/v1/clients
- Create clients addresses
- Method: postPath:
/PASService/rest/services/v1/clients/{clientId}/addresses
- Get a specific address for a specific client by client Id and address Id
- Method: getPath:
/PASService/rest/services/v1/clients/{clientId}/addresses/{addressId}
- Get a specific client by client Id
- Method: getPath:
/PASService/rest/services/v1/clients/{clientId}
- Get a specific phone for a specific client by client Id and phone Id
- Method: getPath:
/PASService/rest/services/v1/clients/{clientId}/phones/{phoneId}
- Get list of clients
- Method: getPath:
/PASService/rest/services/v1/clients
- Get the list of addresses for a specific client by client Id
- Method: getPath:
/PASService/rest/services/v1/clients/{clientId}/addresses
- Get the list of client relationships for a specific client by client Id
- Method: getPath:
/PASService/rest/services/v1/clients/{clientId}/clientRelationships
- Get the list of phones for a specific client by client Id
- Method: getPath:
/PASService/rest/services/v1/clients/{clientId}/phones
- Get the list of roles for a specific client by client Id
- Method: getPath:
/PASService/rest/services/v1/clients/{clientId}/clientRoles
- Update a specific client address for a specific client by client Id and address Id
- Method: putPath:
/PASService/rest/services/v1/clients/{clientId}/addresses/{addressId}
- Update a specific client by client Id
- Method: putPath:
/PASService/rest/services/v1/clients/{clientId}
- Update a specific client phone for a specific client by client Id and phone Id
- Method: putPath:
/PASService/rest/services/v1/clients/{clientId}/phones/{phoneId}
Codes
Codes
- Get the list of code details for a specific code name
- Method: getPath:
/PASService/rest/services/v1/codes
Companies
Companies
- Get a specific company by company Id
- Method: getPath:
/PASService/rest/services/v1/companies/{companyId}
- Get list of companies
- Method: getPath:
/PASService/rest/services/v1/companies
- Get the list of plans for a company by company Id
- Method: getPath:
/PASService/rest/services/v1/companies/{companyId}/plans
- Get the list of products for a company by company Id
- Method: getPath:
/PASService/rest/services/v1/companies/{companyId}/products
Domains
Domains
- Create a domain
- Method: postPath:
/PASService/rest/services/v1/url/domains
- Delete a specific domain by domain Id
- Method: deletePath:
/PASService/rest/services/v1/url/domains/{domainId}
- Get all domains
- Method: getPath:
/PASService/rest/services/v1/url/domains
- Gets a specific domain by domain Id
- Method: getPath:
/PASService/rest/services/v1/url/domains/{domainId}
- Update a specific domain by domain Id
- Method: putPath:
/PASService/rest/services/v1/url/domains/{domainId}
ExposedComputation
ExposedComputation
- Process exposed computation
- Method: postPath:
/PASService/rest/services/v1/exposedComputation
FileReceived
FileReceived
- Create FileReceived
- Method: postPath:
/PASService/rest/services/v1/fileReceived
Generic
Generic
- Encrypt the string
- Method: getPath:
/PASService/rest/services/v1/encryptionService
GroupCustomers
GroupCustomers
- Create group customer
- Method: postPath:
/PASService/rest/services/v1/groupCustomers
- Get a specific address for a specific group customer by groupCustomer Id and address Id
- Method: getPath:
/PASService/rest/services/v1/groupCustomers/{groupCustomerId}/addresses/{addressId}
- Get a specific group customer by groupCustomerId
- Method: getPath:
/PASService/rest/services/v1/groupCustomers/{groupCustomerId}
- Get list of addresses for a specific group customer by groupCustomer Id
- Method: getPath:
/PASService/rest/services/v1/groupCustomers/{groupCustomerId}/addresses
- Get the list of groupCustomers
- Method: getPath:
/PASService/rest/services/v1/groupCustomers
- Update a specific group customer by groupCustomerId
- Method: putPath:
/PASService/rest/services/v1/groupCustomers/{groupCustomerId}
OutboundApplications
OutboundApplications
- Create only security details for an existing application Id
- Method: postPath:
/PASService/rest/services/v1/outboundApplications/{outboundApplicationId}/outboundSecurities
- Create the security details of downstream application
- Method: postPath:
/PASService/rest/services/v1/outboundApplications
- Delete outbound application and corresponding security details
- Method: deletePath:
/PASService/rest/services/v1/outboundApplications/{outboundApplicationId}
- Get details of 100 latest records of outboundApplication
- Method: getPath:
/PASService/rest/services/v1/outboundApplications
- Get details of given application id and its corresponding security
- Method: getPath:
/PASService/rest/services/v1/outboundApplications/{outboundApplicationId}
- Get specific security details of given application Id
- Method: getPath:
/PASService/rest/services/v1/outboundApplications/{outboundApplicationId}/outboundSecurities
- Update outbound application
- Method: putPath:
/PASService/rest/services/v1/outboundApplications/{outboundApplicationId}
- Update outbound application security
- Method: putPath:
/PASService/rest/services/v1/outboundApplications/{outboundApplicationId}/outboundSecurities/{securityId}
Plans
Plans
- Get a specific plan by plan Id
- Method: getPath:
/PASService/rest/services/v1/plans/{planId}
- Get a specific plan slice by plan Id and plan slice Id
- Method: getPath:
/PASService/rest/services/v1/plans/{planId}/planslices/{plansliceId}
- Get list of plan slices by plan Id
- Method: getPath:
/PASService/rest/services/v1/plans/{planId}/planslices
- Get list of plans
- Method: getPath:
/PASService/rest/services/v1/plans
Policies
Policies
- Create policy
- Method: postPath:
/PASService/rest/services/v1/policies
- Create requirements for a policy by policy Id
- Method: postPath:
/PASService/rest/services/v1/policies/{policyId}/requirements
- Create roles for a policy by policy Id
- Method: postPath:
/PASService/rest/services/v1/policies/{policyId}/roles
- Create segments for a policy by policy Id
- Method: postPath:
/PASService/rest/services/v1/policies/{policyId}/segments
- Get a specific impairment for a specific policy by policy Id and impairment Id
- Method: getPath:
/PASService/rest/services/v1/policies/{policyId}/impairments/{impairmentId}
- Get a specific policy by policy Id
- Method: getPath:
/PASService/rest/services/v1/policies/{policyId}
- Get a specific requirement for a specific policy by policy Id and requirement Id
- Method: getPath:
/PASService/rest/services/v1/policies/{policyId}/requirements/{requirementId}
- Get a specific role for a specific policy by policy Id and role Id
- Method: getPath:
/PASService/rest/services/v1/policies/{policyId}/roles/{roleId}
- Get a specific segment for a specific policy by policy Id and segment Id
- Method: getPath:
/PASService/rest/services/v1/policies/{policyId}/segments/{segmentId}
- Get list of impairments for a specific policy by policy Id
- Method: getPath:
/PASService/rest/services/v1/policies/{policyId}/impairments
- Get list of policies
- Method: getPath:
/PASService/rest/services/v1/policies
- Get list of requirements for a specific policy by policy Id
- Method: getPath:
/PASService/rest/services/v1/policies/{policyId}/requirements
- Get list of roles for a specific policy by policy Id
- Method: getPath:
/PASService/rest/services/v1/policies/{policyId}/roles
- Get list of roles for a specific segment by policy Id and segment Id
- Method: getPath:
/PASService/rest/services/v1/policies/{policyId}/segments/{segmentId}/roles
- Get list of segments for a specific policy by policy Id
- Method: getPath:
/PASService/rest/services/v1/policies/{policyId}/segments
- Update a segment for a specific policy by policy Id and segment Id
- Method: putPath:
/PASService/rest/services/v1/policies/{policyId}/segments/{segmentId}
- Update a specific policy by policy Id
- Method: putPath:
/PASService/rest/services/v1/policies/{policyId}
- Update a specific requirement for a specific policy by policy Id and requirement Id
- Method: putPath:
/PASService/rest/services/v1/policies/{policyId}/requirements/{requirementId}
- Update a specific role for a specific policy by policy Id and role Id
- Method: putPath:
/PASService/rest/services/v1/policies/{policyId}/roles/{roleId}
ProcessPolicy
ProcessPolicy
- Process policy
- Method: putPath:
/PASService/rest/services/v1/processPolicy
Products
Products
- Get a specific plan for a product by product Id and plan Id
- Method: getPath:
/PASService/rest/services/v1/products/{productId}/plans/{planId}
- Get a specific product by product Id
- Method: getPath:
/PASService/rest/services/v1/products/{productId}
- Get list of plans for a product by product Id
- Method: getPath:
/PASService/rest/services/v1/products/{productId}/plans
- Get list of products
- Method: getPath:
/PASService/rest/services/v1/products
Queries
Queries
- Execute a saved SQL query by query name
- Method: getPath:
/PASService/rest/services/v1/queries/{queryName}
- Post SQL query to OIPA
- Method: postPath:
/PASService/rest/services/v1/queries
Schemas
Schemas
- Get a specific schema definition by entity
- Method: getPath:
/PASService/rest/services/v1/schema/{entity}
- Get all entity schema definition links
- Method: getPath:
/PASService/rest/services/v1/schemas
Segments
Segments
- Create segment roles by segment Id
- Method: postPath:
/PASService/rest/services/v1/segments/{segmentId}/roles
- Get a specific segment by segment Id
- Method: getPath:
/PASService/rest/services/v1/segments/{segmentId}
- Get list of roles for a specific segment by segment Id
- Method: getPath:
/PASService/rest/services/v1/segments/{segmentId}/roles
- Update a specific segment role for a specific segment by segment Id and role Id
- Method: putPath:
/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: postPath:
/PASService/rest/services/v1/securityGroups
- Create user
- Method: postPath:
/PASService/rest/services/v1/users
- Delete a specific security group by security group name
- Method: deletePath:
/PASService/rest/services/v1/securityGroups/{securityGroupName}
- Delete a specific security group for a user by login name and security group name
- Method: deletePath:
/PASService/rest/services/v1/users/{loginName}/securityGroups/{securityGroupName}
- Delete a specific user by login name
- Method: deletePath:
/PASService/rest/services/v1/users/{loginName}
- Delete all the security groups for a specific user by login name
- Method: deletePath:
/PASService/rest/services/v1/users/{loginName}/securityGroups
- Get a specific security group by security group name
- Method: getPath:
/PASService/rest/services/v1/securityGroups/{securityGroupName}
- Get a specific user by login name
- Method: getPath:
/PASService/rest/services/v1/users/{loginName}
- Get all security groups
- Method: getPath:
/PASService/rest/services/v1/securityGroups
- Get all users
- Method: getPath:
/PASService/rest/services/v1/users
- Get list of security groups for a specific user by login name
- Method: getPath:
/PASService/rest/services/v1/users/{loginName}/securityGroups
- Get list of users for a specific security group by security group name
- Method: getPath:
/PASService/rest/services/v1/securityGroups/{securityGroupName}/users
- Update a specific user by login name
- Method: putPath:
/PASService/rest/services/v1/users/{loginName}