Jump to

• Request
• Response
• Examples

Create an incident

post

/hcmRestApi/resources/11.13.18.05/incidentKiosks

Request

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.
• Upsert-Mode:
  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

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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: Name

  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.

{
    "required":[
        "IncidentSummary",
        "ReptrSpecificLocation",
        "TargetCompletionDate"
    ],
    "type":"object",
    "properties":{
        "IncidentDescription":{
            "title":"Description",
            "type":"string",
            "description":"Description of the incident.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ReptrCountry":{
            "title":"Country",
            "maxLength":"100",
            "type":"string",
            "description":"Country of the incident reporter.",
            "nullable":true
        },
        "ReptrZipCode":{
            "title":"Postal Code",
            "maxLength":"100",
            "type":"string",
            "description":"Postal code of incident reporter.",
            "nullable":true
        },
        "ReptrEmail":{
            "title":"Email",
            "maxLength":"250",
            "type":"string",
            "description":"Email address of incident reporter.",
            "nullable":true
        },
        "NotifiedPersonId":{
            "type":"integer",
            "description":"Person notified of the incident.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "IncidentTypeCode":{
            "title":"Incident Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of the incident.",
            "nullable":true
        },
        "ReptrPhoneNo":{
            "title":"Phone",
            "maxLength":"18",
            "type":"string",
            "description":"Phone number of incident reporter.",
            "nullable":true
        },
        "ReptrCity":{
            "title":"City",
            "maxLength":"100",
            "type":"string",
            "description":"City of the incident reporter.",
            "nullable":true
        },
        "ReptrAreaCode":{
            "title":"Area Code",
            "maxLength":"30",
            "type":"string",
            "description":"The area code of the incident reporter.",
            "nullable":true
        },
        "LocationTypeCode":{
            "title":"Location Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of location.",
            "nullable":true,
            "default":"ORA_ON_SITE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EmployeeId":{
            "title":"Employee",
            "type":"integer",
            "description":"Identification value of the employee.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "IncidentOwnerId":{
            "title":"Name",
            "type":"integer",
            "description":"Value that uniquely identifies the incident owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "IncidentReportedDate":{
            "type":"string",
            "description":"Date of notification of the incident.",
            "format":"date-time",
            "nullable":true
        },
        "ReptrCountryCodeNum":{
            "title":"Country Code",
            "maxLength":"30",
            "type":"string",
            "description":"Country code for the incident reporter.",
            "nullable":true
        },
        "IncidentDetailKiosk":{
            "title":"Incident Detail Kiosks",
            "type":"array",
            "description":"A kiosk version of incident events.",
            "items":{
                "$ref":"#/components/schemas/incidentKiosks-IncidentDetailKiosk-item-post-request"
            }
        },
        "ReptrAddrLine2":{
            "title":"Address Line 2",
            "maxLength":"255",
            "type":"string",
            "description":"Second line of address.",
            "nullable":true
        },
        "ReptrAddrLine1":{
            "title":"Address Line 1",
            "maxLength":"255",
            "type":"string",
            "description":"First line of address.",
            "nullable":true
        },
        "IncidentDate":{
            "title":"Date and Time",
            "type":"string",
            "description":"Incident date and time.",
            "format":"date-time",
            "nullable":false
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier of the location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "IncidentSourceCode":{
            "title":"Incident Source",
            "maxLength":"30",
            "type":"string",
            "description":"The source of the incident.",
            "nullable":true
        },
        "HnsIncidentsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/incidentKiosks-HnsIncidentsDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "IncidentId":{
            "title":"Incident ID",
            "type":"integer",
            "description":"The unique identifier of the incident.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "IncidentImmeActDescr":{
            "title":"Immediate Actions",
            "type":"string",
            "description":"Immediate actions to take.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "IncidentSummary":{
            "title":"Summary",
            "maxLength":"1000",
            "type":"string",
            "description":"Summary of the incident.",
            "nullable":false
        },
        "TargetCompletionDate":{
            "title":"Target Completion Date",
            "type":"string",
            "description":"The date that the incident is targeted for completion.",
            "format":"date-time",
            "nullable":false
        },
        "ReptrSpecificLocation":{
            "title":"Specific Location",
            "maxLength":"255",
            "type":"string",
            "description":"The incident reporter specific location.",
            "nullable":false
        },
        "SeverityLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Level of severity of incident.",
            "nullable":true,
            "default":"ORA_NO_EFFECT"
        },
        "ReptrState":{
            "title":"State",
            "maxLength":"100",
            "type":"string",
            "description":"The state of the incident reporter.",
            "nullable":true
        },
        "ReporterTypeCode":{
            "title":"Incident Reporter",
            "maxLength":"30",
            "type":"string",
            "description":"The reporter of the incident.",
            "nullable":true,
            "default":"ORA_EMPLOYEE"
        },
        "ReptrName":{
            "title":"Name",
            "maxLength":"200",
            "type":"string",
            "description":"Name of incident reporter.",
            "nullable":true
        }
    }
}

Nested Schema : HnsIncidentsDFF

Type: array

Show Source

• Array of: object schema

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

Nested Schema : Incident Detail Kiosks

Type: array

Title: Incident Detail Kiosks

A kiosk version of incident events.

Show Source

• Array of: object incidentKiosks-IncidentDetailKiosk-item-post-request

{
    "title":"Incident Detail Kiosks",
    "type":"array",
    "description":"A kiosk version of incident events.",
    "items":{
        "$ref":"#/components/schemas/incidentKiosks-IncidentDetailKiosk-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

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

{
    "type":"object",
    "properties":{
        "__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"
                }
            }
        },
        "IncidentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "__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_IsDiscriminator":"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"
                }
            }
        }
    }
}

Nested Schema : incidentKiosks-IncidentDetailKiosk-item-post-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "IncidentEventSummary":{
            "maxLength":"1000",
            "type":"string",
            "description":"Audit detail for incident event summary.",
            "nullable":false
        },
        "IncidentDetailId":{
            "type":"integer",
            "description":"An identification value used for the incident event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "IncidentEventDate":{
            "title":"Date and Time",
            "type":"string",
            "description":"The date when the incident event happened.",
            "format":"date-time",
            "nullable":false
        },
        "ActualCompletionDate":{
            "type":"string",
            "description":"The date that the incident is targeted for actual completion.",
            "format":"date-time",
            "nullable":true
        },
        "IncidentEventCode":{
            "title":"Incident Event",
            "maxLength":"30",
            "type":"string",
            "description":"Description of the incident event.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : incidentKiosks-item-response

Type: object

Show Source

• 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: Name

  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.

{
    "type":"object",
    "properties":{
        "IncidentDescription":{
            "title":"Description",
            "type":"string",
            "description":"Description of the incident.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ReptrCountry":{
            "title":"Country",
            "maxLength":"100",
            "type":"string",
            "description":"Country of the incident reporter.",
            "nullable":true,
            "x-queryable":true
        },
        "ReptrZipCode":{
            "title":"Postal Code",
            "maxLength":"100",
            "type":"string",
            "description":"Postal code of incident reporter.",
            "nullable":true,
            "x-queryable":true
        },
        "ReptrEmail":{
            "title":"Email",
            "maxLength":"250",
            "type":"string",
            "description":"Email address of incident reporter.",
            "nullable":true,
            "x-queryable":true
        },
        "NotifiedPersonId":{
            "type":"integer",
            "description":"Person notified of the incident.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IncidentTypeCode":{
            "title":"Incident Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of the incident.",
            "nullable":true,
            "x-queryable":true
        },
        "IncidentNo":{
            "title":"Incident Number",
            "maxLength":"32",
            "type":"string",
            "description":"Value that uniquely identifies the incident.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReptrPhoneNo":{
            "title":"Phone",
            "maxLength":"18",
            "type":"string",
            "description":"Phone number of incident reporter.",
            "nullable":true,
            "x-queryable":true
        },
        "ReptrCity":{
            "title":"City",
            "maxLength":"100",
            "type":"string",
            "description":"City of the incident reporter.",
            "nullable":true,
            "x-queryable":true
        },
        "ReptrAreaCode":{
            "title":"Area Code",
            "maxLength":"30",
            "type":"string",
            "description":"The area code of the incident reporter.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationTypeCode":{
            "title":"Location Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of location.",
            "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":"Identification value of the employee.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IncidentOwnerId":{
            "title":"Name",
            "type":"integer",
            "description":"Value that uniquely identifies the incident owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IncidentReportedDate":{
            "type":"string",
            "description":"Date of notification of the incident.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ReptrCountryCodeNum":{
            "title":"Country Code",
            "maxLength":"30",
            "type":"string",
            "description":"Country code for the incident reporter.",
            "nullable":true,
            "x-queryable":true
        },
        "IncidentDetailKiosk":{
            "title":"Incident Detail Kiosks",
            "type":"array",
            "description":"A kiosk version of incident events.",
            "items":{
                "$ref":"#/components/schemas/incidentKiosks-IncidentDetailKiosk-item-response"
            }
        },
        "ReptrAddrLine2":{
            "title":"Address Line 2",
            "maxLength":"255",
            "type":"string",
            "description":"Second line of address.",
            "nullable":true,
            "x-queryable":true
        },
        "ReptrAddrLine1":{
            "title":"Address Line 1",
            "maxLength":"255",
            "type":"string",
            "description":"First line of address.",
            "nullable":true,
            "x-queryable":true
        },
        "IncidentDate":{
            "title":"Date and Time",
            "type":"string",
            "description":"Incident date and time.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier of the location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IncidentSourceCode":{
            "title":"Incident Source",
            "maxLength":"30",
            "type":"string",
            "description":"The source of the incident.",
            "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":"The unique identifier of the incident.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IncidentImmeActDescr":{
            "title":"Immediate Actions",
            "type":"string",
            "description":"Immediate actions to take.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "IncidentSummary":{
            "title":"Summary",
            "maxLength":"1000",
            "type":"string",
            "description":"Summary of the incident.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetCompletionDate":{
            "title":"Target Completion Date",
            "type":"string",
            "description":"The date that the incident is targeted for completion.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ReptrSpecificLocation":{
            "title":"Specific Location",
            "maxLength":"255",
            "type":"string",
            "description":"The incident reporter specific location.",
            "nullable":false,
            "x-queryable":true
        },
        "SeverityLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Level of severity of incident.",
            "nullable":true,
            "default":"ORA_NO_EFFECT",
            "x-queryable":true
        },
        "ReptrState":{
            "title":"State",
            "maxLength":"100",
            "type":"string",
            "description":"The state of the incident reporter.",
            "nullable":true,
            "x-queryable":true
        },
        "ReporterTypeCode":{
            "title":"Incident Reporter",
            "maxLength":"30",
            "type":"string",
            "description":"The reporter of the incident.",
            "nullable":true,
            "default":"ORA_EMPLOYEE",
            "x-queryable":true
        },
        "ReptrName":{
            "title":"Name",
            "maxLength":"200",
            "type":"string",
            "description":"Name of incident reporter.",
            "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

A kiosk version of incident events.

Show Source

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

{
    "title":"Incident Detail Kiosks",
    "type":"array",
    "description":"A kiosk version of incident 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_IsDiscriminator":"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)
  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.

{
    "type":"object",
    "properties":{
        "IncidentEventSummary":{
            "maxLength":"1000",
            "type":"string",
            "description":"Audit detail for incident event summary.",
            "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":"An identification value used for the incident event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IncidentEventDate":{
            "title":"Date and Time",
            "type":"string",
            "description":"The date when the incident event happened.",
            "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":"Description of the incident event.",
            "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

A kiosk version of incident 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