Create an assignment rule
post
/fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules
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
-
account: string
Title:
Transaction Source Account
Maximum Length:255
The formatted account combination used to select joint venture transactions for the assignment rule. -
accountSet: string
Title:
Account Set
The name of the account set used to select joint venture transactions for the assignment rule. -
assignmentRule: string
Title:
Assignment Rule
Maximum Length:30
The name of the assignment rule. -
assignmentRuleDescription: string
Title:
Description
Maximum Length:240
The description of the assignment rule. -
assignmentRuleDFF: array
assignmentRuleDFF
-
directBilledStakeholder: string
Title:
Direct Billed Stakeholder
The name of the stakeholder to assign to the selected joint venture transactions for the assignment rule. -
endDate: string
(date)
Title:
End Date
The end date of the assignment rule. -
jointVenture: string
Title:
Joint Venture
The unique name of the joint venture. -
jointVentureDescription: string
Title:
Description
The description of the joint venture. -
ownershipDefinition: string
Title:
Ownership Definition
Maximum Length:30
The ownership definition name to assign to the selected joint venture transactions for the assignment rule. -
projectSet: string
Title:
Project Set
Maximum Length:30
The name of the project set used to select joint venture transactions for the assignment rule. -
projectValueSets: array
Project Value Sets
Title:
Project Value Sets
The project value sets resource is used to view, create, update, or delete project value sets for an assignment rule. -
sequenceNumber: integer
(int32)
Title:
Processing Sequence
The sequence number of the assignment rule. -
startDate: string
(date)
Title:
Start Date
The start date of the assignment rule. -
status: string
Title:
Status
The status of the assignment rule. -
structureInstanceNumber: integer
Title:
Structure Instance Number
The unique identifier of the chart of accounts assigned to the primary ledger of the business unit associated with the joint venture.
Nested Schema : Project Value Sets
Type:
array
Title:
Project Value Sets
The project value sets resource is used to view, create, update, or delete project value sets for an assignment rule.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
AssignmentRuleId: integer
(int64)
Title:
Assignment Rule ID
Nested Schema : schema
Type:
Show Source
object
-
expenditureType: string
Title:
Expenditure Type
Maximum Length:240
The name of the expenditure type. -
project: string
Title:
Project Number
Maximum Length:25
The number of the project. -
projectValueSetDFF: array
projectValueSetDFF
-
task: string
Title:
Task Number
Maximum Length:100
The number of the task.
Nested Schema : jointVentureAssignmentRules-projectValueSets-projectValueSetDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
ProjectValueSetId: integer
(int64)
Title:
Project Value Set 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 : jointVentureAssignmentRules-item-response
Type:
Show Source
object
-
account: string
Title:
Transaction Source Account
Maximum Length:255
The formatted account combination used to select joint venture transactions for the assignment rule. -
accountSet: string
Title:
Account Set
The name of the account set used to select joint venture transactions for the assignment rule. -
assignmentRule: string
Title:
Assignment Rule
Maximum Length:30
The name of the assignment rule. -
assignmentRuleDescription: string
Title:
Description
Maximum Length:240
The description of the assignment rule. -
assignmentRuleDFF: array
assignmentRuleDFF
-
assignmentRuleId: integer
(int64)
Title:
Assignment Rule ID
Read Only:true
The unique identifier of the assignment rule. -
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. -
directBilledStakeholder: string
Title:
Direct Billed Stakeholder
The name of the stakeholder to assign to the selected joint venture transactions for the assignment rule. -
endDate: string
(date)
Title:
End Date
The end date of the assignment rule. -
jointVenture: string
Title:
Joint Venture
The unique name of the joint venture. -
jointVentureDescription: string
Title:
Description
The description of the joint venture. -
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. -
ownershipDefinition: string
Title:
Ownership Definition
Maximum Length:30
The ownership definition name to assign to the selected joint venture transactions for the assignment rule. -
projectSet: string
Title:
Project Set
Maximum Length:30
The name of the project set used to select joint venture transactions for the assignment rule. -
projectValueSets: array
Project Value Sets
Title:
Project Value Sets
The project value sets resource is used to view, create, update, or delete project value sets for an assignment rule. -
sequenceNumber: integer
(int32)
Title:
Processing Sequence
The sequence number of the assignment rule. -
startDate: string
(date)
Title:
Start Date
The start date of the assignment rule. -
status: string
Title:
Status
The status of the assignment rule. -
structureInstanceNumber: integer
Title:
Structure Instance Number
The unique identifier of the chart of accounts assigned to the primary ledger of the business unit associated with the joint venture. -
transactionAssignmentsExistFlag: boolean
Title:
Transaction Assignments Exist
Read Only:true
Maximum Length:1
Indicates whether there are existing joint venture transactions that have been updated with ownership definition or direct billed stakeholder values by an assignment rule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Project Value Sets
Type:
array
Title:
Project Value Sets
The project value sets resource is used to view, create, update, or delete project value sets for an assignment rule.
Show Source
Nested Schema : jointVentureAssignmentRules-assignmentRuleDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
AssignmentRuleId: integer
(int64)
Title:
Assignment Rule 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
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 : jointVentureAssignmentRules-projectValueSets-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. -
expenditureType: string
Title:
Expenditure Type
Maximum Length:240
The name of the expenditure type. -
expenditureTypeDescription: string
Title:
Expenditure Type Description
Read Only:true
Maximum Length:2000
The description of the expenditure type. -
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. -
project: string
Title:
Project Number
Maximum Length:25
The number of the project. -
projectName: string
Title:
Project Name
Read Only:true
Maximum Length:240
The name of the project. -
projectValueSetDFF: array
projectValueSetDFF
-
projectValueSetId: integer
(int64)
Title:
Project Value Set ID
Read Only:true
The unique identifier of the project value set. -
task: string
Title:
Task Number
Maximum Length:100
The number of the task. -
taskName: string
Title:
Task Name
Read Only:true
Maximum Length:255
The name of the task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureAssignmentRules-projectValueSets-projectValueSetDFF-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. -
ProjectValueSetId: integer
(int64)
Title:
Project Value Set ID
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- assignmentRuleDFF
-
Parameters:
- assignmentRuleId:
$request.path.assignmentRuleId
- assignmentRuleId:
- projectValueSets
-
Parameters:
- assignmentRuleId:
$request.path.assignmentRuleId
The project value sets resource is used to view, create, update, or delete project value sets for an assignment rule. - assignmentRuleId:
Examples
The following example shows how to create an assignment 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/jointVentureAssignmentRules"
Example Request Body
The following shows an example of the request body in JSON format.
{ "account":"11-1004-11016-31-0001", "accountSet":null, "assignmentRule":"VISION_FAC", "assignmentRuleDescription":"VISIONCORP Facilities- JV20", "directBilledStakeholder":"ALBERTA_1002", "endDate":"2022-03-09", "jointVenture":"ALBERTA", "ownershipDefinition":null, "startDate":"2022-03-07", "status":"Editing" }
Example Response Body
The following shows an example of the response body in JSON format.
{ "assignmentRuleId":300100549962473, "assignmentRule":"VISION_FAC", "assignmentRuleDescription":"VISIONCORP Facilities- JV20", "jointVenture":"ALBERTA", "jointVentureDescription":"Alberta OilSands", "startDate":"2022-03-07", "endDate":"2022-03-09", "status":"Editing", "ownershipDefinition":null, "directBilledStakeholder":"ALBERTA_1002", "accountSet":null, "structureInstanceNumber":46521, "account":"11-1004-11016-31-0001", "createdBy":"username", "creationDate":"2022-03-07T06:34:33+00:00", "lastUpdatedBy":"username", "lastUpdateDate":"2022-03-07T06:34:33.387+00:00", "transactionAssignmentsExistFlag":false, "links":[ { "rel":"self", "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/300100549962473", "name":"jointVentureAssignmentRules", "kind":"item", "properties":{ "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel":"canonical", "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/300100549962473", "name":"jointVentureAssignmentRules", "kind":"item" }, { "rel":"child", "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/300100549962473/child/assignmentRuleDFF", "name":"assignmentRuleDFF", "kind":"collection" }, { "rel":"child", "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/300100549962473/child/projectValueSets", "name":"projectValueSets", "kind":"collection" } ] }