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}

Updates the custom profile specification with the specified ID.

Request

Path Parameters

id(required): string

The ID of the resource item.

Supported Media Types

application/json

Root Schema : CustomProfileSpecificationOracle

Type: object

Title: CustomProfileSpecificationOracle

The custom profile specification resource.

Show Source

@baseType: string

The base type of the custom profile specification.
@schemaLocation: string

The URI of the schema that defines the custom profile specification.
@type(required): string

The class type of the custom profile specification.
applicationName: string

The name of the application associated with the custom profile specification.
charValueObject: array charValueObject

A list of char value objects associated with the custom profile specification.
created: string (date-time)

The date and time of creation.
createdBy: string

The name of the person who created.
customProfileSpecChar: array customProfileSpecChar

A list of custom profile specification characteristics associated with the custom profile specification.
customProfileSpecRel: array customProfileSpecRel

A list of custom profile specification rels associated with the custom profile specification.
description: string

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

The ID of the external associated with the custom profile specification.
href: string

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

Maximum Length: 30

The ID of the custom profile specification.
lastUpdate: string (date-time)

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

The name of the person who updated.
lifecycleStatus: string

Indicates the current lifecycle status of the custom profile specification.
name(required): string

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

The profile code associated with the custom profile specification.
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", "CUSTOM_ANALYZER_RULE", "POLICY_SPEC_TERM", "TIME_MODEL" ]

The type or classification of the custom profile specification.
project: object ProjectRef

Title: ProjectRef

The project reference resource.
relatedParty: array relatedParty

A list of related parties associated with the custom profile specification.
targetProductSchema: object TargetProductSchemaOracle

Title: TargetProductSchemaOracle
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid.
version: string

A string. Custom ProfileSpec version.
versionState: number

The version state of the Customer Profile Specification.

{
    "title":"CustomProfileSpecificationOracle",
    "type":"object",
    "description":"The custom profile specification resource.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the custom profile specification."
        },
        "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":"Indicates the current lifecycle status of the custom profile specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the custom profile specification is valid."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the custom profile specification."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the custom profile specification."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the custom profile specification."
        },
        "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"
            },
            "description":"A list of related parties associated with the custom profile specification."
        },
        "customProfileSpecChar":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/CustomProfileSpecChar"
                    },
                    {
                        "$ref":"#/components/schemas/BusinessConfigurationCharOracle"
                    },
                    {
                        "$ref":"#/components/schemas/ZoneValueMapCharOracle"
                    }
                ]
            },
            "description":"A list of custom profile specification characteristics associated with the custom profile specification."
        },
        "customProfileSpecRel":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRel"
            },
            "description":"A list of custom profile specification rels associated with the custom profile specification."
        },
        "targetProductSchema":{
            "$ref":"#/components/schemas/TargetProductSchemaOracle",
            "description":"The custom profile specification."
        },
        "profileType":{
            "type":"string",
            "description":"The type or classification of the custom profile specification.",
            "enum":[
                "DEVICE_SPEC",
                "BUSINESS_CONFIG",
                "TRADE_IN",
                "CHARGING_TERM",
                "SUSPENSION_TERM",
                "RETURN_CHECKLIST",
                "ENTITY_PROFILE",
                "RENEWAL_TERM",
                "FINANCE_PLAN",
                "ZONE_VALUE_MAP",
                "STANDARD_ZONE",
                "CUSTOM_ANALYZER_RULE",
                "POLICY_SPEC_TERM",
                "TIME_MODEL"
            ]
        },
        "profileCode":{
            "type":"string",
            "description":"The profile code associated with the custom profile specification."
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of creation."
        },
        "createdBy":{
            "type":"string",
            "description":"The name of the person who created."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The name of the person who updated."
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef",
            "description":"The custom profile specification."
        },
        "externalId":{
            "type":"string",
            "description":"The ID of the external associated with the custom profile specification."
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application associated with the custom profile specification."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the Customer Profile Specification."
        },
        "charValueObject":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CharValueObjectRefOracle"
            },
            "description":"A list of char value objects associated with the custom profile specification."
        }
    },
    "required":[
        "name",
        "profileType",
        "@type"
    ]
}

Nested Schema : charValueObject

Type: array

A list of char value objects associated with the custom profile specification.

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"
    },
    "description":"A list of char value objects associated with the custom profile specification."
}

Nested Schema : customProfileSpecChar

Type: array

A list of custom profile specification characteristics associated with the custom profile specification.

Show Source

Array of:

{
    "type":"array",
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/CustomProfileSpecChar"
            },
            {
                "$ref":"#/components/schemas/BusinessConfigurationCharOracle"
            },
            {
                "$ref":"#/components/schemas/ZoneValueMapCharOracle"
            }
        ]
    },
    "description":"A list of custom profile specification characteristics associated with the custom profile specification."
}

Nested Schema : customProfileSpecRel

Type: array

A list of custom profile specification rels associated with the custom profile specification.

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"
    },
    "description":"A list of custom profile specification rels associated with the custom profile specification."
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

The project reference resource.

Show Source

href: string

The hyperlink reference to the project reference.
id(required): string

The ID of the project reference.
name: string

The name of the project reference.
version: string

The version of the project.

{
    "title":"ProjectRef",
    "type":"object",
    "description":"The project reference resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the project reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the project reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the project reference."
        },
        "version":{
            "type":"string",
            "description":"The version of the project."
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : relatedParty

Type: array

A list of related parties associated with the custom profile specification.

Show Source

Array of: object RelatedParty

Title: RelatedParty

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
    },
    "description":"A list of related parties associated with the custom profile specification."
}

Nested Schema : TargetProductSchemaOracle

Type: object

Title: TargetProductSchemaOracle

Match All

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",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetProductSchema"
        },
        {
            "type":"object",
            "properties":{
                "subType":{
                    "type":"string",
                    "description":"The type or classification of the target product schema."
                }
            }
        }
    ]
}

Nested Schema : TimePeriod

Type: object

Title: TimePeriod

The period for which the productOffering is valid.

Show Source

endDateTime: string (date-time)

The end date and time of the time period.
startDateTime: string (date-time)

The start date and time of the time period.

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid.",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start date and time of the time period."
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The end date and time of the time period."
        }
    }
}

Nested Schema : CharValueObjectRefOracle

Type: object

Title: CharValueObjectRefOracle

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

Show Source

@baseType: string

The base type of the characteristic value object reference.
@referredType(required): string

The type of the referred characteristic value object reference.
@schemaLocation: string (uri)

The URI of the schema that defines the characteristic value object reference.
@type(required): string

The class type of the characteristic value object reference.
href: string

The hyperlink reference to the characteristic value object reference.
id(required): string

The ID of the characteristic value object reference.
name: string

The name of the characteristic value object reference.
resourceType: string

Allowed Values: [ "SERVICE_SPEC" ]

The type or classification of the characteristic value object reference. Valid values are SERVICE_SPEC.

{
    "title":"CharValueObjectRefOracle",
    "type":"object",
    "description":"The Reference of the resource referred in CharValue of custom profile specification.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the characteristic value object reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the characteristic value object reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the characteristic value object reference."
        },
        "resourceType":{
            "type":"string",
            "description":"The type or classification of the characteristic value object reference. Valid values are SERVICE_SPEC.",
            "enum":[
                "SERVICE_SPEC"
            ]
        },
        "@referredType":{
            "type":"string",
            "description":"The type of the referred characteristic value object reference."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the characteristic value object reference."
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"The URI of the schema that defines the characteristic value object reference."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the characteristic value object reference."
        }
    },
    "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

The hyperlink reference to the custom profile specification rel.
id(required): string

The ID of the custom profile specification rel.
relationshipType(required): string

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

The type or classification of the custom profile specification rel. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, EXCLUSIVITY, PARENT, CONDITION, EXCLUDES, REQUIRES, and ALLOWED.
validFor: object TimePeriodOracle

Title: TimePeriodOracle

The validity period of the related party.
versionState: number

The version state of the reference.

{
    "title":"CustomProfileSpecRel",
    "type":"object",
    "description":"A migration, substitution, dependency or exclusivity relationship between/among custom profile specifications.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the custom profile specification rel."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the custom profile specification rel."
        },
        "relationshipType":{
            "type":"string",
            "description":"The type or classification of the custom profile specification rel. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, EXCLUSIVITY, PARENT, CONDITION, EXCLUDES, REQUIRES, and ALLOWED.",
            "enum":[
                "AGGREGATION",
                "MIGRATION",
                "SUBSTITUTION",
                "DEPENDENCY",
                "EXCLUSIVITY",
                "PARENT",
                "CONDITION",
                "EXCLUDES",
                "REQUIRES",
                "ALLOWED"
            ]
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle",
            "description":"The period for which the custom profile specification rel is valid."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the reference."
        }
    },
    "required":[
        "id",
        "relationshipType"
    ]
}

Nested Schema : TimePeriodOracle

Type: object

Title: TimePeriodOracle

The validity period of the related party.

Show Source

endDateTime: string (date-time)

The end date and time of the time period.
startDateTime: string (date-time)

The start date and time of the time period.

{
    "description":"The validity period of the related party.",
    "title":"TimePeriodOracle",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start date and time of the time period."
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The end date and time of the time period."
        }
    }
}

Nested Schema : RelatedParty

Type: object

Title: RelatedParty

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

Show Source

@baseType: string

The base type of the related party reference or party role reference.
@schemaLocation: string

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

The class type of the related party reference or party role reference.
partyOrPartyRole(required): partyOrPartyRole

A list of party or party roles associated with the related party reference or party role reference.
role: string

The 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":"The relatedParty reference. A related party defines party or party role linked to a specific entity.",
    "type":"object",
    "properties":{
        "role":{
            "type":"string",
            "description":"The 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":"The class type of the related party reference or party role reference."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the related party reference or party role reference."
        },
        "@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"
                    }
                ]
            },
            "description":"A list of party or party roles associated with the related party reference or party role reference."
        }
    },
    "required":[
        "@type",
        "partyOrPartyRole"
    ]
}

Nested Schema : partyOrPartyRole

Type: array

A list of party or party roles associated with the related party reference or party role reference.

Show Source

Array of:

{
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/PartyRef"
            },
            {
                "$ref":"#/components/schemas/PartyRoleRef"
            }
        ]
    },
    "description":"A list of party or party roles associated with the related party reference or party role reference."
}

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

The URI of the schema that defines the target product schema.
@type(required): string

The class type of the target product schema.

{
    "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":"The class type of the target product schema."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the target product schema."
        }
    },
    "required":[
        "@type",
        "@schemaLocation"
    ]
}

Nested Schema : TargetProductSchemaOracle-allOf[1]

Type: object

Show Source

subType: string

The type or classification of the target product schema.

{
    "type":"object",
    "properties":{
        "subType":{
            "type":"string",
            "description":"The type or classification of the target product schema."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

The custom profile specification was updated successfully.

Root Schema : CustomProfileSpecificationOracle

Type: object

Title: CustomProfileSpecificationOracle

The custom profile specification resource.

Show Source

@baseType: string

The base type of the custom profile specification.
@schemaLocation: string

The URI of the schema that defines the custom profile specification.
@type(required): string

The class type of the custom profile specification.
applicationName: string

The name of the application associated with the custom profile specification.
charValueObject: array charValueObject

A list of char value objects associated with the custom profile specification.
created: string (date-time)

The date and time of creation.
createdBy: string

The name of the person who created.
customProfileSpecChar: array customProfileSpecChar

A list of custom profile specification characteristics associated with the custom profile specification.
customProfileSpecRel: array customProfileSpecRel

A list of custom profile specification rels associated with the custom profile specification.
description: string

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

The ID of the external associated with the custom profile specification.
href: string

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

Maximum Length: 30

The ID of the custom profile specification.
lastUpdate: string (date-time)

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

The name of the person who updated.
lifecycleStatus: string

Indicates the current lifecycle status of the custom profile specification.
name(required): string

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

The profile code associated with the custom profile specification.
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", "CUSTOM_ANALYZER_RULE", "POLICY_SPEC_TERM", "TIME_MODEL" ]

The type or classification of the custom profile specification.
project: object ProjectRef

Title: ProjectRef

The project reference resource.
relatedParty: array relatedParty

A list of related parties associated with the custom profile specification.
targetProductSchema: object TargetProductSchemaOracle

Title: TargetProductSchemaOracle
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid.
version: string

A string. Custom ProfileSpec version.
versionState: number

The version state of the Customer Profile Specification.

{
    "title":"CustomProfileSpecificationOracle",
    "type":"object",
    "description":"The custom profile specification resource.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the custom profile specification."
        },
        "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":"Indicates the current lifecycle status of the custom profile specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the custom profile specification is valid."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the custom profile specification."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the custom profile specification."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the custom profile specification."
        },
        "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"
            },
            "description":"A list of related parties associated with the custom profile specification."
        },
        "customProfileSpecChar":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/CustomProfileSpecChar"
                    },
                    {
                        "$ref":"#/components/schemas/BusinessConfigurationCharOracle"
                    },
                    {
                        "$ref":"#/components/schemas/ZoneValueMapCharOracle"
                    }
                ]
            },
            "description":"A list of custom profile specification characteristics associated with the custom profile specification."
        },
        "customProfileSpecRel":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRel"
            },
            "description":"A list of custom profile specification rels associated with the custom profile specification."
        },
        "targetProductSchema":{
            "$ref":"#/components/schemas/TargetProductSchemaOracle",
            "description":"The custom profile specification."
        },
        "profileType":{
            "type":"string",
            "description":"The type or classification of the custom profile specification.",
            "enum":[
                "DEVICE_SPEC",
                "BUSINESS_CONFIG",
                "TRADE_IN",
                "CHARGING_TERM",
                "SUSPENSION_TERM",
                "RETURN_CHECKLIST",
                "ENTITY_PROFILE",
                "RENEWAL_TERM",
                "FINANCE_PLAN",
                "ZONE_VALUE_MAP",
                "STANDARD_ZONE",
                "CUSTOM_ANALYZER_RULE",
                "POLICY_SPEC_TERM",
                "TIME_MODEL"
            ]
        },
        "profileCode":{
            "type":"string",
            "description":"The profile code associated with the custom profile specification."
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of creation."
        },
        "createdBy":{
            "type":"string",
            "description":"The name of the person who created."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The name of the person who updated."
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef",
            "description":"The custom profile specification."
        },
        "externalId":{
            "type":"string",
            "description":"The ID of the external associated with the custom profile specification."
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application associated with the custom profile specification."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the Customer Profile Specification."
        },
        "charValueObject":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CharValueObjectRefOracle"
            },
            "description":"A list of char value objects associated with the custom profile specification."
        }
    },
    "required":[
        "name",
        "profileType",
        "@type"
    ]
}

Nested Schema : charValueObject

Type: array

A list of char value objects associated with the custom profile specification.

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"
    },
    "description":"A list of char value objects associated with the custom profile specification."
}

Nested Schema : customProfileSpecChar

Type: array

A list of custom profile specification characteristics associated with the custom profile specification.

Show Source

Array of:

{
    "type":"array",
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/CustomProfileSpecChar"
            },
            {
                "$ref":"#/components/schemas/BusinessConfigurationCharOracle"
            },
            {
                "$ref":"#/components/schemas/ZoneValueMapCharOracle"
            }
        ]
    },
    "description":"A list of custom profile specification characteristics associated with the custom profile specification."
}

Nested Schema : customProfileSpecRel

Type: array

A list of custom profile specification rels associated with the custom profile specification.

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"
    },
    "description":"A list of custom profile specification rels associated with the custom profile specification."
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

The project reference resource.

Show Source

href: string

The hyperlink reference to the project reference.
id(required): string

The ID of the project reference.
name: string

The name of the project reference.
version: string

The version of the project.

{
    "title":"ProjectRef",
    "type":"object",
    "description":"The project reference resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the project reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the project reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the project reference."
        },
        "version":{
            "type":"string",
            "description":"The version of the project."
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : relatedParty

Type: array

A list of related parties associated with the custom profile specification.

Show Source

Array of: object RelatedParty

Title: RelatedParty

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
    },
    "description":"A list of related parties associated with the custom profile specification."
}

Nested Schema : TargetProductSchemaOracle

Type: object

Title: TargetProductSchemaOracle

Match All

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",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetProductSchema"
        },
        {
            "type":"object",
            "properties":{
                "subType":{
                    "type":"string",
                    "description":"The type or classification of the target product schema."
                }
            }
        }
    ]
}

Nested Schema : TimePeriod

Type: object

Title: TimePeriod

The period for which the productOffering is valid.

Show Source

endDateTime: string (date-time)

The end date and time of the time period.
startDateTime: string (date-time)

The start date and time of the time period.

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid.",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start date and time of the time period."
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The end date and time of the time period."
        }
    }
}

Nested Schema : CharValueObjectRefOracle

Type: object

Title: CharValueObjectRefOracle

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

Show Source

@baseType: string

The base type of the characteristic value object reference.
@referredType(required): string

The type of the referred characteristic value object reference.
@schemaLocation: string (uri)

The URI of the schema that defines the characteristic value object reference.
@type(required): string

The class type of the characteristic value object reference.
href: string

The hyperlink reference to the characteristic value object reference.
id(required): string

The ID of the characteristic value object reference.
name: string

The name of the characteristic value object reference.
resourceType: string

Allowed Values: [ "SERVICE_SPEC" ]

The type or classification of the characteristic value object reference. Valid values are SERVICE_SPEC.

{
    "title":"CharValueObjectRefOracle",
    "type":"object",
    "description":"The Reference of the resource referred in CharValue of custom profile specification.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the characteristic value object reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the characteristic value object reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the characteristic value object reference."
        },
        "resourceType":{
            "type":"string",
            "description":"The type or classification of the characteristic value object reference. Valid values are SERVICE_SPEC.",
            "enum":[
                "SERVICE_SPEC"
            ]
        },
        "@referredType":{
            "type":"string",
            "description":"The type of the referred characteristic value object reference."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the characteristic value object reference."
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"The URI of the schema that defines the characteristic value object reference."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the characteristic value object reference."
        }
    },
    "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

The hyperlink reference to the custom profile specification rel.
id(required): string

The ID of the custom profile specification rel.
relationshipType(required): string

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

The type or classification of the custom profile specification rel. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, EXCLUSIVITY, PARENT, CONDITION, EXCLUDES, REQUIRES, and ALLOWED.
validFor: object TimePeriodOracle

Title: TimePeriodOracle

The validity period of the related party.
versionState: number

The version state of the reference.

{
    "title":"CustomProfileSpecRel",
    "type":"object",
    "description":"A migration, substitution, dependency or exclusivity relationship between/among custom profile specifications.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the custom profile specification rel."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the custom profile specification rel."
        },
        "relationshipType":{
            "type":"string",
            "description":"The type or classification of the custom profile specification rel. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, EXCLUSIVITY, PARENT, CONDITION, EXCLUDES, REQUIRES, and ALLOWED.",
            "enum":[
                "AGGREGATION",
                "MIGRATION",
                "SUBSTITUTION",
                "DEPENDENCY",
                "EXCLUSIVITY",
                "PARENT",
                "CONDITION",
                "EXCLUDES",
                "REQUIRES",
                "ALLOWED"
            ]
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle",
            "description":"The period for which the custom profile specification rel is valid."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the reference."
        }
    },
    "required":[
        "id",
        "relationshipType"
    ]
}

Nested Schema : TimePeriodOracle

Type: object

Title: TimePeriodOracle

The validity period of the related party.

Show Source

endDateTime: string (date-time)

The end date and time of the time period.
startDateTime: string (date-time)

The start date and time of the time period.

{
    "description":"The validity period of the related party.",
    "title":"TimePeriodOracle",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start date and time of the time period."
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The end date and time of the time period."
        }
    }
}

Nested Schema : RelatedParty

Type: object

Title: RelatedParty

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

Show Source

@baseType: string

The base type of the related party reference or party role reference.
@schemaLocation: string

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

The class type of the related party reference or party role reference.
partyOrPartyRole(required): partyOrPartyRole

A list of party or party roles associated with the related party reference or party role reference.
role: string

The 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":"The relatedParty reference. A related party defines party or party role linked to a specific entity.",
    "type":"object",
    "properties":{
        "role":{
            "type":"string",
            "description":"The 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":"The class type of the related party reference or party role reference."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the related party reference or party role reference."
        },
        "@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"
                    }
                ]
            },
            "description":"A list of party or party roles associated with the related party reference or party role reference."
        }
    },
    "required":[
        "@type",
        "partyOrPartyRole"
    ]
}

Nested Schema : partyOrPartyRole

Type: array

A list of party or party roles associated with the related party reference or party role reference.

Show Source

Array of:

{
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/PartyRef"
            },
            {
                "$ref":"#/components/schemas/PartyRoleRef"
            }
        ]
    },
    "description":"A list of party or party roles associated with the related party reference or party role reference."
}

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

The URI of the schema that defines the target product schema.
@type(required): string

The class type of the target product schema.

{
    "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":"The class type of the target product schema."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the target product schema."
        }
    },
    "required":[
        "@type",
        "@schemaLocation"
    ]
}

Nested Schema : TargetProductSchemaOracle-allOf[1]

Type: object

Show Source

subType: string

The type or classification of the target product schema.

{
    "type":"object",
    "properties":{
        "subType":{
            "type":"string",
            "description":"The type or classification of the target product schema."
        }
    }
}

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

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

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

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

404 Response

The resource with the specified URI couldn't be found.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

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

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

500 Response

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

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

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