1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Incident Kiosks

Create an incident

post

/hcmRestApi/resources/11.13.18.05/incidentKiosks

Request

Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Employee
    Employee ID of the person who reported the incident. If the reporter is Non Employee, Employee ID should be null. This attribute is required if the reporter is an employee. Valid values are defined in the list PersonLovPVO.
  • HnsIncidentsDFF
  • Title: Date and Time
    Date the incident occurred captured by the incident reporter. This attribute is required.
  • Title: Description
    Complete description of the incident captured by the incident reporter.
  • Incident Detail Kiosks
    Title: Incident Detail Kiosks
    The incidentDetailKiosk is a child resource of incidentKiosks. It provides information about incident events. This resource allows a simple GET and POST operation on incidents events.
  • Title: Incident ID
    Unique identifier of the incident. System-generated primary key.
  • Title: Immediate Actions
    Description of any immediate actions undertaken after the incident was captured by the incident reporter.
  • Date and time when the notified person was informed about the incident.
  • Title: Incident Source
    Maximum Length: 30
    Unique identifier for the incident source. Valid values are defined in the list HcmCommonSharedAM_HnsIncidentSource. This attribute is required.
  • Title: Summary
    Maximum Length: 1000
    Summary information of the incident captured by the reporter. This attribute is required.
  • Title: Incident Type
    Maximum Length: 30
    Unique identifier for the incident type. Valid values are defined in the list HcmCommonSharedAM_HnsIncidentType. The default value is Health and Safety Incident.
  • Title: Location ID
    Onsite location where the incident happened. If the incident happened offsite, the Location ID should be null. This attribute is required if the location is ORA_ONSITE. Valid values are defined in the list LocationLovPVO.
  • Title: Location Type
    Maximum Length: 30
    Default Value: ORA_ON_SITE
    Type of location where the incident occurred, captured by the reporter such as ORA_ONSITE or ORA_OFFSITE. Valid values are defined in the list HcmCommonSharedAM_HnsLocation. This attribute is required.
  • Employee ID of the person who is notified about the incident. This attribute is required if the notified person is an employee. Valid values are defined in the list PersonLovPVO.
  • Title: Incident Reporter
    Maximum Length: 30
    Default Value: ORA_EMPLOYEE
    Selection made by the incident reporter to categorize the incident reporter as either an employee or a non-employee. Valid values are defined in the list HcmCommonSharedAM_HnsPerson. This attribute is required.
  • Title: Address Line 1
    Maximum Length: 255
    Address line 1 of the incident captured by the reporter. If the incident happened onsite, then the value should be null. This attribute is required if the location is ORA_OFFSITE.
  • Title: Address Line 2
    Maximum Length: 255
    Address line 2 of the incident captured by the reporter. If the incident happened onsite, then the value should be null.
  • Title: Area Code
    Maximum Length: 30
    Area code for the reporter's phone. If the reporter is an employee, then the value should be null.
  • Title: City
    Maximum Length: 100
    City where the incident was captured by the reporter. If the incident happened onsite, then the value should be null. This attribute is required if the location is ORA_OFFSITE.
  • Title: Country
    Maximum Length: 100
    Country where the incident occurred, captured by the incident reporter. If the incident happened onsite, then the value should be null. This attribute is required if the Location is ORA_OFFSITE.
  • Title: Country Code
    Maximum Length: 30
    Country code for the reporter's phone. Valid values are defined in the list PhoneCountryCodePVO. If the reporter is an employee, then the value should be null. PhoneCountryCodePVO.
  • Title: Email
    Maximum Length: 250
    Email ID of the person who reported the incident. If the reporter is an employee, then the value should be null. Either ReptrPhoneNo or ReptrEmail is required if the reporter is a non employee.
  • Title: Name
    Maximum Length: 200
    Full name of the person who reported the incident. If the reporter is an employee, then the value should be null. This attribute is required if the reporter is a non employee.
  • Title: Phone
    Maximum Length: 18
    Phone number of the person who reported the incident. If the reporter is an employee, then the value should be null. Either ReptrPhoneNo or ReptrEmail is required if the reporter is a non employee.
  • Title: Specific Location
    Maximum Length: 255
    Detailed information on the location of the incident captured by the reporter. This attribute is required.
  • Title: State
    Maximum Length: 100
    State where the incident was captured by the reporter. If the incident happened onsite, then the value should be null. This attribute is required if the location is ORA_OFFSITE.
  • Title: Postal Code
    Maximum Length: 100
    Postal code of the incident captured by the reporter. If the incident happened onsite, then the value should be null.
  • Maximum Length: 30
    Default Value: ORA_NO_EFFECT
    Severity level of the incident.
  • Title: Target Completion Date
    Date and time by when the incident needs to be completed. Prepopulated using the Target Date setup value.
Nested Schema : HnsIncidentsDFF
Type: array
Show Source
Nested Schema : Incident Detail Kiosks
Type: array
Title: Incident Detail Kiosks
The incidentDetailKiosk is a child resource of incidentKiosks. It provides information about incident events. This resource allows a simple GET and POST operation on incidents events.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : incidentKiosks-IncidentDetailKiosk-item-post-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : incidentKiosks-item-response
Type: object
Show Source
  • Title: Employee
    Employee ID of the person who reported the incident. If the reporter is Non Employee, Employee ID should be null. This attribute is required if the reporter is an employee. Valid values are defined in the list PersonLovPVO.
  • HnsIncidentsDFF
  • Title: Date and Time
    Date the incident occurred captured by the incident reporter. This attribute is required.
  • Title: Description
    Complete description of the incident captured by the incident reporter.
  • Incident Detail Kiosks
    Title: Incident Detail Kiosks
    The incidentDetailKiosk is a child resource of incidentKiosks. It provides information about incident events. This resource allows a simple GET and POST operation on incidents events.
  • Title: Incident ID
    Unique identifier of the incident. System-generated primary key.
  • Title: Immediate Actions
    Description of any immediate actions undertaken after the incident was captured by the incident reporter.
  • Date and time when the notified person was informed about the incident.
  • Title: Incident Source
    Maximum Length: 30
    Unique identifier for the incident source. Valid values are defined in the list HcmCommonSharedAM_HnsIncidentSource. This attribute is required.
  • Title: Summary
    Maximum Length: 1000
    Summary information of the incident captured by the reporter. This attribute is required.
  • Title: Incident Type
    Maximum Length: 30
    Unique identifier for the incident type. Valid values are defined in the list HcmCommonSharedAM_HnsIncidentType. The default value is Health and Safety Incident.
  • Links
  • Title: Location ID
    Onsite location where the incident happened. If the incident happened offsite, the Location ID should be null. This attribute is required if the location is ORA_ONSITE. Valid values are defined in the list LocationLovPVO.
  • Title: Location Type
    Maximum Length: 30
    Default Value: ORA_ON_SITE
    Type of location where the incident occurred, captured by the reporter such as ORA_ONSITE or ORA_OFFSITE. Valid values are defined in the list HcmCommonSharedAM_HnsLocation. This attribute is required.
  • Employee ID of the person who is notified about the incident. This attribute is required if the notified person is an employee. Valid values are defined in the list PersonLovPVO.
  • Title: Incident Reporter
    Maximum Length: 30
    Default Value: ORA_EMPLOYEE
    Selection made by the incident reporter to categorize the incident reporter as either an employee or a non-employee. Valid values are defined in the list HcmCommonSharedAM_HnsPerson. This attribute is required.
  • Title: Address Line 1
    Maximum Length: 255
    Address line 1 of the incident captured by the reporter. If the incident happened onsite, then the value should be null. This attribute is required if the location is ORA_OFFSITE.
  • Title: Address Line 2
    Maximum Length: 255
    Address line 2 of the incident captured by the reporter. If the incident happened onsite, then the value should be null.
  • Title: Area Code
    Maximum Length: 30
    Area code for the reporter's phone. If the reporter is an employee, then the value should be null.
  • Title: City
    Maximum Length: 100
    City where the incident was captured by the reporter. If the incident happened onsite, then the value should be null. This attribute is required if the location is ORA_OFFSITE.
  • Title: Country
    Maximum Length: 100
    Country where the incident occurred, captured by the incident reporter. If the incident happened onsite, then the value should be null. This attribute is required if the Location is ORA_OFFSITE.
  • Title: Country Code
    Maximum Length: 30
    Country code for the reporter's phone. Valid values are defined in the list PhoneCountryCodePVO. If the reporter is an employee, then the value should be null. PhoneCountryCodePVO.
  • Title: Email
    Maximum Length: 250
    Email ID of the person who reported the incident. If the reporter is an employee, then the value should be null. Either ReptrPhoneNo or ReptrEmail is required if the reporter is a non employee.
  • Title: Name
    Maximum Length: 200
    Full name of the person who reported the incident. If the reporter is an employee, then the value should be null. This attribute is required if the reporter is a non employee.
  • Title: Phone
    Maximum Length: 18
    Phone number of the person who reported the incident. If the reporter is an employee, then the value should be null. Either ReptrPhoneNo or ReptrEmail is required if the reporter is a non employee.
  • Title: Specific Location
    Maximum Length: 255
    Detailed information on the location of the incident captured by the reporter. This attribute is required.
  • Title: State
    Maximum Length: 100
    State where the incident was captured by the reporter. If the incident happened onsite, then the value should be null. This attribute is required if the location is ORA_OFFSITE.
  • Title: Postal Code
    Maximum Length: 100
    Postal code of the incident captured by the reporter. If the incident happened onsite, then the value should be null.
  • Maximum Length: 30
    Default Value: ORA_NO_EFFECT
    Severity level of the incident.
  • Title: Target Completion Date
    Date and time by when the incident needs to be completed. Prepopulated using the Target Date setup value.
Nested Schema : HnsIncidentsDFF
Type: array
Show Source
Nested Schema : Incident Detail Kiosks
Type: array
Title: Incident Detail Kiosks
The incidentDetailKiosk is a child resource of incidentKiosks. It provides information about incident events. This resource allows a simple GET and POST operation on incidents events.
Show Source
Nested Schema : incidentKiosks-HnsIncidentsDFF-item-response
Type: object
Show Source
Nested Schema : incidentKiosks-IncidentDetailKiosk-item-response
Type: object
Show Source
Links
HnsIncidentsDFF
Parameters:
  • IncidentId: $request.path.IncidentId
IncidentDetailKiosk
Parameters:
  • IncidentId: $request.path.IncidentId
The incidentDetailKiosk is a child resource of incidentKiosks. It provides information about incident events. This resource allows a simple GET and POST operation on incidents events.
Back to Top

Examples

The following example shows how to create a health and safety incident by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> http://host:port/hcmRestApi/resources/11.13.18.05/incidentKiosk

Example of Payload

The following is an example of the payload.

{
  "IncidentDate": "2018-06-26 13:49:55.482",
  "IncidentSummary": "TEST Rest API 3",
  "LocationTypeCode": "ORA_ON_SITE",
  "ReptrSpecificLocation": "Specific Location",
  "ReporterTypeCode": "ORA_EMPLOYEE",
  "EmployeeId" : "100000008153756",
  "LocationId": "2510",
  "IncidentTypeCode": "ORA_HEALTH_AND_SAFETY_INC",
  "SeverityLevelCode": "ORA_NO_EFFECT",
  "NotifiedPersonId": null,
  "IncidentReportedDate": "2020-01-15T11:07:07.248+00:00",
  "IncidentSourceCode" : "ORA_INTERNAL",
  "IncidentDetailKiosk" : [
      {
        "IncidentEventCode" : "ORA_VEHICLE_INCIDENT"
      },
      {
        "IncidentEventCode" : "ORA_NEAR_MISS"
      }
   ]
}

Example of Response Header

The following is an example of the response header.

HTTP/1.1 201  Created
Content-Type : application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "EmployeeId": 100000008153756,
    "IncidentDate": "2018-06-26T13:49:55.482+00:00",
    "IncidentId": 300100191425589,
    "IncidentSummary": "TEST Rest API 3",
    "LocationTypeCode": "ORA_ON_SITE",
    "ReporterTypeCode": "ORA_EMPLOYEE",
    "ReptrCity": null,
    "ReptrCountry": null,
    "ReptrEmail": null,
    "ReptrAddrLine1": null,
    "ReptrName": null,
    "ReptrPhoneNo": null,
    "ReptrSpecificLocation": "Specific Location",
    "TargetCompletionDate": "2020-07-21T18:11:08.478+00:00",
    "ReptrAddrLine2": null,
    "ReptrZipCode": null,
    "ReptrState": null,
    "LocationId": 2510,
    "ReptrCountryCodeNum": null,
    "ReptrAreaCode": null,
    "IncidentSourceCode": "ORA_INTERNAL",
    "IncidentTypeCode": "ORA_HEALTH_AND_SAFETY_INC",
    "SeverityLevelCode": "ORA_NO_EFFECT",
    "NotifiedPersonId": null,
    "IncidentReportedDate": "2020-01-15T11:07:07.248+00:00",
    "IncidentDetailKiosk": [
        {
            "IncidentEventCode": "ORA_VEHICLE_INCIDENT",
            "IncidentDetailId": 300100191425590,
            "IncidentEventDate": "2018-06-26T13:49:55.482+00:00",
            "IncidentEventSummary": "TEST Rest API 3",
            "links": [
                {...
                    }
             ]
        },
        {
            "IncidentEventCode": "ORA_NEAR_MISS",
            "IncidentDetailId": 300100191425591,
            "IncidentEventDate": "2018-06-26T13:49:55.482+00:00",
            "IncidentEventSummary": "TEST Rest API 3",
            "links": [
                {
                  ...}
             ]
}
Back to Top