Jump to

• Request
• Response
• Examples

Get an audit report

post

/fscmRestApi/fndAuditRESTService/audittrail/getaudithistory

Get an audit report

Request

Query Parameters

• attributeDetailMode: boolean
  Indicates whether the old and new attribute values are returned. If true, the old and new values are retrieved. If false, the response contains only attribute names, and not old and new values. The default value is false.
• businessObjectType: string
  The fully qualified view object name of the product to be included in the audit report.
• eventType: string
  A comma-separated list of events you want to include in the audit report such as insert, delete, update, or all events.
• fromDate(required): string
  The date from which the audit history is to be retrieved. The format of the date can be yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. You can retrieve audit history for up to one month.
• includeAttributes: boolean
  Indicates whether the audit report includes business object attributes that were changed in the specified time period. The default value is true.
• includeChildObjects: boolean
  Indicates whether to include the child objects of the business object in the audit report. The default value is false.
• includeExtendedObjectIdentiferColumns: boolean
  Indicates whether to include the context information for the business objects. The default value is false.
• includeImpersonator: boolean
  Indicates whether to include the impersonator name in the audit report. The default value is false. Note: The impersonation functionality is no longer available. However, if impersonation was used earlier, and if you set this parameter to true, the response displays the name of the impersonator as stored in audit report.
• pageNumber: number
  The page number in the audit report you want to view.
• pageSize: number
  The number of records displayed in a page, in the audit report.
• product(required): string
  A predefined product value provided in the request. The valid values are available in the FND_AUDIT_WEBAPP_AM table.
• timeZone: string
  The timezone to be used for the specified period of the audit report. The valid values are availbale in the FND_TIMEZONES_VL view.
• toDate(required): string
  The date up to which the audit report data is to be retrieved. The format of the date can be yyyy-MM-dd or yyyy-MM-dd HH:mm:ss.
• user: string
  The display name of the user.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The following table describes the response for this task.

Body ()

Root Schema : auditHistory

Type: object

Show Source

• actionName: string
  Title: Action Name

  The request method name for which the response is retrieved such as getAuditHistory.
• auditData: array Audit data
  Title: Audit data

  The audit data retrieved for the specified criteria.
• pageNumber: string
  Title: Page Number

  The current page number in the audit report.
• pageSize: string
  Title: Page Size

  The number of records displayed per page in the audit report.
• status: string
  Title: Status

  The status of the audit report request. The valid values are SUCCESS and FAIL.

{ "type":"object", "properties":{ "pageNumber":{ "title":"Page Number", "type":"string", "description":"The current page number in the audit report." }, "pageSize":{ "title":"Page Size", "type":"string", "description":"The number of records displayed per page in the audit report." }, "status":{ "title":"Status", "type":"string", "description":"The status of the audit report request. The valid values are SUCCESS and FAIL." }, "actionName":{ "title":"Action Name", "type":"string", "description":"The request method name for which the response is retrieved such as getAuditHistory." }, "auditData":{ "title":"Audit data", "type":"array", "description":"The audit data retrieved for the specified criteria.", "items":{ "$ref":"#/components/schemas/auditData" } } } }

Nested Schema : Audit data

Type: array

Title: Audit data

The audit data retrieved for the specified criteria.

Show Source

• Array of: object auditData

{ "title":"Audit data", "type":"array", "description":"The audit data retrieved for the specified criteria.", "items":{ "$ref":"#/components/schemas/auditData" } }

Nested Schema : auditData

Type: object

Show Source

• attributeDetails: array Attribute Details
  Title: Attribute Details

  The attribute details displayed in the audit report. To inlcude these details, set includeAttributes attribute to true.
• businessObject: string
  Title: Business Object(display name)

  The display name of the business object.
• contextName1: string
  Title: Context Name1

  The display name of the first context attribute that defines the context of the change in the view object. The context name/value pairs are included in the audit report only when includeExtendedObjectIdentiferColumns attribute is set to true.
• contextName2: string
  Title: Context Name2

  The display name of the second context attribute that defines the context of the change in the view object.
• contextName3: string
  Title: Context Name3

  The display name of the third context attribute that defines the context of the change in the view object.
• contextValue1: string
  Title: Context Value1

  The value of the first context attribute defined in the view object.
• contextValue2: string
  Title: Context Value2

  The value of the second context attribute defined in the view object.
• contextValue3: string
  Title: Context Value3

  The value of the third context attribute defined in the view object.
• date: string
  Title: Date

  The date when the audit record was inserted, updated, or deleted.
• description: string
  Title: Event description

  The description of the event.
• descriptionInternal: string
  Title: Event description(internal name)

  The internal description of the event.
• eventType: string
  Title: Event Type

  The type of event such as insert, delete, update, or all events.
• impersonator: string
  Title: Impersonator name

  The name of the impersonator.
• qualifiedBusinessObject: string
  Title: Business Object(internal name)

  The fully qualified view object name.
• userInternalName: string
  Title: User internal name

  The internal name of the user.
• userName: string
  Title: User display name

  The display name of the user retrieving the audit report.

{ "type":"object", "properties":{ "date":{ "title":"Date", "type":"string", "description":"The date when the audit record was inserted, updated, or deleted." }, "userName":{ "title":"User display name", "type":"string", "description":"The display name of the user retrieving the audit report." }, "userInternalName":{ "title":"User internal name", "type":"string", "description":"The internal name of the user." }, "impersonator":{ "title":"Impersonator name", "type":"string", "description":"The name of the impersonator." }, "eventType":{ "title":"Event Type", "type":"string", "description":"The type of event such as insert, delete, update, or all events." }, "businessObject":{ "title":"Business Object(display name)", "type":"string", "description":"The display name of the business object." }, "qualifiedBusinessObject":{ "title":"Business Object(internal name)", "type":"string", "description":"The fully qualified view object name." }, "description":{ "title":"Event description", "type":"string", "description":"The description of the event." }, "descriptionInternal":{ "title":"Event description(internal name)", "type":"string", "description":"The internal description of the event." }, "attributeDetails":{ "title":"Attribute Details", "type":"array", "description":"The attribute details displayed in the audit report. To inlcude these details, set includeAttributes attribute to true.", "items":{ "$ref":"#/components/schemas/attributeDetails" } }, "contextName1":{ "title":"Context Name1", "type":"string", "description":"The display name of the first context attribute that defines the context of the change in the view object. The context name/value pairs are included in the audit report only when includeExtendedObjectIdentiferColumns attribute is set to true." }, "contextValue1":{ "title":"Context Value1", "type":"string", "description":"The value of the first context attribute defined in the view object." }, "contextName2":{ "title":"Context Name2", "type":"string", "description":"The display name of the second context attribute that defines the context of the change in the view object." }, "contextValue2":{ "title":"Context Value2", "type":"string", "description":"The value of the second context attribute defined in the view object." }, "contextName3":{ "title":"Context Name3", "type":"string", "description":"The display name of the third context attribute that defines the context of the change in the view object." }, "contextValue3":{ "title":"Context Value3", "type":"string", "description":"The value of the third context attribute defined in the view object." } } }

Nested Schema : Attribute Details

Type: array

Title: Attribute Details

The attribute details displayed in the audit report. To inlcude these details, set includeAttributes attribute to true.

Show Source

• Array of: object attributeDetails

{ "title":"Attribute Details", "type":"array", "description":"The attribute details displayed in the audit report. To inlcude these details, set includeAttributes attribute to true.", "items":{ "$ref":"#/components/schemas/attributeDetails" } }

Nested Schema : attributeDetails

Type: object

Show Source

• attribute: string
  Title: Attribute Name

  The display name of the attribute.
• attributeInternalName: string
  Title: Attribute internal name

  The internal name of the attribute.
• newValue: string
  Title: Attribute new value

  The new value of the attribute retrieved in the audit report.
• newValueId: string
  Title: Attribute new value Id

  The attribute Id for the new value.
• oldValue: string
  Title: Attribute old value

  The old value of the attribute retrieved in the audit report.
• oldValueId: string
  Title: Attribute old value Id

  The attribute Id of the old value.

{ "type":"object", "properties":{ "attribute":{ "title":"Attribute Name", "type":"string", "description":"The display name of the attribute." }, "attributeInternalName":{ "title":"Attribute internal name", "type":"string", "description":"The internal name of the attribute." }, "newValue":{ "title":"Attribute new value", "type":"string", "description":"The new value of the attribute retrieved in the audit report." }, "newValueId":{ "title":"Attribute new value Id", "type":"string", "description":"The attribute Id for the new value." }, "oldValue":{ "title":"Attribute old value", "type":"string", "description":"The old value of the attribute retrieved in the audit report." }, "oldValueId":{ "title":"Attribute old value Id", "type":"string", "description":"The attribute Id of the old value." } } }

Back to Top

Examples

The following example shows how to create audit history report by submitting a POST request on the REST resource using cURL.

curl -i --user <user_name:password> -H "Content-Type: application/json" -X POST --data @<@example_request_payload.json> https://<hostname>:<port>/fscmRestApi/fndAuditRESTService/audittrail/getaudithistory 

Example Request Payload

The following example shows the contents of the request body in JSON format:

{ "fromDate": "2017-01-01", "toDate": "2017-01-27", "product": "hcmCore", "businessObjectType": "oracle.apps.hcm.people.core.uiModel.view.ManagePersonVO", "includeChildObjects":"true" }

Example of Response Header

The following shows an example of the response header.

Status: HTTP/1.1 200 OK Content-Type : application/json

Example of Response Body

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

{ "status": "SUCCESS", "actionName": "getAuditHistory", "auditData": [ { "date": "2017-01-24 16:35:28", "userName": "Roger ZCMP_CWB_Federer", "userInternalName": "HCM_USER2" "eventType": "Object Data Insert", "businessObject": "Person Email", "qualifiedBusinessObject":"oracle.apps.hcm.people.core.uiModel.view.ManagePersonEmailAddressVO", "description": "Person ID:Testing1 Termination Test1/PersonId:Termination Test1", "attributeDetails": [ { "attribute": "PersonId", "attributeInternalName": "PersonId", "newValue": "Termination Test1" }, { "attribute": "E-Mail", "attributeInternalName": "EmailAddress", "newValue": "[e-mail]" }, { "attribute": "Type", "attributeInternalName": "EmailType", "newValue": "Work E-Mail" } ] }, { "date": "2017-01-24 16:35:28", "userName": "Roger ZCMP_CWB_Federer", "userInternalName": "HCM_USER2" "eventType": "Object Data Update", "businessObject": "Person Detail", "qualifiedBusinessObject":"oracle.apps.hcm.people.core.uiModel.view.ManagePersonDetailVO", "description": "Person ID:Testing1 Termination Test1/Person ID:Termination Test1", "attributeDetails": [ { "attribute": "PersonId", "attributeInternalName": "PersonId", "newValue": "Termination Test1", "oldValue": "Termination Test" }, { "attribute": "Start Date", "attributeInternalName": "StartDate", "newValue": "2009-10-20", "oldValue": "2017-01-01" }, { "attribute": "Primary Mailing", "attributeInternalName": "MailingAddressId", "newValue": "100000012674101", "oldValue": "100000012674100" }, { "attribute": "Person Number", "attributeInternalName": "PersonNumber", "newValue": "100000012674086", "oldValue": "100000012674085" } ] } ] }

The following example shows how to create audit history report by submitting a POST request on the REST resource for the OPSS product.

Example Request Payload

The following example shows the contents of the request body in JSON format:

{ "fromDate": "2017-01-01", "toDate": "2017-01-30", "product": "OPSS" } 

Example of Response Body

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

{ "status": "SUCCESS", "actionName": "getAuditHistory", "auditData": [ { "date": "2017-01-24 05:39:22", "userName": "Roger ZCMP_CWB_Federer", "userInternalName": "HCM_USER2" "eventType": "RoleMembershipAdd" "description": "Add principal(s) to app role ORA_PAY_PAYROLL_ADMINISTRATOR_JOB successful in APPLICATION scope", "attributeDetails": [ { "attribute": "Code Source", "attributeInternalName": "CodeSource", "newValue": "file:/scratch/aime/work/APPTOP/fusionapps/applications/hcm/deploy/EarHcmCore.ear/APP-INF/lib/AdfHcmApplicationsSecurityFaPolicyStoreService.jar" }, { "attribute": "Principals", "attributeInternalName": "Principals", "newValue": "[]" }, { "attribute": "Managed Application", "attributeInternalName": "ManagedApplication", "newValue": "obi", "newValueId": "W1" } { "attribute": "Application Role", "attributeInternalName": "ApplicationRole", "newValue": "ORA_PAY_PAYROLL_ADMINISTRATOR_JOB" }, { "attribute": "Enterprise Roles", "attributeInternalName": "EnterpriseRoles", "newValue": "([(Name:[e-mail]) (GUID:null) (Unique name:null) (Class name:weblogic.security.principal.WLSUserImpl) (AppID:null) (Type:CUSTOM)])" }, { "attribute": "Permission Scope", "attributeInternalName": "PermissionScope", "newValue": "APPLICATION" } ] } ] }

Back to Top