Jump to

• Request
• Response
• Examples

Get All Data Store Attributes

get

/rest/v16/extract/dataStores/{dataStoreName}/attributes

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

Request

Path Parameters

• dataStoreName(required): string
  Data Store Name corresponds to the unique name returned by the /extract/dataStores endpoint

Back to Top

Response

Supported Media Types

• application/json

Default Response

Returns a list of datas store attributess available for extract

Body ()

Root Schema : extractData_DataStoreAttributesListResponse

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExtractDataStoreAttributeMetadata"
            }
        },
        "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 ExtractDataStoreAttributeMetadata

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

Nested Schema : ExtractDataStoreAttributeMetadata

Type: object

Show Source

• additional: object additional
  Additional Properties Allowed: additionalProperties
• attributeVarName: string
• description: string
• id: integer(int64)
• isPrimaryKey: string
• label: string
• parentStoreMapping: object ParentStoreMapping
• type: object LookupMetadataModel

{
    "type":"object",
    "properties":{
        "attributeVarName":{
            "type":"string"
        },
        "isPrimaryKey":{
            "type":"string"
        },
        "type":{
            "$ref":"#/definitions/LookupMetadataModel"
        },
        "parentStoreMapping":{
            "$ref":"#/definitions/ParentStoreMapping"
        },
        "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"
    }
}

Nested Schema : ParentStoreMapping

Type: object

Show Source

• attributeVarName: string
• dataStoreName: string

{
    "type":"object",
    "properties":{
        "dataStoreName":{
            "type":"string"
        },
        "attributeVarName":{
            "type":"string"
        }
    }
}

Nested Schema : LookupMetadataModel

Type: object

Show Source

• displayValue: string
• lookupCode: string

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "type":"string"
        },
        "displayValue":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to return the list of data store attributes 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 - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/extract/dataStores/oraclecpqo-transaction-DOCUMENT/attributes

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

Back to Top