Jump to

• Request
• Response
• Examples

Update a federal DATA Act balance calculation

patch

/fscmRestApi/resources/11.13.18.05/fedDATAActBalances/{BalanceHeaderId}/child/fedDATAActBalanceCalculationTotals/{BalanceCalculationId}

Request

Path Parameters

• BalanceCalculationId(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=
• BalanceHeaderId(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:
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BalanceName: string
  Title: Balance Name

  Maximum Length: 255

  Balance name of the federal DATA Act balance calculation.
• FromDate: string (date)
  Title: From Date

  The period start date of the federal DATA Act balance calculation.
• Operator: string
  Title: Operator

  Maximum Length: 255

  Operator name of the federal DATA Act balance calculation.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  Sequence number of the federal DATA Act balance calculation.
• ToDate: string (date)
  Title: To Date

  The period end date of the federal DATA Act balance calculation.

{
    "type":"object",
    "properties":{
        "Operator":{
            "title":"Operator",
            "maxLength":"255",
            "type":"string",
            "description":"Operator name of the federal DATA Act balance calculation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"Sequence number of the federal DATA Act balance calculation.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"6",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"The period start date of the federal DATA Act balance calculation.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"The period end date of the federal DATA Act balance calculation.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "BalanceName":{
            "title":"Balance Name",
            "maxLength":"255",
            "type":"string",
            "description":"Balance name of the federal DATA Act balance calculation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : fedDATAActBalances-fedDATAActBalanceCalculationTotals-item-response

Type: object

Show Source

• BalanceCalculationId: integer (int64)
  Title: Balance Calculation ID

  The unique identifier of the DATA Act balance calculation of federal DATA Act balance calculations.
• BalanceHeaderId: integer (int64)
  Title: Balance Header ID

  The unique identifier of the DATA Act balance calculation header of federal DATA Act balance calculations of type total.
• BalanceName: string
  Title: Balance Name

  Maximum Length: 255

  Balance name of the federal DATA Act balance calculation.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• FromDate: string (date)
  Title: From Date

  The period start date of the federal DATA Act balance calculation.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The date when the record was last updated.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Operator: string
  Title: Operator

  Maximum Length: 255

  Operator name of the federal DATA Act balance calculation.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  Sequence number of the federal DATA Act balance calculation.
• ToDate: string (date)
  Title: To Date

  The period end date of the federal DATA Act balance calculation.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date when the record was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Operator":{
            "title":"Operator",
            "maxLength":"255",
            "type":"string",
            "description":"Operator name of the federal DATA Act balance calculation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BalanceName":{
            "title":"Balance Name",
            "maxLength":"255",
            "type":"string",
            "description":"Balance name of the federal DATA Act balance calculation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceCalculationId":{
            "title":"Balance Calculation ID",
            "type":"integer",
            "description":"The unique identifier of the DATA Act balance calculation of federal DATA Act balance calculations.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"Sequence number of the federal DATA Act balance calculation.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"6",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "BalanceHeaderId":{
            "title":"Balance Header ID",
            "type":"integer",
            "description":"The unique identifier of the DATA Act balance calculation header of federal DATA Act balance calculations of type total.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"The period start date of the federal DATA Act balance calculation.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"The period end date of the federal DATA Act balance calculation.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 ToDate, BalanceName, Operator, Sequence number values of a DATA Act Balance Total Calculation 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:443/fscmRestApi/resources/11.13.18.05/fedDATAActBalances/300100577768717(--Balanceheaderid--)/child/fedDATAActBalanceCalculationTotals/300100613848596

Request Body Example

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

{
               "ToDate": "2024-12-31",
                "SequenceNumber": 30,
                "Operator": "Plus",
                "BalanceName": "BAL03"
}

Response Body Example

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

{
    "BalanceCalculationId": "300100613848596",
    "BalanceHeaderId": "300100613850595",
    "BalanceName": "BAL03",
    "Operator": "Plus",
    "SequenceNumber": 30,
    "FromDate": "2023-01-01",
    "ToDate": "2024-12-31",
    "CreationDate": "2023-11-07T12:38:46+00:00",
    "CreatedBy": "usersname",
    "LastUpdatedBy": "usersname",
    "LastUpdateDate": "2023-11-07T12:44:30+00:00",
    "LastUpdateLogin": "082406CD6FD542F6E063A46315ACCDE2",
    "@context": {
        "key": "300100613848596",
        "headers": {
            "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
        },
        "links": [
            {
                "rel": "self",
                "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/fedDATAActBalances/300100613850595/child/fedDATAActBalanceCalculationTotals/300100613848596",
                "name": "fedDATAActBalanceCalculationTotals",
                "kind": "item"
            },
            {
                "rel": "canonical",
                "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/fedDATAActBalances/300100613850595/child/fedDATAActBalanceCalculationTotals/300100613848596",
                "name": "fedDATAActBalanceCalculationTotals",
                "kind": "item"
            },
            {
                "rel": "parent",
                "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/fedDATAActBalances/300100613850595",
                "name": "fedDATAActBalances",
                "kind": "item"
            }
        ]
    }
}

Back to Top