REST API Reference for Launch Cloud Service

Get a destination

get

https://{FusionAppsHost}/crmRestApi/resources/11.13.18.05/PublishingAPI/publishDestination/{id}

Returns the destination that matches the specified ID, including its configured details.

Request

Path Parameters

id(required): string

The ID of the resource item.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

The publish destination was returned successfully.

Root Schema : PublishDestinationOracle

Type: object

Title: PublishDestinationOracle

The publish destination resource.

Show Source

characteristics: object DestinationCharacteristicsOracle

Title: DestinationCharacteristicsOracle

The destination characteristic resource.
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.
excludeReferences: boolean

Whether the publish destination has exclude references.
href: string

The hyperlink reference to the publish destination.
id: string

The ID of the publish destination.
isDesignTime: boolean

Whether the publish destination is design time.
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

The name of the destination. You can filter destinations by destination name, for example DestinationName=RecordName. DestinationName is the target name of the Fabric system descriptor for the registered spoke system projectPublishEvent target.
pauseEnabled: boolean

Whether the publish destination has pause enabled.
publishExclusionRule: array publishExclusionRule

A list of publish exclusion rules associated with the publish destination.
type(required): string

The type of Destination like BRM etc.
url: string

The URL of the destination.
version: string

The version of Destination.

{
    "title":"PublishDestinationOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the publish destination."
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the record was created."
        },
        "name":{
            "type":"string",
            "description":"The name of the destination. You can filter destinations by destination name, for example DestinationName=RecordName. DestinationName is the target name of the Fabric system descriptor for the registered spoke system projectPublishEvent target."
        },
        "url":{
            "type":"string",
            "description":"The URL of the destination."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the publish destination."
        },
        "characteristics":{
            "$ref":"#/components/schemas/DestinationCharacteristicsOracle",
            "description":"The publish destination."
        },
        "description":{
            "type":"string",
            "description":"The description of the Destination."
        },
        "type":{
            "type":"string",
            "description":"The type of Destination like BRM etc."
        },
        "mode":{
            "type":"string",
            "description":"The mode of Destination like Internal etc."
        },
        "version":{
            "type":"string",
            "description":"The version of Destination."
        },
        "entryLifecycleStatus":{
            "type":"string",
            "description":"The lifecycle status associated with Destination."
        },
        "isDesignTime":{
            "type":"boolean",
            "description":"Whether the publish destination is design time."
        },
        "excludeReferences":{
            "type":"boolean",
            "description":"Whether the publish destination has exclude references."
        },
        "pauseEnabled":{
            "type":"boolean",
            "description":"Whether the publish destination has pause enabled."
        },
        "createdBy":{
            "type":"string",
            "description":"The user who created the record."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the destination was last updated."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The user who updated the record."
        },
        "publishExclusionRule":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PublishExclusionRuleOracle"
            },
            "description":"A list of publish exclusion rules associated with the publish destination."
        }
    },
    "required":[
        "name",
        "type"
    ],
    "description":"The publish destination resource."
}

Nested Schema : DestinationCharacteristicsOracle

Type: object

Title: DestinationCharacteristicsOracle

The destination characteristic resource.

Show Source

order: integer

The order of publish.

{
    "type":"object",
    "title":"DestinationCharacteristicsOracle",
    "description":"The destination characteristic resource.",
    "properties":{
        "order":{
            "type":"integer",
            "description":"The order of publish."
        }
    }
}

Nested Schema : publishExclusionRule

Type: array

A list of publish exclusion rules associated with the publish destination.

Show Source

Array of: object PublishExclusionRuleOracle

Title: PublishExclusionRuleOracle

The publish exclusion rule resource.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PublishExclusionRuleOracle"
    },
    "description":"A list of publish exclusion rules associated with the publish destination."
}

Nested Schema : PublishExclusionRuleOracle

Type: object

Title: PublishExclusionRuleOracle

The publish exclusion rule resource.

Show Source

Description: string

A string. Description of the product rule.
ExclusionRule: string

The metering Expression applicable to the product rule.
id: string

The ID of the publish exclusion rule.
resourceType: string

The type or classification of the publish exclusion rule.

{
    "type":"object",
    "title":"PublishExclusionRuleOracle",
    "description":"The publish exclusion rule resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the publish exclusion rule."
        },
        "resourceType":{
            "type":"string",
            "description":"The type or classification of the publish exclusion rule."
        },
        "Description":{
            "type":"string",
            "description":"A string. Description of the product rule."
        },
        "ExclusionRule":{
            "type":"string",
            "description":"The metering Expression applicable to the product rule."
        }
    }
}

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 get a destination by submitting a get 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/{id} -H 'Content-Type: application/json' | json_pp

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