REST API Reference for Launch Cloud Service

Get a balance element

get

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

Request

Path Parameters

id(required): string

The unique identifier of the resource item.

Query Parameters

eligibleVersionForProject: string

Project Id
fields: string

The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a resource.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Root Schema : BalanceElementOracle

Type: object

Title: BalanceElementOracle

Balance element represenst the currency and non currency units units used in Pricing

Show Source

@baseType: string

Immediate base (class) type of the object
@schemaLocation: string

A link to the schema describing this object
@type: string

Indicates the type of resource. Here can be Balance element
applicationName: string

Name of the external application
balanceElementType: string

Allowed Values: [ "COUNTER", "ALLOWANCE", "CURRENCY", "CRYPTO", "PSEUDO" ]

Type of relationship such as migration, substitution, dependency, exclusivity
code: string

Currency (ISO4217 norm uses 3 letters to define the currency and user define code for non currency)
consumptionRule: string

Allowed Values: [ "NONE", "EST", "LST", "EET", "LET", "ESTLET", "ESTEET", "LSTEET", "LSTLET", "EETEST", "ESTLET", "LETEST", "LETLST" ]

Consumption Rule of Balance Element
created: string (date-time)

Date and time of the creation
createdBy: string

Name of the person who created item
decimalPlaces: string

Allowed decimal places
description: string

Description of Balance element
externalId: string

id of the external application
href: string

Hypertext Reference of the Balance element.
id: string

Maximum Length: 30

Unique identifier of the Balance element
lastUpdate: string (date-time)

Latest update date of Balance element
lastUpdatedBy: string

Name of the person who updated item
lifecycleStatus: string

Status of Balance element
name: string

Name of Balance element
numericCode: number

Unique numeric code (ISO 4217 numeric code for currency and auto generated value greater than 1000 for non currency)
project: object ProjectRef

Title: ProjectRef

Project Reference
relatedParty: array relatedParty
roundingMethod: string

Default rounding applicable to the balance element
symbol: string

Symbol of the currency or pseudo currency
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid
version: string

BalanceElement version
versionState: number

Version state of the balance element

{
    "title":"BalanceElementOracle",
    "type":"object",
    "description":"Balance element represenst the currency and non currency units units used in Pricing",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"Unique identifier of the Balance element"
        },
        "href":{
            "type":"string",
            "description":"Hypertext Reference of the Balance element."
        },
        "name":{
            "type":"string",
            "description":"Name of Balance element"
        },
        "description":{
            "type":"string",
            "description":"Description of Balance element"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Latest update date of Balance element"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Status of Balance element"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the type of resource. Here can be Balance element"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the object"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this object"
        },
        "consumptionRule":{
            "type":"string",
            "description":"Consumption Rule of Balance Element",
            "enum":[
                "NONE",
                "EST",
                "LST",
                "EET",
                "LET",
                "ESTLET",
                "ESTEET",
                "LSTEET",
                "LSTLET",
                "EETEST",
                "ESTLET",
                "LETEST",
                "LETLST"
            ]
        },
        "balanceElementType":{
            "type":"string",
            "description":"Type of relationship such as migration, substitution, dependency, exclusivity",
            "enum":[
                "COUNTER",
                "ALLOWANCE",
                "CURRENCY",
                "CRYPTO",
                "PSEUDO"
            ]
        },
        "code":{
            "type":"string",
            "description":"Currency (ISO4217 norm uses 3 letters to define the currency and user define code for non currency)"
        },
        "numericCode":{
            "type":"number",
            "description":"Unique numeric code (ISO 4217 numeric code for currency and auto generated value greater than 1000 for non currency)"
        },
        "symbol":{
            "type":"string",
            "description":"Symbol of the currency or pseudo currency"
        },
        "roundingMethod":{
            "type":"string",
            "description":"Default rounding applicable to the balance element"
        },
        "decimalPlaces":{
            "type":"string",
            "description":"Allowed decimal places"
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "version":{
            "type":"string",
            "description":"BalanceElement version"
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "createdBy":{
            "type":"string",
            "description":"Name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"Name of the person who updated item"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"Name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the balance element"
        }
    }
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

Project Reference

Show Source

href: string

Unique reference of the project
id(required): string

Unique identifier of the project
name: string

Name of the project
version: string

Version of the project

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : relatedParty

Type: array

Show Source

Array of: object RelatedParty

Title: RelatedParty

RelatedParty reference. A related party defines party or party role linked to a specific entity.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedParty"
    }
}

Nested Schema : TimePeriod

Type: object

Title: TimePeriod

The period for which the productOffering is valid

Show Source

endDateTime: string (date-time)

An instant of time, ending at the TimePeriod.
startDateTime(required): string (date-time)

An instant of time, starting at the TimePeriod

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    },
    "required":[
        "startDateTime"
    ]
}

Nested Schema : RelatedParty

Type: object

Title: RelatedParty

RelatedParty reference. A related party defines party or party role linked to a specific entity.

Show Source

@baseType: string

The immediate base class type of the RelatedParty
@referredType: string

The class type of referred party/party role reference
@schemaLocation: string

A link to the schema describing this RelatedParty entity
@type: string

the class type of the RelatedParty
href: string

Reference of the related party, could be a party reference or a party role reference
id(required): string

Unique identifier of a related party
name: string

Name of the related party
role: string

Role of the related party.

{
    "title":"RelatedParty",
    "description":"RelatedParty reference. A related party defines party or party role linked to a specific entity.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related party"
        },
        "href":{
            "type":"string",
            "description":"Reference of the related party, could be a party reference or a party role reference"
        },
        "role":{
            "type":"string",
            "description":"Role of the related party."
        },
        "name":{
            "type":"string",
            "description":"Name of the related party"
        },
        "@referredType":{
            "type":"string",
            "description":"The class type of referred party/party role reference"
        },
        "@type":{
            "type":"string",
            "description":"the class type of the RelatedParty"
        },
        "@baseType":{
            "type":"string",
            "description":"The immediate base class type of the RelatedParty"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this RelatedParty entity"
        }
    },
    "required":[
        "id"
    ]
}

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.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

404 Response

Your request includes a resource URI that doesn't exist.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

Examples

The following example shows how to retrieve details of a balance element by submitting a get request on the REST resource using cURL.

curl -u username:password -X GET https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/balanceElement/{id}

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:17:43.024Z",
    "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": "EST",
    "balanceElementType": "COUNTER",
    "roundingMethod": "CALC",
    "symbol": "%"
}