Jump to

• Request
• Response

Get the audit status of an object

post

/fscmRestApi/fndAuditRESTService/audittrail/check-auditstatus

Get the audit status of 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-checkStatus"
            }
        }
    }
}

Nested Schema : auditDate

Type: array

Show Source

• Array of: object auditData-checkStatus

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

Nested Schema : auditData-checkStatus

Type: object

Show Source

• 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.
• 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",
        "parentBusinessObject"
    ],
    "type":"object",
    "properties":{
        "businessObject":{
            "$ref":"#/components/schemas/businessObject"
        },
        "parentBusinessObject":{
            "$ref":"#/components/schemas/parentBusinessObject"
        }
    }
}

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":{
                "$ref":"#/components/schemas/auditData-checkStatusResponse"
            }
        }
    }
}

Nested Schema : auditDate

Type: array

Show Source

• Array of: object auditData-checkStatusResponse

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

Nested Schema : auditData-checkStatusResponse

Type: object

Show Source

• auditSwitch: string
  Title: Audit Switch

  The value indicates whether or not the business object is setup for audit.
• businessObject: string
  Title: businessObject

  The fully qualified view object name to be set up for audit. This name must not be a null string.
• lastUpdatedTime: string
  Title: Last Updated Time

  The time when the audit status of the business object was last updated.
• parentBusinessObject: 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":"object",
    "properties":{
        "businessObject":{
            "$ref":"#/components/schemas/businessObject"
        },
        "parentBusinessObject":{
            "$ref":"#/components/schemas/parentBusinessObject"
        },
        "auditSwitch":{
            "$ref":"#/components/schemas/auditSwitch"
        },
        "lastUpdatedTime":{
            "$ref":"#/components/schemas/lastUpdatedTime"
        }
    }
}

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