REST API Reference for Launch Cloud Service

Get a destination

get

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

Request

Path Parameters

id(required): string

The unique identifier of the resource item.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Root Schema : PublishDestinationOracle

Type: object

Title: PublishDestinationOracle

Show Source

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.

{
    "title":"PublishDestinationOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier of the publish destination."
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the record was created."
        },
        "name":{
            "type":"string",
            "description":"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."
        },
        "url":{
            "type":"string",
            "description":"The URL of the destination."
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference to the target constraint"
        },
        "characteristics":{
            "$ref":"#/components/schemas/DestinationCharacteristicsOracle"
        },
        "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."
        },
        "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"
            }
        }
    },
    "required":[
        "name",
        "type"
    ]
}

Nested Schema : DestinationCharacteristicsOracle

Type: object

Title: DestinationCharacteristicsOracle

The publish destination characteristics

Show Source

order: integer

the order of publish.

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

Nested Schema : publishExclusionRule

Type: array

Show Source

Array of: object PublishExclusionRuleOracle

Title: PublishExclusionRuleOracle

The publish exclusion rule

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PublishExclusionRuleOracle"
    }
}

Nested Schema : PublishExclusionRuleOracle

Type: object

Title: PublishExclusionRuleOracle

The publish exclusion rule

Show Source

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

{
    "type":"object",
    "title":"PublishExclusionRuleOracle",
    "description":"The publish exclusion rule",
    "properties":{
        "id":{
            "type":"string",
            "description":"A string. Unique identifier of the product rule."
        },
        "resourceType":{
            "type":"string",
            "description":"A string. The name given to the product rule"
        },
        "Description":{
            "type":"string",
            "description":"A string. Description of the product rule."
        },
        "ExclusionRule":{
            "type":"string",
            "description":"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

Show Source

@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

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

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

Show Source

@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

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

404 Response

Your request includes a resource URI that doesn't exist.

Root Schema : Error

Type: object

Title: Error

Show Source

@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

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

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

Show Source

@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

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

500 Response

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

Root Schema : Error

Type: object

Title: Error

Show Source

@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

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

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": "2024-11-28T06:32:45.062Z",
    "lastUpdatedBy": "booth",
    "created": "2024-11-28T06:32:45.000Z",
    "createdBy": "booth",
    "modificationNumber": 1,
    "id": 300100614433908,
    "mode": "Internal",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/PublishingAPI/publishDestination/300100614433908",
    "publishExclusionRule": [
        {
            "resourceType": "productOffering",
            "exclusionRule": "(VALUEOF(productType) IN_LIST (COMMERCIAL_BUNDLE,SERVICE_BUNDLE))"
        }
    ],
    "characteristics": {
        "order": 2
    }
}