Jump to

• Request
• Response
• Examples

Get Commerce Process Document Modify Options

get

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

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

Request

Path Parameters

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : ResponseCollectionModel_DocModifyItemModel

Type: object

Show Source

• count: integer()
  Title: Count

  Read Only: true

  The number of resource instances returned in the current range.
• hasMore: boolean()
  Title: HasMore

  Read Only: true

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array items
• limit: integer()
  Title: Limit

  Read Only: true

  The actual paging size used by the server.
• offset: integer()
  Title: OffSet

  Read Only: true

  The offset value used in the current page.
• totalResults: integer()
  Title: Total Results

  Read Only: true

  Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "properties":{
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore",
            "readOnly":true
        },
        "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 retrieve modify options for the specified Commerce Process document 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 "Accept: application/json"
https://sitename.oracle.com/rest/v19/commerceProcessSetups/automationStd/documents/transactionLine/modifyTab?limit=10&offset=0&q={"attributeVarName":"contactCity_t"}

Response Body Sample

{

}{
  "offset": 0,
  "limit": 2,
  "count": 2,
  "totalResults": 28,
  "hasMore": true,
  "items": [{
      "attributeId": 3022948822,
      "useFormula": false,
      "overrideModify": false,
      "customAttribute": false,
      "formulaPresent": false,
      "attributeVarName": "_customer_t_company_name",
      "attributeLabel": "Customer Company Name"
    }, {
      "attributeId": 3022948844,
      "useFormula": false,
      "overrideModify": false,
      "customAttribute": false,
      "formulaPresent": false,
      "attributeVarName": "_customer_t_company_name_2",
      "attributeLabel": "Customer Company Name 2"
    }
  ]
}

Back to Top