Jump to

• Request
• Response
• Examples

Get an incident

get

/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}

Request

Path Parameters

• IncidentId(required): integer(int64)
  Unique identifier of the incident. System-generated primary key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  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".
• REST-Framework-Version:
  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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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".
• REST-Framework-Version(required):
  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

• EmployeeId: integer (int64)
  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: array HnsIncidentsDFF
• IncidentDate: string (date-time)
  Title: Date and Time

  Date the incident occurred captured by the incident reporter. This attribute is required.
• IncidentDescription: string (byte)
  Title: Description

  Complete description of the incident captured by the incident reporter.
• IncidentDetailKiosk: array 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.
• IncidentId: integer (int64)
  Title: Incident ID

  Unique identifier of the incident. System-generated primary key.
• IncidentImmeActDescr: string (byte)
  Title: Immediate Actions

  Description of any immediate actions undertaken after the incident was captured by the incident reporter.
• IncidentReportedDate: string (date-time)
  Date and time when the notified person was informed about the incident.
• IncidentSourceCode: string
  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.
• IncidentSummary: string
  Title: Summary

  Maximum Length: 1000

  Summary information of the incident captured by the reporter. This attribute is required.
• IncidentTypeCode: string
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationId: integer (int64)
  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.
• LocationTypeCode: string
  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.
• NotifiedPersonId: integer (int64)
  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.
• ReporterTypeCode: string
  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.
• ReptrAddrLine1: string
  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.
• ReptrAddrLine2: string
  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.
• ReptrAreaCode: string
  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.
• ReptrCity: string
  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.
• ReptrCountry: string
  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.
• ReptrCountryCodeNum: string
  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.
• ReptrEmail: string
  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.
• ReptrName: string
  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.
• ReptrPhoneNo: string
  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.
• ReptrSpecificLocation: string
  Title: Specific Location

  Maximum Length: 255

  Detailed information on the location of the incident captured by the reporter. This attribute is required.
• ReptrState: string
  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.
• ReptrZipCode: string
  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.
• SeverityLevelCode: string
  Maximum Length: 30

  Default Value: ORA_NO_EFFECT

  Severity level of the incident.
• TargetCompletionDate: string (date-time)
  Title: Target Completion Date

  Date and time by when the incident needs to be completed. Prepopulated using the Target Date setup value.

{
    "type":"object",
    "properties":{
        "IncidentDescription":{
            "title":"Description",
            "type":"string",
            "description":"Complete description of the incident captured by the incident reporter.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ReptrCountry":{
            "title":"Country",
            "maxLength":100,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ReptrZipCode":{
            "title":"Postal Code",
            "maxLength":100,
            "type":"string",
            "description":"Postal code of the incident captured by the reporter. If the incident happened onsite, then the value should be null.",
            "nullable":true,
            "x-queryable":true
        },
        "ReptrEmail":{
            "title":"Email",
            "maxLength":250,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "NotifiedPersonId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IncidentTypeCode":{
            "title":"Incident Type",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the incident type. Valid values are defined in the list HcmCommonSharedAM_HnsIncidentType. The default value is Health and Safety Incident.",
            "nullable":true,
            "x-queryable":true
        },
        "ReptrPhoneNo":{
            "title":"Phone",
            "maxLength":18,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ReptrCity":{
            "title":"City",
            "maxLength":100,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ReptrAreaCode":{
            "title":"Area Code",
            "maxLength":30,
            "type":"string",
            "description":"Area code for the reporter's phone. If the reporter is an employee, then the value should be null.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationTypeCode":{
            "title":"Location Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"ORA_ON_SITE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EmployeeId":{
            "title":"Employee",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IncidentReportedDate":{
            "type":"string",
            "description":"Date and time when the notified person was informed about the incident.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ReptrCountryCodeNum":{
            "title":"Country Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "IncidentDetailKiosk":{
            "title":"Incident Detail Kiosks",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/incidentKiosks-IncidentDetailKiosk-item-response"
            }
        },
        "ReptrAddrLine2":{
            "title":"Address Line 2",
            "maxLength":255,
            "type":"string",
            "description":"Address line 2 of the incident captured by the reporter. If the incident happened onsite, then the value should be null.",
            "nullable":true,
            "x-queryable":true
        },
        "ReptrAddrLine1":{
            "title":"Address Line 1",
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "IncidentDate":{
            "title":"Date and Time",
            "type":"string",
            "description":"Date the incident occurred captured by the incident reporter. This attribute is required.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IncidentSourceCode":{
            "title":"Incident Source",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the incident source. Valid values are defined in the list HcmCommonSharedAM_HnsIncidentSource. This attribute is required.",
            "nullable":true,
            "x-queryable":true
        },
        "HnsIncidentsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/incidentKiosks-HnsIncidentsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "IncidentId":{
            "title":"Incident ID",
            "type":"integer",
            "description":"Unique identifier of the incident. System-generated primary key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IncidentImmeActDescr":{
            "title":"Immediate Actions",
            "type":"string",
            "description":"Description of any immediate actions undertaken after the incident was captured by the incident reporter.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "IncidentSummary":{
            "title":"Summary",
            "maxLength":1000,
            "type":"string",
            "description":"Summary information of the incident captured by the reporter. This attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetCompletionDate":{
            "title":"Target Completion Date",
            "type":"string",
            "description":"Date and time by when the incident needs to be completed. Prepopulated using the Target Date setup value.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ReptrSpecificLocation":{
            "title":"Specific Location",
            "maxLength":255,
            "type":"string",
            "description":"Detailed information on the location of the incident captured by the reporter. This attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "SeverityLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Severity level of the incident.",
            "nullable":true,
            "default":"ORA_NO_EFFECT",
            "x-queryable":true
        },
        "ReptrState":{
            "title":"State",
            "maxLength":100,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ReporterTypeCode":{
            "title":"Incident Reporter",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"ORA_EMPLOYEE",
            "x-queryable":true
        },
        "ReptrName":{
            "title":"Name",
            "maxLength":200,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : HnsIncidentsDFF

Type: array

Show Source

• Array of: object incidentKiosks-HnsIncidentsDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/incidentKiosks-HnsIncidentsDFF-item-response"
    },
    "x-cardinality":"1"
}

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

• Array of: object incidentKiosks-IncidentDetailKiosk-item-response

{
    "title":"Incident Detail Kiosks",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/incidentKiosks-IncidentDetailKiosk-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : incidentKiosks-HnsIncidentsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• IncidentId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "IncidentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : incidentKiosks-IncidentDetailKiosk-item-response

Type: object

Show Source

• ActualCompletionDate: string (date-time)
  The date that the incident is targeted for actual completion.
• IncidentDetailId: integer (int64)
  Unique identifier of the incident event. System-generated primary key.
• IncidentEventCode: string
  Title: Incident Event

  Maximum Length: 30

  Unique identifier for the incident event. Valid values are defined in the list HcmCommonSharedAM_HnsIncidentEvent. Multiselect.
• IncidentEventDate: string (date-time)
  Title: Date and Time

  Date and time when the incident was captured by the incident reporter. Copied from the parent incident.
• IncidentEventSummary: string
  Maximum Length: 1000

  Summary information of the incident captured by the reporter. Copied from the parent incident.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "IncidentEventSummary":{
            "maxLength":1000,
            "type":"string",
            "description":"Summary information of the incident captured by the reporter. Copied from the parent incident.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IncidentDetailId":{
            "type":"integer",
            "description":"Unique identifier of the incident event. System-generated primary key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IncidentEventDate":{
            "title":"Date and Time",
            "type":"string",
            "description":"Date and time when the incident was captured by the incident reporter. Copied from the parent incident.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ActualCompletionDate":{
            "type":"string",
            "description":"The date that the incident is targeted for actual completion.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "IncidentEventCode":{
            "title":"Incident Event",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the incident event. Valid values are defined in the list HcmCommonSharedAM_HnsIncidentEvent. Multiselect.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

HnsIncidentsDFF

Operation: /hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/child/HnsIncidentsDFF

Parameters:

• IncidentId: $request.path.IncidentId

IncidentDetailKiosk

Operation: /hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/child/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 retrieve a health and safety incident by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET  https://<host>:<port>/hcmCoreApi/resources/11.13.18.05/incidentKiosks/{incidentID}

Example of Response Header

The following is an example of the response header.

HTTP/1.1 200 OK
Content-Type : application/vnd.oracle.adf.resourceitem+json

Example of Response Body

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

{
    "EmployeeId": 300100172372584,
    "IncidentDate": "2018-11-01T11:06:06.352+00:00",
    "IncidentId": 300100172522925,
    "IncidentSummary": "UPG EADI 1901 Adding Results",
    "LocationTypeCode": "ORA_ON_SITE",
    "ReporterTypeCode": "ORA_EMPLOYEE",
    "ReptrCity": null,
    "ReptrCountry": null,
    "ReptrEmail": null,
    "ReptrAddrLine1": null,
    "ReptrName": null,
    "ReptrPhoneNo": null,
    "ReptrSpecificLocation": "UPG EADI 1901 Adding Results",
    "TargetCompletionDate": "2018-12-31T11:06:06.346+00:00",
    "ReptrAddrLine2": null,
    "ReptrZipCode": null,
    "ReptrState": null,
    "LocationId": 3030,
    "ReptrCountryCodeNum": null,
    "ReptrAreaCode": null,
    "IncidentSourceCode": "ORA_INTERNAL",
    "links": [
        {
          ...}
   ]
}

Back to Top