Jump to

• Request
• Response
• Examples

Update the bill quantity of bill transactions

post

/fscmRestApi/resources/11.13.18.05/projectContractBillTransactions/action/changeBillQuantity

Update the bill quantity of one or more bill transactions using the change bill quantity custom action.

Request

Header Parameters

• Effective-Of: string
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• billQuantity: number
  The new bill quantity for the selected bill transactions, if you're performing a change bill quantity action.
• billTransactionIds: array billTransactionIds
  Unique identifiers of the bill transactions selected to perform a custom action.

{
    "type":"object",
    "properties":{
        "billTransactionIds":{
            "type":"array",
            "description":"Unique identifiers of the bill transactions selected to perform a custom action.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        },
        "billQuantity":{
            "type":"number",
            "description":"The new bill quantity for the selected bill transactions, if you're performing a change bill quantity action.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : billTransactionIds

Type: array

Unique identifiers of the bill transactions selected to perform a custom action.

Show Source

• Array of: number

{
    "type":"array",
    "description":"Unique identifiers of the bill transactions selected to perform a custom action.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  The status of the custom action, indicating whether the operation was successful. Values can be SUCCESS or FAILURE.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            },
            "description":"The status of the custom action, indicating whether the operation was successful. Values can be SUCCESS or FAILURE."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    },
    "description":"The status of the custom action, indicating whether the operation was successful. Values can be SUCCESS or FAILURE."
}

The status of the custom action, indicating whether the operation was successful. Values can be SUCCESS or FAILURE.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top

Examples

The following example shows how to update the bill quantity of bill transactions by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractBillTransactions/action/changeBillQuantity

Request Body Example

The following shows an example of the request body in JSON format.

{

"billQuantity": 20,
"billTransactionIds: [100106159277586, 100106159276892, 100106159272453]

}

Back to Top