1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Custom Profile Specification

Get a custom profile specification

get

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

Request

Path Parameters
Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : CustomProfileSpecificationOracle
Type: object
Title: CustomProfileSpecificationOracle
CustomProfileSpecificationOracle
Show Source
Nested Schema : charValueObject
Type: array
Show Source
Nested Schema : customProfileSpecChar
Type: array
Show Source
Nested Schema : customProfileSpecRel
Type: array
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : relatedParty
Type: array
Show Source
Nested Schema : TargetProductSchemaOracle
Type: object
Title: TargetProductSchemaOracle
The reference object to the schema and type of target product which is described by product specification
Match All
The reference object to the schema and type of target product which is described by product specification
The reference object to the schema and type of target product which is described by product specification
Show Source
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid
Show Source
Nested Schema : CharValueObjectRefOracle
Type: object
Title: CharValueObjectRefOracle
The Reference of the resource referred in CharValue of custom profile specification
Show Source
Nested Schema : CustomProfileSpecRel
Type: object
Title: CustomProfileSpecRel
A migration, substitution, dependency or exclusivity relationship between/among custom profile specifications.
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
Validity period of the related party
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
Nested Schema : partyOrPartyRole
Type: array
Show Source
Nested Schema : TargetProductSchema
Type: object
Title: TargetProductSchema
The reference object to the schema and type of target product which is described by product specification
Show Source
Nested Schema : TargetProductSchemaOracle-allOf[1]
Type: object
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 get a custom profile specification 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/customProfileSpecification/id

Example of Request Body

The following shows an example of the request body.

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

Example of Response Body

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

{
    "id": "BuiltInCustSpec004",
    "name": "Built In Cust Spec updated",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/BuiltInCustSpec004",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "created": "2021-06-01T09:17:41.000Z",
    "createdBy": "booth",
    "lastUpdate": "2021-06-01T09:27:26.108Z",
    "lastUpdatedBy": "booth",
    "@type": "CustomProfileSpecificationOracle",
    "project": {
        "id": "CustomProject",
        "name": "CustomProject"
    },
    "customProfileSpecChar": [
        {
            "name": "Align Cycle 001",
            "description": "The day the cycle charges apply and are applicable for recurring charges",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "customProfileSpecCharValue": [
                {
                    "isDefault": true,
                    "valueType": "STRING",
                    "value": "Activation Day"
                },
                {
                    "isDefault": false,
                    "valueType": "STRING",
                    "value": "Subscription Day"
                },
                {
                    "isDefault": false,
                    "valueType": "STRING",
                    "value": "Suspense  Day"
                }
            ]
        },
        {
            "name": "Discounts",
            "description": "Application of discount based on the discount validity",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "customProfileSpecCharRel": [
                {
                    "relationshipType": "AGGREGATION",
                    "name": "Discount to Mid Cycle for Cycle"
                },
                {
                    "relationshipType": "AGGREGATION",
                    "name": "Discount For Part Of Cycle for Cycle"
                }
            ]
        }
    ],
    "profileType": "CHARGING_TERM"
}
Back to Top