Jump to

• Request
• Response

Get the audit level for products

post

/fscmRestApi/fndAuditRESTService/audittrail/get-auditlevel

Get the audit level for products

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

• product: array product

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

Nested Schema : product

Type: array

Show Source

• Array of: string
  Title: product

  The products for which you can set up audit and get audit status. The valid values are ODI, ESS, MDS, SOA, ADF, and OPSS.

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

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

Nested Schema : auditDate

Type: array

Show Source

• Array of: object auditData-auditLevel

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

Nested Schema : auditData-auditLevel

Type: object

Show Source

• auditLevel(required): string
  Title: auditLevel

  The audit level of the product. The valid values are High, Medium, Low, and None. If you don't want to setup audit for an object, set the audit level to None.
• product(required): string
  Title: product

  The products for which you can set up audit and get audit status. The valid values are ODI, ESS, MDS, SOA, ADF, and OPSS.

{
    "required":[
        "auditLevel",
        "product"
    ],
    "type":"object",
    "properties":{
        "product":{
            "$ref":"#/components/schemas/product"
        },
        "auditLevel":{
            "$ref":"#/components/schemas/auditLevel"
        }
    }
}

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