Jump to

• Request
• Response
• Examples

Request Data Extract

post

/rest/v16/extract/transactions

Use this endpoint to submit an asynchronous task to extract CPQ transaction and transaction lines data.

Request

Supported Media Types

• application/json

Body ()

Root Schema : extractData_TransactionRequest

Type: object

Show Source

• attributes(required): string
  Title: Attribute Names

  Pipe(|)separated attribute names to extract
• documentName(required): string
  Title: Document Variable Name

  Document Variable Name
• modifiedDate: string
  Title: Modified Date

  Modified Date
• parURL(required): string
  Title: Pre-Authenticated Request URL

  Pre-Authenticated Request URL
• processName(required): string
  Title: Process Variable Name

  Process Variable Name
• timeoutHours: integer
  Title: Timeout Hours

  Timeout Hours as a positive integer

{
    "type":"object",
    "required":[
        "attributes",
        "documentName",
        "parURL",
        "processName"
    ],
    "properties":{
        "processName":{
            "type":"string",
            "description":"Process Variable Name",
            "title":"Process Variable Name"
        },
        "documentName":{
            "type":"string",
            "description":"Document Variable Name",
            "title":"Document Variable Name"
        },
        "parURL":{
            "type":"string",
            "description":"Pre-Authenticated Request URL",
            "title":"Pre-Authenticated Request URL"
        },
        "attributes":{
            "type":"string",
            "description":"Pipe(|)separated attribute names to extract",
            "title":"Attribute Names"
        },
        "modifiedDate":{
            "type":"string",
            "description":"Modified Date",
            "title":"Modified Date"
        },
        "timeoutHours":{
            "type":"integer",
            "description":"Timeout Hours as a positive integer",
            "title":"Timeout Hours"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Provides taskId and a message

Body ()

Root Schema : extractData_SubmitResponse

Type: object

Show Source

• message: string
  Title: Message

  Submit Task Message
• taskId: string
  Title: Task Identifier

  Task Id

{
    "type":"object",
    "properties":{
        "taskId":{
            "type":"string",
            "description":"Task Id",
            "title":"Task Identifier"
        },
        "message":{
            "type":"string",
            "description":"Submit Task Message",
            "title":"Message"
        }
    }
}

Back to Top

Examples

The following example shows how to submit an asynchronous task to extract CPQ transaction and transaction lines data by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X POST - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/extract/transactions

Request Body

{
  "processName": "transaction_bmClone_2",
  "documentName": "quote",
  "attributes": "ID|subtotal|_bill_to_address|addFromCatalogSaveFromForm|addFromCatalogAdvancedModifyInput|addFromCatalogAdvancedModifyOutput|addFromCatalogFormulaInput|addFromCatalogFormulaOutput",
  "modifiedDate": "yyyy-MM-dd HH:mm:ss",
  "parURL": "your storage parURL",
  "timeoutHours": "24"
}

Response Body

{
  "Task Id": 3022955677,
  "Message": "Extract request submitted successfully"
}

Back to Top