Sign in
Setup Component

Update

Update an existing Setup Component record by ID.

put/api/cp/setup/component/{id}

Path parameters

idinteger required

Id identifier

Request body

idinteger

Id

account_idinteger

Account Id

namestring required

Name

pathstring

Path

sectionstring

Section

titlestring

Title

subtitlestring required

Subtitle

graph_type'line' | 'area' | 'bar' | 'pie' | 'radar' | 'sankey' | 'gauge'

Graph Type

colspaninteger

Colspan

heightinteger required

Height

outputstring[]

Output

queriesstring

Queries

graphobject

Graph

scriptforge_idinteger

Scriptforge Id

analytic_idinteger

Analytic Id

pre_processor_scriptstring

Pre Processor Script

Example request

{
  "id": 12345,
  "account_id": 1,
  "name": "Example Name",
  "path": "example_path",
  "section": "example_section",
  "title": "Example Name",
  "subtitle": "example_subtitle",
  "graph_type": "line",
  "colspan": 1,
  "height": 123,
  "output": "graph",
  "queries": "example_queries",
  "graph": "Sample graph text content",
  "scriptforge_id": 1,
  "analytic_id": 1,
  "pre_processor_script": "Sample pre_processor_script text content"
}

Response

Operation completed successfully

statusstring

Operation status

Example response

{
  "status": "OK"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.