Jump to

• Request
• Response
• Examples

Extract Data Stores

post

/rest/v19/extract/dataStores/actions/extractData

Use this endpoint to submit a request to extract data stores.

Request

Supported Media Types

• application/json

Body ()

Data Stores Extract Request

Root Schema : extractData_DataStoresRequest

Type: object

Show Source

• dataStores(required): array dataStores
  List of data stores.
• parURL(required): string
  URL of the object storage.
• timeoutHours: integer
  Timeout duration in hours.

{
    "type":"object",
    "required":[
        "dataStores",
        "parURL"
    ],
    "properties":{
        "parURL":{
            "type":"string",
            "description":"URL of the object storage."
        },
        "timeoutHours":{
            "type":"integer",
            "description":"Timeout duration in hours."
        },
        "dataStores":{
            "type":"array",
            "description":"List of data stores.",
            "items":{
                "$ref":"#/definitions/RequestDataStore"
            }
        }
    }
}

Nested Schema : dataStores

Type: array

List of data stores.

Show Source

• Array of: object RequestDataStore

{
    "type":"array",
    "description":"List of data stores.",
    "items":{
        "$ref":"#/definitions/RequestDataStore"
    }
}

Nested Schema : RequestDataStore

Type: object

Show Source

• attributes(required): string
  Attributes associated with the data store.
• dataStoreName(required): string
  Name of the data store.
• modifiedDate: string
  Last modified date of the data store.

{
    "type":"object",
    "required":[
        "attributes",
        "dataStoreName"
    ],
    "properties":{
        "dataStoreName":{
            "type":"string",
            "description":"Name of the data store."
        },
        "attributes":{
            "type":"string",
            "description":"Attributes associated with the data store."
        },
        "modifiedDate":{
            "type":"string",
            "description":"Last modified date of the data store."
        }
    }
}

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 a request to extract data stores 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/extract/dataStores/actions/extractData

Request Body for 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"
    }
  ]
}

Response Body

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

Request Body for 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"
    }
  ]
}

Response Body

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

Back to Top