Jump to

• Request
• Response
• Examples

Move a catalog item

post

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

Move a catalog item with a given type and id to a specific folder. Use this API to move folders, workbooks, subject areas, analyses, dashboards, dashboard pages, and reports. You can't use the API to move connections, datasets, data flows, sequences, scripts, or semantic models.

Request

Path Parameters

• id(required): string
  Catalog item ID in base64url format.
• type(required):
  Type of catalog item. The content types that this API supports include folders, workbooks, subject areas, analyses, dashboards, dashboard pages, reports, connections, datasets, data flows, sequences, scripts, and semantic models.

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":{
                    "$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":{
            "$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: string
  Allowed Values: [ "workbooks", "folders", "datasets", "connections", "dataflows", "models", "sequences", "subjectAreas", "analysis", "reports", "dashboards", "dashboardpages", "scripts" ]

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"Catalog item description, if any"
        },
        "type":{
            "$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

In this example, you move a catalog object with a given type (workbook) and a given id to a specific folder. The workbook is called MySalesWorkbook. 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/MySalesWorkbook which has the Base64URL-safe encoded destId value L0BDYXRhbG9nL3NoYXJlZC9OZXdTYWxlcy9NeVNhbGVzV29ya2Jvb2s

cURL Example:

First, obtain the object ID of the workbook you want to move and the object ID if the destination folder. Base64URL-safe encode both values to determine the id and destId. You can obtain the Object ID value from the Inspect dialog for the workbook (or folder) in Oracle Analytics Cloud.

Run the cURL command with the required type, id and destId :

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

Example of Request Body

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

For example:

{"destId": "L0BDYXRhbG9nL3NoYXJlZC9OZXdTYWxlcy9NeVNhbGVzV29ya2Jvb2s"}

Example of Response Body

Status 200:
{    
    "owner": "<User-Name>",
    "name": "MySalesWorkbook",
    "description": "",
    "id": "L3NoYXJlZC9OZXdTYWxlcy9NeVNhbGVzV29ya2Jvb2s",
    "lastModified": "2024-02-27T18:11:33Z",
    "type": "workbooks",
    "parentId": "L3NoYXJlZC9OZXdTYWxlcw"

Back to Top