Create a joint venture periodic adjustment factor
post
/fscmRestApi/resources/11.13.18.05/jointVenturePeriodicAdjustmentFactors
Request
Header Parameters
-
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.
-
Upsert-Mode: string
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 FactorMaximum Length:30The unique name of the periodic adjustment factor. -
factorDescription: string
Title:
DescriptionMaximum Length:240The description of the periodic adjustment factor. -
factorStatus: string
Title:
StatusThe status of the periodic adjustment factor. -
factorValues: array
Factor Values
Title:
Factor ValuesThe 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:
arrayTitle:
Factor ValuesThe 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:
PercentageThe percentage to be applied to the overhead method. -
valueStartDate: string
(date)
Title:
Start DateThe start date associated with the factor value.
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
ValueId: integer
(int64)
Title:
Adjustment Factor Value ID
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext 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 ByRead Only:trueMaximum Length:64The user who created the resource item. -
creationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the resource item was created. -
factor: string
Title:
Adjustment FactorMaximum Length:30The unique name of the periodic adjustment factor. -
factorDescription: string
Title:
DescriptionMaximum Length:240The description of the periodic adjustment factor. -
factorId: integer
(int64)
Title:
Periodic Adjustment Factor IDRead Only:trueThe unique identifier of the periodic adjustment factor. -
factorStatus: string
Title:
StatusThe status of the periodic adjustment factor. -
factorValues: array
Factor Values
Title:
Factor ValuesThe factor values resource is used to view, create, update, or delete the values used to adjust overhead methods. -
lastFactorValueDate: string
(date)
Title:
Last Start DateRead Only:trueThe last factor value start date in the periodic adjustment factor. -
lastFactorValuePercentage: number
Title:
Last PercentageRead Only:trueThe factor value percent associated with the most recent factor value start date. -
lastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the resource item was last updated. -
lastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the resource item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
periodicAdjustmentFactorDFF: array
periodicAdjustmentFactorDFF
Nested Schema : Factor Values
Type:
arrayTitle:
Factor ValuesThe factor values resource is used to view, create, update, or delete the values used to adjust overhead methods.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : jointVenturePeriodicAdjustmentFactors-factorValues-item-response
Type:
Show Source
object-
createdBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the resource item. -
creationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the resource item was created. -
factorValueDFF: array
factorValueDFF
-
lastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the resource item was last updated. -
lastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the resource item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
valueAppliedFlag: boolean
Title:
AppliedRead Only:trueMaximum Length:1Indicates that the factor value has been applied to an overhead method. -
valueId: integer
(int64)
Title:
Adjustment Factor Value IDRead Only:trueThe unique identifier of the factor value. -
valuePercentage: number
Title:
PercentageThe percentage to be applied to the overhead method. -
valueStartDate: string
(date)
Title:
Start DateThe start date associated with the factor value.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ValueId: integer
(int64)
Title:
Adjustment Factor Value ID
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
FactorId: integer
(int64)
Title:
Periodic Adjustment Factor ID -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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"
}
]
}