Jump to

• Request
• Response
• Examples

Create a Performance Debugger Logging Task

post

/rest/v19/performanceDebugger/actions/createLog

Use this endpoint to create a performance debugger log for the Configuration action identified in the request payload.

Request

Supported Media Types

• application/json

Body ()

Root Schema : Performance Debugger Create Log Request

Type: object

Title: Performance Debugger Create Log Request

Show Source

• actionName: string
  Title: Action Name

  What action to performance profile
• bsId: integer
  Title: bsId

  ID of a transaction used as a configuration source (for reconfigure) or an invocation target (for add to transaction)
• description: string
  Title: Description

  User entered description of the run
• documentNumber: integer
  Title: documentNumber

  Document Number for a model line on the specified transaction to be used as a data source (for reconfigure)
• favoriteId: integer
  Title: Favorite ID

  ID of a favorite to be used as input data
• headlessMode: boolean
  Title: Headless Mode

  This property determines the API execution behavior. When false, API execution mimics the legacy UI behavior. When true, executes in UI agnostic mode. The default value is false.
• invocationId: integer
  Title: Invocation ID

  ID of a process invocation to be used for invocation
• model: string
  Title: Model

  The variable name of the model
• productFamily: string
  Title: Product Family

  The variable name of the product family
• productLine: string
  Title: Product Line

  The variable name of the product line

{
    "type":"object",
    "properties":{
        "productFamily":{
            "type":"string",
            "description":"The variable name of the product family",
            "title":"Product Family"
        },
        "productLine":{
            "type":"string",
            "description":"The variable name of the product line",
            "title":"Product Line"
        },
        "bsId":{
            "type":"integer",
            "description":"ID of a transaction used as a configuration source (for reconfigure) or an invocation target (for add to transaction)",
            "title":"bsId"
        },
        "favoriteId":{
            "type":"integer",
            "description":"ID of a favorite to be used as input data",
            "title":"Favorite ID"
        },
        "headlessMode":{
            "type":"boolean",
            "description":"This property determines the API execution behavior. When false, API execution mimics the legacy UI behavior. When true, executes in UI agnostic mode. The default value is false.",
            "title":"Headless Mode"
        },
        "documentNumber":{
            "type":"integer",
            "description":"Document Number for a model line on the specified transaction to be used as a data source (for reconfigure)",
            "title":"documentNumber"
        },
        "description":{
            "type":"string",
            "description":"User entered description of the run",
            "title":"Description"
        },
        "model":{
            "type":"string",
            "description":"The variable name of the model",
            "title":"Model"
        },
        "invocationId":{
            "type":"integer",
            "description":"ID of a process invocation to be used for invocation",
            "title":"Invocation ID"
        },
        "actionName":{
            "type":"string",
            "description":"What action to performance profile",
            "title":"Action Name"
        }
    },
    "title":"Performance Debugger Create Log Request"
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Performance Debugger Create Log Response

Type: object

Title: Performance Debugger Create Log Response

Show Source

• id: integer
  Title: Id

  Primary Key of the resource

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Primary Key of the resource",
            "title":"Id"
        }
    },
    "title":"Performance Debugger Create Log Response"
}

Back to Top

Examples

The following example shows how to create a performance debugger log for the Configuration action identified in the request payload by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X POST -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/performanceLogger/actions/createLog

Request Body Samples

Add to an Existing Transaction

{
  "actionName": "CONFIG_ADD_TO_TXN" ,
  "favoriteId": 3023525714,
  "bsid" : 3023337829
}

Add to Cart

{
  "actionName": "CONFIG_ADD_TO_CART",
  "favoriteId":  3023525714,
  "invocationId": 6993047
}

Configure

{
  "actionName": "CONFIG_CONFIGURE",
  "description": "CONFIGURE: Vision Vehicles SUV",
  "productFamily": "visionVehicles",
  "productLine": "consumerVehicles",
  "model": "sUV"
}

Create a New Transaction from Configuration (i.e. Invocation)

{
  "favoriteId": 3023525714,
  "invocationId": 12068225,
  "actionName": "CONFIG_INVOKE"
}

Reconfigure (Inbound)

{
  "bsId": 12068225,
  "documentNumber": 2,
  "actionName": "CONFIG_RECONFIGURE"
}

Reconfigure and Save

{
  "actionName": "CONFIG_SAVE_AFTER_RECONFIGURE",
  "bsid" : 3023337829,
  "documentNumber": 2
}

Update

{
  "description": "This is a test payload",
  "favoriteId": 18350193,
  "actionName": "CONFIG_UPDATE"
}

Response Body Sample

{
  "id": "3023221370"
}

Back to Top