Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

BlueprintDocument clone request

Description

Clone a document. The operation receives a name string, representing the new name to assign to the cloned document. It creates a new document in the workspace (version = 0) which is a copy of the source document, and a corresponding new blueprint.

API stability classification

Unassigned

API overview


HTTP
method

URI

Return
type

Return type
multiplicity

POST

csm/BlueprintDocument/guid/clone

1


HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Request message body

This API uses the following objects in the request message body JSON.

Top-level objects


Name

Type

Multi-
plicity

Description

callbackURL
String

0..1

URL to call when the operation finishes

postCallout
String

0..1

Identifier of a callout to run after the operation executes

preCallout
String

0..1

Identifier of a callout to run before the operation executes

timeout
Integer

0..1

Timeout setting. For more information about using the timeout, see Synchronous-and-asynchronous-operations. Timeout values:

  • 0: Immediate timeout
  • -1: Uses the system default timeout value
  • 1..*: Times out in the specified number of seconds
operationParams

1

Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing-input-parameters-with-an-API-request.


Input parameters to include in operationParams


Name

Type

Multi-
plicity

Description

name
String

1

 


Ensure that you enter the correct nameCloneBluePrint in the request body.

{
   "operationParams": [
       {
           "name": "name",
           "type": "java.lang.String",
           "multiplicity": "1",
           "value": "ClonedBlueprintAPI"({nameCloneBluePrint})
       }
    ],
   "timeout": -1
}


HTTP response message

Response message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Response message body

The response message body contains a Task object.

[
   {
       "cloudClass": "com.bmc.cloud.model.beans.BlueprintDocument",
       "author": "Admin",
       "baseDocument": "/blueprintdocument/0c8c5c4a-5cbb-4641-9a22-d860e522614a",
       "blueprint": "/blueprint/4e503c51-7782-491a-b522-da758f57c1a3",
       "blueprintObject": {
           "cloudClass": "com.bmc.cloud.model.beans.Blueprint",
           "author": "Admin",
           "category": "ServiceBlueprint",
           "description": "IMPORTED_BP",
           "guid": "4e503c51-7782-491a-b522-da758f57c1a3",
           "name": "ClonedBlueprintAPI",
           "provider": "/provider/5bda6741-3375-4672-90c3-6f2980bc5998",
           "purpose": "ServiceOfferingModel",
           "state": "NEW",
           "workingCopy": "/blueprintdocument/6cfdbf4b-bee8-433f-a496-3af282f3b467"
       },
       "category": "ServiceBlueprint",
       "content": "{\r\n \"category\" : \"ServiceBlueprint\",\r\n \"purpose\" : \"ServiceOfferingModel\",\r\n \"author\" : \"clmadmin\",\r\n \"schemaVersion\" : \"4.6\",\r\n \"configurations\" : [ {\r\n \"functionalModel\" : {\r\n \"functionalcomponent\" : [ {\r\n \"software\" : [ {\r\n \"installableResourceType\" : \"Product Catalog\",\r\n \"productcatalogid\" : \"PDC000000012130\",\r\n \"sequence\" : 1,\r\n \"standard\" : true,\r\n \"guid\" : \"1f314555-6861-40fe-907a-08222e31c05d\",\r\n \"name\" : \"Windows_MySQL\"\r\n } ],\r\n \"guid\" : \"e46d391a-54c8-4571-9667-b40b519d6243\",\r\n \"name\" : \"App1\",\r\n \"tags\" : [ {\r\n \"tag\" : \"RS\",\r\n \"taggroup\" : \"CLM\"\r\n } ]\r\n } ],\r\n \"guid\" : \"8fa08844-9211-4a0a-9ea3-a31965f78b79\"\r\n },\r\n \"deploymentModel\" : {\r\n \"resourceset\" : [ {\r\n \"functionalComponentReferences\" : [ {\r\n \"type\" : \"functionalcomponent\",\r\n \"objectGuid\" : \"e46d391a-54c8-4571-9667-b40b519d6243\",\r\n \"guid\" : \"09303ac0-3d7e-4200-b7a9-fa61b2f0b855\"\r\n } ],\r\n \"compute\" : {\r\n \"instances\" : 1,\r\n \"computecontainer\" : {\r\n \"cloudPlatforms\" : [ {\r\n \"name\" : \"vmware\",\r\n \"installableresources\" : [ \"PDC000000012427\" ],\r\n \"guid\" : \"8c012b05-3cdb-4c00-a4db-c7519801afc1\"\r\n } ],\r\n \"memory\" : [ {\r\n \"mb\" : 2048,\r\n \"policy\" : \"No Less Than\",\r\n \"guid\" : \"662d02d8-432f-471e-99e7-70ee2b709ae4\"\r\n } ],\r\n \"cpus\" : [ {\r\n \"count\" : 2,\r\n \"policy\" : \"No Less Than\",\r\n \"guid\" : \"2ad64099-3fdc-4f2a-a2d2-e853eacb4b4c\"\r\n } ],\r\n \"hwarchitecture\" : \"Unknown\",\r\n \"virtual\" : true,\r\n \"installsoftware\" : true,\r\n \"guid\" : \"6f348fcb-475f-4697-adf4-e5bdc0a1e684\",\r\n \"name\" : \"vmware\",\r\n \"tags\" : [ {\r\n \"tag\" : \"Large\",\r\n \"taggroup\" : \"VDR\"\r\n } ]\r\n },\r\n \"guid\" : \"029b2a4b-b8ae-4f60-8c03-4b5bdfec8f90\",\r\n \"tags\" : [ {\r\n \"tag\" : \"Large\",\r\n \"taggroup\" : \"VDR\"\r\n } ]\r\n },\r\n \"network\" : {\r\n \"nics\" : [ {\r\n \"isdhcp\" : true,\r\n \"nicnumber\" : 0,\r\n \"publicip\" : false,\r\n \"useExternalDNS\" : false,\r\n \"ipForDNS\" : \"PrivateIP\",\r\n \"guid\" : \"870b75e3-ad87-4bc3-a590-1a25a4926d08\",\r\n \"tags\" : [ {\r\n \"tag\" : \"Management\",\r\n \"taggroup\" : \"NetworkType\"\r\n } ]\r\n }, {\r\n \"isdhcp\" : true,\r\n \"nicnumber\" : 1,\r\n \"publicip\" : false,\r\n \"useExternalDNS\" : false,\r\n \"ipForDNS\" : \"PrivateIP\",\r\n \"guid\" : \"5b459579-e2c6-4dc6-bbb0-496dd108c96c\",\r\n \"tags\" : [ {\r\n \"tag\" : \"Customer\",\r\n \"taggroup\" : \"NetworkType\"\r\n } ]\r\n } ],\r\n \"guid\" : \"17ca8308-92d2-4616-b46d-bcd9d1bf119b\"\r\n },\r\n \"guid\" : \"de94ad8c-24f9-4ecb-845b-24f2d0ab07ee\",\r\n \"name\" : \"Server Group 1\",\r\n \"tags\" : [ {\r\n \"tag\" : \"VM_Cluster1\",\r\n \"taggroup\" : \"CP\"\r\n }, {\r\n \"tag\" : \"RS\",\r\n \"taggroup\" : \"CLM\"\r\n } ]\r\n } ],\r\n \"functionalModelReference\" : {\r\n \"type\" : \"functionalmodel\",\r\n \"objectGuid\" : \"8fa08844-9211-4a0a-9ea3-a31965f78b79\",\r\n \"guid\" : \"20ac2786-2fbf-480c-8d66-4d4803808d02\"\r\n },\r\n \"installorder\" : {\r\n \"installstep\" : [ {\r\n \"sequence\" : 1,\r\n \"objectReferences\" : [ {\r\n \"type\" : \"resourceset\",\r\n \"objectGuid\" : \"de94ad8c-24f9-4ecb-845b-24f2d0ab07ee\",\r\n \"guid\" : \"4e4662d8-ddb1-4881-a614-daa38b4f479e\"\r\n } ],\r\n \"guid\" : \"49b24927-64a2-4b81-8d7b-773cd8cab8d5\"\r\n }, {\r\n \"sequence\" : 2,\r\n \"objectReferences\" : [ {\r\n \"type\" : \"functionalcomponent\",\r\n \"objectGuid\" : \"e46d391a-54c8-4571-9667-b40b519d6243\",\r\n \"guid\" : \"1dd577e0-d93c-41ad-ab0d-db680919688d\"\r\n } ],\r\n \"guid\" : \"9abb1efc-e97c-4824-acea-4b3a958d7034\"\r\n } ],\r\n \"guid\" : \"46a6cf67-7740-4ea8-a280-7baac1caf5e9\"\r\n },\r\n \"monitoring\" : {\r\n \"enable\" : true,\r\n \"enablePolicies\" : false,\r\n \"guid\" : \"2baa05e4-079d-47f7-9f8f-9c87cfbd54fb\"\r\n },\r\n \"guid\" : \"e83c5f11-148c-4d96-a3a6-95ea927f92a4\"\r\n },\r\n \"guid\" : \"447b90d0-ae03-4156-944f-ad61a6def996\",\r\n \"name\" : \"Definition 1\",\r\n \"tags\" : [ {\r\n \"tag\" : \"GOLD\",\r\n \"taggroup\" : \"NC\"\r\n }, {\r\n \"tag\" : \"Bronze\",\r\n \"taggroup\" : \"MonitoringLevel\"\r\n } ]\r\n } ],\r\n \"guid\" : \"f0cf041f-d9dc-47e8-8794-516423244a60\"\r\n}",
       "customFieldDefinitions": [],
       "description": "Cloned from SANITY-BP v1",
       "documentDate": 1565164236414,
       "guid": "6cfdbf4b-bee8-433f-a496-3af282f3b467",
       "name": "ClonedBlueprintAPI",
       "provider": "/provider/5bda6741-3375-4672-90c3-6f2980bc5998",
       "purpose": "ServiceOfferingModel",
       "schemaVersion": "4.6",
       "versionNumber": 0,
       "workspaceCopy": true
   }
]


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*