Jump to

• Request
• Response
• Examples

Update a stakeholder reporting book

patch

/fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholderReportingBooks/{stakeholderReportingBookId}

Request

Path Parameters

• jointVentureId(required): integer(int64)
  The unique identifier of the joint venture.
• stakeholderReportingBookId(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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• sourceLedger: string
  Title: Source Ledger

  Maximum Length: 80

  The name of the source ledger associated with the stakeholder reporting ledger.
• stakeholderLedger: string
  Title: Stakeholder Reporting Ledger

  Maximum Length: 80

  The name of the stakeholder reporting ledger associated with the source ledger.
• status: string
  Title: Status

  Maximum Length: 80

  The status of the stakeholder reporting book.

{
    "type":"object",
    "properties":{
        "stakeholderLedger":{
            "title":"Stakeholder Reporting Ledger",
            "maxLength":80,
            "type":"string",
            "description":"The name of the stakeholder reporting ledger associated with the source ledger.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "ledgerId2"
                ]
            }
        },
        "sourceLedger":{
            "title":"Source Ledger",
            "maxLength":80,
            "type":"string",
            "description":"The name of the source ledger associated with the stakeholder reporting ledger.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "ledgerId1"
                ]
            }
        },
        "status":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the stakeholder reporting book.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCodeStatus"
                ]
            }
        }
    }
}

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 : jointVentures-stakeholderReportingBooks-item-response

Type: object

Show Source

• 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.
• 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.
• sourceLedger: string
  Title: Source Ledger

  Maximum Length: 80

  The name of the source ledger associated with the stakeholder reporting ledger.
• sourceLedgerDescription: string
  Title: Source Ledger Description

  Read Only: true

  Maximum Length: 240

  The description of the source ledger associated with the stakeholder reporting ledger.
• stakeholderLedger: string
  Title: Stakeholder Reporting Ledger

  Maximum Length: 80

  The name of the stakeholder reporting ledger associated with the source ledger.
• stakeholderLedgerDescription: string
  Title: Stakeholder Reporting Ledger Description

  Read Only: true

  Maximum Length: 240

  The description of the stakeholder reporting ledger associated with the source ledger.
• stakeholderReportingBookId: integer (int64)
  Title: Stakeholder Reporting Book ID

  Read Only: true

  The unique identifier of the stakeholder reporting book.
• status: string
  Title: Status

  Maximum Length: 80

  The status of the stakeholder reporting book.

{
    "type":"object",
    "properties":{
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the resource item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the resource item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resource item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "stakeholderReportingBookId":{
            "title":"Stakeholder Reporting Book ID",
            "type":"integer",
            "description":"The unique identifier of the stakeholder reporting book.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "stakeholderLedger":{
            "title":"Stakeholder Reporting Ledger",
            "maxLength":80,
            "type":"string",
            "description":"The name of the stakeholder reporting ledger associated with the source ledger.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "ledgerId2"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the resource item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "stakeholderLedgerDescription":{
            "title":"Stakeholder Reporting Ledger Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the stakeholder reporting ledger associated with the source ledger.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ledgerId2"
                ]
            },
            "x-queryable":true
        },
        "sourceLedger":{
            "title":"Source Ledger",
            "maxLength":80,
            "type":"string",
            "description":"The name of the source ledger associated with the stakeholder reporting ledger.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "ledgerId1"
                ]
            },
            "x-queryable":true
        },
        "sourceLedgerDescription":{
            "title":"Source Ledger Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the source ledger associated with the stakeholder reporting ledger.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ledgerId1"
                ]
            },
            "x-queryable":true
        },
        "status":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the stakeholder reporting book.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCodeStatus"
                ]
            },
            "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 update a stakeholder reporting book by submitting a PATCH request on the REST resource using cURL.

curl -i -u "username:password" -H "Content-type: application/json" -X PATCH
"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentures/300100634761638/child/stakeholderReportingBooks/300100615727768"

Example Request Body

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

{
   "status": "Inactive"
}

Example Response Body

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

{
    "stakeholderReportingBookId": 300100634787600,
    "sourceLedger": "HEPPLedger US",
    "stakeholderLedger": "HEPPLedger US SH Reporting",
    "status": "Inctive",
    "createdBy": "username",
    "creationDate": "2025-05-13T03:58:49+00:00",
    "lastUpdatedBy": "username",
    "lastUpdateDate": "2025-05-13T03:58:49.397+00:00",
    "sourceLedgerDescription": null,
    "stakeholderLedgerDescription": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentures/300100634761638/child/stakeholderReportingBooks/300100634787600",
            "name": "stakeholderReportingBooks",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentures/300100634761638/child/stakeholderReportingBooks/300100634787600",
            "name": "stakeholderReportingBooks",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentures/300100634761638",
            "name": "jointVentures",
            "kind": "item"
        }
    ]
}

Back to Top