REST API Reference for Launch Cloud Service

Update a custom profile specification

patch

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

Request

Path Parameters

id(required): string

The unique identifier of the resource item.

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(required): 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/RelatedPartyRefOrPartyRoleRef"
            }
        },
        "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",
        "@type"
    ]
}

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/RelatedPartyRefOrPartyRoleRef"
    }
}

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: 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."
        }
    }
}

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(required): 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(required): 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",
        "@type",
        "@referredType"
    ]
}

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

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

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

When sub-classing, this defines the sub-class Extensible name.
partyOrPartyRole(required): partyOrPartyRole
role: string

Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'.

{
    "title":"RelatedParty",
    "description":"RelatedParty reference. A related party defines party or party role linked to a specific entity.",
    "type":"object",
    "properties":{
        "role":{
            "type":"string",
            "description":"Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'."
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
        },
        "partyOrPartyRole":{
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/PartyRef"
                    },
                    {
                        "$ref":"#/components/schemas/PartyRoleRef"
                    }
                ]
            }
        }
    },
    "required":[
        "@type",
        "partyOrPartyRole"
    ]
}

Nested Schema : partyOrPartyRole

Type: array

Show Source

Array of:

{
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/PartyRef"
            },
            {
                "$ref":"#/components/schemas/PartyRoleRef"
            }
        ]
    }
}

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

200 Response

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(required): 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/RelatedPartyRefOrPartyRoleRef"
            }
        },
        "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",
        "@type"
    ]
}

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/RelatedPartyRefOrPartyRoleRef"
    }
}

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: 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."
        }
    }
}

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(required): 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(required): 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",
        "@type",
        "@referredType"
    ]
}

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

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

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

When sub-classing, this defines the sub-class Extensible name.
partyOrPartyRole(required): partyOrPartyRole
role: string

Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'.

{
    "title":"RelatedParty",
    "description":"RelatedParty reference. A related party defines party or party role linked to a specific entity.",
    "type":"object",
    "properties":{
        "role":{
            "type":"string",
            "description":"Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'."
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
        },
        "partyOrPartyRole":{
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/PartyRef"
                    },
                    {
                        "$ref":"#/components/schemas/PartyRoleRef"
                    }
                ]
            }
        }
    },
    "required":[
        "@type",
        "partyOrPartyRole"
    ]
}

Nested Schema : partyOrPartyRole

Type: array

Show Source

Array of:

{
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/PartyRef"
            },
            {
                "$ref":"#/components/schemas/PartyRoleRef"
            }
        ]
    }
}

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 example shows how to update a custom profile specification by submitting a PATCH request on the REST resource using cURL

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

Example of Request Body

The following shows an example of the request body.

{
    "description" : "Suspension Term Template 1",
    "validFor": {
        "startDateTime": "2024-08-09T00:00:00.000Z",
        "endDateTime": "2028-08-09T00:00:00.000Z"
    }
}

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",
    "description": "Suspension Term Template 1",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ATC_SUSPENSION_TERM_TEMP",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "created": "2025-02-19T11:46:55.000Z",
    "createdBy": "booth",
    "lastUpdate": "2025-03-10T09:36:45.220Z",
    "lastUpdatedBy": "booth",
    "@type": "CustomProfileSpecificationOracle",
    "validFor": {
        "startDateTime": "2024-08-09T00:00:00.000Z",
        "endDateTime": "2028-08-09T00:00:00.000Z"
    },
    "profileType": "SUSPENSION_TERM",
    "customProfileSpecChar": [
        {
            "name": "Contract Duration",
            "description": "The impact to contract duration due to suspension",
            "valueType": "STRING",
            "@type": "CustomProfileSpecChar",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "active": true,
            "customProfileSpecCharValue": [
                {
                    "value": "Original Duration",
                    "valueType": "STRING",
                    "isDefault": true,
                    "@type": "CustomProfileSpecCharValue"
                },
                {
                    "value": "Extended Duration",
                    "valueType": "STRING",
                    "isDefault": false,
                    "@type": "CustomProfileSpecCharValue"
                }
            ]
        },
        {
            "name": "Duration",
            "description": "Duration of suspension",
            "valueType": "NUMBER",
            "@type": "CustomProfileSpecChar",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "active": true,
            "allowedUnits": [
                "DAYS",
                "MONTHS"
            ]
        },
        {
            "name": "Duration Of Suspension",
            "description": "Define the suspension duration",
            "@type": "CustomProfileSpecChar",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "active": true,
            "customProfileSpecCharRel": [
                {
                    "id": "ATC_SUSPENSION_TERM_TEMP",
                    "name": "Duration",
                    "relationshipType": "AGGREGATION",
                    "@type": "CustomProfileSpecCharRel",
                    "charSpecSeq": 1
                },
                {
                    "id": "ATC_SUSPENSION_TERM_TEMP",
                    "name": "Contract Duration",
                    "relationshipType": "AGGREGATION",
                    "@type": "CustomProfileSpecCharRel",
                    "charSpecSeq": 2
                },
                {
                    "id": "ATC_SUSPENSION_TERM_TEMP",
                    "name": "Upgrade Eligibility Duration",
                    "relationshipType": "AGGREGATION",
                    "@type": "CustomProfileSpecCharRel",
                    "charSpecSeq": 3
                }
            ]
        },
        {
            "name": "Maximum Number Of Bill Suspensions",
            "description": "Number of Bill suspensions allowed",
            "valueType": "NUMBER",
            "@type": "CustomProfileSpecChar",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "active": true
        },
        {
            "name": "Suspend Resume Terms",
            "description": "Terms to resume suspension",
            "valueType": "STRING",
            "@type": "CustomProfileSpecChar",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "active": true,
            "customProfileSpecCharValue": [
                {
                    "value": "No Suspense",
                    "valueType": "STRING",
                    "isDefault": false,
                    "@type": "CustomProfileSpecCharValue"
                },
                {
                    "value": "Suspense At Reduced Rate",
                    "valueType": "STRING",
                    "isDefault": false,
                    "@type": "CustomProfileSpecCharValue"
                },
                {
                    "value": "Suspense At Regular Rate",
                    "valueType": "STRING",
                    "isDefault": true,
                    "@type": "CustomProfileSpecCharValue"
                }
            ]
        },
        {
            "name": "Upgrade Eligibility Duration",
            "description": "The impact to upgrade eligibility duration due to suspension",
            "valueType": "STRING",
            "@type": "CustomProfileSpecChar",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "active": true,
            "customProfileSpecCharValue": [
                {
                    "value": "Original Contract Duration",
                    "valueType": "STRING",
                    "isDefault": true,
                    "@type": "CustomProfileSpecCharValue"
                },
                {
                    "value": "Extended Duration",
                    "valueType": "STRING",
                    "isDefault": false,
                    "@type": "CustomProfileSpecCharValue"
                }
            ]
        }
    ]
}