Extract Data REST API

Overview

The Extract Data REST API sends bulk transaction and transaction line data to the Fusion Analytics Warehouse (FAW) to produce advanced reports and dashboards.

Administration

ClosedRequest Data Extract

  Request Data Extract POST method
Description This action will submit an asynchronous task to extract CPQ transaction and transaction lines data.
URI Endpoint

/rest/v17/extract/transactions
Endpoint Parameters None
HTTP Method POST
Request Body Parameters

processName

 The process variable name

documentName

 The document variable name

partURL

 Pre-Authenticated Request URL

attributes

 Pipe "|" separated attribute names to extract

modifiedDate

 The modified date

timeoutHours

 Timeout Hours as a positive integer
Response Body Parameters

taskId

 The data extract task identifier

message

 The submit task message

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/extract/transactions

ClosedRequest Body Sample

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

ClosedResponse Body Sample

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

ClosedGet Site Status for Data Extract

  Get Site Status for Data Extract GET Method
Description Returns the status of the site if it is available for extraction.
URI Endpoint

/rest/v17/extract/siteStatus
Endpoint Parameters None
HTTP Method GET
Request Body Parameters None
Response HTTP Status Code

200

 Site connection successful

503

 Data extract is currently unavailable due to site activity. Please try again later

403

 CPQ Data Extract service is not enabled for this site

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/extract/siteStatus

ClosedGet Data Extract Task Status

  Get Data Extract Task Status GET Method
Description Returns the status of the site if it is available for extraction.
URI Endpoint

/rest/v17/extract/siteStatus/{teskId}
Endpoint Parameters

taskId

 The data extract task identifier
HTTP Method GET
Request Body Parameters None
Response Body Parameters

taskId

 The data extract task identifier

taskStatus

 The submit task message

startTime

 The extract start time

endTime

 The extract end time

totalRows

 The total number of rows extracted

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/extract/status/3022955677

ClosedResponse Body Sample

{ "Task ID": 3022955677, "Total Rows Extracted": 1896, "Task Status": "Completed", "Start Time": "2023-03-01 13:51:38.0", "End Time": "2023-03-01 13:52:01" }

ClosedCancel Data Extract Task

  Cancel Data Extract Task POST method
Description This action will cancel the data extract task if not complete.
URI Endpoint

/rest/v17/extract/cancel/{taskId}
Endpoint Parameters

taskId

 The data extract task identifier
HTTP Method POST
Request Body Parameters None
Response Body Parameters

taskId

 The data extract task identifier

taskStatus

 The submit task message

startTime

 The extract start time

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/extract/status/3022955677

ClosedResponse Body Sample

{ "taskId": 3023103675, "taskStatus": "Cancellation Requested", "startTime": "2023-03-23 15:00:37.0" }

Data Stores

ClosedGet All Data Stores

  Get All Data Stores GET Method
Description Use this endpoint to return the list of data stores available for extract.
URI Endpoint

/rest/v17/extract/dataStores
Endpoint Parameters None
HTTP Method GET
Request Body Parameters None
Response Body Parameters

Returns a list of data store items available for extract.

dataStoreName

A unique name for the data store across the CPQ system

dataStoreType

The type of data store (e.g. DOCUMENT, DOCUMENTARRAYSET)

description

Description for the data store item

id

The Id for the data store item

label

The name for the data store item

additional

This is a map of name value pairs with values specific to a particular data store and data store type.

  • processType - "0" for a standard process, "1" for all others

  • processTypeLabel - "Standard Process" for a standard process, "Blank Process" for all others

  • isMainDoc - Indicates if the data store document is main document

  • isStandardComponent - Indicates if the data store document is from the CPQ standard process

  • parentDataStoreName - All child stores of a data store will have this populated

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/extract/dataStores

ClosedResponse Body Sample

{ "items": [{ "id": 36893204, "dataStoreName": "oraclecpqo-transaction-DOCUMENT", "dataStoreType": "DOCUMENT", "label": "Transaction", "description": "Main (Header Level) Commerce Document - serves as Quote/Order depending on step in process flow", "additional": { "processVarName": "oraclecpqo", "processTypeLabel": "Standard Process", "documentVarName": "transaction", "processType": "0", "isStandardComponent": "true", "isMainDoc": "true" } }, { "id": 36893248, "dataStoreName": "oraclecpqo-transactionLine-oRCL_charges-DOCUMENTARRAYSET", "dataStoreType": "DOCUMENTARRAYSET", "label": "Prices", "description": "All prices including Product Price for OM Integration", "additional": { "arraySetVarName": "oRCL_charges", "processVarName": "oraclecpqo", "processTypeLabel": "Standard Process", "documentVarName": "transactionLine", "isStandardComponent": "true", "processType": "0", "parentDataStoreName": "oraclecpqo-transactionLine-DOCUMENT" } }, { "id": 36995759, "dataStoreName": "oraclecpqo-transactionLine-_chargeSet-DOCUMENTARRAYSET", "dataStoreType": "DOCUMENTARRAYSET", "label": "Charge Set", "description": "", "additional": { "arraySetVarName": "_chargeSet", "processVarName": "oraclecpqo", "processTypeLabel": "Standard Process", "documentVarName": "transactionLine", "isStandardComponent": "true", "processType": "0", "parentDataStoreName": "oraclecpqo-transactionLine-DOCUMENT" } }, { "id": 37165040, "dataStoreName": "oraclecpqo-transactionLine-_availableRatePlanSet-DOCUMENTARRAYSET", "dataStoreType": "DOCUMENTARRAYSET", "label": "Available Rate Plan Set", "description": "This array set fetches the list of available Rate Plans.", "additional": { "arraySetVarName": "_availableRatePlanSet", "processVarName": "oraclecpqo", "processTypeLabel": "Standard Process", "documentVarName": "transactionLine", "isStandardComponent": "true", "processType": "0", "parentDataStoreName": "oraclecpqo-transactionLine-DOCUMENT" } }, { "id": 36893226, "dataStoreName": "oraclecpqo-transactionLine-DOCUMENT", "dataStoreType": "DOCUMENT", "label": "Transaction Line", "description": "Line Level Document - Captures pricing and data at the line level", "additional": { "processVarName": "oraclecpqo", "processTypeLabel": "Standard Process", "documentVarName": "transactionLine", "processType": "0", "isStandardComponent": "true", "isMainDoc": "false" } } ] }

ClosedGet All Data Store Attributes

  Get All Data Store Attributes GET Method
Description Use this endpoint to return the list of data store attributes available for extract.
URI Endpoint

/rest/v17/extract/dataStores/{dataStoreName}/attributes
Endpoint Parameters

dataStoreName

A unique name for the data store across the CPQ system
HTTP Method GET
Request Body Parameters

None
Response Body Parameters

Returns a list of data store attribute set items available for extract.

dataStoreName

The unique name for the data store attribute set

dataStoreType

The type of data store (e.g. DOCUMENTARRAYSET)

description

Description for the data store attribute set

description

Description for the attribute set

id

The Id for the attribute set

isPrimaryKey

 Indicates if an attribute is a primary key

label

The name for the data store attribute set

parentStoreMapping

 If an attribute is an foreign key, this object will contain the parent dataStoreName and attributeVarName

type

The lookup code and display value for the attribute

additional

This is a map of name value pairs with values specific to a particular data store and data store type.

  • processType - "0" for a standard process, "1" for all others

  • processTypeLabel - "Standard Process" for a standard process, "Blank Process" for all others

  • isMainDoc - Indicates if the data store document is main document

  • isStandardComponent - Indicates if the data store document is from the CPQ standard process

  • parentDataStoreName - All child stores of a data store will have this populated

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/extract/dataStores/oraclecpqo-transaction-DOCUMENT/attributes

ClosedResponse Body Sample

{ "items": [{ "id": 36893314, "attributeVarName": "_document_number", "label": "Document Number", "description": "Unique doc number to be used as document identifier in a process", "isPrimaryKey": "true", "type": { "lookupCode": "CmTextAttribute", "displayValue": "Text" }, "additional": { "isStandardComponent": "true" } }, { "id": 36894810, "attributeVarName": "annualValue_l", "label": "Annual Value (Net)", "description": "The annual contract value of the recurring charges on this line.", "type": { "lookupCode": "CmCurrencyAttribute", "displayValue": "Currency" }, "additional": { "isStandardComponent": "true" } }, { "id": 36893336, "attributeVarName": "_price_book_var_name", "label": "Price Book Variable Name", "description": "Variable Name of the Price Book used to get the price for this line item", "type": { "lookupCode": "CmTextAttribute", "displayValue": "Text" }, "additional": { "isStandardComponent": "true" } }, { "id": 36894832, "attributeVarName": "cancelReason_l", "label": "Cancel Reason", "description": "The reason why the customer canceled this line.", "type": { "lookupCode": "CmMenuAttribute", "displayValue": "Menu" }, "additional": { "isStandardComponent": "true" } }, { ... }, { "id": -1, "attributeVarName": "_bs_id", "label": "BsId", "description": "BsId", "isPrimaryKey": "true", "type": { "lookupCode": "CmNumberAttribute", "displayValue": "Integer" }, "additional": { "isStandardComponent": "true" } } ], "additional": { "dataStoreName": "oraclecpqo-transactionLine-DOCUMENT" } }

ClosedExtract Data Stores

 Extract Data Stores POST method
Description Use this endpoint to submit a request to extract data stores.
URI Endpoint

/rest/v17/extract/dataStores/actions/extractData
Endpoint Parameters

None
HTTP Method POST
Request Body Parameters

dataStores

 A list of data store items

parURL

 The URL for the storage object

timeOutHours

 Time duration in hours
Response Body Parameters

taskId

 The data extract task identifier

message

 The submit task message

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/extract/dataStores/actions/extractData

ClosedRequest Body Sample for a Main Document

{ "parURL": "https://objectstorage.regionexample.oraclecloud.com/parURLExamplecpq/b/bucket-20231120-1151/o/", "timeoutHours": "", "dataStores": [{ "dataStoreName": "oraclecpqo-transaction-DOCUMENT", "attributes": "_document_number|_customer_t_first_name|_customer_t_last_name|_id" } ] }

ClosedRequest Body Sample for a Sub-Document

{ "parURL": "https://objectstorage.regionexample.oraclecloud.com/parURLExamplecpq/b/bucket-20231120-1151/o/", "timeoutHours": "", "dataStores": [{ "dataStoreName": "oraclecpqo-transactionLine-DOCUMENT", "attributes": "_document_number}annualValue_l|_price_book_var_name" }, { "dataStoreName": "oraclecpqo-transactionLine-_availableRatePlanSet-DOCUMENTARRAYSET", "attributes": "_document_number|_availableRatePlanSet_rate_plan_name|_availableRatePlanSet_rate_plan_number" } ] }

ClosedResponse Body Sample

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

 

Related Topics

Related Topics Link IconSee Also