Jump to

• Request
• Response

updateHiddenComponentTypes

put

/ccadmin/v1/components/hidden

Update Hidden Component Types. Endpoint for updating the hidden-from-studio-site flag on component descriptors which match the type in the input list.

Request

Supported Media Types

• application/json

Body ()

Root Schema : updateHiddenComponentTypes_request

Type: object

Show Source

• widgetDescriptors(optional): array widgetDescriptors
  Contains the components to be hidden or unhidden.

{
    "properties":{
        "widgetDescriptors":{
            "description":"Contains the components to be hidden or unhidden.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "hiddenFromSiteStudio":{
                        "description":"Is the component to be hidden or not.",
                        "type":"boolean"
                    },
                    "widgetType":{
                        "description":"The ID of the component to be hidden/unhidden.",
                        "type":"string"
                    }
                }
            }
        }
    },
    "example":{
        "widgetDescriptors":[
            {
                "hiddenFromSiteStudio":true,
                "widgetType":"600003"
            }
        ]
    }
}

Example:

{
    "widgetDescriptors":[
        {
            "hiddenFromSiteStudio":true,
            "widgetType":"600003"
        }
    ]
}

Nested Schema : widgetDescriptors

Type: array

Contains the components to be hidden or unhidden.

Show Source

• Array of: object items

{
    "description":"Contains the components to be hidden or unhidden.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "hiddenFromSiteStudio":{
                "description":"Is the component to be hidden or not.",
                "type":"boolean"
            },
            "widgetType":{
                "description":"The ID of the component to be hidden/unhidden.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• hiddenFromSiteStudio(optional): boolean
  Is the component to be hidden or not.
• widgetType(optional): string
  The ID of the component to be hidden/unhidden.

{
    "type":"object",
    "properties":{
        "hiddenFromSiteStudio":{
            "description":"Is the component to be hidden or not.",
            "type":"boolean"
        },
        "widgetType":{
            "description":"The ID of the component to be hidden/unhidden.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateHiddenComponentTypes_response

Type: object

Show Source

• repositoryId(optional): string
  The component ID of the widget.

{
    "properties":{
        "repositoryId":{
            "description":"The component ID of the widget.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "repositoryId":"600003",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/components/hidden"
        }
    ]
}

Default Response

The error response.

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top