Partially update showback configuration

PATCH 
/c/showback/showbacks/:id/

Updates one or more fields of an existing showback configuration. This allows partial modifications without requiring the full object. Common use cases include updating metadata, tags, or specific parameters related to the showback report.

Request

application/json

Body

required

extra_values string[]

Possible values: non-empty and <= 256 characters

tag_keys string[]

Possible values: non-empty and <= 256 characters

name Name (string)required

Possible values: non-empty and <= 256 characters

removed_showback_values Removed showback values (string)[]

Possible values: non-empty and <= 256 characters

active Active (boolean)
allocation_tag_type Allocation tag type (string)

Possible values: [tags, labels, cost_allocation_tags]

owner_id Owner id (integer)nullable

Possible values: >= -2147483648 and <= 2147483647

is_locked Is locked (boolean)

Responses

200

application/json

Schema

Schema

id ID (integer)
cost_distribution Cost distribution (string)
allocation_rules_cost_distribution Allocation rules cost distribution (string)
percentage_allocation_rules_distribution Percentage allocation rules distribution (string)

combined_values

object[]

Array [

id ID (integer)

combined_values string[]required

Possible values: non-empty and <= 256 characters

created date-time

modified date-time

name Name (string)required

Possible values: non-empty and <= 256 characters

showback Showback (integer)

]

extra_values string[]

Possible values: non-empty and <= 256 characters

tag_keys string[]

Possible values: non-empty and <= 256 characters

created date-time
modified date-time
client_id Client id (integer)
name Name (string)required

Possible values: non-empty and <= 256 characters

removed_showback_values Removed showback values (string)[]

Possible values: non-empty and <= 256 characters

active Active (boolean)
allocation_tag_type Allocation tag type (string)

Possible values: [tags, labels, cost_allocation_tags]

creator_id Creator id (integer)
owner_id Owner id (integer)nullable

Possible values: >= -2147483648 and <= 2147483647

is_locked Is locked (boolean)

Example (from schema)

{
  "id": 0,
  "cost_distribution": "string",
  "allocation_rules_cost_distribution": "string",
  "percentage_allocation_rules_distribution": "string",
  "combined_values": [
    {
      "id": 0,
      "combined_values": [
        "string"
      ],
      "created": "2024-07-29T15:51:28.071Z",
      "modified": "2024-07-29T15:51:28.071Z",
      "name": "string",
      "showback": 0
    }
  ],
  "extra_values": [
    "string"
  ],
  "tag_keys": [
    "string"
  ],
  "created": "2024-07-29T15:51:28.071Z",
  "modified": "2024-07-29T15:51:28.071Z",
  "client_id": 0,
  "name": "string",
  "removed_showback_values": [
    "string"
  ],
  "active": true,
  "allocation_tag_type": "tags",
  "creator_id": 0,
  "owner_id": 0,
  "is_locked": true
}

Loading...