Create a distributable project rule
post
/fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/distributableProjectRules
Request
Path Parameters
-
jointVentureId(required): integer(int64)
The unique identifier of the joint venture.
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
-
distributableProjectDFF: array
distributableProjectDFF
-
expenditureType: string
Title:
Expenditure Type Name
The name of the expenditure type. -
project: string
Title:
Project Number
The number of the project. -
task: string
Title:
Task Number
The number of the task.
Nested Schema : jointVentures-distributableProjectRules-distributableProjectDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
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 : jointVentures-distributableProjectRules-item-response
Type:
Show Source
object
-
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the distributable project rule. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the distributable project rule was created. -
distributableProjectDFF: array
distributableProjectDFF
-
distributableProjectRuleId: integer
(int64)
Title:
Distributable Project Rule ID
Read Only:true
The unique identifier of the distributable project rule. -
expenditureType: string
Title:
Expenditure Type Name
The name of the expenditure type. -
expenditureTypeDescription: string
Title:
Expenditure Type Description
Read Only:true
The description of the expenditure type. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the distributable project rule was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the distributable project rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
project: string
Title:
Project Number
The number of the project. -
projectName: string
Title:
Project Name
Read Only:true
The name of the project. -
task: string
Title:
Task Number
The number of the task. -
taskName: string
Title:
Task Name
Read Only:true
The name of the task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentures-distributableProjectRules-distributableProjectDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
DistributableProjectValueId: integer
(int64)
Title:
Distributable Project Rule ID
Read Only:true
-
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
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.
Links
- distributableProjectDFF
-
Parameters:
- distributableProjectRuleId:
$request.path.distributableProjectRuleId
- jointVentureId:
$request.path.jointVentureId
- distributableProjectRuleId:
Examples
The following example shows how to create a distributable project rule 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/jointVentures/300100542316822/child/distributableProjectRules"
Request Body Example
The following shows an example of the request body in JSON format.
{ "expenditureType": "", "project": "04 - Apollo Capital Project", "task": "" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "distributableProjectRuleId": 300100545781269, "project": "04 - Apollo Capital Project", "task": null, "expenditureType": null, "createdBy": "username", "creationDate": "2021-03-08T11:01:36+00:00", "lastUpdatedBy": "username", "lastUpdateDate": "2021-03-08T11:01:36.025+00:00", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentures/300100542316822/child/distributableProjectRules/300100545781269", "name": "distributableProjectRules", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentures/300100542316822/child/distributableProjectRules/300100545781269", "name": "distributableProjectRules", "kind": "item" }, { "rel": "parent", "href": "servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentures/300100542316822", "name": "jointVentures", "kind": "item" } ] }