COconnexcs
Setup Component

Update

Changed on

Update an existing Setup Component record by ID.

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

Request

  • Base URL
    https://app.connexcs.com
  • Auth
    • OAuth 2
      Authorization code: https://auth.connexcs.com/authorize
      Token URL: https://auth.connexcs.com/token
    • or HTTP bearer

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

  • fa097c4785b8Revision changes
    • info

      the endpoint scheme security oAuth2 was added to the API

    • info

      the endpoint scheme security opaqueToken was added to the API

    • info

      the endpoint scheme security basicAuth was removed from the API