1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Balance Element

Update a balance element

patch

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/balanceElement/{id}

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : BalanceElementOracle
Type: object
Title: BalanceElementOracle
Balance element represenst the currency and non currency units units used in Pricing
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : relatedParty
Type: array
Show Source
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid
Show Source
Nested Schema : RelatedParty
Type: object
Title: RelatedParty
RelatedParty reference. A related party defines party or party role linked to a specific entity.
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : BalanceElementOracle
Type: object
Title: BalanceElementOracle
Balance element represenst the currency and non currency units units used in Pricing
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : relatedParty
Type: array
Show Source
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid
Show Source
Nested Schema : RelatedParty
Type: object
Title: RelatedParty
RelatedParty reference. A related party defines party or party role linked to a specific entity.
Show Source

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

404 Response

Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source
Back to Top

Examples

The following example shows how to update a balance element by submitting a patch request on the REST resource using cURL. 

curl  -H 'Authorization: Bearer <accessToken> -H PATCH https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/balanceElement/{id} -H "Content-Type: application/json" -D @patch_balanceElement.json | json_pp

Example of Request Header

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

{
    "id": "BalanceElementSet002",
    "name": "BalanceElementSet002",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "@type": "BalanceElementOracle",
    "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/BalanceElementOracle.yml",
    "validFor": {
        "startDateTime": "2020-09-29T03:50:48.000Z"
    },
    "consumptionRule": "ESTLET",
    "balanceElementType": "ALLOWANCE",
    "symbol": "%",
    "roundingMethod": "CALC",
    "decimalPlaces": "4",
    "relatedParty": [
        {
            "name": "Party N1",
            "id": "party001"
        },
        {
            "name": "Party N2",
            "id": "party002"
        },
        {
            "name": "Party N3",
            "id": "party003"
        }
    ]
}

Example of Response Body

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

{
    "id": "BalanceElementSet002",
    "name": "BalanceElementSet002",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/balanceElement/BalanceElementSet002",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "created": "2021-02-23T10:17:43.000Z",
    "createdBy": "booth",
    "lastUpdate": "2021-02-23T10:22:39.011Z",
    "lastUpdatedBy": "booth",
    "@type": "BalanceElementOracle",
    "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/BalanceElementOracle.yml",
    "validFor": {
        "startDateTime": "2020-09-29T03:50:48.000Z"
    },
    "relatedParty": [
        {
            "id": "party001",
            "name": "Party N1"
        },
        {
            "id": "party002",
            "name": "Party N2"
        },
        {
            "id": "party003",
            "name": "Party N3"
        }
    ],
    "decimalPlaces": "4",
    "consumptionRule": "ESTLET",
    "balanceElementType": "ALLOWANCE",
    "roundingMethod": "CALC",
    "symbol": "%"
}
Back to Top