Create a joint venture periodic adjustment factor
post
/fscmRestApi/resources/11.13.18.05/jointVenturePeriodicAdjustmentFactors
Request
Header Parameters
-
Metadata-Context:
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:
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
factor: string
Title:
Adjustment Factor
Maximum Length:30
The unique name of the periodic adjustment factor. -
factorDescription: string
Title:
Description
Maximum Length:240
The description of the periodic adjustment factor. -
factorStatus: string
Title:
Status
The status of the periodic adjustment factor. -
factorValues: array
Factor Values
Title:
Factor Values
The factor values resource is used to view, create, update, or delete the values used to adjust overhead methods. -
periodicAdjustmentFactorDFF: array
periodicAdjustmentFactorDFF
Nested Schema : Factor Values
Type:
array
Title:
Factor Values
The factor values resource is used to view, create, update, or delete the values used to adjust overhead methods.
Show Source
Nested Schema : jointVenturePeriodicAdjustmentFactors-factorValues-item-post-request
Type:
Show Source
object
-
factorValueDFF: array
factorValueDFF
-
valuePercentage: number
Title:
Percentage
The percentage to be applied to the overhead method. -
valueStartDate: string
(date)
Title:
Start Date
The start date associated with the factor value.
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
ValueId: integer
(int64)
Title:
Adjustment Factor Value ID
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
FactorId: integer
(int64)
Title:
Periodic Adjustment Factor ID
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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:
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.
Root Schema : jointVenturePeriodicAdjustmentFactors-item-response
Type:
Show Source
object
-
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the resource item. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the resource item was created. -
factor: string
Title:
Adjustment Factor
Maximum Length:30
The unique name of the periodic adjustment factor. -
factorDescription: string
Title:
Description
Maximum Length:240
The description of the periodic adjustment factor. -
factorId: integer
(int64)
Title:
Periodic Adjustment Factor ID
Read Only:true
The unique identifier of the periodic adjustment factor. -
factorStatus: string
Title:
Status
The status of the periodic adjustment factor. -
factorValues: array
Factor Values
Title:
Factor Values
The factor values resource is used to view, create, update, or delete the values used to adjust overhead methods. -
lastFactorValueDate: string
(date)
Title:
Last Start Date
Read Only:true
The last factor value start date in the periodic adjustment factor. -
lastFactorValuePercentage: number
Title:
Last Percentage
Read Only:true
The factor value percent associated with the most recent factor value start date. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the resource item was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the resource item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
periodicAdjustmentFactorDFF: array
periodicAdjustmentFactorDFF
Nested Schema : Factor Values
Type:
array
Title:
Factor Values
The factor values resource is used to view, create, update, or delete the values used to adjust overhead methods.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVenturePeriodicAdjustmentFactors-factorValues-item-response
Type:
Show Source
object
-
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the resource item. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the resource item was created. -
factorValueDFF: array
factorValueDFF
-
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the resource item was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the resource item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
valueAppliedFlag: boolean
Title:
Applied
Read Only:true
Maximum Length:1
Indicates that the factor value has been applied to an overhead method. -
valueId: integer
(int64)
Title:
Adjustment Factor Value ID
Read Only:true
The unique identifier of the factor value. -
valuePercentage: number
Title:
Percentage
The percentage to be applied to the overhead method. -
valueStartDate: string
(date)
Title:
Start Date
The start date associated with the factor value.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVenturePeriodicAdjustmentFactors-factorValues-factorValueDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ValueId: integer
(int64)
Title:
Adjustment Factor Value ID
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : jointVenturePeriodicAdjustmentFactors-periodicAdjustmentFactorDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
FactorId: integer
(int64)
Title:
Periodic Adjustment Factor ID
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- factorValues
-
Parameters:
- factorId:
$request.path.factorId
The factor values resource is used to view, create, update, or delete the values used to adjust overhead methods. - factorId:
- periodicAdjustmentFactorDFF
-
Parameters:
- factorId:
$request.path.factorId
- factorId:
Examples
The following example shows how to create a joint venture periodic adjustment factor by submitting a POST request on the REST resource using cURL.
curl -i -u "username:password" -H "Content-type: application/json" -X POST -d <payload> "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVenturePeriodicAdjustmentFactors"
Request Body Example
The following shows an example of the request body in JSON format.
{ "factorStatus": "Editing", "factor": "COPAS", "factorDescription": "COPAS Overhead Adjustment Factor" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "factorId": 300100572162877, "factor": "COPAS", "factorDescription": "COPAS Overhead Adjustment Factor", "factorStatus": "Editing", "lastFactorValueDate": null, "lastFactorValuePercentage": null, "createdBy": "username", "creationDate": "2023-02-17T04:43:19+00:00", "lastUpdatedBy": "username", "lastUpdateDate": "2023-02-17T04:43:19.023+00:00", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVenturePeriodicAdjustmentFactors/300100572162877", "name": "jointVenturePeriodicAdjustmentFactors", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVenturePeriodicAdjustmentFactors/300100572162877", "name": "jointVenturePeriodicAdjustmentFactors", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVenturePeriodicAdjustmentFactors/300100572162877/child/factorValues", "name": "factorValues", "kind": "collection" } ] }