Jump to

• Request
• Response
• Examples

Copy a catalog item

post

/api/20210901/catalog/{type}/{id}/actions/copy

Create a copy of a catalog item with a given type and ID to the same folder or a different folder. Includes the option to specify a different name for the copy and whether to overwrite an existing item with the same name.

Request

Path Parameters

• id(required): string
  Catalog item ID in base64url format.
• type(required):
  Type of catalog item. These content types are supported

  • folders - Folders containing catalog objects.
  • workbooks - Workbooks.
  • subjectAreas - Subject areas.
  • datasets - Datasets.
  • connections - Objects containing connection details.
  • dataflows - Data flows.
  • models - Predictive and machine learning models.
  • sequences - Sequences.
  • analysis - Analyses.
  • reports - Pixel-perfect reports (BIP reports).
  • dashboards - Dashboards.
  • dashboardpages - Dashboard pages.
  • dashboardgroupfolders - Workbooks and dashboards available from the Navigation menu on the Home page.
  • scripts - Custom scripts for machine learning and data curation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• createIntermediateFolders: boolean
  Create all intermediate folders if any folder in the parent folder hierarchy doesn't currently exist.
• destId: string
  Catalog item identifier for destination item.
• destParentId: string
  Parent folder ID.
• newItemName: string
  Name for the new catalog item that you copy.
• overwrite: boolean
  If specified and true, overwrite the destination catalog item if it exists.

{
    "type":"object",
    "properties":{
        "destId":{
            "type":"string",
            "description":"Catalog item identifier for destination item."
        },
        "destParentId":{
            "type":"string",
            "description":"Parent folder ID."
        },
        "newItemName":{
            "type":"string",
            "description":"Name for the new catalog item that you copy."
        },
        "overwrite":{
            "type":"boolean",
            "description":"If specified and true, overwrite the destination catalog item if it exists."
        },
        "createIntermediateFolders":{
            "type":"boolean",
            "description":"Create all intermediate folders if any folder in the parent folder hierarchy doesn't currently exist."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : CatalogItem

Match All

Show Source

• object CatalogItemIdRef
• object CatalogItemParentIdNameRef
• object Discriminator: type
  Discriminator: { "propertyName":"type" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CatalogItemIdRef"
        },
        {
            "$ref":"#/components/schemas/CatalogItemParentIdNameRef"
        },
        {
            "type":"object",
            "properties":{
                "description":{
                    "type":"string",
                    "description":"Catalog item description, if any"
                },
                "type":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Types"
                        },
                        {
                            "description":"Catalog item type"
                        },
                        {
                        }
                    ]
                },
                "owner":{
                    "type":"string",
                    "description":"Catalog item owner"
                },
                "lastModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Catalog item last modified date and time"
                }
            },
            "discriminator":{
                "propertyName":"type"
            }
        }
    ]
}

Nested Schema : Discriminator: type

Type: object

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"Catalog item description, if any"
        },
        "type":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Types"
                },
                {
                    "description":"Catalog item type"
                },
                {
                }
            ]
        },
        "owner":{
            "type":"string",
            "description":"Catalog item owner"
        },
        "lastModified":{
            "type":"string",
            "format":"date-time",
            "description":"Catalog item last modified date and time"
        }
    },
    "discriminator":{
        "propertyName":"type"
    }
}

Show Source

• description: string
  Catalog item description, if any
• lastModified: string (date-time)
  Catalog item last modified date and time
• owner: string
  Catalog item owner
• type: type

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"Catalog item description, if any"
        },
        "type":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Types"
                },
                {
                    "description":"Catalog item type"
                },
                {
                }
            ]
        },
        "owner":{
            "type":"string",
            "description":"Catalog item owner"
        },
        "lastModified":{
            "type":"string",
            "format":"date-time",
            "description":"Catalog item last modified date and time"
        }
    },
    "discriminator":{
        "propertyName":"type"
    }
}

Nested Schema : CatalogItemIdRef

Type: object

Show Source

• id: string
  Catalog item identifier

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Catalog item identifier"
        }
    }
}

Nested Schema : CatalogItemParentIdNameRef

Type: object

Show Source

• name: string
  Catalog item name
• parentId: string
  Catalog parent item identifier (if catalog item has a parent)

{
    "type":"object",
    "properties":{
        "parentId":{
            "type":"string",
            "description":"Catalog parent item identifier (if catalog item has a parent)"
        },
        "name":{
            "type":"string",
            "description":"Catalog item name"
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

403 Response

Forbidden (missing permissions for operation, request denied for unspecified reason, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

404 Response

Not Found. The requested resource was not found.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

Back to Top

Examples

These examples show you how to copy a catalog object with a given type and id.

• Example 1 - Copy a workbook into the same folder
• Example 2 - Copy a workbook into a different folder

When you copy an object, you can specify several, optional parameter in the request body:

• destId - Destination path where you want to save the copied object. If specified, none of the other parameters are used.
• destParentId and newItemName - Copies the object to a specific destination folder and gives the copied object a new name. The new name is not Base64URL-safe encoded.
• newItemName - New name for the copied object. If you don't specify destParentId, a copy is created in the same folder with the new name.

Example 1 - Copy a workbook into the same folder

In this example, you create a copy of a workbook called MySalesWorkbook in the same folder. The object ID of the workbook is /@Catalog/shared/Sales/MySalesWorkbook which has the Base64URL-safe encoded id value L0BDYXRhbG9nL3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s

The new workbook is named MySalesWookbookCopy because the option newItemName is not provided.

cURL Example:

Run the cURL command with the required type and id:

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Length: 0' \
     --request POST 'https://<hostname>/api/20210901/catalog/workbooks/L0BDYXRhbG9nL3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s/actions/copy'

Example of Request Body

None required for this example

Example of Response Body

Status 200:

Example 2 - Copy a workbook into a different folder

In this example, you copy a workbook called MySalesWorkbook into a different folder. The object ID of the workbook is /@Catalog/shared/Sales/MySalesWorkbook which has the Base64URL-safe encoded id value L0BDYXRhbG9nL3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s

The object ID of the destination folder is /@Catalog/shared/NewSales which has the Base64URL-safe encoded destParentId value L0BDYXRhbG9nL3NoYXJlZC9OZXdTYWxlcw

cURL Example:

Run the cURL command with the required id and destId:

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request POST 'https://<hostname>/api/20210901/catalog/workbooks/L0BDYXRhbG9nL3NoYXJlZC9NeUZvbGRlci9NeVNhbGVzV29ya2Jvb2s/actions/copy' \
     --data '{"destId": "L0BDYXRhbG9nL3NoYXJlZC9OZXdTYWxlcw"}'

Example of Request Body

{"destId": "string", 
      "destParentId": "string", 
      "newItemName": "string", 
      "overwrite": true, 
      "createIntermediateFolders": true}

For example:

{"destParentId": "L0BDYXRhbG9nL3NoYXJlZC9OZXdTYWxlcw" }

Example of Response Body

Status 200:
{    "owner": "<user-name>",
    "name": "MySalesWorkbook copy",
    "description": "",
    "id": "L3NoYXJlZC9OZXdTYWxlcy9NeVNhbGVzV29ya2Jvb2sgY29weQ",
    "lastModified": "2024-02-27T17:15:46Z",
    "type": "workbooks",
    "parentId": "L3NoYXJlZC9OZXdTYWxlcw"
}

Back to Top