Jump to

• Request
• Response
• Examples

Create a Commerce Process Data Column

post

/rest/v19/commerceProcessSetups/{processVarName}/dataColumns

Use this endpoint to create Data Columns for the specified Commerce Process.

Request

Supported Media Types

• application/json

Path Parameters

• processVarName(required): string

Body ()

Root Schema : CmAdminDataColumnRequestModel

Type: object

Show Source

• attributeType: string()
  Title: Attribute Type

  Type of Attribute
• catAttrId: integer()
  Title: Catalog Attribute Id

  ID of Catalog Attribute
• catModelId: integer()
  Title: Model Id

  Id of Catalog Model Id
• catPlineId: integer()
  Title: Product Line Id

  Id of Catalog Product Line
• catSegmentId: integer()
  Title: Segment Id

  Id of Segment
• cmAttrId: integer()
  Title: Commerce Attribute Id

  ID of Commerce Attribute
• documentId: integer()
  Title: documentId

  ID of document
• isIndexed: boolean()
  Title: Is Indexed

  Is Indexing enabled for the data column
• isKeywordSearch: boolean()
  Title: Is KeywordSearch

  Is keyword search enabled
• reportLabel: string()
  Title: Report Label

  Report Label
• searchLabel: string()
  Title: Search Label

  Search Label
• variableName: string()
  Title: Variable Name

  Variable Name of Data Column

{
    "properties":{
        "attributeType":{
            "type":"string",
            "format":"",
            "description":"Type of Attribute",
            "title":"Attribute Type"
        },
        "documentId":{
            "type":"integer",
            "format":"",
            "description":"ID of document",
            "title":"documentId"
        },
        "isIndexed":{
            "type":"boolean",
            "format":"",
            "description":"Is Indexing enabled for the data column",
            "title":"Is Indexed"
        },
        "isKeywordSearch":{
            "type":"boolean",
            "format":"",
            "description":"Is keyword search enabled",
            "title":"Is KeywordSearch"
        },
        "cmAttrId":{
            "type":"integer",
            "format":"",
            "description":"ID of Commerce Attribute",
            "title":"Commerce Attribute Id"
        },
        "catAttrId":{
            "type":"integer",
            "format":"",
            "description":"ID of Catalog Attribute",
            "title":"Catalog Attribute Id"
        },
        "searchLabel":{
            "type":"string",
            "format":"",
            "description":"Search Label",
            "title":"Search Label"
        },
        "reportLabel":{
            "type":"string",
            "format":"",
            "description":"Report Label",
            "title":"Report Label"
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"Variable Name of Data Column",
            "title":"Variable Name"
        },
        "catSegmentId":{
            "type":"integer",
            "format":"",
            "description":"Id of Segment",
            "title":"Segment Id"
        },
        "catPlineId":{
            "type":"integer",
            "format":"",
            "description":"Id of Catalog Product Line",
            "title":"Product Line Id"
        },
        "catModelId":{
            "type":"integer",
            "format":"",
            "description":"Id of Catalog Model Id",
            "title":"Model Id"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Success

Back to Top

Examples

The following example shows how to create Data Columns for the specified Commerce Process 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/commerceProcessSetups/oraclecpqo/dataColumns

Request Body Samples

{
  "attributeType": "COMMERCE",
  "documentId": 3023304905,
  "isIndexed": false,
  "isKeywordSearch": false,
  "cmAttrId": 3023312918,
  "catAttrId": -1,
  "searchLabel": "abc",
  "reportLabel": "abc",
  "variableName": "abcdhjiIIii_c",
  "catSegmentId": 50,
  "catPlineId": 3023271275,
  "catModelId": 3023271276
}

Response Body Sample

{
  "id": 3023491496
}

Back to Top