Update an incident event
patch
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/child/IncidentDetailKiosk/{IncidentDetailId}
Request
Path Parameters
-
IncidentDetailId(required): integer(int64)
Unique identifier of the incident event. System-generated primary key.
-
IncidentId(required): integer(int64)
Unique identifier of the incident. System-generated primary key.
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
-
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.
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.
Root 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)
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.
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.