UpdateCollection

Updates an existing collection. If the collection already exists, it will first delete the old collection and its collaborators, and then create a new collection with the provided details.

put
Authorizations
Body
collectionIdinteger · int32 | nullableOptional
collectionNamestring · min: 1Required
isFavouritebooleanOptional
rowLevelCollectionIdstring | nullableOptional
workspaceIdstring[]Required
workspaceNamestring[]Required
reportIdstring[]Required
reportNamestring[]Required
pageIdstring[]Required
createdBystring · min: 1Required
lastUpdatedBystring | nullableOptional
pageNamestring[]Required
createdDatestring · min: 1Required
lastUpdatedDatestring | nullableOptional
userActionsFlagboolean[]Required
userActionsstring[] | nullableOptional
isRLSboolean[]Required
datasetIdstring[] | nullableOptional
roleNamestring[] | nullableOptional
roleValuestring[] | nullableOptional
collaboratorEmailstring[]Required
collaboratorAccessstring[]Required
Responses
200
Success: The collection was successfully updated.
put
PUT /Collections/UpdateCollection HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 491

{
  "collectionId": 1,
  "collectionName": "text",
  "isFavourite": true,
  "rowLevelCollectionId": "text",
  "workspaceId": [
    "text"
  ],
  "workspaceName": [
    "text"
  ],
  "reportId": [
    "text"
  ],
  "reportName": [
    "text"
  ],
  "pageId": [
    "text"
  ],
  "createdBy": "text",
  "lastUpdatedBy": "text",
  "pageName": [
    "text"
  ],
  "createdDate": "text",
  "lastUpdatedDate": "text",
  "userActionsFlag": [
    true
  ],
  "userActions": [
    "text"
  ],
  "isRLS": [
    true
  ],
  "datasetId": [
    "text"
  ],
  "roleName": [
    "text"
  ],
  "roleValue": [
    "text"
  ],
  "collaboratorEmail": [
    "text"
  ],
  "collaboratorAccess": [
    "text"
  ]
}
No content
PreviousCreateCollectionNextDeleteCollection