Create a channel
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/channel
Request
There are no request parameters for this operation.
- application/json
objectChannelOracle-
@baseType: string
The base type of the channel.
-
@schemaLocation: string
The URI of the schema that defines the channel.
-
@type(required): string
The class type of the channel.
-
applicationName: string
The name of the application associated with the channel.
-
channelType: string
The type or classification of the channel.
-
created: string
(date-time)
The date and time of the channel creation.
-
createdBy: string
The name of the person who created the channel.
-
description: string
The description of channel.
-
externalId: string
The ID of the external associated with the channel.
-
href: string
The hyperlink reference to the channel.
-
id: string
Maximum Length:
30The ID of the channel. -
lastUpdate: string
(date-time)
The date and time when the channel was last updated.
-
lastUpdatedBy: string
The name of the person who updated the channel.
-
lifecycleStatus: string
The status of the channel.
-
name(required): string
The name of the channel.
-
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
The channel version.
-
versionState: number
The version state of the channel.
objectProjectRef-
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.
objectTimePeriod-
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.
Response
- application/json
201 Response
objectChannelOracle-
@baseType: string
The base type of the channel.
-
@schemaLocation: string
The URI of the schema that defines the channel.
-
@type(required): string
The class type of the channel.
-
applicationName: string
The name of the application associated with the channel.
-
channelType: string
The type or classification of the channel.
-
created: string
(date-time)
The date and time of the channel creation.
-
createdBy: string
The name of the person who created the channel.
-
description: string
The description of channel.
-
externalId: string
The ID of the external associated with the channel.
-
href: string
The hyperlink reference to the channel.
-
id: string
Maximum Length:
30The ID of the channel. -
lastUpdate: string
(date-time)
The date and time when the channel was last updated.
-
lastUpdatedBy: string
The name of the person who updated the channel.
-
lifecycleStatus: string
The status of the channel.
-
name(required): string
The name of the channel.
-
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
The channel version.
-
versionState: number
The version state of the channel.
objectProjectRef-
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.
objectTimePeriod-
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.
400 Response
objectError-
@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.
401 Response
objectError-
@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.
404 Response
objectError-
@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.
405 Response
objectError-
@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.
500 Response
objectError-
@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.
Examples
The following examples show how to create a channel by submitting a POST request on the REST resource using cURL.
cURL Command
curl -u username:password -X POST
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/channel
\ -H 'Content-Type: application/json' -D @channel_create.json | json_pp
Example of Request Body
The following example shows the contents of the request body in JSON format.
{
"validFor": {
"startDateTime": "2025-09-12T00:00:00.000Z",
"endDateTime": "2025-10-09T00:00:00.000Z"
},
"project": {
"id": "P-2341675923-1758270057151",
"name": "Retire Init3",
"@type": "ProjectRef",
"@referredType": "ProjectOracle"
},
"version": "1.0",
"lifecycleStatus": "In design",
"description": "Channel Test",
"id": "CH-3109730861-1758272609752",
"name": "channel-new1",
"@type": "ChannelOracle"
}
Example of Response Body
The following shows an example of the response body in JSON format.
{
"id": "CH-3109730861-1758272609752",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/channel/CH-3109730861-1758272609752",
"name": "channel-new1",
"description": "Channel Test",
"validFor": {
"startDateTime": "2025-09-12T00:00:00.000Z",
"endDateTime": "2025-10-09T00:00:00.000Z"
},
"@type": "ChannelOracle",
"version": "1.0",
"created": "2025-09-19T09:03:41.000Z",
"createdBy": "booth",
"lastUpdate": "2025-10-22T05:24:38.018Z",
"lastUpdatedBy": "booth",
"lifecycleStatus": "In design",
"project": {
"id": "P-2341675923-1758270057151",
"name": "Retire Init3",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/P-2341675923-1758270057151",
"version": "1.0",
"@referredType": "ProjectOracle",
"@type": "ProjectRef"
}
}