REST API Reference for Launch Cloud Service

Create a custom profile specification

post

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

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : CustomProfileSpecificationOracle

Type: object

Title: CustomProfileSpecificationOracle

CustomProfileSpecificationOracle

Show Source

@baseType: string

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

A link to the schema describing this Custom ProfileSpec
@type: string

Class type of the Custom ProfileSpec
applicationName: string

name of the external application
charValueObject: array charValueObject
created: string (date-time)

Date and time of creation
createdBy: string

name of the person who created
customProfileSpecChar: array customProfileSpecChar
customProfileSpecRel: array customProfileSpecRel
description: string

A string. A narrative that explains in detail what the Custom ProfileSpec is.
externalId: string

id of the external application
href: string

A string. Reference of the Custom ProfileSpec.
id: string

Maximum Length: 30

A string. Unique identifier of the Custom ProfileSpec.
lastUpdate: string (date-time)

A date time (DateTime). Date and time of the last update of the Custom ProfileSpec.
lastUpdatedBy: string

name of the person who updated
lifecycleStatus: string

A string. Used to indicate the current lifecycle status of the custom profile specification.
name(required): string

A string. Name of the Custom ProfileSpec.
profileCode: string

Code of the profile
profileType(required): string

Allowed Values: [ "DEVICE_SPEC", "BUSINESS_CONFIG", "TRADE_IN", "CHARGING_TERM", "SUSPENSION_TERM", "RETURN_CHECKLIST", "ENTITY_PROFILE", "RENEWAL_TERM", "FINANCE_PLAN", "ZONE_VALUE_MAP", "STANDARD_ZONE" ]

type of the profile
project: object ProjectRef

Title: ProjectRef

Project Reference
relatedParty: array relatedParty
targetProductSchema: object TargetProductSchemaOracle

Title: TargetProductSchemaOracle

The reference object to the schema and type of target product which is described by product specification
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid
version: string

A string. Custom ProfileSpec version.
versionState: number

Version state of the Customer Profile Specification

{
    "title":"CustomProfileSpecificationOracle",
    "type":"object",
    "description":"CustomProfileSpecificationOracle",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"A string. Unique identifier of the Custom ProfileSpec."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the Custom ProfileSpec."
        },
        "version":{
            "type":"string",
            "description":"A string. Custom ProfileSpec version."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the Custom ProfileSpec."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the Custom ProfileSpec is."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"A string. Used to indicate the current lifecycle status of the custom profile specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the Custom ProfileSpec"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the Custom ProfileSpec"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this Custom ProfileSpec"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"A date time (DateTime). Date and time of the last update of the Custom ProfileSpec."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "customProfileSpecChar":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/CustomProfileSpecChar"
                    },
                    {
                        "$ref":"#/components/schemas/BusinessConfigurationCharOracle"
                    },
                    {
                        "$ref":"#/components/schemas/ZoneValueMapCharOracle"
                    }
                ]
            }
        },
        "customProfileSpecRel":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRel"
            }
        },
        "targetProductSchema":{
            "$ref":"#/components/schemas/TargetProductSchemaOracle"
        },
        "profileType":{
            "type":"string",
            "description":"type of the profile",
            "enum":[
                "DEVICE_SPEC",
                "BUSINESS_CONFIG",
                "TRADE_IN",
                "CHARGING_TERM",
                "SUSPENSION_TERM",
                "RETURN_CHECKLIST",
                "ENTITY_PROFILE",
                "RENEWAL_TERM",
                "FINANCE_PLAN",
                "ZONE_VALUE_MAP",
                "STANDARD_ZONE"
            ]
        },
        "profileCode":{
            "type":"string",
            "description":"Code of the profile"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated"
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "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 Customer Profile Specification"
        },
        "charValueObject":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CharValueObjectRefOracle"
            }
        }
    },
    "required":[
        "name",
        "profileType"
    ]
}

Nested Schema : charValueObject

Type: array

Show Source

Array of: object CharValueObjectRefOracle

Title: CharValueObjectRefOracle

The Reference of the resource referred in CharValue of custom profile specification

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

Nested Schema : customProfileSpecChar

Type: array

Show Source

Array of:

{
    "type":"array",
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/CustomProfileSpecChar"
            },
            {
                "$ref":"#/components/schemas/BusinessConfigurationCharOracle"
            },
            {
                "$ref":"#/components/schemas/ZoneValueMapCharOracle"
            }
        ]
    }
}

Nested Schema : customProfileSpecRel

Type: array

Show Source

Array of: object CustomProfileSpecRel

Title: CustomProfileSpecRel

A migration, substitution, dependency or exclusivity relationship between/among custom profile specifications.

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

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 : 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

Show Source

object TargetProductSchema

Title: TargetProductSchema

The reference object to the schema and type of target product which is described by product specification
object TargetProductSchemaOracle-allOf[1]

{
    "title":"TargetProductSchemaOracle",
    "type":"object",
    "description":"The reference object to the schema and type of target product which is described by product specification",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetProductSchema"
        },
        {
            "type":"object",
            "properties":{
                "subType":{
                    "type":"string",
                    "description":"class sub type of the target product"
                }
            }
        }
    ]
}

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 : CharValueObjectRefOracle

Type: object

Title: CharValueObjectRefOracle

The Reference of the resource referred in CharValue of custom profile specification

Show Source

@baseType: string

When sub-classing, this defines the super-class
@referredType: string

The actual type of the target instance when needed for disambiguation
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type: string

When sub-classing, this defines the sub-class entity name
href: string

Unique reference of the project
id(required): string

Unique identifier of the resource referenced
name: string

Name of the resource
resourceType: string

Allowed Values: [ "SERVICE_SPEC" ]

A string. The type of resource referenced in the char value

{
    "title":"CharValueObjectRefOracle",
    "type":"object",
    "description":"The Reference of the resource referred in CharValue of custom profile specification",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the resource referenced"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the resource"
        },
        "resourceType":{
            "type":"string",
            "description":"A string. The type of resource referenced in the char value",
            "enum":[
                "SERVICE_SPEC"
            ]
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : CustomProfileSpecRel

Type: object

Title: CustomProfileSpecRel

A migration, substitution, dependency or exclusivity relationship between/among custom profile specifications.

Show Source

href: string

Reference of the custom profile Specification
id(required): string

Unique identifier of the custom profile Specification
relationshipType(required): string

Allowed Values: [ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY", "PARENT", "CONDITION", "EXCLUDES", "REQUIRES", "ALLOWED" ]

Type of relationship such as migration, substitution, dependency, exclusivity
validFor: object TimePeriodOracle

Title: TimePeriodOracle

Validity period of the related party
versionState: number

To hold the version state of reference

{
    "title":"CustomProfileSpecRel",
    "type":"object",
    "description":"A migration, substitution, dependency or exclusivity relationship between/among custom profile specifications.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the custom profile Specification"
        },
        "href":{
            "type":"string",
            "description":"Reference of the custom profile Specification"
        },
        "relationshipType":{
            "type":"string",
            "description":"Type of relationship such as migration, substitution, dependency, exclusivity",
            "enum":[
                "AGGREGATION",
                "MIGRATION",
                "SUBSTITUTION",
                "DEPENDENCY",
                "EXCLUSIVITY",
                "PARENT",
                "CONDITION",
                "EXCLUDES",
                "REQUIRES",
                "ALLOWED"
            ]
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state of reference"
        }
    },
    "required":[
        "id",
        "relationshipType"
    ]
}

Nested Schema : TimePeriodOracle

Type: object

Title: TimePeriodOracle

Validity period of the related party

Show Source

endDateTime: string (date-time)

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

An instant of time, starting at the TimePeriod

{
    "description":"Validity period of the related party",
    "title":"TimePeriodOracle",
    "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."
        }
    }
}

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"
    ]
}

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

@schemaLocation(required): string

This field provides a link to the schema describing the target product
@type(required): string

class type of the target product

{
    "title":"TargetProductSchema",
    "description":"The reference object to the schema and type of target product which is described by product specification",
    "type":"object",
    "properties":{
        "@type":{
            "type":"string",
            "description":"class type of the target product"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing the target   product"
        }
    },
    "required":[
        "@type",
        "@schemaLocation"
    ]
}

Nested Schema : TargetProductSchemaOracle-allOf[1]

Type: object

Show Source

subType: string

class sub type of the target product

{
    "type":"object",
    "properties":{
        "subType":{
            "type":"string",
            "description":"class sub type of the target product"
        }
    }
}

Response

Supported Media Types

application/json

201 Response

Your request is successful and a new resource has been created.

Root Schema : CustomProfileSpecificationOracle

Type: object

Title: CustomProfileSpecificationOracle

CustomProfileSpecificationOracle

Show Source

@baseType: string

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

A link to the schema describing this Custom ProfileSpec
@type: string

Class type of the Custom ProfileSpec
applicationName: string

name of the external application
charValueObject: array charValueObject
created: string (date-time)

Date and time of creation
createdBy: string

name of the person who created
customProfileSpecChar: array customProfileSpecChar
customProfileSpecRel: array customProfileSpecRel
description: string

A string. A narrative that explains in detail what the Custom ProfileSpec is.
externalId: string

id of the external application
href: string

A string. Reference of the Custom ProfileSpec.
id: string

Maximum Length: 30

A string. Unique identifier of the Custom ProfileSpec.
lastUpdate: string (date-time)

A date time (DateTime). Date and time of the last update of the Custom ProfileSpec.
lastUpdatedBy: string

name of the person who updated
lifecycleStatus: string

A string. Used to indicate the current lifecycle status of the custom profile specification.
name(required): string

A string. Name of the Custom ProfileSpec.
profileCode: string

Code of the profile
profileType(required): string

Allowed Values: [ "DEVICE_SPEC", "BUSINESS_CONFIG", "TRADE_IN", "CHARGING_TERM", "SUSPENSION_TERM", "RETURN_CHECKLIST", "ENTITY_PROFILE", "RENEWAL_TERM", "FINANCE_PLAN", "ZONE_VALUE_MAP", "STANDARD_ZONE" ]

type of the profile
project: object ProjectRef

Title: ProjectRef

Project Reference
relatedParty: array relatedParty
targetProductSchema: object TargetProductSchemaOracle

Title: TargetProductSchemaOracle

The reference object to the schema and type of target product which is described by product specification
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid
version: string

A string. Custom ProfileSpec version.
versionState: number

Version state of the Customer Profile Specification

{
    "title":"CustomProfileSpecificationOracle",
    "type":"object",
    "description":"CustomProfileSpecificationOracle",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"A string. Unique identifier of the Custom ProfileSpec."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the Custom ProfileSpec."
        },
        "version":{
            "type":"string",
            "description":"A string. Custom ProfileSpec version."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the Custom ProfileSpec."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the Custom ProfileSpec is."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"A string. Used to indicate the current lifecycle status of the custom profile specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the Custom ProfileSpec"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the Custom ProfileSpec"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this Custom ProfileSpec"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"A date time (DateTime). Date and time of the last update of the Custom ProfileSpec."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "customProfileSpecChar":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/CustomProfileSpecChar"
                    },
                    {
                        "$ref":"#/components/schemas/BusinessConfigurationCharOracle"
                    },
                    {
                        "$ref":"#/components/schemas/ZoneValueMapCharOracle"
                    }
                ]
            }
        },
        "customProfileSpecRel":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRel"
            }
        },
        "targetProductSchema":{
            "$ref":"#/components/schemas/TargetProductSchemaOracle"
        },
        "profileType":{
            "type":"string",
            "description":"type of the profile",
            "enum":[
                "DEVICE_SPEC",
                "BUSINESS_CONFIG",
                "TRADE_IN",
                "CHARGING_TERM",
                "SUSPENSION_TERM",
                "RETURN_CHECKLIST",
                "ENTITY_PROFILE",
                "RENEWAL_TERM",
                "FINANCE_PLAN",
                "ZONE_VALUE_MAP",
                "STANDARD_ZONE"
            ]
        },
        "profileCode":{
            "type":"string",
            "description":"Code of the profile"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated"
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "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 Customer Profile Specification"
        },
        "charValueObject":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CharValueObjectRefOracle"
            }
        }
    },
    "required":[
        "name",
        "profileType"
    ]
}

Nested Schema : charValueObject

Type: array

Show Source

Array of: object CharValueObjectRefOracle

Title: CharValueObjectRefOracle

The Reference of the resource referred in CharValue of custom profile specification

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

Nested Schema : customProfileSpecChar

Type: array

Show Source

Array of:

{
    "type":"array",
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/CustomProfileSpecChar"
            },
            {
                "$ref":"#/components/schemas/BusinessConfigurationCharOracle"
            },
            {
                "$ref":"#/components/schemas/ZoneValueMapCharOracle"
            }
        ]
    }
}

Nested Schema : customProfileSpecRel

Type: array

Show Source

Array of: object CustomProfileSpecRel

Title: CustomProfileSpecRel

A migration, substitution, dependency or exclusivity relationship between/among custom profile specifications.

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

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 : 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

Show Source

object TargetProductSchema

Title: TargetProductSchema

The reference object to the schema and type of target product which is described by product specification
object TargetProductSchemaOracle-allOf[1]

{
    "title":"TargetProductSchemaOracle",
    "type":"object",
    "description":"The reference object to the schema and type of target product which is described by product specification",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetProductSchema"
        },
        {
            "type":"object",
            "properties":{
                "subType":{
                    "type":"string",
                    "description":"class sub type of the target product"
                }
            }
        }
    ]
}

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 : CharValueObjectRefOracle

Type: object

Title: CharValueObjectRefOracle

The Reference of the resource referred in CharValue of custom profile specification

Show Source

@baseType: string

When sub-classing, this defines the super-class
@referredType: string

The actual type of the target instance when needed for disambiguation
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type: string

When sub-classing, this defines the sub-class entity name
href: string

Unique reference of the project
id(required): string

Unique identifier of the resource referenced
name: string

Name of the resource
resourceType: string

Allowed Values: [ "SERVICE_SPEC" ]

A string. The type of resource referenced in the char value

{
    "title":"CharValueObjectRefOracle",
    "type":"object",
    "description":"The Reference of the resource referred in CharValue of custom profile specification",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the resource referenced"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the resource"
        },
        "resourceType":{
            "type":"string",
            "description":"A string. The type of resource referenced in the char value",
            "enum":[
                "SERVICE_SPEC"
            ]
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : CustomProfileSpecRel

Type: object

Title: CustomProfileSpecRel

A migration, substitution, dependency or exclusivity relationship between/among custom profile specifications.

Show Source

href: string

Reference of the custom profile Specification
id(required): string

Unique identifier of the custom profile Specification
relationshipType(required): string

Allowed Values: [ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY", "PARENT", "CONDITION", "EXCLUDES", "REQUIRES", "ALLOWED" ]

Type of relationship such as migration, substitution, dependency, exclusivity
validFor: object TimePeriodOracle

Title: TimePeriodOracle

Validity period of the related party
versionState: number

To hold the version state of reference

{
    "title":"CustomProfileSpecRel",
    "type":"object",
    "description":"A migration, substitution, dependency or exclusivity relationship between/among custom profile specifications.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the custom profile Specification"
        },
        "href":{
            "type":"string",
            "description":"Reference of the custom profile Specification"
        },
        "relationshipType":{
            "type":"string",
            "description":"Type of relationship such as migration, substitution, dependency, exclusivity",
            "enum":[
                "AGGREGATION",
                "MIGRATION",
                "SUBSTITUTION",
                "DEPENDENCY",
                "EXCLUSIVITY",
                "PARENT",
                "CONDITION",
                "EXCLUDES",
                "REQUIRES",
                "ALLOWED"
            ]
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state of reference"
        }
    },
    "required":[
        "id",
        "relationshipType"
    ]
}

Nested Schema : TimePeriodOracle

Type: object

Title: TimePeriodOracle

Validity period of the related party

Show Source

endDateTime: string (date-time)

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

An instant of time, starting at the TimePeriod

{
    "description":"Validity period of the related party",
    "title":"TimePeriodOracle",
    "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."
        }
    }
}

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"
    ]
}

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

@schemaLocation(required): string

This field provides a link to the schema describing the target product
@type(required): string

class type of the target product

{
    "title":"TargetProductSchema",
    "description":"The reference object to the schema and type of target product which is described by product specification",
    "type":"object",
    "properties":{
        "@type":{
            "type":"string",
            "description":"class type of the target product"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing the target   product"
        }
    },
    "required":[
        "@type",
        "@schemaLocation"
    ]
}

Nested Schema : TargetProductSchemaOracle-allOf[1]

Type: object

Show Source

subType: string

class sub type of the target product

{
    "type":"object",
    "properties":{
        "subType":{
            "type":"string",
            "description":"class sub type of the target product"
        }
    }
}

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 examples show how to create a custom profile specification by submitting a POST request on the REST resource using cURL:

Creating custom profile specification using CHARGING_TERM
Creating custom profile specification using SUSPENSION_TERM
Creating custom profile specification of type Entity Profile
Extending Finance Plan in custom profile specification
Value Map Template for Custom Profile Specification
Standard Zone for Custom Profile Specification

Creating custom profile specification using CHARGING_TERM

cURL Command

curl  -u username:password -H POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ -H 'Content-Type: application/json' -D @post_customprofspec.json | json_pp

Example of Request Body

The following shows an example of the request body.

{
    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
    "name": "Basic Charging Term template 3",
   "version": "1.0",
    "lifecycleStatus": "In design",
    "created": "2022-07-01T11:15:57.000Z",
    "createdBy": "booth",
    "lastUpdate": "2022-07-05T19:36:52.038Z",
    "lastUpdatedBy": "booth",
    "@type": "CustomProfileSpecificationOracle",
    "validFor": {
        "startDateTime": "2022-07-05T00:00:00.000Z"
    },
    "project": {
        "id": "P-3815217701-1650979232417",
        "name": "Airtel Initiative",
        "version": "1.0"
    },
    "profileType": "CHARGING_TERM",
    "customProfileSpecChar": [
        {
            "name": "Align Cycle",
            "description": "The day the cycle charges apply and are applicable for recurring charges",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Activation Day",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Subscription Day",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Suspense  Day",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Apply Taxes for Recurring",
            "description": "Parameter that determines when tax need to be applied",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "customProfileSpecCharValue": [
                {
                    "value": "At Billing",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "After computing charge",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "None",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Apply Taxes for Usage",
            "description": "Parameter that determines when tax need to be applied",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "USAGE",
            "customProfileSpecCharValue": [
                {
                    "value": "At Billing",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "After computing charge",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "None",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Apply Taxes for one time",
            "description": "Parameter that determines when tax need to be applied",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "ONE_TIME",
            "customProfileSpecCharValue": [
                {
                    "value": "After computing charge",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "None",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "At suspense",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Bill Ahead Value",
            "description": "Bill Ahead Value",
            "valueType": "DECIMAL",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "allowedUnits": [
                "DAYS",
                "MONTHS"
            ]
        },
        {
            "name": "Cancel Pro-ration",
            "description": "Cancel Pro-ration applicable for recurring charges",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Prorate",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Do not prorate",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Discount For Part Of Cycle for Cycle",
            "description": "Application of discount When discount is Valid for part of cycle",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Apply from Validity start to validity end",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Apply to full cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Dont apply to this cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Not applicable",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Discount For Part Of Cycle for Usage",
            "description": "Application of discount When discount is Valid for part of cycle",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "USAGE",
            "customProfileSpecCharValue": [
                {
                    "value": "Apply from Validity start to validity end",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Apply to full cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Dont apply to this cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Not applicable",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Discount From Mid Cycle for Cycle",
            "description": "Application of discount When discount is Valid from Mid-cycle",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Apply from Validity start",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Apply to full cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Dont apply to this cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Not applicable",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Discount From Mid Cycle for Usage",
            "description": "Application of discount When discount is Valid from Mid-cycle",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "USAGE",
            "customProfileSpecCharValue": [
                {
                    "value": "Apply from Validity start",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Apply to full cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Dont apply to this cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Not applicable",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Discount Validity proration for Cycle",
            "description": "Application of discount based on the discount validity",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "customProfileSpecCharRel": [
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Discount to Mid Cycle for Cycle",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                },
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Discount For Part Of Cycle for Cycle",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                },
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Discount From Mid Cycle for Cycle",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                }
            ]
        },
        {
            "name": "Discount Validity proration for Usage",
            "description": "Application of discount based on the discount validity",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "USAGE",
            "customProfileSpecCharRel": [
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Discount From Mid Cycle for Usage",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                },
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Discount to Mid Cycle for Usage",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                },
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Discount For Part Of Cycle for Usage",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                }
            ]
        },
        {
            "name": "Discount to Mid Cycle for Cycle",
            "description": "Application of discount When discount is Valid to Mid-cycle",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Apply to Validity end",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Apply to full cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Dont apply to this cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Not applicable",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Discount to Mid Cycle for Usage",
            "description": "Application of discount When discount is Valid to Mid-cycle",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "USAGE",
            "customProfileSpecCharValue": [
                {
                    "value": "Apply to Validity end",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Apply to full cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Dont apply to this cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Not applicable",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "In Advance Suspense",
            "description": "Determines the unit of number of cycles for which the charges will be calculated and payment collected on order of a new subscription.",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "customProfileSpecCharValue": [
                {
                    "value": "No Advance suspense",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Charge Ahead/ Value/Unit",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Increment Quantity",
            "description": "Select the increment that is used to determine the charge",
            "valueType": "DECIMAL",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "USAGE"
        },
        {
            "name": "Minimum Quantity",
            "description": "Enter the minimum quantity of the event that results in a fee",
            "valueType": "DECIMAL",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "USAGE"
        },
        {
            "name": "Purchase Pro-ration",
            "description": "Purchase Pro-ration applicable for recurring charges",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Prorate",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Do not prorate",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Quantity Treatment",
            "description": "Define the Quantity of units based on which charging should be done",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "USAGE",
            "customProfileSpecCharRel": [
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Rounding Increment Units",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                },
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Minimum Quantity",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                },
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Increment Quantity",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                },
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Rounding Mode",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                }
            ]
        },
        {
            "name": "Rounding Increment Units",
            "description": "The units to which the rounding should be done",
            "valueType": "DECIMAL",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "characteristicType": "USAGE"
        },
        {
            "name": "Rounding Mode",
            "description": "Select how the Usage event quantity is rounded",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "characteristicType": "USAGE",
            "customProfileSpecCharValue": [
                {
                    "value": "To the Nearest",
                    "valueType": "STRING",
                    "unitOfMeasure": "NONE",
                    "isDefault": true
                },
                {
                    "value": "Up",
                    "valueType": "STRING",
                    "unitOfMeasure": "NONE",
                    "isDefault": false
                },
                {
                    "value": "Down",
                    "valueType": "STRING",
                    "unitOfMeasure": "NONE",
                    "isDefault": false
                }
            ]
        }
    ]
}

Example of Response Body

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

{
    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
    "name": "Basic Charging Term template 3",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ATC_BASIC_CHARG_TERM_TEMP_3",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "created": "2022-07-06T06:14:00.000Z",
    "createdBy": "booth",
    "lastUpdate": "2022-07-06T06:14:09.615Z",
    "lastUpdatedBy": "booth",
    "@type": "CustomProfileSpecificationOracle",
    "validFor": {
        "startDateTime": "2022-07-05T00:00:00.000Z"
    },
    "project": {
        "id": "P-3815217701-1650979232417",
        "name": "Airtel Initiative",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/P-3815217701-1650979232417",
        "version": "1.0"
    },
    "profileType": "CHARGING_TERM",
    "customProfileSpecChar": [
        {
            "name": "Align Cycle",
            "description": "The day the cycle charges apply and are applicable for recurring charges",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Activation Day",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Subscription Day",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Suspense  Day",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Apply Taxes for Recurring",
            "description": "Parameter that determines when tax need to be applied",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "customProfileSpecCharValue": [
                {
                    "value": "At Billing",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "After computing charge",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "None",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Apply Taxes for Usage",
            "description": "Parameter that determines when tax need to be applied",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "USAGE",
            "customProfileSpecCharValue": [
                {
                    "value": "At Billing",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "After computing charge",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "None",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Apply Taxes for one time",
            "description": "Parameter that determines when tax need to be applied",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "ONE_TIME",
            "customProfileSpecCharValue": [
                {
                    "value": "After computing charge",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "None",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "At suspense",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Bill Ahead Value",
            "description": "Bill Ahead Value",
            "valueType": "DECIMAL",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "allowedUnits": [
                "DAYS",
                "MONTHS"
            ]
        },
        {
            "name": "Cancel Pro-ration",
            "description": "Cancel Pro-ration applicable for recurring charges",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Prorate",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Do not prorate",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Discount For Part Of Cycle for Cycle",
            "description": "Application of discount When discount is Valid for part of cycle",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Apply from Validity start to validity end",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Apply to full cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Dont apply to this cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Not applicable",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Discount For Part Of Cycle for Usage",
            "description": "Application of discount When discount is Valid for part of cycle",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "USAGE",
            "customProfileSpecCharValue": [
                {
                    "value": "Apply from Validity start to validity end",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Apply to full cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Dont apply to this cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Not applicable",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Discount From Mid Cycle for Cycle",
            "description": "Application of discount When discount is Valid from Mid-cycle",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Apply from Validity start",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Apply to full cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Dont apply to this cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Not applicable",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Discount From Mid Cycle for Usage",
            "description": "Application of discount When discount is Valid from Mid-cycle",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "USAGE",
            "customProfileSpecCharValue": [
                {
                    "value": "Apply from Validity start",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Apply to full cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Dont apply to this cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Not applicable",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Discount Validity proration for Cycle",
            "description": "Application of discount based on the discount validity",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "customProfileSpecCharRel": [
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Discount to Mid Cycle for Cycle",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                },
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Discount For Part Of Cycle for Cycle",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                },
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Discount From Mid Cycle for Cycle",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                }
            ]
        },
        {
            "name": "Discount Validity proration for Usage",
            "description": "Application of discount based on the discount validity",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "USAGE",
            "customProfileSpecCharRel": [
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Discount From Mid Cycle for Usage",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                },
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Discount to Mid Cycle for Usage",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                },
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Discount For Part Of Cycle for Usage",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                }
            ]
        },
        {
            "name": "Discount to Mid Cycle for Cycle",
            "description": "Application of discount When discount is Valid to Mid-cycle",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Apply to Validity end",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Apply to full cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Dont apply to this cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Not applicable",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Discount to Mid Cycle for Usage",
            "description": "Application of discount When discount is Valid to Mid-cycle",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "USAGE",
            "customProfileSpecCharValue": [
                {
                    "value": "Apply to Validity end",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Apply to full cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Dont apply to this cycle",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Not applicable",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "In Advance Suspense",
            "description": "Determines the unit of number of cycles for which the charges will be calculated and payment collected on order of a new subscription.",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "customProfileSpecCharValue": [
                {
                    "value": "No Advance suspense",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Charge Ahead/ Value/Unit",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Increment Quantity",
            "description": "Select the increment that is used to determine the charge",
            "valueType": "DECIMAL",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "USAGE"
        },
        {
            "name": "Minimum Quantity",
            "description": "Enter the minimum quantity of the event that results in a fee",
            "valueType": "DECIMAL",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "USAGE"
        },
        {
            "name": "Purchase Pro-ration",
            "description": "Purchase Pro-ration applicable for recurring charges",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "RECURRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Prorate",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                },
                {
                    "value": "Do not prorate",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    }
                }
            ]
        },
        {
            "name": "Quantity Treatment",
            "description": "Define the Quantity of units based on which charging should be done",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2022-07-05T00:00:00.000Z"
            },
            "characteristicType": "USAGE",
            "customProfileSpecCharRel": [
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Rounding Increment Units",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                },
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Minimum Quantity",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                },
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Increment Quantity",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                },
                {
                    "id": "ATC_BASIC_CHARG_TERM_TEMP_3",
                    "name": "Rounding Mode",
                    "relationshipType": "AGGREGATION",
                    "validFor": {
                        "startDateTime": "2022-07-05T00:00:00.000Z"
                    },
                    "charSpecSeq": 0
                }
            ]
        },
        {
            "name": "Rounding Increment Units",
            "description": "The units to which the rounding should be done",
            "valueType": "DECIMAL",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "characteristicType": "USAGE"
        },
        {
            "name": "Rounding Mode",
            "description": "Select how the Usage event quantity is rounded",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "characteristicType": "USAGE",
            "customProfileSpecCharValue": [
                {
                    "value": "To the Nearest",
                    "valueType": "STRING",
                    "unitOfMeasure": "NONE",
                    "isDefault": true
                },
                {
                    "value": "Up",
                    "valueType": "STRING",
                    "unitOfMeasure": "NONE",
                    "isDefault": false
                },
                {
                    "value": "Down",
                    "valueType": "STRING",
                    "unitOfMeasure": "NONE",
                    "isDefault": false
                }
            ]
        }
    ]
}

Creating custom profile specification using SUSPENSION_TERM

cURL Command

curl  -u username:password -H POST \
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ \
 -H 'Content-Type: application/json' -D @post_customerprofspecsuspensionterm.json | json_pp

Example of Request Body

The following shows an example of the request body.

{
   "id": "ATC_SUSPENSION_TERM_TEMP",
   "name": "PSP Suspension Term template",
   "version": "1.0",
   "lifecycleStatus": "In design",
   "@type": "CustomProfileSpecificationOracle",
   "profileType": "SUSPENSION_TERM",
   "customProfileSpecChar": [
       {
           "name": "Contract Duration",
           "description": "The impact to contract duration due to suspension",
           "valueType": "STRING",
           "configurable": true,
           "minCardinality": 0,
           "maxCardinality": 1,
           "customProfileSpecCharValue": [
               {
                   "value": "Original Duration",
                   "valueType": "STRING",
                   "isDefault": true
               },
               {
                   "value": "Extended Duration",
                   "valueType": "STRING",
                   "isDefault": false
               }
           ]
       },
       {
           "name": "Duration",
           "description": "Duration of suspension",
           "valueType": "NUMBER",
           "configurable": true,
           "minCardinality": 0,
           "maxCardinality": 1,
           "allowedUnits": [
               "DAYS",
               "MONTHS"
           ]
       },
       {
           "name": "Duration Of Suspension",
           "description": "Define the suspension duration",
           "configurable": true,
           "minCardinality": 0,
           "maxCardinality": 1,
           "customProfileSpecCharRel": [
               {
                   "id": "ATC_SUSPENSION_TERM_TEMP",
                   "name": "Duration",
                   "charSpecSeq": 1,
                   "relationshipType": "AGGREGATION"
               },
               {
                   "id": "ATC_SUSPENSION_TERM_TEMP",
                   "name": "Contract Duration",
                   "charSpecSeq": 2,
                   "relationshipType": "AGGREGATION"
               },
               {
                   "id": "ATC_SUSPENSION_TERM_TEMP",
                   "name": "Upgrade Eligibility Duration",
                   "charSpecSeq": 3,
                   "relationshipType": "AGGREGATION"
               }
           ]
       },
       {
           "name": "Maximum Number Of Bill Suspensions",
           "description": "Number of Bill suspensions allowed",
           "valueType": "NUMBER",
           "configurable": true,
           "minCardinality": 0,
           "maxCardinality": 1
       },
       {
           "name": "Suspend Resume Terms",
           "description": "Terms to resume suspension",
           "valueType": "STRING",
           "configurable": true,
           "minCardinality": 0,
           "maxCardinality": 1,
           "customProfileSpecCharValue": [
               {
                   "value": "Suspense At Regular Rate",
                   "valueType": "STRING",
                   "isDefault": true
               },
               {
                   "value": "No Suspense",
                   "valueType": "STRING",
                   "isDefault": false
               },
               {
                   "value": "Suspense At Reduced Rate",
                   "valueType": "STRING",
                   "isDefault": false
               }
           ]
       },
       {
           "name": "Upgrade Eligibility Duration",
           "description": "The impact to upgrade eligibility duration due to suspension",
           "valueType": "STRING",
           "configurable": true,
           "minCardinality": 0,
           "maxCardinality": 1,
           "customProfileSpecCharValue": [
               {
                   "value": "Original Contract Duration",
                   "valueType": "STRING",
                   "isDefault": true
               },
               {
                   "value": "Extended Duration",
                   "valueType": "STRING",
                   "isDefault": false
               }
           ]
       }
   ]
}

Example of Response Body

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

{
    "id": "ATC_SUSPENSION_TERM_TEMP",
    "name": "PSP Suspension Term template",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ATC_SUSPENSION_TERM_TEMP",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "created": "2021-10-05T01:48:35.000Z",
    "createdBy": "booth",
    "lastUpdate": "2021-10-05T01:48:38.363Z",
    "lastUpdatedBy": "booth",
    "@type": "CustomProfileSpecificationOracle",
    "profileType": "SUSPENSION_TERM",
    "customProfileSpecChar": [
        {
            "name": "Contract Duration",
            "description": "The impact to contract duration due to suspension",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "customProfileSpecCharValue": [
                {
                    "value": "Original Duration",
                    "valueType": "STRING",
                    "isDefault": true
                },
                {
                    "value": "Extended Duration",
                    "valueType": "STRING",
                    "isDefault": false
                }
            ]
        },
        {
            "name": "Duration",
            "description": "Duration of suspension",
            "valueType": "NUMBER",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "allowedUnits": [
                "DAYS",
                "MONTHS"
            ]
        },
        {
            "name": "Duration Of Suspension",
            "description": "Define the suspension duration",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "customProfileSpecCharRel": [
                {
                    "id": "ATC_SUSPENSION_TERM_TEMP",
                    "name": "Duration",
                    "charSpecSeq": 1,
                    "relationshipType": "AGGREGATION"
                },
                {
                    "id": "ATC_SUSPENSION_TERM_TEMP",
                    "name": "Contract Duration",
                    "charSpecSeq": 2,
                    "relationshipType": "AGGREGATION"
                },
                {
                    "id": "ATC_SUSPENSION_TERM_TEMP",
                    "name": "Upgrade Eligibility Duration",
                    "charSpecSeq": 3,
                    "relationshipType": "AGGREGATION"
                }
            ]
        },
        {
            "name": "Maximum Number Of Bill Suspensions",
            "description": "Number of Bill suspensions allowed",
            "valueType": "NUMBER",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1
        },
        {
            "name": "Suspend Resume Terms",
            "description": "Terms to resume suspension",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "customProfileSpecCharValue": [
                {
                    "value": "Suspense At Regular Rate",
                    "valueType": "STRING",
                    "isDefault": true
                },
                {
                    "value": "No Suspense",
                    "valueType": "STRING",
                    "isDefault": false
                },
                {
                    "value": "Suspense At Reduced Rate",
                    "valueType": "STRING",
                    "isDefault": false
                }
            ]
        },
        {
            "name": "Upgrade Eligibility Duration",
            "description": "The impact to upgrade eligibility duration due to suspension",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "customProfileSpecCharValue": [
                {
                    "value": "Original Contract Duration",
                    "valueType": "STRING",
                    "isDefault": true
                },
                {
                    "value": "Extended Duration",
                    "valueType": "STRING",
                    "isDefault": false
                }
            ]
        }
    ]
}

Creating custom profile specification of type Entity Profile

You could then set modeling rules for design-time features available for a service provider, ensuring the design-time application follows the applied restrictions resulting in an error-free publishing to runtime applications. Such restrictions are based on the service provider's ecosystem and not on individual runtime applications. Which means, there could only be one restriction for the ecosystem and not for each runtime application. You can achieve this by setting up an entity profile.

The following examples show how to create a custom profile specification of type entity profile. This example has a rule that restricts only one commitment term for Product Offering entity of the type package.

cURL Command

curl  -u username:password -H POST \
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ \
 -H 'Content-Type: application/json' -D @post_customerprofspecsuspensionterm.json | json_pp

Example of Request Body

The following shows an example of the request body.

{
    "id": "ProductOfferingOracle",
    "name": "Product Offering",
     "version": "1.0",
    "lifecycleStatus": "In design",
    "@type": "CustomProfileSpecificationOracle",
    "profileType": "ENTITY_PROFILE",
    "targetProductSchema": {
        "@type": "ProductOfferingOracle",
        "@schemaLocation": "ProductOfferingOracle.yml"
    },
    "customProfileSpecChar": [
        {
           "name": "condition_productType_bundle_package",
           "characteristicType": "ATTRIBUTE",
            "attributeName": "productOfferingInfo.productType",
            "customProfileSpecCharValue": [
                {
                    "value": "PACKAGE"
                }
            ],
            "customProfileSpecCharRel": [
                {
                    "id": "ProductOfferingOracle",
                    "name": "requires_term_type_commitmentTerm",
                    "relationshipType": "REQUIRES"
                }
            ]
        },
        {
            "name": "requires_term_type_commitmentTerm",
            "minCardinality": 1,
            "maxCardinality": 1,
            "characteristicType": "ATTRIBUTE",
            "attributeName": "productOfferingTerm[@type=='CommitmentTermOracle']"
        },
        {
            "name": "rule 1",
            "description": "package offerings + commitment term = 1",
            "validFor": {
                "startDateTime": "2022-11-15T05:32:47.143Z"
            },
            "characteristicType": "RULE",
            "customProfileSpecCharRel": [
                {
                    "id": "ProductOfferingOracle",
                    "name": "rule 1_info_productType_bundle",
                    "relationshipType": "AGGREGATION"
                }
            ]
        },
        {
            "name": "rule 1_info_productType_bundle",
            "characteristicType": "FEATURE",
            "attributeName": "productOfferingInfo.productType",
            "customProfileSpecCharRel": [
               {
                    "id": "ProductOfferingOracle",
                    "name": "condition_productType_bundle_package",
                    "relationshipType": "CONDITION"
                }
            ]
        }
    ],
    "applicationName": "ALL"
}

Example of Response Body

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

{
    "id": "ATC_SUSPENSION_TERM_TEMP",
    "name": "PSP Suspension Term template",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ATC_SUSPENSION_TERM_TEMP",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "created": "2021-10-05T01:48:35.000Z",
    "createdBy": "booth",
    "lastUpdate": "2021-10-05T01:48:38.363Z",
    "lastUpdatedBy": "booth",
    "@type": "CustomProfileSpecificationOracle",
    "profileType": "SUSPENSION_TERM",
    "customProfileSpecChar":[
        {
            "name": "condition_productType_bundle_package",
            "characteristicType": "ATTRIBUTE",
            "attributeName": "productOfferingInfo.productType",
            "customProfileSpecCharValue": [
                {
                    "value": "PACKAGE"
                }
            ],
            "customProfileSpecCharRel": [
                {
                    "id": "ProductOfferingOracle",
                    "name": "requires_term_type_commitmentTerm",
                    "relationshipType": "REQUIRES"
                }
            ]
        },
        {
            "name": "requires_term_type_commitmentTerm",
            "minCardinality": 1,
            "maxCardinality": 1,
            "characteristicType": "ATTRIBUTE",
            "attributeName": "productOfferingTerm[commitmentTermType=='SERVICE']"
        },
        {
            "name": "rule 1",
            "description": "package offerings + commitment term = 1",
            "validFor": {
                "startDateTime": "2022-11-15T05:32:47.143Z"
            },
            "characteristicType": "RULE",
            "customProfileSpecCharRel": [
                {
                    "id": "ProductOfferingOracle",
                    "name": "rule 1_info_productType_bundle",
                    "relationshipType": "AGGREGATION"
                }
            ]
        },
        {
            "name": "rule 1_info_productType_bundle",
            "characteristicType": "FEATURE",
            "attributeName": "productOfferingInfo.productType",
            "customProfileSpecCharRel": [
                {
                    "id": "ProductOfferingOracle",
                    "name": "condition_productType_bundle_package",
                    "relationshipType": "CONDITION"
                }
            ]
        }
    ] 
}

Extending Finance Plan in custom profile specification

cURL Command

curl  -u username:password -H POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ -H 'Content-Type: application/json' -D @post_customprofspecfinance.json | json_pp

Example of Request Body

The following shows an example of the request body.

{
        "id": "GlobalFinancePlan",
        "name": "GlobalFinancePlan",
        "description": "The Global Finance Plan sets the amortization details for interest based installment plans ",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "created": "2023-02-19T08:44:12.000Z",
        "createdBy": "booth",
        "lastUpdate": "2023-03-30T16:51:06.004Z",
        "lastUpdatedBy": "booth",
        "@type": "CustomProfileSpecificationOracle",
        "project": {
            "id": "P-3815217701-1650979232417",
            "name": "RetailsIntiative",
            "versionState": 0
        },
        "versionState": 0,
        "profileType": "FINANCE_PLAN",
        "customProfileSpecChar": [
            {
                "name": "INTEREST_TYPE",
                "displayText" : "Interest Type",
                "valueType": "STRING",
                "characteristicType" : "LOOKUP"
            },
            {
                "name": "PATTERN_TYPE",
                "displayText" : "Pattern Type",
                "valueType": "STRING",
                "characteristicType" : "LOOKUP"
            },
            {
                "name": "FINANCE_TERM_PERIOD",
                "displayText" : "Duration",
                "valueType": "STRING",
                "characteristicType" : "LOOKUP"
            },
            {
                "name": "interestDetails",
                "displayText" : "Interest Details",
                "valueType": "DECIMAL",
                "customProfileSpecCharValue": [
                    {
                        "valueTo": "1",
                        "value": 1.0,
                        "valueType": "DECIMAL",
                        "isDefault": false
                    },
                    {
                        "valueTo": "2",
                        "value": 0.5,
                        "valueType": "DECIMAL",
                        "isDefault": false
                    },
                    {
                        "valueTo": "3",
                        "value": 0.357,
                        "valueType": "DECIMAL",
                        "isDefault": false
                    }
                ]
            },
            {
                "name": "InterestConcession",
                "customProfileSpecCharValue": [
                    {
                        "valueTo": "1",
                        "value":4.0,
                        "valueType": "DECIMAL",
                        "isDefault": false
                    },
                    {
                        "valueTo": "2",
                        "value":3.0,
                        "valueType": "DECIMAL",
                        "isDefault": false
                    },
                    {
                        "valueTo": "3",
                        "value": 5.0,
                        "valueType": "DECIMAL",
                        "isDefault": false
                    }
                ],
                 "customProfileSpecCharRel": [
                    {
                        "charSpecSeq": 1,
                        "id": "GlobalFinancePlan",
                        "relationshipType": "PARENT",
                        "name": "interestDetails"
                    }
                ]
            }
             
        ]
    }

Example of Response Body

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

{
        "id": "GlobalFinancePlan",
        "name": "GlobalFinancePlan",
        "description": "The Global Finance Plan sets the amortization details for interest based installment plans ",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "created": "2023-02-19T08:44:12.000Z",
        "createdBy": "booth",
        "lastUpdate": "2023-03-30T16:51:06.004Z",
        "lastUpdatedBy": "booth",
        "@type": "CustomProfileSpecificationOracle",
        "project": {
            "id": "P-3815217701-1650979232417",
            "name": "RetailsIntiative",
            "versionState": 0
        },
        "versionState": 0,
        "profileType": "FINANCE_PLAN",
        "customProfileSpecChar": [
            {
                "name": "INTEREST_TYPE",
                "displayText" : "Interest Type",
                "valueType": "STRING",
                "characteristicType" : "LOOKUP"
            },
            {
                "name": "PATTERN_TYPE",
                "displayText" : "Pattern Type",
                "valueType": "STRING",
                "characteristicType" : "LOOKUP"
            },
            {
                "name": "FINANCE_TERM_PERIOD",
                "displayText" : "Duration",
                "valueType": "STRING",
                "characteristicType" : "LOOKUP"
            },
            {
                "name": "PRORATION TERM",
                "description": "If the prorartion  annually,half yearly or quarterly",
                "valueType": "STRING",
                "active": true
            },
            {
                "name": "InterestDetails",
                "displayText" : "Interest Details",
                "valueType": "DECIMAL",
                "customProfileSpecCharValue": [
                    {
                        "valueTo": "1",
                        "value": 1.0,
                        "valueType": "DECIMAL",
                        "isDefault": false
                    },
                    {
                        "valueTo": "2",
                        "value": 0.5,
                        "valueType": "DECIMAL",
                        "isDefault": false
                    },
                    {
                        "valueTo": "3",
                        "value": 0.357,
                        "valueType": "DECIMAL",
                        "isDefault": false
                    }
                ]
            },
            {
                "name": "InterestConcession",
                "customProfileSpecCharValue": [
                    {
                        "valueTo": "1",
                        "value":4.0,
                        "valueType": "DECIMAL",
                        "isDefault": false
                    },
                    {
                        "valueTo": "2",
                        "value":3.0,
                        "valueType": "DECIMAL",
                        "isDefault": false
                    },
                    {
                        "valueTo": "3",
                        "value": 5.0,
                        "valueType": "DECIMAL",
                        "isDefault": false
                    }
                ],
                 "customProfileSpecCharRel": [
                    {
                        "charSpecSeq": 1,
                        "id": "GlobalFinancePlan",
                        "relationshipType": "PARENT",
                        "name": "InterestDetails"
                    }
                ]
            }
             
        ]
    }

Value Map Template for Custom Profile Specification

cURL Command

curl  -u username:password -H POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ -H 'Content-Type: application/json' -D @post_customprofspecvaluemap.json | json_pp

Example of Request Body

The following shows an example of the request body.

{
        "id": "Europe_Value_Map",
        "name": "Europe Value Map",
        "description": "This describes zones for Europe Value Map",
        "href": "https://fa-wsdc-pintlabfadev.fa.ocs.oc-test.com:443/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/Europe_Value_Map",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "created": "2024-03-05T06:05:29.000Z",
        "createdBy": "booth",
        "lastUpdate": "2024-03-29T05:10:55.341Z",
        "lastUpdatedBy": "booth",
        "@type": "CustomProfileSpecificationOracle",
        "project": {
            "id": "Inititive_A",
            "name": "Europe Initiative",
            "href": "https://fa-wsdc-pintlabfadev.fa.ocs.oc-test.com/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/Inititive_A",
            "versionState": 0
        },
        "versionState": 0,
        "profileType": "ZONE_VALUE_MAP",
        "customProfileSpecChar": [
            {
                "name": "*",
                "valueType": "STRING",
                "extensible": true,
                "displayText": "*",
                "active": true,
                "characteristicType": "STRING"
            },
            {
                "name": "213",
                "valueType": "STRING",
                "extensible": true,
                "displayText": "213",
                "active": true,
                "characteristicType": "STRING",
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Germany",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            },
            {
                "name": "214",
                "valueType": "STRING",
                "extensible": true,
                "displayText": "214",
                "active": true,
                "characteristicType": "STRING",
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Austria",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            },
            {
                "name": "707",
                "valueType": "STRING",
                "extensible": true,
                "displayText": "707",
                "active": true,
                "characteristicType": "STRING",
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Onnet",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            },
            {
                "name": "765",
                "valueType": "STRING",
                "extensible": true,
                "displayText": "765",
                "active": true,
                "characteristicType": "STRING",
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Fixed",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            },
            {
                "name": "786",
                "valueType": "STRING",
                "extensible": true,
                "displayText": "786",
                "active": true,
                "characteristicType": "STRING",
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Offnet",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            },
            {
                "name": "Austria",
                "valueType": "STRING",
                "displayText": "Austria",
                "active": true,
                "characteristicType": "STRING",
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Latvia",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            },
            {
                "name": "Fixed",
                "valueType": "STRING",
                "displayText": "Fixed",
                "active": true,
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Latvia",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            },
            {
                "name": "Germany",
                "valueType": "STRING",
                "displayText": "Germany",
                "active": true,
                "characteristicType": "STRING",
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Latvia",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            },
            {
                "name": "Latvia",
                "valueType": "STRING",
                "extensible": true,
                "displayText": "Latvia",
                "active": true,
                "characteristicType": "STRING"
            },
            {
                "name": "Offnet",
                "valueType": "STRING",
                "displayText": "Offnet",
                "active": true,
                "characteristicType": "STRING",
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Latvia",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            },
            {
                "name": "Onnet",
                "valueType": "STRING",
                "extensible": true,
                "displayText": "Onnet",
                "active": true,
                "characteristicType": "STRING",
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Latvia",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            }
        ]
    }

Example of Response Body

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

{
        "id": "Europe_Value_Map",
        "name": "Europe Value Map",
        "description": "This describes zones for Europe Value Map",
        "href": "https://fa-wsdc-pintlabfadev.fa.ocs.oc-test.com:443/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/Europe_Value_Map",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "created": "2024-03-05T06:05:29.000Z",
        "createdBy": "booth",
        "lastUpdate": "2024-03-29T05:10:55.341Z",
        "lastUpdatedBy": "booth",
        "@type": "CustomProfileSpecificationOracle",
        "project": {
            "id": "Inititive_A",
            "name": "Europe Initiative",
            "href": "https://fa-wsdc-pintlabfadev.fa.ocs.oc-test.com/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/Inititive_A",
            "versionState": 0
        },
        "versionState": 0,
        "profileType": "ZONE_VALUE_MAP",
        "customProfileSpecChar": [
            {
                "name": "*",
                "valueType": "STRING",
                "extensible": true,
                "displayText": "*",
                "active": true,
                "characteristicType": "STRING"
            },
            {
                "name": "213",
                "valueType": "STRING",
                "extensible": true,
                "displayText": "213",
                "active": true,
                "characteristicType": "STRING",
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Germany",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            },
            {
                "name": "214",
                "valueType": "STRING",
                "extensible": true,
                "displayText": "214",
                "active": true,
                "characteristicType": "STRING",
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Austria",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            },
            {
                "name": "707",
                "valueType": "STRING",
                "extensible": true,
                "displayText": "707",
                "active": true,
                "characteristicType": "STRING",
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Onnet",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            },
            {
                "name": "765",
                "valueType": "STRING",
                "extensible": true,
                "displayText": "765",
                "active": true,
                "characteristicType": "STRING",
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Fixed",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            },
            {
                "name": "786",
                "valueType": "STRING",
                "extensible": true,
                "displayText": "786",
                "active": true,
                "characteristicType": "STRING",
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Offnet",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            },
            {
                "name": "Austria",
                "valueType": "STRING",
                "displayText": "Austria",
                "active": true,
                "characteristicType": "STRING",
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Latvia",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            },
            {
                "name": "Fixed",
                "valueType": "STRING",
                "displayText": "Fixed",
                "active": true,
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Latvia",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            },
            {
                "name": "Germany",
                "valueType": "STRING",
                "displayText": "Germany",
                "active": true,
                "characteristicType": "STRING",
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Latvia",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            },
            {
                "name": "Latvia",
                "valueType": "STRING",
                "extensible": true,
                "displayText": "Latvia",
                "active": true,
                "characteristicType": "STRING"
            },
            {
                "name": "Offnet",
                "valueType": "STRING",
                "displayText": "Offnet",
                "active": true,
                "characteristicType": "STRING",
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Latvia",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            },
            {
                "name": "Onnet",
                "valueType": "STRING",
                "extensible": true,
                "displayText": "Onnet",
                "active": true,
                "characteristicType": "STRING",
                "customProfileSpecCharRel": [
                    {
                        "id": "Europe_Value_Map",
                        "name": "Latvia",
                        "relationshipType": "PARENT",
                        "charSpecSeq": 1
                    }
                ]
            }
        ]
    }

Standard Zone for Custom Profile Specification

cURL Command

curl  -u username:password -H POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ -H 'Content-Type: application/json' -D @post_customprofspecstandardzone.json | json_pp

Example of Request Body

The following shows an example of the request body.

{
    "id": "UKStandardZone",
    "name": "UKStandardZone",
    "href": "https://fa-xaws-pintlabfadev.fa.ocs.oc-test.com:443/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/UKStandardZone",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "created": "2024-06-11T05:08:21.000Z",
    "createdBy": "booth",
    "lastUpdate": "2024-06-19T04:38:02.004Z",
    "lastUpdatedBy": "booth",
    "@type": "CustomProfileSpecificationOracle",
    "project": {
        "id": "P-2916199872-1718860192278",
        "href": "https://fa-wsdc-pintlabfadev.fa.ocs.oc-test.com:443/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/P-2916199872-1718860192278",
        "name": "Demo-STANZONE",
        "version": "1.0"
    },
    "versionState": 0,
    "profileType": "STANDARD_ZONE",
    "customProfileSpecChar": [
        {
            "name": "IC_Global",
            "description": "IC_Global",
            "valueType": "STRING",
            "active": true,
            "characteristicType": "STRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Rule1",
                    "valueTo": "156",
                    "valueFrom": "801",
                    "valueType": "STRING",
                    "valueReferenceId": "All",
                    "valueReferenceType": "SERVICE_SPEC"
                }
            ],
            "customProfileSpecCharRel": [
                {
                    "id": "UKStandardZone",
                    "name": "IMPACT_CATEGORY",
                    "relationshipType": "PARENT",
                    "charSpecSeq": 1
                }
            ]
        },
        {
            "name": "IC_Bhutan",
            "description": "IC_Bhutan",
            "valueType": "STRING",
            "active": true,
            "characteristicType": "STRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Rule2",
                    "valueTo": "15",
                    "valueFrom": "801",
                    "valueType": "STRING",
                    "valueReferenceId": "All",
                    "valueReferenceType": "SERVICE_SPEC"
                }
            ],
            "customProfileSpecCharRel": [
                {
                    "id": "UKStandardZone",
                    "name": "IMPACT_CATEGORY",
                    "relationshipType": "PARENT",
                    "charSpecSeq": 1
                }
            ]
        },
        {
            "name": "IC_EEU",
            "description": "IC_EEU",
            "valueType": "STRING",
            "active": true,
            "characteristicType": "STRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Rule9",
                    "valueTo": "820.0",
                    "valueFrom": "311.0",
                    "valueType": "STRING",
                    "valueReferenceId": "ServiceSpecGprs",
                    "valueReferenceType": "SERVICE_SPEC"
                }
            ],
            "customProfileSpecCharRel": [
                {
                    "id": "UKStandardZone",
                    "name": "IMPACT_CATEGORY",
                    "relationshipType": "PARENT",
                    "charSpecSeq": 1
                }
            ]
        },
        {
            "name": "IC_International",
            "description": "IC_International",
            "valueType": "STRING",
            "active": true,
            "characteristicType": "STRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Rule2",
                    "valueTo": "321.0",
                    "valueFrom": "913.0",
                    "valueType": "STRING",
                    "valueReferenceId": "ServiceSpecGsm",
                    "valueReferenceType": "SERVICE_SPEC"
                },
                {
                    "value": "Rule1",
                    "valueTo": "891.0",
                    "valueFrom": "945.0",
                    "valueReferenceId": "ServiceSpecGprs",
                    "valueReferenceType": "SERVICE_SPEC"
                },
                {
                    "value": "Rule3",
                    "valueTo": "563.0",
                    "valueFrom": "256.0",
                    "valueReferenceId": "All",
                    "valueReferenceType": "SERVICE_SPEC"
                }
            ],
            "customProfileSpecCharRel": [
                {
                    "id": "UKStandardZone",
                    "name": "IMPACT_CATEGORY",
                    "relationshipType": "PARENT",
                    "charSpecSeq": 1
                }
            ]
        },
        {
            "name": "IC_National",
            "description": "IC_National",
            "valueType": "STRING",
            "active": true,
            "characteristicType": "STRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Rule3",
                    "valueTo": "567.0",
                    "valueFrom": "913.0",
                    "valueType": "STRING",
                    "valueReferenceId": "ServiceSpecGsm",
                    "valueReferenceType": "SERVICE_SPEC"
                }
            ],
            "customProfileSpecCharRel": [
                {
                    "id": "UKStandardZone",
                    "name": "IMPACT_CATEGORY",
                    "relationshipType": "PARENT",
                    "charSpecSeq": 1
                }
            ]
        },
        {
            "name": "IC_RegionY",
            "description": "IC_RegionY",
            "valueType": "STRING",
            "active": true,
            "characteristicType": "STRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Rule7",
                    "valueTo": "520.0",
                    "valueFrom": "911.0",
                    "valueType": "STRING",
                    "valueReferenceId": "ServiceSpecGsm",
                    "valueReferenceType": "SERVICE_SPEC"
                }
            ],
            "customProfileSpecCharRel": [
                {
                    "id": "UKStandardZone",
                    "name": "IMPACT_CATEGORY",
                    "relationshipType": "PARENT",
                    "charSpecSeq": 1
                }
            ]
        },
        {
            "name": "IMPACT_CATEGORY",
            "valueType": "STRING",
            "displayText": "Impact Category",
            "active": true,
            "characteristicType": "STRING"
        }
    ],
    "charValueObject": [
        {
            "id": "ServiceSpecGprs",
            "name": "TelcoGprs",
            "version": "1.0",
            "@referredType": "ServiceSpecificationOracle",
            "@baseType": "ServiceSpecificationOracle",
            "resourceType": "SERVICE_SPEC"
        },
        {
            "id": "ServiceSpecGsm",
            "name": "TelcoGsm",
            "version": "1.0",
            "@referredType": "ServiceSpecificationOracle",
            "@baseType": "ServiceSpecificationOracle",
            "resourceType": "SERVICE_SPEC"
        }
    ]
}

Example of Response Body

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

{
    "id": "UKStandardZone",
    "name": "UKStandardZone",
    "href": "https://fa-xaws-pintlabfadev.fa.ocs.oc-test.com:443/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/UKStandardZone",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "created": "2024-06-11T05:08:21.000Z",
    "createdBy": "booth",
    "lastUpdate": "2024-06-19T04:38:02.004Z",
    "lastUpdatedBy": "booth",
    "@type": "CustomProfileSpecificationOracle",
    "project": {
        "id": "P-2916199872-1718860192278",
        "href": "https://fa-wsdc-pintlabfadev.fa.ocs.oc-test.com:443/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/P-2916199872-1718860192278",
        "name": "Demo-STANZONE",
        "version": "1.0"
    },
    "versionState": 0,
    "profileType": "STANDARD_ZONE",
    "customProfileSpecChar": [
        {
            "name": "IC_Global",
            "description": "IC_Global",
            "valueType": "STRING",
            "active": true,
            "characteristicType": "STRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Rule1",
                    "valueTo": "156",
                    "valueFrom": "801",
                    "valueType": "STRING",
                    "valueReferenceId": "All",
                    "valueReferenceType": "SERVICE_SPEC"
                }
            ],
            "customProfileSpecCharRel": [
                {
                    "id": "UKStandardZone",
                    "name": "IMPACT_CATEGORY",
                    "relationshipType": "PARENT",
                    "charSpecSeq": 1
                }
            ]
        },
        {
            "name": "IC_Bhutan",
            "description": "IC_Bhutan",
            "valueType": "STRING",
            "active": true,
            "characteristicType": "STRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Rule2",
                    "valueTo": "15",
                    "valueFrom": "801",
                    "valueType": "STRING",
                    "valueReferenceId": "All",
                    "valueReferenceType": "SERVICE_SPEC"
                }
            ],
            "customProfileSpecCharRel": [
                {
                    "id": "UKStandardZone",
                    "name": "IMPACT_CATEGORY",
                    "relationshipType": "PARENT",
                    "charSpecSeq": 1
                }
            ]
        },
        {
            "name": "IC_EEU",
            "description": "IC_EEU",
            "valueType": "STRING",
            "active": true,
            "characteristicType": "STRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Rule9",
                    "valueTo": "820.0",
                    "valueFrom": "311.0",
                    "valueType": "STRING",
                    "valueReferenceId": "ServiceSpecGprs",
                    "valueReferenceType": "SERVICE_SPEC"
                }
            ],
            "customProfileSpecCharRel": [
                {
                    "id": "UKStandardZone",
                    "name": "IMPACT_CATEGORY",
                    "relationshipType": "PARENT",
                    "charSpecSeq": 1
                }
            ]
        },
        {
            "name": "IC_International",
            "description": "IC_International",
            "valueType": "STRING",
            "active": true,
            "characteristicType": "STRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Rule2",
                    "valueTo": "321.0",
                    "valueFrom": "913.0",
                    "valueType": "STRING",
                    "valueReferenceId": "ServiceSpecGsm",
                    "valueReferenceType": "SERVICE_SPEC"
                },
                {
                    "value": "Rule1",
                    "valueTo": "891.0",
                    "valueFrom": "945.0",
                    "valueReferenceId": "ServiceSpecGprs",
                    "valueReferenceType": "SERVICE_SPEC"
                },
                {
                    "value": "Rule3",
                    "valueTo": "563.0",
                    "valueFrom": "256.0",
                    "valueReferenceId": "All",
                    "valueReferenceType": "SERVICE_SPEC"
                }
            ],
            "customProfileSpecCharRel": [
                {
                    "id": "UKStandardZone",
                    "name": "IMPACT_CATEGORY",
                    "relationshipType": "PARENT",
                    "charSpecSeq": 1
                }
            ]
        },
        {
            "name": "IC_National",
            "description": "IC_National",
            "valueType": "STRING",
            "active": true,
            "characteristicType": "STRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Rule3",
                    "valueTo": "567.0",
                    "valueFrom": "913.0",
                    "valueType": "STRING",
                    "valueReferenceId": "ServiceSpecGsm",
                    "valueReferenceType": "SERVICE_SPEC"
                }
            ],
            "customProfileSpecCharRel": [
                {
                    "id": "UKStandardZone",
                    "name": "IMPACT_CATEGORY",
                    "relationshipType": "PARENT",
                    "charSpecSeq": 1
                }
            ]
        },
        {
            "name": "IC_RegionY",
            "description": "IC_RegionY",
            "valueType": "STRING",
            "active": true,
            "characteristicType": "STRING",
            "customProfileSpecCharValue": [
                {
                    "value": "Rule7",
                    "valueTo": "520.0",
                    "valueFrom": "911.0",
                    "valueType": "STRING",
                    "valueReferenceId": "ServiceSpecGsm",
                    "valueReferenceType": "SERVICE_SPEC"
                }
            ],
            "customProfileSpecCharRel": [
                {
                    "id": "UKStandardZone",
                    "name": "IMPACT_CATEGORY",
                    "relationshipType": "PARENT",
                    "charSpecSeq": 1
                }
            ]
        },
        {
            "name": "IMPACT_CATEGORY",
            "valueType": "STRING",
            "displayText": "Impact Category",
            "active": true,
            "characteristicType": "STRING"
        }
    ],
    "charValueObject": [
        {
            "id": "ServiceSpecGprs",
            "name": "TelcoGprs",
            "version": "1.0",
            "@referredType": "ServiceSpecificationOracle",
            "@baseType": "ServiceSpecificationOracle",
            "resourceType": "SERVICE_SPEC"
        },
        {
            "id": "ServiceSpecGsm",
            "name": "TelcoGsm",
            "version": "1.0",
            "@referredType": "ServiceSpecificationOracle",
            "@baseType": "ServiceSpecificationOracle",
            "resourceType": "SERVICE_SPEC"
        }
    ]
}