Get an ownership definition
get
/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/{agreementId}/child/stakeholderGroups/{stakeholderGroupId}/child/ownershipDefinitions/{ownershipDefinitionId}
Request
Path Parameters
-
agreementId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
ownershipDefinitionId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
stakeholderGroupId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : carriedInterestAgreements-stakeholderGroups-ownershipDefinitions-item-response
Type:
Show Source
object
-
activeFlag: boolean
Title:
Invoicing Partner Active
Read Only:true
Ownership Definition Active -
agreement: string
Title:
Agreement
Read Only:true
Maximum Length:30
The name of the carried interest agreement. -
changeReason: string
Title:
Change Reason
Maximum Length:255
Indicates the reason for changing the effective dates on the ownership definition. -
changeReasonAdditionalText: string
Title:
Change Reason Additional Information
Maximum Length:240
Additional information describing the reason for changing the ownership definition. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the ownership definition. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time the ownership definition was created. -
defaultOwnershipDefinitionFlag: boolean
Title:
Default Ownership Definition
Read Only:true
Indicates that the ownership definition is the default ownership definition of the joint venture. -
distributionExist: string
Title:
Distributions Exist
Read Only:true
Indicates whether joint venture distributions exist for the ownership definition. -
effectiveEndDate: string
(date)
Title:
End Date
The end date of the effective date range of the ownership definition. -
effectiveStartDate: string
(date)
Title:
Start Date
The start date of the effective date range of the ownership definition. -
externalStakeholderExistsFlag: boolean
Title:
External Stakeholder Exists
Read Only:true
Internal Stakeholder Exists -
internalStakeholderExistsFlag: boolean
Title:
Internal Stakeholder Exists
Read Only:true
External Stakeholder Exists -
jointVentureDescription: string
Title:
Joint Venture Description
Read Only:true
Maximum Length:240
The description of the joint venture. -
jointVentureName: string
Title:
Joint Venture Name
Read Only:true
Maximum Length:30
The name of the joint venture. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time the ownership definition was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the ownership definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ownershipChangeFlag: boolean
Title:
Ownership Definition Changed
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether the ownership definition has changed and the associated joint venture distributions need to be rebilled. -
ownershipDefinitionDescription: string
Title:
Description
Maximum Length:240
A description of the ownership definition. -
ownershipDefinitionId: integer
(int64)
Title:
Ownership Definition ID
Read Only:true
The unique identifier of the ownership definition. -
ownershipDefinitionShortName: string
Title:
Ownership Definition
Maximum Length:30
The short name of the ownership definition that's used as an identifier across effective dates for the joint venture. -
ownershipDefinitionStatus: string
Title:
Status
Maximum Length:255
The status of the ownership definition. -
ownershipPercentages: array
Ownership Percentages
Title:
Ownership Percentages
The ownership percentages resource is used to view, create, update, or delete each stakeholder's percentage of ownership in an ownership definition. The percentages must total 100% for all stakeholders in the ownership definition. -
ownershipVersion: integer
(int32)
Title:
Ownership Definition Version
Read Only:true
The version number of the ownership definition. -
sourceOwnershipDefinition: string
Title:
Source Ownership Definition
Read Only:true
Maximum Length:30
The name of the ownership definition used as the basis for creating the carried interest ownership definition. -
sourceOwnershipDefinitionDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the ownership definition used as the basis for creating the carried interest ownership definition. -
stakeholderGroup: string
Title:
Stakeholder Group
Read Only:true
Maximum Length:30
The name of the stakeholder group associated with the carried interest ownership definition. -
stakeholderGroupDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the stakeholder group associated with the carried interest ownership definition. -
totalPercentage: integer
Title:
Total Percentage
Read Only:true
The sum of all percentages of ownership in the ownership definition.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Ownership Percentages
Type:
array
Title:
Ownership Percentages
The ownership percentages resource is used to view, create, update, or delete each stakeholder's percentage of ownership in an ownership definition. The percentages must total 100% for all stakeholders in the ownership definition.
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 : carriedInterestAgreements-stakeholderGroups-ownershipDefinitions-ownershipPercentages-item-response
Type:
Show Source
object
-
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the ownership percentage. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the ownership percentage was created. -
distributionOnlyFlag: boolean
Title:
Distribution Only
Maximum Length:1
Indicates that the joint venture stakeholder is only participating in the transaction distribution and isn't being invoiced. -
internalStakeholderFlag: boolean
Title:
Stakeholder Type
Read Only:true
Maximum Length:1
Indicates that the joint venture stakeholder is an internal stakeholder. -
invoicingPartnerId: integer
(int64)
Title:
Invoicing Partner ID
Read Only:true
The unique identifier of the invoicing partner. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time the ownership percentage was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the ownership percentage. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ownershipDefinitionName: string
Title:
Ownership Definition
Read Only:true
Maximum Length:30
The name of the ownership definition. -
ownershipPercentageId: integer
(int64)
Title:
Ownership Percentage ID
Read Only:true
The unique identifier of the ownership percentage. -
percentageOfInterest: number
Title:
Ownership Percentage
Default Value:0
The percent of ownership a stakeholder has in a joint venture transaction. -
roundingPartnerFlag: boolean
Title:
Rounding Partner
Maximum Length:1
Indicates that the joint venture stakeholder is the rounding partner, receiving any extra cost or revenue after the split. Only one stakeholder in an ownership definition can be the rounding partner. -
stakeholderDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the joint venture stakeholder. -
stakeholderName: string
Title:
Stakeholder
The name of the joint venture stakeholder.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ownershipPercentages
-
Parameters:
- agreementId:
$request.path.agreementId
- ownershipDefinitionId:
$request.path.ownershipDefinitionId
- stakeholderGroupId:
$request.path.stakeholderGroupId
The ownership percentages resource is used to view, create, update, or delete each stakeholder's percentage of ownership in an ownership definition. The percentages must total 100% for all stakeholders in the ownership definition. - agreementId: