Jump to

• Request
• Response

Set the audit status for an object

post

/fscmRestApi/fndAuditRESTService/audittrail/update-auditstatus

Set the audit status for an object

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

• auditDate: array auditDate

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

Nested Schema : auditDate

Type: array

Show Source

• Array of: object auditData-updateStatus

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

Nested Schema : auditData-updateStatus

Type: object

Show Source

• attributesList: array attributesList
• businessObject(required): string
  Title: businessObject

  The fully qualified view object name to be set up for audit. This name must not be a null string.
• enable(required): string
  Title: enable

  Value to indicate whether to turn auditing ON or OFF for the business object.
• parentBusinessObject(required): 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.

{
    "required":[
        "businessObject",
        "enable",
        "parentBusinessObject"
    ],
    "type":"object",
    "properties":{
        "businessObject":{
            "$ref":"#/components/schemas/businessObject"
        },
        "parentBusinessObject":{
            "$ref":"#/components/schemas/parentBusinessObject"
        },
        "enable":{
            "$ref":"#/components/schemas/enable"
        },
        "attributesList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/attributesList"
            }
        }
    }
}

Nested Schema : attributesList

Type: array

Show Source

• Array of: object attributesList

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

Nested Schema : attributesList

Type: object

Show Source

• attributeName: string
  Title: Attribute Name

  An attribute specified in the attribute list of the business object for which you want to setup 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"
        }
    }
}

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-updateStatusResponse"
                        }
                    }
                }
            }
        }
    }
}

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-updateStatusResponse"
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• objectDetails: array objectDetails

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

Nested Schema : objectDetails

Type: array

Show Source

• Array of: object auditData-updateStatusResponse

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

Nested Schema : auditData-updateStatusResponse

Type: object

Show Source

• attributesList: array attributesList
• parentObject: 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.
• viewObject: string
  Title: businessObject

  The fully qualified view object name to be set up for audit. This name must not be a null string.

{
    "type":"object",
    "properties":{
        "viewObject":{
            "$ref":"#/components/schemas/businessObject"
        },
        "parentObject":{
            "$ref":"#/components/schemas/parentBusinessObject"
        },
        "attributesList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/attributesList"
            }
        }
    }
}

Nested Schema : attributesList

Type: array

Show Source

• Array of: object attributesList

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

Nested Schema : attributesList

Type: object

Show Source

• attributeName: string
  Title: Attribute Name

  An attribute specified in the attribute list of the business object for which you want to setup 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"
        }
    }
}

400 Response

The following table describes the error 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/auditUpdateStatusOnError"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : auditDate

Type: array

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

Show Source

• objectDetails: array objectDetails

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

Nested Schema : objectDetails

Type: array

Show Source

• Array of: object auditUpdateStatusOnError

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

Nested Schema : auditUpdateStatusOnError

Type: object

Show Source

• attributesList: array attributesList
• errorMessage: string
  Title: Error Message

  Error Message.
• parentObject: 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.
• viewObject: string
  Title: businessObject

  The fully qualified view object name to be set up for audit. This name must not be a null string.

{
    "type":"object",
    "properties":{
        "viewObject":{
            "$ref":"#/components/schemas/businessObject"
        },
        "parentObject":{
            "$ref":"#/components/schemas/parentBusinessObject"
        },
        "errorMessage":{
            "$ref":"#/components/schemas/errorMessage"
        },
        "attributesList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/attributesList-error"
            }
        }
    }
}

Nested Schema : attributesList

Type: array

Show Source

• Array of: object attributesList-error

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

Nested Schema : attributesList-error

Type: object

Show Source

• attributeName: string
  Title: Attribute Name

  An attribute specified in the attribute list of the business object for which you want to setup audit.
• errorMessage: string
  Title: Error Message

  Error Message.
• isAuditable: string
  Title: Auditable

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

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

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