Create or update an array of custom profile specifications
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/customProfileSpecifications
Request
There are no request parameters for this operation.
- application/json
array150-
Array of:
object CustomProfileSpecificationOracle
Title:
CustomProfileSpecificationOracleCustomProfileSpecificationOracle
objectCustomProfileSpecificationOracle-
@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:
30A 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", "CUSTOM_ANALYZER_RULE" ]type of the profile -
project: object
ProjectRef
Title:
ProjectRefProject Reference - relatedParty: array relatedParty
-
targetProductSchema: object
TargetProductSchemaOracle
Title:
TargetProductSchemaOracleThe reference object to the schema and type of target product which is described by product specification -
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid -
version: string
A string. Custom ProfileSpec version.
-
versionState: number
Version state of the Customer Profile Specification
array-
Array of:
object CharValueObjectRefOracle
Title:
CharValueObjectRefOracleThe Reference of the resource referred in CharValue of custom profile specification
array-
Array of:
object CustomProfileSpecRel
Title:
CustomProfileSpecRelA migration, substitution, dependency or exclusivity relationship between/among custom profile specifications.
objectProjectRef-
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
objectTargetProductSchemaOracle-
object
TargetProductSchema
Title:
TargetProductSchemaThe reference object to the schema and type of target product which is described by product specification -
object
TargetProductSchemaOracle-allOf[1]
objectTimePeriod-
endDateTime: string
(date-time)
An instant of time, ending at the TimePeriod.
-
startDateTime: string
(date-time)
An instant of time, starting at the TimePeriod
objectCharValueObjectRefOracle-
@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
objectCustomProfileSpecRel-
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:
TimePeriodOracleValidity period of the related party -
versionState: number
To hold the version state of reference
objectTimePeriodOracle-
endDateTime: string
(date-time)
An instant of time, ending at the TimePeriod.
-
startDateTime: string
(date-time)
An instant of time, starting at the TimePeriod
objectRelatedParty-
@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'.
objectTargetProductSchema-
@schemaLocation(required): string
This field provides a link to the schema describing the target product
-
@type(required): string
class type of the target product
object-
subType: string
class sub type of the target product
Response
- application/json
200 Response
array-
Array of:
object CustomProfileSpecificationOracle
Title:
CustomProfileSpecificationOracleCustomProfileSpecificationOracle
objectCustomProfileSpecificationOracle-
@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:
30A 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", "CUSTOM_ANALYZER_RULE" ]type of the profile -
project: object
ProjectRef
Title:
ProjectRefProject Reference - relatedParty: array relatedParty
-
targetProductSchema: object
TargetProductSchemaOracle
Title:
TargetProductSchemaOracleThe reference object to the schema and type of target product which is described by product specification -
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid -
version: string
A string. Custom ProfileSpec version.
-
versionState: number
Version state of the Customer Profile Specification
array-
Array of:
object CharValueObjectRefOracle
Title:
CharValueObjectRefOracleThe Reference of the resource referred in CharValue of custom profile specification
array-
Array of:
object CustomProfileSpecRel
Title:
CustomProfileSpecRelA migration, substitution, dependency or exclusivity relationship between/among custom profile specifications.
objectProjectRef-
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
objectTargetProductSchemaOracle-
object
TargetProductSchema
Title:
TargetProductSchemaThe reference object to the schema and type of target product which is described by product specification -
object
TargetProductSchemaOracle-allOf[1]
objectTimePeriod-
endDateTime: string
(date-time)
An instant of time, ending at the TimePeriod.
-
startDateTime: string
(date-time)
An instant of time, starting at the TimePeriod
objectCharValueObjectRefOracle-
@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
objectCustomProfileSpecRel-
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:
TimePeriodOracleValidity period of the related party -
versionState: number
To hold the version state of reference
objectTimePeriodOracle-
endDateTime: string
(date-time)
An instant of time, ending at the TimePeriod.
-
startDateTime: string
(date-time)
An instant of time, starting at the TimePeriod
objectRelatedParty-
@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'.
objectTargetProductSchema-
@schemaLocation(required): string
This field provides a link to the schema describing the target product
-
@type(required): string
class type of the target product
object-
subType: string
class sub type of the target product
400 Response
array-
Array of:
object Discriminator: @type
Discriminator:
{ "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error", "BulkError":"#/components/schemas/BulkError" } }
401 Response
objectError-
@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
404 Response
objectError-
@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
405 Response
objectError-
@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
500 Response
objectError-
@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
Examples
The following example shows how to create or update an array of custom profile specification by submitting a PUT request on the REST resource using cURL.
cURL Command
curl -u username:password -X PUT \
'https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/customProfileSpecifications' -H 'Content-Type: application/json' -D @put_customprofilespec.json | json_pp
Example of Request Body
The following shows an example of the request body in JSON format.
[
{
"id": "CustomProfileSpec_001",
"name": "CustomProfileSpec_001",
"description": "Custom profile Spec desc",
"href": "https: //{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/Oracle_59DGQJAK",
"version": "1.0",
"lifecycleStatus": "In design",
"@type": "CustomProfileSpecificationOracle",
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"project": {
"id": "BulkDocProject",
"name": "Bulk Doc Project"
},
"customProfileSpecChar": [
{
"name": "DeviceType",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"customProfileSpecCharValue": [
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Mobile"
},
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Tablet"
}
]
},
{
"name": "Family",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"customProfileSpecCharValue": [
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "123a"
},
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Note"
},
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Galaxy"
}
]
},
{
"name": "Make",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"customProfileSpecCharValue": [
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Apple"
},
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Samsung"
}
]
}
],
"profileType": "TRADE_IN"
},
{
"id": "CustomProfileSpec_002",
"name": "CustomProfileSpec_002",
"description": "Custom profile Spec desc",
"href": "https: //{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/Oracle_59DGQJAK",
"version": "1.0",
"lifecycleStatus": "In design",
"@type": "CustomProfileSpecificationOracle",
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"project": {
"id": "BulkDocProject",
"name": "Bulk Doc Project"
},
"customProfileSpecChar": [
{
"name": "DeviceType",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"customProfileSpecCharValue": [
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Mobile"
},
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Tablet"
}
]
},
{
"name": "Family",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime":"2020-09-29T03:50:48.000Z"
},
"customProfileSpecCharValue": [
{
"isDefault": false,
"validFor": {
"startDateTime":"2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "123a"
},
{
"isDefault": false,
"validFor": {
"startDateTime":"2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Note"
},
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Galaxy"
}
]
},
{
"name": "Make",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"customProfileSpecCharValue": [
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Apple"
},
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Samsung"
}
]
}
],
"profileType": "TRADE_IN"
}
]
Example of Response Body
The following shows an example of the response body in JSON format.
[
{
"id": "CustomProfileSpec_001",
"name": "CustomProfileSpec_001",
"description": "Custom profile Spec desc",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/customProfileSpecifications/CustomProfileSpec_001",
"version": "1.0",
"lifecycleStatus": "In design",
"@type": "CustomProfileSpecificationOracle",
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"project": {
"id": "BulkDocProject",
"name": "Bulk Doc Project",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
},
"customProfileSpecChar": [
{
"name": "DeviceType",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"customProfileSpecCharValue": [
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Mobile"
},
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Tablet"
}
]
},
{
"name": "Family",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"customProfileSpecCharValue": [
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "123a"
},
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Note"
},
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Galaxy"
}
]
},
{
"name": "Make",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"customProfileSpecCharValue": [
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Apple"
},
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Samsung"
}
]
}
],
"profileType": "TRADE_IN"
},
{
"id": "CustomProfileSpec_002",
"name": "CustomProfileSpec_002",
"description": "Custom profile Spec desc",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/customProfileSpecifications/CustomProfileSpec_002",
"version": "1.0",
"lifecycleStatus": "In design",
"@type": "CustomProfileSpecificationOracle",
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"project": {
"id": "BulkDocProject",
"name": "Bulk Doc Project",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
},
"customProfileSpecChar": [
{
"name": "DeviceType",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"customProfileSpecCharValue": [
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Mobile"
},
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Tablet"
}
]
},
{
"name": "Family",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"customProfileSpecCharValue": [
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "123a"
},
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Note"
},
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Galaxy"
}
]
},
{
"name": "Make",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"customProfileSpecCharValue": [
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Apple"
},
{
"isDefault": false,
"validFor": {
"startDateTime": "2020-09-29T03:50:48.000Z"
},
"valueType": "STRING",
"value": "Samsung"
}
]
}
],
"profileType": "TRADE_IN"
}
]