Get a specific schema definition by entity

get

/PASService/rest/services/v1/schema/{entity}

Get a specific schema based on the specified entity name. The entity name can be either of the following: policies, clients, cases, group customers, segments, roles, requirements, segment roles, addresses, or phones. For more information refer to Query Schema Parameters.

Request

Path Parameters
  • Entity Id policies, segments, roles, segmentRoles, requirements, cases, groupCustomers, addresses, phones, clients, outboundApplication, and outboundSecurity.
Query Parameters

There's no request body for this operation.

Back to Top

Response

200 Response

This operation fetches a specific schema definition by entity successfully.
Back to Top

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: addressType and country
  • groupCustomers: type
  • segments: planId and segmentName
  • segmentRoles: segmentName and roleCode
  • roles: roleCode
  • requirements: requirementName
  • clients: type
  • policy: planId, issueStateCode, systemCode

Example Generic cURL Command

Use the following generic cURL command to submit a request on the REST resource:

curl \
    -X GET \
    -H "Content-Type: application/json" \  
    -u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
    -L "http://server:port/PASService/rest/services/v1/schema/{entity}"

Note:

The example shown below is a very dynamic response and depends on the screen configuration including the fields, multifield etc. It will differ from case to case based on the configuration.

For example: In case of policies, entity would be replaced by the following text: http://server:port/PASService/rest/services/schema/policies?q=planId eq '01616C8F-4430-4F11-9257-B23626C50E99'

Example Response Body

The following shows an example of the response body in JSON format for Policies:

{
    "type": "object",
    "id": "urn:jsonschema:com:oracle:service:model:PolicyResourceModel",
    "required": [
        "status",
        "systemCode"
    ],
    "properties": {
        "multiFields": {
            "refLink": "schema/policy/multifields"
        },
        "requirements": {
            "refLink": "schema/requirements"
        },
        "policyName": {
            "type": "string"
        },
        "roles": {
            "refLink": "schema/roles"
        },
        "policyNumber": {
            "type": [
                "string",
                "null"
            ]
        },
        "updatedDate": {
            "type": [
                "string",
                "null"
            ],
            "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 ]$",
            "properties": {
                "Encrypt": "No",
                "Disabled": "false",
                "Hidden": "false",
                "customType": "Date"
            }
        },
        "creationDate": {
            "type": [
                "string",
                "null"
            ],
            "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 ]$",
            "properties": {
                "Encrypt": "No",
                "Disabled": "false",
                "Hidden": "false",
                "customType": "Date"
            }
        },
        "planDate": {
            "type": "string",
            "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 ]$",
            "properties": {
                "Encrypt": "No",
                "Disabled": "false",
                "Hidden": "false",
                "customType": "Date"
            }
        },
        "segments": {
            "refLink": "schema/segments"
        },
        "companyId": {
            "type": "string"
        },
        "issueStateCode": {
            "type": "string"
        },
        "policyId": {
            "type": [
                "string",
                "null"
            ]
        },
        "systemCode": {
            "type": "string"
        },
        "planId": {
            "type": "string"
        },
        "status": {
            "type": "string"
        }
    }
}

Example Response Body

The following shows an example of the response body in JSON format for 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"
 
 
  }
 
}

Example Response Body

The following shows an example of the response body in JSON format for Cases:

{
    "type": "object",
    "id": "urn:jsonschema:com:oracle:service:model:CaseResourceModel",
    "required": [
        "companyId",
        "status"
    ],
    "properties": {
        "companyId": {
            "type": [
                "string"
            ]
        },
        "caseNumber": {
            "type": [
                "string",
                "null"
            ]
        },
        "caseId": {
            "type": [
                "string",
                "null"
            ]
        },
        "policies": {
            "refLink": "schema/policies"
        },
        "caseName": {
            "type": [
                "string",
                "null"
            ]
        },
        "creationDate": {
            "type": [
                "string",
                "null"
            ],
            "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 ]$",
            "properties": {
                "Encrypt": "No",
                "Disabled": "false",
                "Hidden": "false",
                "customType": "Date"
            }
        },
        "status": {
            "type": "string"
        },
        "updatedDateTime": {
            "type": [
                "string",
                "null"
            ],
            "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 ]$",
            "properties": {
                "Encrypt": "No",
                "Disabled": "false",
                "Hidden": "false",
                "customType": "Date"
            }
        }
    }
}

Example Response Body

The following shows an example of the response body in JSON format for 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"
 
 
  }
 
}

Example Response Body

The following shows an example of the response body in JSON format in 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"
 
 
  }
 
}
 
}
    

Example Response Body

The following shows an example of the response body in JSON format for 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"
 
 
  }
 
}
    

Example Response Body

The following shows an example of the response body in JSON format for 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"
 
 
  }
 
}
    

Example Response Body

The following shows an example of the response body in JSON format for Segment Roles:

{
  
  "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"
  
  
  }
  
}

Example Response Body

The following shows an example of the response body in JSON format for 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"
   }
  
}

Example Response Body

The following shows an example of the response body in JSON format for Phones:


{
    "type": "object",
    "id": "urn:jsonschema:com:oracle:service:model:PhoneResourceModel",
    "required": [
        "type",
        "countryCode",
        "phoneType",
        "status"
    ],
    "properties": {
        "phoneId": {
            "type": [
                "string",
                "null"
            ]
        },
        "countryCode": {
            "type": "string"
        },
        "callingCode": {
            "type": [
                "string",
                "null"
            ]
        },
        "phoneNumber": {
            "type": [
                "string",
                "null"
            ]
        },
        "extension": {
            "type": [
                "string",
                "null"
            ]
        },
        "preferred": {
            "type": [
                "string",
                "null"
            ]
        },
        "status": {
            "type": "string"
        },
        "type": {
            "type": "string"
        },
        "phoneType": {
            "type": "string"
        }
    }
}
 

Example Response Body

The following shows an example of the response body in JSON format for Outbound Applications:

JMS
{
  "type": "object",
  "id": "urn:jsonschema:com:oracle:service:model:outboundApplicationsResourceModel",
  "required": [
    "eventName",
    "environment",
    "protocolType",
    "outboundConfiguration"
  ],
  "properties": {
    "outboundSecurity": {
      "refLink": "schema/outboundSecurities?q=protocolType eq JMS"
    },
    "outboundApplicationId": {
      "type": [
        "string",
        "null"
      ]
    },
    "eventName": {
      "type": "string"
    },
    "environment": {
      "type": "string"
    },
    "maxTimeOut": {
      "type": [
        "string",
        "null"
      ]
    },
    "protocolType": {
      "type": "string"
    },
    "outboundConfiguration": {
      "type": "object",
      "properties": {
        "providerUrl": {
          "type": "string"
        },
        "connectionFactory": {
          "type": "string"
        },
        "destinationName": {
          "type": "string"
        },
        "deliveryMode": {
          "type": [
            "string",
            "null"
          ]
        },
        "priorityLevel": {
          "type": [
            "integer",
            "null"
          ]
        },
        "timeToLive": {
          "type": [
            "string",
            "null"
          ]
        },
        "acknowledgementMode": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  }
}
SOAP
{
  "type": "object",
  "id": "urn:jsonschema:com:oracle:service:model:outboundApplicationsResourceModel",
  "required": [
    "eventName",
    "environment",
    "protocolType",
    "outboundConfiguration"
  ],
  "properties": {
    "outboundSecurity": {
      "refLink": "schema/outboundSecurities?q=protocolType eq SOAP"
    },
    "outboundApplicationId": {
      "type": [
        "string",
        "null"
      ]
    },
    "eventName": {
      "type": "string"
    },
    "environment": {
      "type": "string"
    },
    "maxTimeOut": {
      "type": [
        "string",
        "null"
      ]
    },
    "protocolType": {
      "type": "string"
    },
    "outboundConfiguration": {
      "type": "object",
      "properties": {
        "wsdlLocation": {
          "type": "string"
        },
        "serviceName": {
          "type": "string"
        },
        "portName": {
          "type": "string"
        },
        "invokeOneWay": {
          "type": [
            "string",
            "null"
          ]
        },
        "securityType": {
          "type": "string"
        },
        "soapAction": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  }
}
REST
{
  "type": "object",
  "id": "urn:jsonschema:com:oracle:service:model:outboundApplicationsResourceModel",
  "required": [
    "eventName",
    "environment",
    "protocolType",
    "outboundConfiguration"
  ],
  "properties": {
    "outboundSecurity": {
      "refLink": "schema/outboundSecurities?q=protocolType eq REST"
    },
    "outboundApplicationId": {
      "type": [
        "string",
        "null"
      ]
    },
    "eventName": {
      "type": "string"
    },
    "environment": {
      "type": "string"
    },
    "maxTimeOut": {
      "type": [
        "string",
        "null"
      ]
    },
    "protocolType": {
      "type": "string"
    },
    "outboundConfiguration": {
      "type": "object",
      "properties": {
        "applicationUri": {
          "type": "string"
        },
        "contentType": {
          "type": "string"
        }
      }
    }
  }
}

Example Response Body

The following shows an example of the response body in JSON format for Outbound Security:

JMS
{
  "type": "object",
  "id": "urn:jsonschema:com:oracle:service:model:outboundSecurityResourceModel",
  "required": [
    "authType",
    "authentication"
  ],
  "properties": {
    "outboundSecurityId": {
      "type": [
        "string",
        "null"
      ]
    },
    "outboundApplicationId": {
      "type": [
        "string",
        "null"
      ]
    },
    "authType": {
      "type": "string"
    },
    "authentication": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string"
        },
        "password": {
          "type": "string"
        }
      }
    }
  }
}
SOAP
{
  "type": "object",
  "id": "urn:jsonschema:com:oracle:service:model:outboundSecurityResourceModel",
  "required": [
    "authType",
    "authentication"
  ],
  "properties": {
    "outboundSecurityId": {
      "type": [
        "string",
        "null"
      ]
    },
    "outboundApplicationId": {
      "type": [
        "string",
        "null"
      ]
    },
    "authType": {
      "type": "string"
    },
    "authentication": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string"
        },
        "password": {
          "type": "string"
        }
      }
    }
  }
}
REST
{
  "type": "object",
  "id": "urn:jsonschema:com:oracle:service:model:outboundSecurityResourceModel",
  "required": [
    "authType",
    "authentication"
  ],
  "properties": {
    "outboundSecurityId": {
      "type": [
        "string",
        "null"
      ]
    },
    "outboundApplicationId": {
      "type": [
        "string",
        "null"
      ]
    },
    "authType": {
      "type": "string"
    },
    "authentication": {
      "type": "object",
      "properties": {
        "token": {
          "type": "string"
        }
      }
    }
  }
}
Back to Top