Jump to

• Request
• Response
• Examples

Create a Commerce Process Document

post

/rest/v19/commerceProcessSetups/{processVarName}/documents

Use this endpoint to create a main document or sub-document for the specified Commerce Process.

Request

Supported Media Types

• application/json

Path Parameters

• processVarName(required): string

Body ()

Root Schema : DocumentRequestModel

Type: object

Show Source

• coverageEnabled: boolean()
  Title: Coverage Enabled

  Indicates whether Coverage feature is enabled
• coverageMapping: Coverage Mapping
  Title: Coverage Mapping

  Property object for storing coverage related mappings
• cvgStdDefaultOverride: boolean()
  Title: Coverage Standard Default Override

  Specifies whether the standard coverage options are overridden
• description: string()
  Title: Description

  Description of the Document
• id: integer()
  Title: Id

  Id of the document
• label: string()
  Title: Label

  Label of the Document
• modifyRuleExecPolicy: boolean()
  Title: Modify Rule Exec Policy

  Indicates whether Modify Rule Exec Policy is enabled
• opportunityIdMapping: string()
  Title: Opportunity Id Mapping

  Field that store the field name of mapped opportunity Id
• postAdvancedDefault: Post Advanced Modify
  Title: Post Advanced Modify

  Property object for Post Advanced Modify
• postAutoUpdate: Pre Auto Update
  Title: Pre Auto Update

  Property object for Pre Auto Update
• preAdvancedDefault: Pre Advanced Modify
  Title: Pre Advanced Modify

  Property object for Pre Advanced Modify
• preAutoUpdate: Pre Auto Update
  Title: Pre Auto Update

  Property object for Pre Auto Update
• subDocId: integer()
  Title: Sub Document Id

  Document Id of the linked Sub Document
• type: integer()
  Title: Type

  Type of the Document (Sub or Main)
• variableName: string()
  Title: Variable Name

  Variable Name of the Document

{
    "properties":{
        "subDocId":{
            "type":"integer",
            "format":"",
            "description":"Document Id of the linked Sub Document",
            "title":"Sub Document Id"
        },
        "label":{
            "type":"string",
            "format":"",
            "description":"Label of the Document",
            "title":"Label"
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"Variable Name of the Document",
            "title":"Variable Name"
        },
        "type":{
            "type":"integer",
            "format":"",
            "description":"Type of the Document (Sub or Main)",
            "title":"Type"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the Document",
            "title":"Description"
        },
        "opportunityIdMapping":{
            "type":"string",
            "format":"",
            "description":"Field that store the field name of mapped opportunity Id",
            "title":"Opportunity Id Mapping"
        },
        "modifyRuleExecPolicy":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether Modify Rule Exec Policy is enabled",
            "title":"Modify Rule Exec Policy"
        },
        "preAutoUpdate":{
            "format":"",
            "description":"Property object for Pre Auto Update",
            "title":"Pre Auto Update",
            "allOf":[
                {
                    "$ref":"#/definitions/DocumentOverrideStdPropsModel"
                }
            ]
        },
        "postAutoUpdate":{
            "format":"",
            "description":"Property object for Pre Auto Update",
            "title":"Pre Auto Update",
            "allOf":[
                {
                    "$ref":"#/definitions/DocumentOverrideStdPropsModel"
                }
            ]
        },
        "coverageEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether Coverage feature is enabled",
            "title":"Coverage Enabled"
        },
        "cvgStdDefaultOverride":{
            "type":"boolean",
            "format":"",
            "description":"Specifies whether the standard coverage options are overridden",
            "title":"Coverage Standard Default Override"
        },
        "coverageMapping":{
            "format":"",
            "description":"Property object for storing coverage related mappings",
            "title":"Coverage Mapping",
            "allOf":[
                {
                    "$ref":"#/definitions/CoverageMappingResourceModel"
                }
            ]
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"Id of the document",
            "title":"Id"
        },
        "preAdvancedDefault":{
            "format":"",
            "description":"Property object for Pre Advanced Modify",
            "title":"Pre Advanced Modify",
            "allOf":[
                {
                    "$ref":"#/definitions/DocumentOverrideStdPropsModel"
                }
            ]
        },
        "postAdvancedDefault":{
            "format":"",
            "description":"Property object for Post Advanced Modify",
            "title":"Post Advanced Modify",
            "allOf":[
                {
                    "$ref":"#/definitions/DocumentOverrideStdPropsModel"
                }
            ]
        }
    }
}

Nested Schema : Coverage Mapping

Title: Coverage Mapping

Property object for storing coverage related mappings

Match All

Property object for storing coverage related mappings

Show Source

• object CoverageMappingResourceModel

{
    "format":"",
    "description":"Property object for storing coverage related mappings",
    "title":"Coverage Mapping",
    "allOf":[
        {
            "$ref":"#/definitions/CoverageMappingResourceModel"
        }
    ]
}

Nested Schema : Post Advanced Modify

Title: Post Advanced Modify

Property object for Post Advanced Modify

Match All

Property object for Post Advanced Modify

Show Source

• object DocumentOverrideStdPropsModel

{
    "format":"",
    "description":"Property object for Post Advanced Modify",
    "title":"Post Advanced Modify",
    "allOf":[
        {
            "$ref":"#/definitions/DocumentOverrideStdPropsModel"
        }
    ]
}

Nested Schema : Pre Auto Update

Title: Pre Auto Update

Property object for Pre Auto Update

Match All

Property object for Pre Auto Update

Show Source

• object DocumentOverrideStdPropsModel

{
    "format":"",
    "description":"Property object for Pre Auto Update",
    "title":"Pre Auto Update",
    "allOf":[
        {
            "$ref":"#/definitions/DocumentOverrideStdPropsModel"
        }
    ]
}

Nested Schema : Pre Advanced Modify

Title: Pre Advanced Modify

Property object for Pre Advanced Modify

Match All

Property object for Pre Advanced Modify

Show Source

• object DocumentOverrideStdPropsModel

{
    "format":"",
    "description":"Property object for Pre Advanced Modify",
    "title":"Pre Advanced Modify",
    "allOf":[
        {
            "$ref":"#/definitions/DocumentOverrideStdPropsModel"
        }
    ]
}

Nested Schema : Pre Auto Update

Title: Pre Auto Update

Property object for Pre Auto Update

Match All

Property object for Pre Auto Update

Show Source

• object DocumentOverrideStdPropsModel

{
    "format":"",
    "description":"Property object for Pre Auto Update",
    "title":"Pre Auto Update",
    "allOf":[
        {
            "$ref":"#/definitions/DocumentOverrideStdPropsModel"
        }
    ]
}

Nested Schema : CoverageMappingResourceModel

Type: object

Show Source

• coverageLineNo: integer()
  Title: Coverage Line Number

  Attribute Id of field that stores Coverage Product's Line Number
• coverageOrderNo: integer()
  Title: Coverage Order Number

  Attribute Id of field that stores Coverage Product's Order Number
• customerID: integer()
  Title: Customer ID

  Attribute Id of field that stores Customer ID
• orderNo: integer()
  Title: Order Number

  Attribute Id of field that stores Covered Product's Order Number
• quantity: integer()
  Title: Quantity

  Attribute Id of field that stores Quantity
• unitOfMeasure: integer()
  Title: Unit Of Measure

  Attribute Id of field that stores Unit Of Measure

{
    "properties":{
        "coverageOrderNo":{
            "type":"integer",
            "format":"",
            "description":"Attribute Id of field that stores Coverage Product's Order Number",
            "title":"Coverage Order Number"
        },
        "coverageLineNo":{
            "type":"integer",
            "format":"",
            "description":"Attribute Id of field that stores Coverage Product's Line Number",
            "title":"Coverage Line Number"
        },
        "unitOfMeasure":{
            "type":"integer",
            "format":"",
            "description":"Attribute Id of field that stores Unit Of Measure",
            "title":"Unit Of Measure"
        },
        "quantity":{
            "type":"integer",
            "format":"",
            "description":"Attribute Id of field that stores Quantity",
            "title":"Quantity"
        },
        "orderNo":{
            "type":"integer",
            "format":"",
            "description":"Attribute Id of field that stores Covered Product's Order Number",
            "title":"Order Number"
        },
        "customerID":{
            "type":"integer",
            "format":"",
            "description":"Attribute Id of field that stores Customer ID",
            "title":"Customer ID"
        }
    }
}

Nested Schema : DocumentOverrideStdPropsModel

Type: object

Show Source

• functionDefined: boolean()
  Title: Function Defined

  Specifies whether Function is Defined
• functionValid: boolean
• overrideEnabled: boolean()
  Title: Override Enabled

  Specifies whether the standard option is overridden

{
    "properties":{
        "overrideEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Specifies whether the standard option is overridden",
            "title":"Override Enabled"
        },
        "functionDefined":{
            "type":"boolean",
            "format":"",
            "description":"Specifies whether Function is Defined",
            "title":"Function Defined"
        },
        "functionValid":{
            "type":"boolean"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : DocumentRequestModel

Type: object

Show Source

• coverageEnabled: boolean()
  Title: Coverage Enabled

  Indicates whether Coverage feature is enabled
• coverageMapping: Coverage Mapping
  Title: Coverage Mapping

  Property object for storing coverage related mappings
• cvgStdDefaultOverride: boolean()
  Title: Coverage Standard Default Override

  Specifies whether the standard coverage options are overridden
• description: string()
  Title: Description

  Description of the Document
• id: integer()
  Title: Id

  Id of the document
• label: string()
  Title: Label

  Label of the Document
• modifyRuleExecPolicy: boolean()
  Title: Modify Rule Exec Policy

  Indicates whether Modify Rule Exec Policy is enabled
• opportunityIdMapping: string()
  Title: Opportunity Id Mapping

  Field that store the field name of mapped opportunity Id
• postAdvancedDefault: Post Advanced Modify
  Title: Post Advanced Modify

  Property object for Post Advanced Modify
• postAutoUpdate: Pre Auto Update
  Title: Pre Auto Update

  Property object for Pre Auto Update
• preAdvancedDefault: Pre Advanced Modify
  Title: Pre Advanced Modify

  Property object for Pre Advanced Modify
• preAutoUpdate: Pre Auto Update
  Title: Pre Auto Update

  Property object for Pre Auto Update
• subDocId: integer()
  Title: Sub Document Id

  Document Id of the linked Sub Document
• type: integer()
  Title: Type

  Type of the Document (Sub or Main)
• variableName: string()
  Title: Variable Name

  Variable Name of the Document

{
    "properties":{
        "subDocId":{
            "type":"integer",
            "format":"",
            "description":"Document Id of the linked Sub Document",
            "title":"Sub Document Id"
        },
        "label":{
            "type":"string",
            "format":"",
            "description":"Label of the Document",
            "title":"Label"
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"Variable Name of the Document",
            "title":"Variable Name"
        },
        "type":{
            "type":"integer",
            "format":"",
            "description":"Type of the Document (Sub or Main)",
            "title":"Type"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the Document",
            "title":"Description"
        },
        "opportunityIdMapping":{
            "type":"string",
            "format":"",
            "description":"Field that store the field name of mapped opportunity Id",
            "title":"Opportunity Id Mapping"
        },
        "modifyRuleExecPolicy":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether Modify Rule Exec Policy is enabled",
            "title":"Modify Rule Exec Policy"
        },
        "preAutoUpdate":{
            "format":"",
            "description":"Property object for Pre Auto Update",
            "title":"Pre Auto Update",
            "allOf":[
                {
                    "$ref":"#/definitions/DocumentOverrideStdPropsModel"
                }
            ]
        },
        "postAutoUpdate":{
            "format":"",
            "description":"Property object for Pre Auto Update",
            "title":"Pre Auto Update",
            "allOf":[
                {
                    "$ref":"#/definitions/DocumentOverrideStdPropsModel"
                }
            ]
        },
        "coverageEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether Coverage feature is enabled",
            "title":"Coverage Enabled"
        },
        "cvgStdDefaultOverride":{
            "type":"boolean",
            "format":"",
            "description":"Specifies whether the standard coverage options are overridden",
            "title":"Coverage Standard Default Override"
        },
        "coverageMapping":{
            "format":"",
            "description":"Property object for storing coverage related mappings",
            "title":"Coverage Mapping",
            "allOf":[
                {
                    "$ref":"#/definitions/CoverageMappingResourceModel"
                }
            ]
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"Id of the document",
            "title":"Id"
        },
        "preAdvancedDefault":{
            "format":"",
            "description":"Property object for Pre Advanced Modify",
            "title":"Pre Advanced Modify",
            "allOf":[
                {
                    "$ref":"#/definitions/DocumentOverrideStdPropsModel"
                }
            ]
        },
        "postAdvancedDefault":{
            "format":"",
            "description":"Property object for Post Advanced Modify",
            "title":"Post Advanced Modify",
            "allOf":[
                {
                    "$ref":"#/definitions/DocumentOverrideStdPropsModel"
                }
            ]
        }
    }
}

Nested Schema : Coverage Mapping

Title: Coverage Mapping

Property object for storing coverage related mappings

Match All

Property object for storing coverage related mappings

Show Source

• object CoverageMappingResourceModel

{
    "format":"",
    "description":"Property object for storing coverage related mappings",
    "title":"Coverage Mapping",
    "allOf":[
        {
            "$ref":"#/definitions/CoverageMappingResourceModel"
        }
    ]
}

Nested Schema : Post Advanced Modify

Title: Post Advanced Modify

Property object for Post Advanced Modify

Match All

Property object for Post Advanced Modify

Show Source

• object DocumentOverrideStdPropsModel

{
    "format":"",
    "description":"Property object for Post Advanced Modify",
    "title":"Post Advanced Modify",
    "allOf":[
        {
            "$ref":"#/definitions/DocumentOverrideStdPropsModel"
        }
    ]
}

Nested Schema : Pre Auto Update

Title: Pre Auto Update

Property object for Pre Auto Update

Match All

Property object for Pre Auto Update

Show Source

• object DocumentOverrideStdPropsModel

{
    "format":"",
    "description":"Property object for Pre Auto Update",
    "title":"Pre Auto Update",
    "allOf":[
        {
            "$ref":"#/definitions/DocumentOverrideStdPropsModel"
        }
    ]
}

Nested Schema : Pre Advanced Modify

Title: Pre Advanced Modify

Property object for Pre Advanced Modify

Match All

Property object for Pre Advanced Modify

Show Source

• object DocumentOverrideStdPropsModel

{
    "format":"",
    "description":"Property object for Pre Advanced Modify",
    "title":"Pre Advanced Modify",
    "allOf":[
        {
            "$ref":"#/definitions/DocumentOverrideStdPropsModel"
        }
    ]
}

Nested Schema : Pre Auto Update

Title: Pre Auto Update

Property object for Pre Auto Update

Match All

Property object for Pre Auto Update

Show Source

• object DocumentOverrideStdPropsModel

{
    "format":"",
    "description":"Property object for Pre Auto Update",
    "title":"Pre Auto Update",
    "allOf":[
        {
            "$ref":"#/definitions/DocumentOverrideStdPropsModel"
        }
    ]
}

Nested Schema : CoverageMappingResourceModel

Type: object

Show Source

• coverageLineNo: integer()
  Title: Coverage Line Number

  Attribute Id of field that stores Coverage Product's Line Number
• coverageOrderNo: integer()
  Title: Coverage Order Number

  Attribute Id of field that stores Coverage Product's Order Number
• customerID: integer()
  Title: Customer ID

  Attribute Id of field that stores Customer ID
• orderNo: integer()
  Title: Order Number

  Attribute Id of field that stores Covered Product's Order Number
• quantity: integer()
  Title: Quantity

  Attribute Id of field that stores Quantity
• unitOfMeasure: integer()
  Title: Unit Of Measure

  Attribute Id of field that stores Unit Of Measure

{
    "properties":{
        "coverageOrderNo":{
            "type":"integer",
            "format":"",
            "description":"Attribute Id of field that stores Coverage Product's Order Number",
            "title":"Coverage Order Number"
        },
        "coverageLineNo":{
            "type":"integer",
            "format":"",
            "description":"Attribute Id of field that stores Coverage Product's Line Number",
            "title":"Coverage Line Number"
        },
        "unitOfMeasure":{
            "type":"integer",
            "format":"",
            "description":"Attribute Id of field that stores Unit Of Measure",
            "title":"Unit Of Measure"
        },
        "quantity":{
            "type":"integer",
            "format":"",
            "description":"Attribute Id of field that stores Quantity",
            "title":"Quantity"
        },
        "orderNo":{
            "type":"integer",
            "format":"",
            "description":"Attribute Id of field that stores Covered Product's Order Number",
            "title":"Order Number"
        },
        "customerID":{
            "type":"integer",
            "format":"",
            "description":"Attribute Id of field that stores Customer ID",
            "title":"Customer ID"
        }
    }
}

Nested Schema : DocumentOverrideStdPropsModel

Type: object

Show Source

• functionDefined: boolean()
  Title: Function Defined

  Specifies whether Function is Defined
• functionValid: boolean
• overrideEnabled: boolean()
  Title: Override Enabled

  Specifies whether the standard option is overridden

{
    "properties":{
        "overrideEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Specifies whether the standard option is overridden",
            "title":"Override Enabled"
        },
        "functionDefined":{
            "type":"boolean",
            "format":"",
            "description":"Specifies whether Function is Defined",
            "title":"Function Defined"
        },
        "functionValid":{
            "type":"boolean"
        }
    }
}

Back to Top

Examples

The following example shows how to create a main document or sub-document 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/documents

Request Body Samples

Main Document Sample

{
  "variableName": "maindocument_c",
  "label": "Main document",
  "description": "Description for the main document",
  "type": 0,
  "opportunityIdMapping": "transaction.opportunityNumber"
}

Sub-Document Sample

{
  "variableName": "subdocument_c",
  "label": "Sub document",
  "description": "Description for the sub document",
  "type": 1
}

Response Body Samples

Main Document Sample

{
  "id": 1543613,
  "variableName": "maindocument_c",
  "label": "Main document",
  "description": "Description for the main document",
  "type": 0
}

Sub-Document Sample

{
  "id": 1543614,
  "variableName": "subdocument_c",
  "label": "Sub document",
  "description": "Description for the sub document",
  "type": 1
}

Back to Top