Jump to

• Request
• Response

Get all objects for a product

post

/fscmRestApi/fndAuditRESTService/audittrail/get-auditsetup

Get all objects for a product

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• application: string
  Title: application

  The product for which the business objects, along with the attribute details, are retrieved.

{ "type":"object", "properties":{ "application":{ "$ref":"#/components/schemas/application" } } }

Back to Top

Response

Supported Media Types

• application/json

200 Response

The following table describes the response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• actionName: string
  Title: Action Name

  The request method for which response is retrieved such as get-auditsetup.
• auditDate: array auditDate
• status: string
  Title: Status

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

{ "type":"object", "properties":{ "status":{ "$ref":"#/components/schemas/status" }, "actionName":{ "$ref":"#/components/schemas/actionName" }, "auditDate":{ "type":"array", "items":{ "type":"object", "properties":{ "objectDetails":{ "type":"array", "items":{ "$ref":"#/components/schemas/auditData-setupResponse" } } } } } } }

Nested Schema : auditDate

Type: array

Show Source

• Array of: object items

{ "type":"array", "items":{ "type":"object", "properties":{ "objectDetails":{ "type":"array", "items":{ "$ref":"#/components/schemas/auditData-setupResponse" } } } } }

Nested Schema : items

Type: object

Show Source

• objectDetails: array objectDetails

{ "type":"object", "properties":{ "objectDetails":{ "type":"array", "items":{ "$ref":"#/components/schemas/auditData-setupResponse" } } } }

Nested Schema : objectDetails

Type: array

Show Source

• Array of: object auditData-setupResponse

{ "type":"array", "items":{ "$ref":"#/components/schemas/auditData-setupResponse" } }

Nested Schema : auditData-setupResponse

Type: object

Show Source

• amdisplayName: string
  Title: Application Module Display Name

  The display name of the Application Module, for example FndDocumentCategoriesAdminUIAM.
• amname: string
  Title: Application Module Name

  The Application Module that contains the view object to set up for audit.
• attributesList: array attributesList
• parentObjectList: array parentObjectList
• viewObject: string
  Title: businessObject

  The fully qualified view object name to be set up for audit. This name must not be a null string.
• viewObjectDisplayName: string
  Title: Business Object Display Name

  Business Object Display Name.
• webApplication: string
  Title: application

  The product for which the business objects, along with the attribute details, are retrieved.

{ "type":"object", "properties":{ "webApplication":{ "$ref":"#/components/schemas/application" }, "amname":{ "$ref":"#/components/schemas/amname" }, "amdisplayName":{ "$ref":"#/components/schemas/amdisplayName" }, "viewObject":{ "$ref":"#/components/schemas/businessObject" }, "viewObjectDisplayName":{ "$ref":"#/components/schemas/viewObjectDisplayName" }, "parentObjectList":{ "type":"array", "items":{ "$ref":"#/components/schemas/parentBusinessObject" } }, "attributesList":{ "type":"array", "items":{ "$ref":"#/components/schemas/attributesList-setup" } } } }

Nested Schema : attributesList

Type: array

Show Source

• Array of: object attributesList-setup

{ "type":"array", "items":{ "$ref":"#/components/schemas/attributesList-setup" } }

Nested Schema : parentObjectList

Type: array

Show Source

• Array of: string
  Title: parentBusinessObject

  The fully qualified parent view object name, as defined by the view link in the Application Module where the view object instance exists. If the view object does'nt a parent, use the view object name as it's parent. This name must not be null string.

{ "type":"array", "items":{ "$ref":"#/components/schemas/parentBusinessObject" } }

Nested Schema : attributesList-setup

Type: object

Show Source

• attributeDataType: string
  Title: Attribute DataType

  The data type of the attribute, for example, java.lang.Long.
• attributeName: string
  Title: Attribute Name

  An attribute specified in the attribute list of the business object for which you want to setup audit.
• attributeSize: string
  Title: Attribute Size

  The size of the attribute. For example, CategoryID with data type as java.lang.Long has size defined as 18.
• displayName: string
  Title: Attribute Display Name

  The display name of the attribute, which is specified in the attribute list enabled for audit.
• isAuditable: string
  Title: Auditable

  The value indicates whether this attribute of the business object is enabled or not for audit.

{ "type":"object", "properties":{ "attributeName":{ "$ref":"#/components/schemas/attributeName" }, "isAuditable":{ "$ref":"#/components/schemas/isAuditable" }, "displayName":{ "$ref":"#/components/schemas/displayName" }, "attributeDataType":{ "$ref":"#/components/schemas/attributeDataType" }, "attributeSize":{ "$ref":"#/components/schemas/attributeSize" } } }

401 Response

The following table describes the response for authentication failure.

Body ()

Root Schema : auditSetupOnError

Type: object

Show Source

• actionName: string
  Title: Action Name

  The request method for which response is retrieved such as get-auditsetup.
• error: object auditData-error
• status: string
  Title: Status

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

{ "type":"object", "properties":{ "status":{ "$ref":"#/components/schemas/status" }, "actionName":{ "$ref":"#/components/schemas/actionName" }, "error":{ "$ref":"#/components/schemas/auditData-error" } } }

Nested Schema : auditData-error

Type: object

Show Source

• detail: string
  Title: Detail

  Detail.
• status: string
  Title: Status

  The status of the audit setup request. The valid values are SUCCESS and FAIL.
• title: string
  Title: Title

  Title.
• type: string
  Title: Type

  Type.

{ "type":"object", "properties":{ "detail":{ "$ref":"#/components/schemas/detail" }, "status":{ "$ref":"#/components/schemas/status" }, "title":{ "$ref":"#/components/schemas/title" }, "type":{ "$ref":"#/components/schemas/type" } } }

403 Response

The following table describes the response for authorization failure.

Body ()

Root Schema : auditSetupOnError

Type: object

Show Source

• actionName: string
  Title: Action Name

  The request method for which response is retrieved such as get-auditsetup.
• error: object auditData-error
• status: string
  Title: Status

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

{ "type":"object", "properties":{ "status":{ "$ref":"#/components/schemas/status" }, "actionName":{ "$ref":"#/components/schemas/actionName" }, "error":{ "$ref":"#/components/schemas/auditData-error" } } }

Nested Schema : auditData-error

Type: object

Show Source

• detail: string
  Title: Detail

  Detail.
• status: string
  Title: Status

  The status of the audit setup request. The valid values are SUCCESS and FAIL.
• title: string
  Title: Title

  Title.
• type: string
  Title: Type

  Type.

{ "type":"object", "properties":{ "detail":{ "$ref":"#/components/schemas/detail" }, "status":{ "$ref":"#/components/schemas/status" }, "title":{ "$ref":"#/components/schemas/title" }, "type":{ "$ref":"#/components/schemas/type" } } }

Back to Top