Jump to

• Request
• Response
• Examples

Get All Data Stores

get

/rest/v19/extract/dataStores

Use this endpoint to return the list of data stores available for extract.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Returns a list of datas stores available for extract

Body ()

Root Schema : extractData_DataStoresListResponse

Type: object

Show Source

• additional: object additional
  Additional Properties Allowed: additionalProperties
• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExtractDataStoreMetadata"
            }
        },
        "additional":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : additional

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ExtractDataStoreMetadata

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ExtractDataStoreMetadata"
    }
}

Nested Schema : ExtractDataStoreMetadata

Type: object

Show Source

• additional: object additional
  Additional Properties Allowed: additionalProperties
• dataStoreName: string
• dataStoreType: string
• description: string
• id: integer(int64)
• label: string

{
    "type":"object",
    "properties":{
        "dataStoreName":{
            "type":"string"
        },
        "dataStoreType":{
            "type":"string"
        },
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "label":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "additional":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : additional

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top

Examples

The following example shows how to return the list of data stores available for extract by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/extract/dataStores

Response 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"
      }
    }
  ]
}

Back to Top