Update an incident
patch
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}
Request
Path Parameters
-
IncidentId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
EmployeeId: integer
(int64)
Title:
Employee
Identification value of the employee. -
HnsIncidentsDFF: array
HnsIncidentsDFF
-
IncidentDate: string
(date-time)
Title:
Date and Time
Incident date and time. -
IncidentDescription: string
(byte)
Title:
Description
Description of the incident. -
IncidentDetailKiosk: array
Incident Detail Kiosks
Title:
Incident Detail Kiosks
A kiosk version of incident events. -
IncidentId: integer
(int64)
Title:
Incident ID
The unique identifier of the incident. -
IncidentImmeActDescr: string
(byte)
Title:
Immediate Actions
Immediate actions to take. -
IncidentOwnerId: integer
(int64)
Title:
IncidentOwnerId
Value that uniquely identifies the incident owner. -
IncidentReportedDate: string
(date-time)
Date of notification of the incident.
-
IncidentSourceCode: string
Title:
Incident Source
Maximum Length:30
The source of the incident. -
IncidentSummary(required): string
Title:
Summary
Maximum Length:1000
Summary of the incident. -
IncidentTypeCode: string
Title:
Incident Type
Maximum Length:30
Type of the incident. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier of the location. -
LocationTypeCode: string
Title:
Location Type
Maximum Length:30
Default Value:ORA_ON_SITE
Type of location. -
NotifiedPersonId: integer
(int64)
Person notified of the incident.
-
ReporterTypeCode: string
Title:
Incident Reporter
Maximum Length:30
Default Value:ORA_EMPLOYEE
The reporter of the incident. -
ReptrAddrLine1: string
Title:
Address Line 1
Maximum Length:255
First line of address. -
ReptrAddrLine2: string
Title:
Address Line 2
Maximum Length:255
Second line of address. -
ReptrAreaCode: string
Title:
Area Code
Maximum Length:30
The area code of the incident reporter. -
ReptrCity: string
Title:
City
Maximum Length:100
City of the incident reporter. -
ReptrCountry: string
Title:
Country
Maximum Length:100
Country of the incident reporter. -
ReptrCountryCodeNum: string
Title:
Country Code
Maximum Length:30
Country code for the incident reporter. -
ReptrEmail: string
Title:
Email
Maximum Length:250
Email address of incident reporter. -
ReptrName: string
Title:
Name
Maximum Length:200
Name of incident reporter. -
ReptrPhoneNo: string
Title:
Phone
Maximum Length:18
Phone number of incident reporter. -
ReptrSpecificLocation(required): string
Title:
Specific Location
Maximum Length:255
The incident reporter specific location. -
ReptrState: string
Title:
State
Maximum Length:100
The state of the incident reporter. -
ReptrZipCode: string
Title:
Postal Code
Maximum Length:100
Postal code of incident reporter. -
SeverityLevelCode: string
Maximum Length:
30
Default Value:ORA_NO_EFFECT
Level of severity of incident. -
TargetCompletionDate(required): string
(date-time)
Title:
Target Completion Date
The date that the incident is targeted for completion.
Nested Schema : Incident Detail Kiosks
Type:
array
Title:
Incident Detail Kiosks
A kiosk version of incident events.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
IncidentId: integer
(int64)
Nested Schema : incidentKiosks-IncidentDetailKiosk-item-patch-request
Type:
Show Source
object
-
ActualCompletionDate: string
(date-time)
The date that the incident is targeted for actual completion.
-
IncidentDetailId: integer
(int64)
An identification value used for the incident event.
-
IncidentEventCode: string
Title:
Incident Event
Maximum Length:30
Description of the incident event. -
IncidentEventDate: string
(date-time)
Title:
Date and Time
The date when the incident event happened. -
IncidentEventSummary: string
Maximum Length:
1000
Audit detail for incident event summary.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : incidentKiosks-item-response
Type:
Show Source
object
-
EmployeeId: integer
(int64)
Title:
Employee
Identification value of the employee. -
HnsIncidentsDFF: array
HnsIncidentsDFF
-
IncidentDate: string
(date-time)
Title:
Date and Time
Incident date and time. -
IncidentDescription: string
(byte)
Title:
Description
Description of the incident. -
IncidentDetailKiosk: array
Incident Detail Kiosks
Title:
Incident Detail Kiosks
A kiosk version of incident events. -
IncidentId: integer
(int64)
Title:
Incident ID
The unique identifier of the incident. -
IncidentImmeActDescr: string
(byte)
Title:
Immediate Actions
Immediate actions to take. -
IncidentNo: string
Title:
Incident Number
Read Only:true
Maximum Length:32
Value that uniquely identifies the incident. -
IncidentOwnerId: integer
(int64)
Title:
IncidentOwnerId
Value that uniquely identifies the incident owner. -
IncidentReportedDate: string
(date-time)
Date of notification of the incident.
-
IncidentSourceCode: string
Title:
Incident Source
Maximum Length:30
The source of the incident. -
IncidentSummary: string
Title:
Summary
Maximum Length:1000
Summary of the incident. -
IncidentTypeCode: string
Title:
Incident Type
Maximum Length:30
Type of the incident. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier of the location. -
LocationTypeCode: string
Title:
Location Type
Maximum Length:30
Default Value:ORA_ON_SITE
Type of location. -
NotifiedPersonId: integer
(int64)
Person notified of the incident.
-
ReporterTypeCode: string
Title:
Incident Reporter
Maximum Length:30
Default Value:ORA_EMPLOYEE
The reporter of the incident. -
ReptrAddrLine1: string
Title:
Address Line 1
Maximum Length:255
First line of address. -
ReptrAddrLine2: string
Title:
Address Line 2
Maximum Length:255
Second line of address. -
ReptrAreaCode: string
Title:
Area Code
Maximum Length:30
The area code of the incident reporter. -
ReptrCity: string
Title:
City
Maximum Length:100
City of the incident reporter. -
ReptrCountry: string
Title:
Country
Maximum Length:100
Country of the incident reporter. -
ReptrCountryCodeNum: string
Title:
Country Code
Maximum Length:30
Country code for the incident reporter. -
ReptrEmail: string
Title:
Email
Maximum Length:250
Email address of incident reporter. -
ReptrName: string
Title:
Name
Maximum Length:200
Name of incident reporter. -
ReptrPhoneNo: string
Title:
Phone
Maximum Length:18
Phone number of incident reporter. -
ReptrSpecificLocation: string
Title:
Specific Location
Maximum Length:255
The incident reporter specific location. -
ReptrState: string
Title:
State
Maximum Length:100
The state of the incident reporter. -
ReptrZipCode: string
Title:
Postal Code
Maximum Length:100
Postal code of incident reporter. -
SeverityLevelCode: string
Maximum Length:
30
Default Value:ORA_NO_EFFECT
Level of severity of incident. -
TargetCompletionDate: string
(date-time)
Title:
Target Completion Date
The date that the incident is targeted for completion.
Nested Schema : Incident Detail Kiosks
Type:
array
Title:
Incident Detail Kiosks
A kiosk version of incident events.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : incidentKiosks-HnsIncidentsDFF-item-response
Type:
Show Source
object
-
__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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : incidentKiosks-IncidentDetailKiosk-item-response
Type:
Show Source
object
-
ActualCompletionDate: string
(date-time)
The date that the incident is targeted for actual completion.
-
IncidentDetailId: integer
(int64)
An identification value used for the incident event.
-
IncidentEventCode: string
Title:
Incident Event
Maximum Length:30
Description of the incident event. -
IncidentEventDate: string
(date-time)
Title:
Date and Time
The date when the incident event happened. -
IncidentEventSummary: string
Maximum Length:
1000
Audit detail for incident event summary. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- HnsIncidentsDFF
-
Parameters:
- IncidentId:
$request.path.IncidentId
- IncidentId:
- IncidentDetailKiosk
-
Parameters:
- IncidentId:
$request.path.IncidentId
A kiosk version of incident events. - IncidentId: