Jump to

• Request
• Response
• Examples

Get a joint venture transaction change

get

/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedTransactions/{transactionId}/child/transactionChanges/{transactionChangeId}

Request

Path Parameters

• transactionChangeId(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=
• transactionId(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 Top

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.

Body ()

Root Schema : jointVentureGeneratedTransactions-transactionChanges-item-response

Type: object

Show Source

• afterAssignmentRule: string
  Title: After Assignment Rule

  Read Only: true

  Maximum Length: 30

  The new ownership definition assignment rule assigned to the transaction.
• afterDistributionOnlyFlag: boolean
  Title: After Distribution Only

  Read Only: true

  Maximum Length: 1

  The new distribution only value assigned to the transaction.
• afterOwnershipDefinition: string
  Title: After Ownership Definition

  Read Only: true

  Maximum Length: 30

  The new ownership definition assigned to the transaction.
• afterStakeholder: string
  Title: After Direct Billed Stakeholder

  Read Only: true

  Maximum Length: 30

  The new name of the direct billed stakeholder assigned to the transaction.
• afterStakeholderDescription: string
  Title: After Direct Billed Stakeholder Description

  Read Only: true

  Maximum Length: 240

  The new description of the direct billed stakeholder assigned to the transaction.
• afterStatus: string
  Title: After Status

  Read Only: true

  Maximum Length: 80

  The new status assigned to the transaction.
• afterTransactionDate: string (date)
  Title: After Transaction Date

  Read Only: true

  The new transaction date assigned to the transaction.
• beforeAssignmentRule: string
  Title: Before Assignment Rule

  Read Only: true

  Maximum Length: 30

  The previous ownership definition assignment rule assigned to the transaction.
• beforeDistributionOnlyFlag: boolean
  Title: Before Distribution Only

  Read Only: true

  Maximum Length: 1

  The previous distribution only value assigned to the transaction.
• beforeOwnershipDefinition: string
  Title: Before Ownership Definition

  Read Only: true

  Maximum Length: 30

  The previous ownership definition assigned to the transaction.
• beforeStakeholder: string
  Title: Before Direct Billed Stakeholder

  Read Only: true

  Maximum Length: 30

  The previous name of the direct billed stakeholder assigned to the transaction.
• beforeStakeholderDescription: string
  Title: Before Direct Billed Stakeholder Description

  Read Only: true

  Maximum Length: 240

  The previous description of the direct billed stakeholder assigned to the transaction.
• beforeStatus: string
  Title: Before Status

  Read Only: true

  Maximum Length: 80

  The previous status assigned to the transaction.
• beforeTransactionDate: string (date)
  Title: Before Transaction Date

  Read Only: true

  The previous transaction date assigned to the transaction.
• changeReason: string
  Title: Change Reason

  Read Only: true

  Maximum Length: 80

  The reason for the manual change to the joint venture transaction.
• changeReasonDetails: string
  Title: Change Reason Details

  Read Only: true

  Maximum Length: 240

  Additional text to describe the reason the joint venture transaction was manually changed.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the joint venture transaction change.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the joint venture transaction change was created.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• transactionChangeId: integer (int64)
  Title: Transaction Change ID

  Read Only: true

  The unique identifier of the joint venture transaction change.

{
    "type":"object",
    "properties":{
        "beforeAssignmentRule":{
            "title":"Before Assignment Rule",
            "maxLength":30,
            "type":"string",
            "description":"The previous ownership definition assignment rule assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "changeReasonDetails":{
            "title":"Change Reason Details",
            "maxLength":240,
            "type":"string",
            "description":"Additional text to describe the reason the joint venture transaction was manually changed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "changeReason":{
            "title":"Change Reason",
            "maxLength":80,
            "type":"string",
            "description":"The reason for the manual change to the joint venture transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "afterOwnershipDefinition":{
            "title":"After Ownership Definition",
            "maxLength":30,
            "type":"string",
            "description":"The new ownership definition assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "beforeStatus":{
            "title":"Before Status",
            "maxLength":80,
            "type":"string",
            "description":"The previous status assigned to the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "beforeStakeholder":{
            "title":"Before Direct Billed Stakeholder",
            "maxLength":30,
            "type":"string",
            "description":"The previous name of the direct billed stakeholder assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionChangeId":{
            "title":"Transaction Change ID",
            "type":"integer",
            "description":"The unique identifier of the joint venture transaction change.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "afterTransactionDate":{
            "title":"After Transaction Date",
            "type":"string",
            "description":"The new transaction date assigned to the transaction.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the joint venture transaction change was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "afterStatus":{
            "title":"After Status",
            "maxLength":80,
            "type":"string",
            "description":"The new status assigned to the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "beforeDistributionOnlyFlag":{
            "title":"Before Distribution Only",
            "maxLength":1,
            "type":"boolean",
            "description":"The previous distribution only value assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "beforeOwnershipDefinition":{
            "title":"Before Ownership Definition",
            "maxLength":30,
            "type":"string",
            "description":"The previous ownership definition assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the joint venture transaction change.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "afterDistributionOnlyFlag":{
            "title":"After Distribution Only",
            "maxLength":1,
            "type":"boolean",
            "description":"The new distribution only value assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "afterStakeholder":{
            "title":"After Direct Billed Stakeholder",
            "maxLength":30,
            "type":"string",
            "description":"The new name of the direct billed stakeholder assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "beforeStakeholderDescription":{
            "title":"Before Direct Billed Stakeholder Description",
            "maxLength":240,
            "type":"string",
            "description":"The previous description of the direct billed stakeholder assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "afterStakeholderDescription":{
            "title":"After Direct Billed Stakeholder Description",
            "maxLength":240,
            "type":"string",
            "description":"The new description of the direct billed stakeholder assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "beforeTransactionDate":{
            "title":"Before Transaction Date",
            "type":"string",
            "description":"The previous transaction date assigned to the transaction.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "afterAssignmentRule":{
            "title":"After Assignment Rule",
            "maxLength":30,
            "type":"string",
            "description":"The new ownership definition assignment rule assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve a joint venture transaction change by submitting a GET request on the REST resource using cURL.

curl -i -u "username:password" -H "Content-type: application/json" -X GET "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedTransactions/100105352341697/child/transactionChanges/300100587030153" 
 

Response Body Example

The following shows an example of the response body in JSON format.

{
    "transactionChangeId": 300100587030153,
    "changeReason": "Setup issue",
    "changeReasonDetails": null,
    "beforeTransactionDate": null,
    "afterTransactionDate": null,
    "beforeStatus": "Available to process",
    "afterStatus": "On hold",
    "beforeOwnershipDefinition": null,
    "afterOwnershipDefinition": null,
    "beforeStakeholder": null,
    "beforeStakeholderDescription": null,
    "afterStakeholder": null,
    "afterStakeholderDescription": null,
    "creationDate": "2024-02-21T07:04:12.001+00:00",
    "createdBy": "username",
    "beforeAssignmentRule": null,
    "afterAssignmentRule": null,
    "beforeDistributionOnlyFlag": null,
    "afterDistributionOnlyFlag": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedTransactions/100105352341697/child/transactionChanges/300100587030153",
            "name": "transactionChanges",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedTransactions/100105352341697/child/transactionChanges/300100587030153",
            "name": "transactionChanges",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedTransactions/100105352341697",
            "name": "jointVentureGeneratedTransactions",
            "kind": "item"
        }
    ]
}

Back to Top