Jump to

• Request
• Response
• Examples

Update Commerce Process Document Modify Options

patch

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

Use this endpoint to update modify options for the specified Commerce Process document.

Request

Supported Media Types

• application/json

Path Parameters

• docVarName(required): string
• processVarName(required): string

Body ()

Root Schema : DocModifyRequestModel

Type: object

Show Source

• items: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object DocModifyItemModel

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

Nested Schema : DocModifyItemModel

Type: object

Show Source

• attributeId: integer()
  Title: Attribute Id

  Id of the attribute
• attributeLabel: string()
  Title: Attribute Label

  Display Label of the attribute
• attributeVarName: string()
  Title: Attribute Variable Name

  Variable Name of the attribute
• customAttribute: boolean()
  Title: Is Custom Attribute

  Specifies whether the attribute is custom or not
• formulaPresent: boolean()
  Title: Has Formula

  Specifies whether the attribute has formula defined
• overrideModify: boolean()
  Title: Override Modify

  Specifies whether the standard option should be overridden
• useFormula: boolean()
  Title: Use Formula

  Specifies whether formula should be used or not

{
    "properties":{
        "attributeId":{
            "type":"integer",
            "format":"",
            "description":"Id of the attribute",
            "title":"Attribute Id"
        },
        "useFormula":{
            "type":"boolean",
            "format":"",
            "description":"Specifies whether formula should be used or not",
            "title":"Use Formula"
        },
        "overrideModify":{
            "type":"boolean",
            "format":"",
            "description":"Specifies whether the standard option should be overridden",
            "title":"Override Modify"
        },
        "customAttribute":{
            "type":"boolean",
            "format":"",
            "description":"Specifies whether the attribute is custom or not",
            "title":"Is Custom Attribute"
        },
        "formulaPresent":{
            "type":"boolean",
            "format":"",
            "description":"Specifies whether the attribute has formula defined",
            "title":"Has Formula"
        },
        "attributeVarName":{
            "type":"string",
            "format":"",
            "description":"Variable Name of the attribute",
            "title":"Attribute Variable Name"
        },
        "attributeLabel":{
            "type":"string",
            "format":"",
            "description":"Display Label of the attribute",
            "title":"Attribute Label"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : DocModifyRequestModel

Type: object

Show Source

• items: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object DocModifyItemModel

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

Nested Schema : DocModifyItemModel

Type: object

Show Source

• attributeId: integer()
  Title: Attribute Id

  Id of the attribute
• attributeLabel: string()
  Title: Attribute Label

  Display Label of the attribute
• attributeVarName: string()
  Title: Attribute Variable Name

  Variable Name of the attribute
• customAttribute: boolean()
  Title: Is Custom Attribute

  Specifies whether the attribute is custom or not
• formulaPresent: boolean()
  Title: Has Formula

  Specifies whether the attribute has formula defined
• overrideModify: boolean()
  Title: Override Modify

  Specifies whether the standard option should be overridden
• useFormula: boolean()
  Title: Use Formula

  Specifies whether formula should be used or not

{
    "properties":{
        "attributeId":{
            "type":"integer",
            "format":"",
            "description":"Id of the attribute",
            "title":"Attribute Id"
        },
        "useFormula":{
            "type":"boolean",
            "format":"",
            "description":"Specifies whether formula should be used or not",
            "title":"Use Formula"
        },
        "overrideModify":{
            "type":"boolean",
            "format":"",
            "description":"Specifies whether the standard option should be overridden",
            "title":"Override Modify"
        },
        "customAttribute":{
            "type":"boolean",
            "format":"",
            "description":"Specifies whether the attribute is custom or not",
            "title":"Is Custom Attribute"
        },
        "formulaPresent":{
            "type":"boolean",
            "format":"",
            "description":"Specifies whether the attribute has formula defined",
            "title":"Has Formula"
        },
        "attributeVarName":{
            "type":"string",
            "format":"",
            "description":"Variable Name of the attribute",
            "title":"Attribute Variable Name"
        },
        "attributeLabel":{
            "type":"string",
            "format":"",
            "description":"Display Label of the attribute",
            "title":"Attribute Label"
        }
    }
}

Back to Top

Examples

The following example shows how to update modify options for the specified Commerce Process document by submitting a PATCH request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X PATCH -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/commerceProcessSetups/automationStd/documents/transactionLine/modifyTab

Request Body Sample

{
  "items": [
    {
      "attributeId": 3022948910,
      "useFormula": true,
      "overrideModify": false,
      "customAttribute": false,
      "attributeVarName": "_customer_t_city"
    }
  ]
}

Back to Top