Create a destination
https://{FusionAppsHost}/crmRestApi/resources/11.13.18.05/PublishingAPI/publishDestination
Request
There are no request parameters for this operation.
- application/json
object
PublishDestinationOracle
-
characteristics: object
DestinationCharacteristicsOracle
Title:
DestinationCharacteristicsOracle
The publish destination characteristics -
created: string
(date-time)
The date and time when the record was created.
-
createdBy: string
The user who created the record.
-
description: string
The description of the Destination.
-
entryLifecycleStatus: string
The lifecycle status associated with Destination.
-
href: string
Hyperlink reference to the target constraint
-
id: string
The unique identifier of the publish destination.
-
lastUpdate: string
(date-time)
The date and time when the destination was last updated.
-
lastUpdatedBy: string
The user who updated the record.
-
mode: string
The mode of Destination like Internal etc.
-
name(required): string
Name of the Destination. You can filter destinations using the desitnation name. For example, DestinationName=RecordName. The DestinationName is the target-name of the Fabric systemDescriptor (TTD) for the registered spoke system projectPublishEvent endpoint.
-
publishExclusionRule: array
publishExclusionRule
-
type(required): string
The type of Destination like BRM etc.
-
url: string
The URL of the destination.
-
version: string
The version of Destination.
object
DestinationCharacteristicsOracle
-
order: integer
the order of publish.
array
-
Array of:
object PublishExclusionRuleOracle
Title:
PublishExclusionRuleOracle
The publish exclusion rule
object
PublishExclusionRuleOracle
-
Description: string
A string. Description of the product rule.
-
ExclusionRule: string
Metering Expression applicable to the product rule
-
id: string
A string. Unique identifier of the product rule.
-
resourceType: string
A string. The name given to the product rule
Response
- application/json
201 Response
object
PublishDestinationOracle
-
characteristics: object
DestinationCharacteristicsOracle
Title:
DestinationCharacteristicsOracle
The publish destination characteristics -
created: string
(date-time)
The date and time when the record was created.
-
createdBy: string
The user who created the record.
-
description: string
The description of the Destination.
-
entryLifecycleStatus: string
The lifecycle status associated with Destination.
-
href: string
Hyperlink reference to the target constraint
-
id: string
The unique identifier of the publish destination.
-
lastUpdate: string
(date-time)
The date and time when the destination was last updated.
-
lastUpdatedBy: string
The user who updated the record.
-
mode: string
The mode of Destination like Internal etc.
-
name(required): string
Name of the Destination. You can filter destinations using the desitnation name. For example, DestinationName=RecordName. The DestinationName is the target-name of the Fabric systemDescriptor (TTD) for the registered spoke system projectPublishEvent endpoint.
-
publishExclusionRule: array
publishExclusionRule
-
type(required): string
The type of Destination like BRM etc.
-
url: string
The URL of the destination.
-
version: string
The version of Destination.
object
DestinationCharacteristicsOracle
-
order: integer
the order of publish.
array
-
Array of:
object PublishExclusionRuleOracle
Title:
PublishExclusionRuleOracle
The publish exclusion rule
object
PublishExclusionRuleOracle
-
Description: string
A string. Description of the product rule.
-
ExclusionRule: string
Metering Expression applicable to the product rule
-
id: string
A string. Unique identifier of the product rule.
-
resourceType: string
A string. The name given to the product rule
400 Response
object
Error
-
@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
401 Response
object
Error
-
@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
object
Error
-
@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
object
Error
-
@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
object
Error
-
@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 a destination by submitting a post request on the REST resource using cURL.
cURL Command
curl -u username:password -X POST
https://{FusionAppsHost}/crmRestApi/resources/11.13.18.05/PublishingAPI/publishDestination
-H 'Content-Type: application/json' -D @create_publishdestination.json |
json_pp
Example of Request Body
The following shows an example of the request body in JSON format.
{ "name": "siebel-test", "type": "siebel", "id": 300100626551273, "mode": "Internal", "characteristics": { "order": 1 }, "publishExclusionRule": [ { "resourceType": "productOffering", "exclusionRule": "(VALUEOF(productType) IN_LIST (COMMERCIAL_BUNDLE,SERVICE_BUNDLE))" } ] }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "name": "siebel-test", "type": "siebel", "lastUpdate": "2025-02-19T15:03:27.004Z", "lastUpdatedBy": "booth", "created": "2025-01-13T07:54:08.000Z", "createdBy": "booth", "id": 300100626551273, "mode": "Internal", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/PublishingAPI/publishDestination/300100626551273", "publishExclusionRule": [ { "resourceType": "productOffering", "exclusionRule": "(VALUEOF(productType) IN_LIST (COMMERCIAL_BUNDLE,SERVICE_BUNDLE))" } ], "characteristics": { "order": 1 } }