Retrieve HR Incident

Prev Next
Get
/hcm-rest-api/rest/1/hrincident

Query Standards

Finder

Following row finders are available for data filtering and optimizing request performance.

  • Select By Code
  • By UUID

Select By Code

Recommended finder parameters. Refer to Query Parameters for example.

Parameter Description Sample
EmpNo Employee Number TST1
PlanCode Plan Code DEFAULT
PloCode Plan Option Code CHILD
EffDate Effective Date 2018-12-31
ElectedCode Elected Plan Code AD&D
EndDate End Date 2022-10-06

By UUID

This is an optional finder for querying a specific Employee Elected Plan by row ID.

Parameter Description Sample
/VUUID The VUuid attribute is the Unique row ID /hcm-rest-api/rest/1/hrelectedplans/F05ACE4E269C2547E05316821FAC3C18
Security
HTTP
Type basic

Basic authentication

Query parameters
finder
string
ExamplefindByCode;empOrNon=E,empNo=LG1-BW-HR10,claimType=L,incidentType=BURN,contribType=INEXPER, auditDate=2022-10-06
limit
integer
Example500
offset
integer
Example0
totalResults
boolean
Exampletrue
orderBy
string
ExampleIncVUuid
Responses
200

OK

Headers
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourcecollection+json
{
  "items": [
    {
      "IncActivityEngaged": null,
      "IncAddrCode": null,
      "IncAddrCompCode": "LG1",
      "IncAddrName": null,
      "IncAdjustersPhone": null,
      "IncAsOfDate": null,
      "IncAuthoritiesContacted": null,
      "IncAuthoritiesPhone": null,
      "IncAuthoritiesReport": null,
      "IncAutoClaimDesc": null,
      "IncBodyPartCode": null,
      "IncBodyPartName": null,
      "IncCaseNotes": null,
      "IncClaimContactEmpNo": null,
      "IncClaimContactPhone": null,
      "IncClaimNum": "22",
      "IncClaimType": "L",
      "IncClaimantContact": null,
      "IncClaimantInjuryType": null,
      "IncClaimantInsInfo": null,
      "IncClaimantName": null,
      "IncCloseBchNum": null,
      "IncClosePostDate": null,
      "IncClosedFlag": "N",
      "IncClvNameCode1": null,
      "IncClvNameCode2": null,
      "IncClvNameCode3": null,
      "IncClvNameCode4": null,
      "IncClvNameCode5": null,
      "IncClvNameCode6": null,
      "IncClvTitleCode1": null,
      "IncClvTitleCode2": null,
      "IncClvTitleCode3": null,
      "IncClvTitleCode4": null,
      "IncClvTitleCode5": null,
      "IncClvTitleCode6": null,
      "IncClvValueCode1": "GL",
      "IncClvValueCode2": "2014-10-15T00:00:00Z",
      "IncClvValueCode3": "BOA",
      "IncClvValueCode4": null,
      "IncClvValueCode5": null,
      "IncClvValueCode6": null,
      "IncCode": "61",
      "IncCompCode": "LG1",
      "IncCompensCountryCode": null,
      "IncCompensCountryName": null,
      "IncCompensLostTimeFlag": "N",
      "IncCompensStateCode": null,
      "IncCompensStateName": null,
      "IncContribFactorCode": "INEXPER",
      "IncContribFactorName": null,
      "IncCoverageTypeDesc": null,
      "IncCreatedDate": "2013-09-05T14:43:30Z",
      "IncCrewCode": null,
      "IncCrewType": null,
      "IncDateToDoctor": null,
      "IncDaysLost": 0,
      "IncDaysRestricted": 0,
      "IncDeathDate": null,
      "IncDescription": null,
      "IncEffectSafetyFlag": "N",
      "IncEmpBeganWork": null,
      "IncEmpBeganWorkTime": null,
      "IncEmpDateOfBirth": "1980-01-01",
      "IncEmpHospOvernight": "N",
      "IncEmpName": "Kim Preston",
      "IncEmpSex": "F",
      "IncEmpSsnNo": "*********",
      "IncEmpType": "H",
      "IncEqpCode": null,
      "IncEventOccurred": null,
      "IncExtentOfDamaged": null,
      "IncFatalityFlag": "M",
      "IncFirstDisabilityDate": null,
      "IncIcode": "LG1-BW-HR10",
      "IncIllnessTypeCode": null,
      "IncIllnessTypeName": null,
      "IncIncidentDate": "2013-09-04",
      "IncIncidentDay": 4,
      "IncIncidentTime": null,
      "IncIncidentTimeDate": null,
      "IncIncidentTypeCode": "BURN",
      "IncIncidentTypeName": "Burn",
      "IncInjuryTypeCode": null,
      "IncInjuryTypeName": null,
      "IncInsAdjustersName": null,
      "IncItype": "E",
      "IncIuCreateDate": "2013-09-05T14:43:30Z",
      "IncIuUpdateDate": "2024-08-23T20:25:41Z",
      "IncJobCode": null,
      "IncJobCompCode": "LG1",
      "IncJobName": null,
      "IncLastDateWorked": null,
      "IncLastDisabilityDate": null,
      "IncLastUpdDate": "2024-08-23T20:25:41Z",
      "IncLiabClaimDesc": null,
      "IncLiabRecordableFlag": "N",
      "IncLitigationFlag": "N",
      "IncLongDesc": null,
      "IncNo": 61,
      "IncNonprescMedNames": null,
      "IncOcipCcipFlag": "N",
      "IncOnSiteFlag": "N",
      "IncOperatorCode": null,
      "IncOperatorName": null,
      "IncOshaLostTimeFlag": "N",
      "IncOshaReportableFlag": "N",
      "IncPartnTextCode": null,
      "IncPartnTextName": null,
      "IncPartnTextType": null,
      "IncPhysicianName": null,
      "IncPolicyDesc": "101-EQUIP",
      "IncPrescMedNames": null,
      "IncProMgrEmpNo": null,
      "IncProMgrPhone": null,
      "IncPropertyDamaged": null,
      "IncRegCode": null,
      "IncRegCompCode": null,
      "IncRegMgrEmpNo": null,
      "IncRegMgrPhone": null,
      "IncRegularWorkFlag": "N",
      "IncReportDate": "2024-07-25",
      "IncRestrictedDutyFlag": "N",
      "IncSafetyApplianceCode": "N",
      "IncSafetyEmpName": null,
      "IncSafetyEmpNo": null,
      "IncSafetyMgrPhone": null,
      "IncSituatedCountryCode": "US",
      "IncSituatedCountryName": "United States of America",
      "IncSituatedStateCode": "FL",
      "IncSituatedStateName": "Florida",
      "IncSponsoringOrgCode": null,
      "IncStatusCode": null,
      "IncSubjectEmpNo": "LG1-BW-HR10",
      "IncSubjectPartnCode": null,
      "IncSubjectPartnName": "Kim Preston",
      "IncSubrogationFlag": "N",
      "IncSupervisorEmpNo": null,
      "IncSupervisorPhone": null,
      "IncSuptEmpNo": null,
      "IncSuptPhone": null,
      "IncTextCode": null,
      "IncTextType": null,
      "IncTreatEmergency": "N",
      "IncTreatOrgCity": null,
      "IncTreatOrgState": null,
      "IncTreatOrgStreet": null,
      "IncTreatOrgZip": null,
      "IncTreatingOrgCode": null,
      "IncTreatmentTypeCode": null,
      "IncTreatmentTypeName": null,
      "IncUser": "DA",
      "IncUtilityMarking": null,
      "IncUtilityOneCallDate": null,
      "IncUtilityOneCallFlag": "N",
      "IncUtilityOneTicket": null,
      "IncUtilityTypeDesc": null,
      "IncVUuid": "1F965ED13B151EDEE0630B811DAC12B1",
      "IncWitnessContact": null,
      "IncWitnessDesc": null,
      "IncWitnessName": null,
      "IncWorkRelatedFlag": "N",
      "links": [
        {
          "rel": "self",
          "href": "http://127.0.0.1:7101/hcm-rest-api/rest/1/hrincident/1F965ED13B151EDEE0630B811DAC12B1",
          "name": "hrincident",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://127.0.0.1:7101/hcm-rest-api/rest/1/hrincident/1F965ED13B151EDEE0630B811DAC12B1",
          "name": "hrincident",
          "kind": "item"
        }
      ]
    }
  ],
  "totalResults": 1,
  "count": 1,
  "hasMore": false,
  "limit": 500,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://127.0.0.1:7101/hcm-rest-api/rest/1/hrincident",
      "name": "hrincident",
      "kind": "collection"
    }
  ]
}
object
Copyright © 2024 CMiC All Rights Reserved