Jump to

• Request
• Response

listApplicationStylings

get

/ccadmin/v1/applicationStyling

List application stylings.

Request

Supported Media Types

• application/json

Query Parameters

• applicationId: string
  The ID of Application to retrieve application stylings for.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listApplicationStylings_response

Type: object

Show Source

• items: array items
  The array of collection items.

{
    "properties":{
        "items":{
            "description":"The array of collection items.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "filename":{
                        "description":"name of the CSS file.",
                        "type":"string"
                    },
                    "ranking":{
                        "description":"Ranking (order) for the application styling file.",
                        "type":"integer"
                    },
                    "sites":{
                        "description":"ID of zero or more site associations for the application styling. If empty array then the application styling is available for all sites.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "repositoryId":{
                                    "description":"Repository id of site.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "applicationId":{
                        "description":"ID of the application.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The array of collection items.

Show Source

• Array of: object items

{
    "description":"The array of collection items.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "filename":{
                "description":"name of the CSS file.",
                "type":"string"
            },
            "ranking":{
                "description":"Ranking (order) for the application styling file.",
                "type":"integer"
            },
            "sites":{
                "description":"ID of zero or more site associations for the application styling. If empty array then the application styling is available for all sites.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "repositoryId":{
                            "description":"Repository id of site.",
                            "type":"string"
                        }
                    }
                }
            },
            "applicationId":{
                "description":"ID of the application.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• applicationId: string
  ID of the application.
• filename: string
  name of the CSS file.
• ranking: integer
  Ranking (order) for the application styling file.
• sites: array sites
  ID of zero or more site associations for the application styling. If empty array then the application styling is available for all sites.

{
    "type":"object",
    "properties":{
        "filename":{
            "description":"name of the CSS file.",
            "type":"string"
        },
        "ranking":{
            "description":"Ranking (order) for the application styling file.",
            "type":"integer"
        },
        "sites":{
            "description":"ID of zero or more site associations for the application styling. If empty array then the application styling is available for all sites.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository id of site.",
                        "type":"string"
                    }
                }
            }
        },
        "applicationId":{
            "description":"ID of the application.",
            "type":"string"
        }
    }
}

Nested Schema : sites

Type: array

ID of zero or more site associations for the application styling. If empty array then the application styling is available for all sites.

Show Source

• Array of: object items

{
    "description":"ID of zero or more site associations for the application styling. If empty array then the application styling is available for all sites.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"Repository id of site.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId: string
  Repository id of site.

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository id of site.",
            "type":"string"
        }
    }
}

Example Response (application/json)

[
    {
        "filename":"customStyling1.css",
        "repositoryId":"500001",
        "ranking":0,
        "sites":[
        ],
        "applicationId":"cloudlake"
    },
    {
        "filename":"customStyling2.css",
        "repositoryId":"500002",
        "ranking":20,
        "sites":[
            {
                "repositoryId":"siteUS"
            }
        ],
        "applicationId":"cloudlake"
    }
]

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: 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: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: 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