Update the Azure Cosmos DB Cassandra API instance subclient properties

Select

SaaS

Customer Managed

This operation is used to update the Azure Cosmos DB Cassandra api Instance subclient properties

Path Parameters

• subclientId integer required

  Subclient Id of the Azure Cosmos DB Cassandra API instance to be updated

application/json

Request Body required

Request Body

• subClientProperties object

  cloudAppsSubClientProp object

  instanceType string

  cloudDbContent object

  children object[]

  allOrAnyChildren boolean

  name string

  type string

  path string

  displayName string

  negation boolean

  planEntity object

  planId integer
• association object

  entity object[]

  subclientId integer

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object[]

  warningCode integer

  errorCode integer

  warningMessage string

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "warningCode": 0,
      "errorCode": 0,
      "warningMessage": "string"
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "warningCode": 0,
      "errorCode": 0,
      "warningMessage": ""
    }
  ]
}

Bad Request

application/json

• Schema
• Example

---

Schema

• string

Request body is empty or format is invalid

application/xml

• Schema
• Example (from schema)

---

Schema

• object

<root/>

Unauthorized

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Access Denied",
  "errorCode": 5
}

POST /subclient/:subclientid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

subclientId — path required

Body required

• Default
• Example1

---

{
  "subClientProperties": {
    "cloudAppsSubClientProp": {
      "instanceType": "string"
    },
    "cloudDbContent": {
      "children": [
        {
          "allOrAnyChildren": true,
          "name": "string",
          "type": "string",
          "path": "string",
          "displayName": "string",
          "negation": true
        }
      ]
    },
    "planEntity": {
      "planId": 0
    }
  },
  "association": {
    "entity": [
      {
        "subclientId": 0
      }
    ]
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "cloudAppsSubClientProp": {
      "instanceType": "string"
    },
    "cloudDbContent": {
      "children": [
        {
          "allOrAnyChildren": true,
          "name": "string",
          "type": "string",
          "path": "string",
          "displayName": "string",
          "negation": true
        }
      ]
    },
    "planEntity": {
      "planId": 0
    }
  },
  "association": {
    "entity": [
      {
        "subclientId": 0
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "cloudAppsSubClientProp": {
      "instanceType": "string"
    },
    "cloudDbContent": {
      "children": [
        {
          "allOrAnyChildren": true,
          "name": "string",
          "type": "string",
          "path": "string",
          "displayName": "string",
          "negation": true
        }
      ]
    },
    "planEntity": {
      "planId": 0
    }
  },
  "association": {
    "entity": [
      {
        "subclientId": 0
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "cloudAppsSubClientProp": {
      "instanceType": "string"
    },
    "cloudDbContent": {
      "children": [
        {
          "allOrAnyChildren": true,
          "name": "string",
          "type": "string",
          "path": "string",
          "displayName": "string",
          "negation": true
        }
      ]
    },
    "planEntity": {
      "planId": 0
    }
  },
  "association": {
    "entity": [
      {
        "subclientId": 0
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "cloudAppsSubClientProp": {
      "instanceType": "string"
    },
    "cloudDbContent": {
      "children": [
        {
          "allOrAnyChildren": true,
          "name": "string",
          "type": "string",
          "path": "string",
          "displayName": "string",
          "negation": true
        }
      ]
    },
    "planEntity": {
      "planId": 0
    }
  },
  "association": {
    "entity": [
      {
        "subclientId": 0
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "cloudAppsSubClientProp": {
      "instanceType": "string"
    },
    "cloudDbContent": {
      "children": [
        {
          "allOrAnyChildren": true,
          "name": "string",
          "type": "string",
          "path": "string",
          "displayName": "string",
          "negation": true
        }
      ]
    },
    "planEntity": {
      "planId": 0
    }
  },
  "association": {
    "entity": [
      {
        "subclientId": 0
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "cloudAppsSubClientProp": {
      "instanceType": "string"
    },
    "cloudDbContent": {
      "children": [
        {
          "allOrAnyChildren": true,
          "name": "string",
          "type": "string",
          "path": "string",
          "displayName": "string",
          "negation": true
        }
      ]
    },
    "planEntity": {
      "planId": 0
    }
  },
  "association": {
    "entity": [
      {
        "subclientId": 0
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "cloudAppsSubClientProp": {
      "instanceType": "string"
    },
    "cloudDbContent": {
      "children": [
        {
          "allOrAnyChildren": true,
          "name": "string",
          "type": "string",
          "path": "string",
          "displayName": "string",
          "negation": true
        }
      ]
    },
    "planEntity": {
      "planId": 0
    }
  },
  "association": {
    "entity": [
      {
        "subclientId": 0
      }
    ]
  }
}'