Get a specific entity schema definition
get
/PASService/rest/services/schemas/{entity}
Gets a schema definition based on the specified entity name. The entity name can be either of the following: policies, clients, cases, groupCustomers, segments, roles, requirements, segmentRoles, addresses, or phones
Request
Path Parameters
-
entity: string
Entity Id policies,segments,roles,segmentRoles,requirements,cases,groupCustomers,addresses,phones,clients
Query Parameters
-
q(optional): string
Search Parameter - planId, issueStateCode, systemCode, resolveUri, segmentName, policyId, roleCode, companyId, requirementName, type, addressType, country
Response
Supported Media Types
- application/json
Default Response
successful operation
Examples
This example describes how to get a schema definition based on the specified entity name. The entity name can be either of the following: policies, clients, cases, groupCustomers, segments, roles, requirements, segmentRoles, addresses, or phones. Note that specifying the "query" parameter is mandatory for the following entities: addresses (mandatory query parameters: addressType and country), groupCustomers (mandatory query parameter: type), segments (mandatory query parameters: planId and segmentName), segmentRoles (mandatory query parameters: segmentName and roleCode), roles (mandatory query parameter: roleCode), requirements (mandatory query parameter: requirementName), and clients (mandatory query parameter: type).
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -X GET -H "Accept: application/json" -u username:password "server:port/PASService/rest/schemas/{entity}"
Example Response Body
The following shows an example of the response body in JSON format:
/schema/policies { "type": "object", "id": "urn:jsonschema:com:oracle:service:model:PolicyResourceModel", "required": [ "status", "systemCode", "companyId", "planId" ], "properties": { "links": { "type": "array" }, "multiFields": { "refLink": "schema/policy/multifields" }, "requirements": { "refLink": "schema/requirements" }, "policyName": { "type": ["string","null"] }, "roles": { "refLink": "schema/roles" }, "policyNumber": { "type": ["string","null"] }, "automaticPolicyNumber": { "type": "integer" }, "updatedDate": { "type": "string", "properties": { "Encrypt": "No", "Disabled": "false", "Hidden": "false", "customType": "DateField", "pattern": "^\\d{4}-(?:0[0-9]{1}|1[0-2]{1})-(0?[1-9]|[12][0-9]|3[01])[tT ]\\d{2}:\\d{2}:\\d{2}[zZ ]$" } }, "creationDate": { "type": "string", "properties": { "Encrypt": "No", "Disabled": "false", "Hidden": "false", "customType": "DateField", "pattern": "^\\d{4}-(?:0[0-9]{1}|1[0-2]{1})-(0?[1-9]|[12][0-9]|3[01])[tT ]\\d{2}:\\d{2}:\\d{2}[zZ ]$" } }, "planDate": { "type": "string", "properties": { "Encrypt": "No", "Disabled": "false", "Hidden": "false", "customType": "DateField", "pattern": "^\\d{4}-(?:0[0-9]{1}|1[0-2]{1})-(0?[1-9]|[12][0-9]|3[01])[tT ]\\d{2}:\\d{2}:\\d{2}[zZ ]$" } }, "segments": { "refLink": "schema/segments" }, "companyId": { "type": ["string","null"] }, "issueStateCode": { "type": ["string","null"] }, "policyId": { "type": ["string","null"] }, "systemCode": { "type": "string" }, "links": { "type": "array" }, "planId": { "type": ["string","null"] }, "status": { "type": "string" }, "refLink": "schema/dynamicfields" } } /schemas/clients { "type": "object", "id": "urn:jsonschema:com:oracle:service:model:ClientResourceModel", "required": [ "type", "entityTypeCode", "companyId" ], "properties": { "links": { "type": "array" }, "multiFields": { "refLink": "schema/client/multifields" }, "addresses": { "refLink": "schema/addresses" }, "phones": { "refLink": "schema/phones" }, "companyId": { "type": ["string","null"] }, "clientId": { "type": ["string","null"] }, "type": { "type": "string" }, "companyName": { "type": ["string","null"] }, "lastName": { "type": ["string","null"] }, "firstName": { "type": ["string","null"] }, "middleInitial": { "type": ["string","null"] }, "prefix": { "type": ["string","null"] }, "suffix": { "type": ["string","null"] }, "sex": { "type": ["string","null"] }, "clientId": { "type": ["string","null"] }, "dateOfBirth": { "type": "string", "properties": { "Encrypt": "No", "Disabled": "false", "Hidden": "false", "customType": "DateField", "pattern": "^\\d{4}-(?:0[0-9]{1}|1[0-2]{1})-(0?[1-9]|[12][0-9]|3[01])[tT ]\\d{2}:\\d{2}:\\d{2}[zZ ]$" } }, "dateOfDeath": { "type": "string", "properties": { "Encrypt": "No", "Disabled": "false", "Hidden": "false", "customType": "DateField", "pattern": "^\\d{4}-(?:0[0-9]{1}|1[0-2]{1})-(0?[1-9]|[12][0-9]|3[01])[tT ]\\d{2}:\\d{2}:\\d{2}[zZ ]$" } }, "taxId": { "type": ["string","null"] }, "email": { "type": ["string","null"] }, "XMLData": { "type": "CLOB" }, "legalResidenceCountryCode": { "type": ["string","null"] }, "radio1": { "type": ["string","null"] }, "radio2": { "type": ["string","null"] }, "combo1": { "type": ["string","null"] }, "alternateName1": { "type": ["string","null"] }, "alternateName2": { "type": ["string","null"] }, "alternateName3": { "type": ["string","null"] }, "alternateName4": { "type": ["string","null"] }, "alternateName5": { "type": ["string","null"] }, "additionalPrefix": { "type": ["string","null"] }, "additionalSuffix": { "type": ["string","null"] }, "taxIdType": { "type": ["string","null"] }, "title": { "type": ["string","null"] }, "maritalStatus": { "type": ["string","null"] }, "birthCountryCode": { "type": ["string","null"] }, "birthRegionCode": { "type": ["string","null"] }, "primaryPhone": { "type": ["string","null"] }, "textField1": { "type": ["string","null"] }, "textField2": { "type": ["string","null"] }, "checkBox1": { "type": ["string","null"] }, "checkBox2": { "type": ["string","null"] }, "combo2": { "type": ["string","null"] }, "date1": { "type": "string", "properties": { "Encrypt": "No", "Disabled": "false", "Hidden": "false", "customType": "DateField", "pattern": "^\\d{4}-(?:0[0-9]{1}|1[0-2]{1})-(0?[1-9]|[12][0-9]|3[01])[tT ]\\d{2}:\\d{2}:\\d{2}[zZ ]$" } }, "date2": { "type": "string", "properties": { "Encrypt": "No", "Disabled": "false", "Hidden": "false", "customType": "DateField", "pattern": "^\\d{4}-(?:0[0-9]{1}|1[0-2]{1})-(0?[1-9]|[12][0-9]|3[01])[tT ]\\d{2}:\\d{2}:\\d{2}[zZ ]$" } }, "entityTypeCode": { "type": "string" }, "statusCode": { "type": ["string","null"] }, "refLink": "schema/dynamicfields" } } /schemas/cases { "type": "object", "id": "urn:jsonschema:com:oracle:service:model:CaseResourceModel", "required": [ "companyId" "status" ], "properties": { "links": { "type": "array" }, "multiFields": { "refLink": "schema/case/multifields" }, "policies": { "refLink": "schema/policies" [*Note: User will be able to create Case with Policy only, but not Case with Policy and roles/segments/requirements, etc inside policy. This restriction is present only while creating policy inside the case. After successful creation of Cases, we will return the Case GUID and its associated policy GUIDs so that the user can use POST/PUT to create policy roles and segments.] }, "companyId": { "type": "string" }, "caseId": { "type": ["string","null"] }, "status": { "type": "string" }, "caseName": { "type": ["string","null"] }, "caseNumber": { "type": ["string","null"] }, "creationDate": { "type": "string", "properties": { "Encrypt": "No", "Disabled": "false", "Hidden": "false", "customType": "DateField", "pattern": "^\\d{4}-(?:0[0-9]{1}|1[0-2]{1})-(0?[1-9]|[12][0-9]|3[01])[tT ]\\d{2}:\\d{2}:\\d{2}[zZ ]$" } }, "updatedDateTime": { "type": "string", "properties": { "Encrypt": "No", "Disabled": "false", "Hidden": "false", "customType": "DateField", "pattern": "^\\d{4}-(?:0[0-9]{1}|1[0-2]{1})-(0?[1-9]|[12][0-9]|3[01])[tT ]\\d{2}:\\d{2}:\\d{2}[zZ ]$" } }, "refLink": "schema/dynamicfields" } } /schemas/groupCustomers { "type": "object", "id": "urn:jsonschema:com:oracle:service:model:groupCustomerResourceModel", "required": [ "companyId", "type" ], "properties": { "links": { "type": "array" }, "companyId": { "type": ["string"] }, "multiFields": { "refLink": "schema/client/multifields" }, "addresses": { "refLink": "schema/addresses" }, "phones": { "refLink": "schema/phones" }, "customerNumber": { "type": ["string","null"] }, "typeCode": { "type": ["string"] }, "companyName": { "type": ["string","null"] }, "lastName": { "type": ["string","null"] }, "firstName": { "type": ["string","null"] }, "middleInitial": { "type": ["string","null"] }, "prefix": { "type": ["string","null"] }, "suffix": { "type": ["string","null"] }, "sex": { "type": ["string","null"] }, "dateOfBirth": { "type": "string", "properties": { "Encrypt": "No", "Disabled": "false", "Hidden": "false", "customType": "DateField", "pattern": "^\\d{4}-(?:0[0-9]{1}|1[0-2]{1})-(0?[1-9]|[12][0-9]|3[01])[tT ]\\d{2}:\\d{2}:\\d{2}[zZ ]$" }} "dateOfDeath": { "type": "string", "properties": { "Encrypt": "No", "Disabled": "false", "Hidden": "false", "customType": "DateField", "pattern": "^\\d{4}-(?:0[0-9]{1}|1[0-2]{1})-(0?[1-9]|[12][0-9]|3[01])[tT ]\\d{2}:\\d{2}:\\d{2}[zZ ]$" }} "taxId": { "type": ["string","null"] }, "email": { "type": ["string","null"] }, "xmlData": { "type": ["CLOB","null"] }, "legalResidanceCountryCode": { "type": ["string","null"] }, "radio1": { "type": ["string","null"] }, "radio2": { "type": ["string","null"] }, "combo1": { "type": ["string","null"] }, "alternateName1": { "type": ["string","null"] }, "alternateName2": { "type": ["string","null"] }, "alternateName3": { "type": ["string","null"] }, "alternateName4": { "type": ["string","null"] }, "alternateName5": { "type": ["string","null"] }, "additionalPrefix": { "type": ["string","null"] }, "additionalSuffix": { "type": ["string","null"] }, "taxIdType": { "type": ["string","null"] }, "title": { "type": ["string","null"] }, "maritalStatus": { "type": ["string","null"] }, "birthCountryCode": { "type": ["string","null"] }, "citizenshipCountryCode": { "type": ["string","null"] }, "birthRegionCode": { "type": ["string","null"] }, "primaryPhone": { "type": ["string","null"] }, "textfield1": { "type": ["string","null"] }, "textfield2": { "type": ["string","null"] }, "checkbox1": { "type": ["string","null"] }, "checkbox2": { "type": ["string","null"] }, "combo2": { "type": ["string","null"] }, "date1": { "type": "string", "properties": { "Encrypt": "No", "Disabled": "false", "Hidden": "false", "customType": "DateField", "pattern": "^\\d{4}-(?:0[0-9]{1}|1[0-2]{1})-(0?[1-9]|[12][0-9]|3[01])[tT ]\\d{2}:\\d{2}:\\d{2}[zZ ]$" }} "date2": { "type": "string", "properties": { "Encrypt": "No", "Disabled": "false", "Hidden": "false", "customType": "DateField", "pattern": "^\\d{4}-(?:0[0-9]{1}|1[0-2]{1})-(0?[1-9]|[12][0-9]|3[01])[tT ]\\d{2}:\\d{2}:\\d{2}[zZ ]$" }} "entityTypeCode": { "type": ["string","null"] }, "ststusCode": { "type": ["string","null"] }, "primaryEnrollmentRelationship": { "type": ["string","null"] }, "enrollmentClassGroup": { "type": ["string","null"] }, "allowedForCopy": { "type": ["string","null"] }, "hierarchyRelationship": { "type": ["string","null"] }, "refLink": "schema/dynamicfields" } } /schemas/segments { "type": "object", "id": "urn:jsonschema:com:oracle:service:model:segmentResourceModel", "required": [ "policyId", "segmentNameId" ], "properties": { "segments": { "links": { "type": "array" }, "multiFields": { "refLink": "schema/client/multifields" }, "segmentId": { "type": ["string","null"] }, "parentSegmentId": { "type": ["string","null"] }, "policyId": { "type": ["string","null"] }, "segmentNameId": { "type": ["string","null"] }, "status": { "type": ["string","null"] }, "effectiveDate": { "type": ["string","null"] }, "planSegmentId": { "type": ["string","null"] }, "segmentName": { "segmentNameId": { "type": ["string","null"] }, "planId": { "type": ["string","null"] }, "segmentName": { "type": ["string","null"] }, "type": { "type": ["string","null"] }, "activityFromDate": { "type": ["string","null"] }, "activityToDate": { "type": ["string","null"] }, "status": { "type": ["string","null"] }, } "refLink": "schema/dynamicfields" } } } /schemas/roles { "type": "object", "id": "urn:jsonschema:com:oracle:service:model:rolesResourceModel", "required": [ "roleCode", "companyId", "policyId" ], "properties": { "links": { "type": "array" }, "multiFields": { "refLink": "schema/client/multifields" }, "roleId": { "type": ["string","null"] }, "companyId": { "type": ["string","null"] }, "policyId": { "type": ["string","null"] }, "segmentId": { "type": ["string","null"] }, "clientId": { "type": ["string","null"] }, "externalClientId": { "type": ["string","null"] }, "stateCode": { "type": ["string","null"] }, "roleCode": { "type": "string" }, "percentDollarCode": { "type": ["string","null"] }, "rolePercent": { "type": ["string","null"] }, "roleAmount": { "type": ["string","null"] }, "status": { "type": ["string","null"] }, "refLink": "schema/dynamicfields" } } /schemas/requirements { "type": "object", "id": "urn:jsonschema:com:oracle:service:model:requirementsResourceModel", "required": [ "requirementDefinitionId", "statusCode", "openDate", "policyId", "clientId" ], "properties": { "links": { "type": "array" }, "multiFields": { "refLink": "schema/client/multifields" }, "requirementId": { "type": ["string","null"] }, "policyId": { "type": "["string","null"] }, "clientId": { "type": ["string","null"] }, "fullName": { "type": ["string","null"] }, "statusCode": { "type": "string" }, "openDate": { "type": "string" "properties": { "Encrypt": "No", "Disabled": "false", "Hidden": "false", "customType": "DateField", "pattern": "^\\d{4}-(?:0[0-9]{1}|1[0-2]{1})-(0?[1-9]|[12][0-9]|3[01])[tT ]\\d{2}:\\d{2}:\\d{2}[zZ ]$" } }, "lastModifiedDate": { "type": "string" "properties": { "Encrypt": "No", "Disabled": "false", "Hidden": "false", "customType": "DateField", "pattern": "^\\d{4}-(?:0[0-9]{1}|1[0-2]{1})-(0?[1-9]|[12][0-9]|3[01])[tT ]\\d{2}:\\d{2}:\\d{2}[zZ ]$" } }, "createdDate": { "type": "string" "properties": { "Encrypt": "No", "Disabled": "false", "Hidden": "false", "customType": "DateField", "pattern": "^\\d{4}-(?:0[0-9]{1}|1[0-2]{1})-(0?[1-9]|[12][0-9]|3[01])[tT ]\\d{2}:\\d{2}:\\d{2}[zZ ]$" } }, "requirementdefinition": { "requirementDefinitionId": { "type": "string" }, "requirementName": { "type": ["string","null"] }, "companyId": { "type": ["string","null"] }, "description": { "type": ["string","null"] }, "category": { "type": ["string","null"] }, "level": { "type": ["string","null"] }, } "refLink": "schema/dynamicfields" } } /schemas/segmentRoles { "type": "object", "id": "urn:jsonschema:com:oracle:service:model:rolesResourceModel", "required": [ "roleCode" "companyId" "policyId" "segmentId" ], "properties": { "links": { "type": "array" }, "multiFields": { "refLink": "schema/client/multifields" }, "roleId": { "type": ["string","null"] }, "companyId": { "type": ["string","null"] }, "policyId": { "type": ["string","null"] }, "segmentId": { "type": ["string","null"] }, "clientId": { "type": ["string","null"] }, "externalClientId": { "type": ["string","null"] }, "stateCode": { "type": ["string","null"] }, "roleCode": { "type": "string" }, "percentDollar": { "type": ["string","null"] }, "rolePercent": { "type": ["string","null"] }, "roleAmount": { "type": ["string","null"] }, "status": { "type": ["string","null"] }, "refLink": "schema/dynamicfields" } } /schemas/addresses { "type": "object", "id": "urn:jsonschema:com:oracle:service:model:addressesResourceModel", "required": [ "companyId" "addressType" "country" ], "properties": { "links": { "type": "array" }, "multiFields": { "refLink": "schema/addresses/multifields" }, "companyId": { "type": ["string"] }, "addressType": { "type": ["string"] }, "addressId": { "type": ["string","null"] }, "addressLine1": { "type": ["string","null"] }, "addressLine2": { "type": ["string","null"] }, "addressLine3": { "type": ["string","null"] }, "addressLine4": { "type": ["string","null"] }, "city": { "type": ["string","null"] }, "stateCode": { "type": ["string","null"] }, "stateCode": { "type": "string" }, "countryCode": { "type": ["string"] }, "postalId": { "type": ["string","null"] }, "email": { "type": ["string","null"] }, "phoneNumber": { "type": ["string","null"] }, "faxNumber": { "type": ["string","null"] }, "effectiveDate": { "type": "string" "properties": { "Encrypt": "No", "Disabled": "false", "Hidden": "false", "customType": "DateField", "pattern": "^\\d{4}-(?:0[0-9]{1}|1[0-2]{1})-(0?[1-9]|[12][0-9]|3[01])[tT ]\\d{2}:\\d{2}:\\d{2}[zZ ]$" } }, "expirationDate": { "type": "string" "properties": { "Encrypt": "No", "Disabled": "false", "Hidden": "false", "customType": "DateField", "pattern": "^\\d{4}-(?:0[0-9]{1}|1[0-2]{1})-(0?[1-9]|[12][0-9]|3[01])[tT ]\\d{2}:\\d{2}:\\d{2}[zZ ]$" } }, "addressLine5": { "type": ["string","null"] }, "addressLine6": { "type": ["string","null"] }, "regionCode": { "type": ["string","null"] }, "municipalityCode": { "type": ["string","null"] }, "addressRoleCode": { "type": ["string","null"] }, "defaultFlag": { "type": ["string","null"] }, "emailCorrospondanceFlag": { "type": ["string","null"] }, "refLink": "schema/dynamicfields" } } /schemas/phones { "type": "object", "id": "urn:jsonschema:com:oracle:service:model:phonesResourceModel", "required": [ phonenumberId ], "properties": { "links": { "type": "array" }, "multiFields": { "refLink": "schema/addresses/multifields" }, "phonenumberId": { "type": ["string"] }, "countryCode": { "type": ["string"] }, "phoneType": { "type": ["string","null"] }, "status": { "type": ["string","null"] }, "typecode": { "type": ["string","null"] }, "callingCode": { "type": ["string","null"] }, "phonenumber": { "type": ["string","null"] }, "extension": { "type": ["string","null"] }, "preferred": { "type": ["string","null"] }, "refLink": "schema/dynamicfields" } }