PaletteService provides operations for creating and managing palettes.
addPalette
Add a palette.
Capability required: SiteWrite
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| palette | Palette | The palette to add. | Req |
Response
PaletteResponse - The response, which indicates if the operation succeeded or failed, and the palette.
addPalettes
Add a list of palettes.
Quota is charged for each object in the request.
Capability required: SiteWrite
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| palettes | Palette[] | The list of palettes to add. | Req |
Response
PaletteResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of palettes.
copyPalette
Copy a palette.
Capability required: SiteWrite
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| paletteID | long | The ID of the palette to copy. | Req |
| newName | string | The new name of the palette to be created as a copy. | Req |
Response
PaletteResponse - The response, which indicates if the operation succeeded or failed and the newly copied palette.
deletePalette
Delete a palette.
Capability required: SiteWrite
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| paletteID | long | The ID of the palette to delete. | Req |
Response
BasicResponse - The response, which indicates if the operation succeeded or failed.
deletePalettes
Delete a list of palettes.
Quota is charged for each object in the request.
Capability required: SiteWrite
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| paletteIDs | long[] | The IDs of the palettes to delete. | Req |
Response
BasicResponse[] - The list of responses, which indicate if the operations succeeded or failed.
getPalette
Get a palette.
Capability required: SiteRead
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| paletteID | long | The ID of the palette to retrieve. | Req |
Response
Palette - The palette.
getPalettes
Get a list of palettes.
Quota is charged for each object in the request.
Capability required: SiteRead
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| paletteIDs | long[] | The IDs of the palettes to retrieve. | Req |
Response
Palette[] - The list of palettes.
getPalettesByAccountID
Get the palettes for an account.
Capability required: SiteRead
License command group: Inventory
Parameters
none
Response
Palette[] - The list of palettes for the account (in the request).
updatePalette
Update a palette.
Capability required: SiteWrite
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| palette | Palette | The palette to update. | Req |
Response
PaletteResponse - The response, which indicates if the operation succeeded or failed, and the palette.
updatePalettes
Update a list of palettes.
Quota is charged for each object in the request.
Capability required: SiteWrite
License command group: Inventory
Parameters
| Parameter | Data Type | Description | Restriction |
|---|---|---|---|
| palettes | Palette[] | The list of palettes to update. | Req |
Response
PaletteResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of palettes.