Modify Informix Subclient

Select

SaaS

Customer Managed

This operation is used to modify subclient property

Path Parameters

• subclientId string required

  ID of database group

application/json

Request Body

• subClientProperties object

  planEntity object

  planName string

  Plan Name

  planId integer

  Plan ID

  commonProperties object

  contentOperationType integer

  informixSubclientProp object

  backupMode string

  Backup mode

  incrementalLevel integer

  Incremental level for backup

  maxBarStreams integer

  Number of backup stream used for backup

  content object[]

  informixContent object

  fileType integer

  tableSpace string

  Table

• association object

  entity object[]

  clientName string required

  Client name

  instanceName string required

  Instance Name

  displayName string

  backupsetId integer

  _type_ integer

  commCellName string

  instanceId integer

  Instance ID

  csGUID string

  subclientGUID string

  subclientId integer

  Subclient ID

  clientId integer

  Client ID

  appName string required

  Default value: Informix

  Application Name

  backupsetName string

  applicationId integer

  Default value: 3

  Application ID

  subclientName string required

  Suib

  entityInfo object

  companyId integer

  companyName string

  multiCommcellId integer

Responses

• 200
• 400
• 401
• 403
• 500

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

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": ""
    }
  ]
}

application/xml

• Schema
• Example (from schema)

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object[]

  warningCode integer

  Response warning code

  errorCode integer

  Response error code

  warningMessage string

  Response warning message

<root>
  <processinginstructioninfo>
    <attributes>
      <name>string</name>
      <value>string</value>
    </attributes>
  </processinginstructioninfo>
  <response>
    <warningCode>0</warningCode>
    <errorCode>0</errorCode>
    <warningMessage>string</warningMessage>
  </response>
</root>

Bad Request

application/json

• Schema
• Example

---

Schema

• string

Request body is empty or format is invalid.

Unauthorized

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

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

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

Forbidden

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "User [Remote User] does not have required capability [Agent Management] for this subclient and this operation.",
  "errorCode": 5
}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "Could not update property changes. Backup running for subclient.",
  "errorCode": 1
}

POST /subclient/:subclientid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

token

subclientId — path required

Body

• Default
• Changing the Plan
• Changing the backup mode
• Changing backup level for incremental

---

{
  "subClientProperties": {
    "planEntity": {
      "planName": "string",
      "planId": 0
    },
    "commonProperties": {},
    "contentOperationType": 0,
    "informixSubclientProp": {
      "backupMode": "string",
      "incrementalLevel": 0,
      "maxBarStreams": 0
    },
    "content": [
      {
        "informixContent": {
          "fileType": 0,
          "tableSpace": "string"
        }
      }
    ]
  },
  "association": {
    "entity": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "_type_": 0,
        "commCellName": "string",
        "instanceId": 0,
        "csGUID": "string",
        "subclientGUID": "string",
        "subclientId": 0,
        "clientId": 0,
        "appName": "Informix",
        "backupsetName": "string",
        "applicationId": 3,
        "subclientName": "string",
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        }
      }
    ]
  }
}

Accept

application/jsonapplication/xml

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": {
    "planEntity": {
      "planName": "string",
      "planId": 0
    },
    "commonProperties": {},
    "contentOperationType": 0,
    "informixSubclientProp": {
      "backupMode": "string",
      "incrementalLevel": 0,
      "maxBarStreams": 0
    },
    "content": [
      {
        "informixContent": {
          "fileType": 0,
          "tableSpace": "string"
        }
      }
    ]
  },
  "association": {
    "entity": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "_type_": 0,
        "commCellName": "string",
        "instanceId": 0,
        "csGUID": "string",
        "subclientGUID": "string",
        "subclientId": 0,
        "clientId": 0,
        "appName": "Informix",
        "backupsetName": "string",
        "applicationId": 3,
        "subclientName": "string",
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 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": {
    "planEntity": {
      "planName": "string",
      "planId": 0
    },
    "commonProperties": {},
    "contentOperationType": 0,
    "informixSubclientProp": {
      "backupMode": "string",
      "incrementalLevel": 0,
      "maxBarStreams": 0
    },
    "content": [
      {
        "informixContent": {
          "fileType": 0,
          "tableSpace": "string"
        }
      }
    ]
  },
  "association": {
    "entity": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "_type_": 0,
        "commCellName": "string",
        "instanceId": 0,
        "csGUID": "string",
        "subclientGUID": "string",
        "subclientId": 0,
        "clientId": 0,
        "appName": "Informix",
        "backupsetName": "string",
        "applicationId": 3,
        "subclientName": "string",
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 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": {
    "planEntity": {
      "planName": "string",
      "planId": 0
    },
    "commonProperties": {},
    "contentOperationType": 0,
    "informixSubclientProp": {
      "backupMode": "string",
      "incrementalLevel": 0,
      "maxBarStreams": 0
    },
    "content": [
      {
        "informixContent": {
          "fileType": 0,
          "tableSpace": "string"
        }
      }
    ]
  },
  "association": {
    "entity": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "_type_": 0,
        "commCellName": "string",
        "instanceId": 0,
        "csGUID": "string",
        "subclientGUID": "string",
        "subclientId": 0,
        "clientId": 0,
        "appName": "Informix",
        "backupsetName": "string",
        "applicationId": 3,
        "subclientName": "string",
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 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": {
    "planEntity": {
      "planName": "string",
      "planId": 0
    },
    "commonProperties": {},
    "contentOperationType": 0,
    "informixSubclientProp": {
      "backupMode": "string",
      "incrementalLevel": 0,
      "maxBarStreams": 0
    },
    "content": [
      {
        "informixContent": {
          "fileType": 0,
          "tableSpace": "string"
        }
      }
    ]
  },
  "association": {
    "entity": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "_type_": 0,
        "commCellName": "string",
        "instanceId": 0,
        "csGUID": "string",
        "subclientGUID": "string",
        "subclientId": 0,
        "clientId": 0,
        "appName": "Informix",
        "backupsetName": "string",
        "applicationId": 3,
        "subclientName": "string",
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 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": {
    "planEntity": {
      "planName": "string",
      "planId": 0
    },
    "commonProperties": {},
    "contentOperationType": 0,
    "informixSubclientProp": {
      "backupMode": "string",
      "incrementalLevel": 0,
      "maxBarStreams": 0
    },
    "content": [
      {
        "informixContent": {
          "fileType": 0,
          "tableSpace": "string"
        }
      }
    ]
  },
  "association": {
    "entity": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "_type_": 0,
        "commCellName": "string",
        "instanceId": 0,
        "csGUID": "string",
        "subclientGUID": "string",
        "subclientId": 0,
        "clientId": 0,
        "appName": "Informix",
        "backupsetName": "string",
        "applicationId": 3,
        "subclientName": "string",
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 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": {
    "planEntity": {
      "planName": "string",
      "planId": 0
    },
    "commonProperties": {},
    "contentOperationType": 0,
    "informixSubclientProp": {
      "backupMode": "string",
      "incrementalLevel": 0,
      "maxBarStreams": 0
    },
    "content": [
      {
        "informixContent": {
          "fileType": 0,
          "tableSpace": "string"
        }
      }
    ]
  },
  "association": {
    "entity": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "_type_": 0,
        "commCellName": "string",
        "instanceId": 0,
        "csGUID": "string",
        "subclientGUID": "string",
        "subclientId": 0,
        "clientId": 0,
        "appName": "Informix",
        "backupsetName": "string",
        "applicationId": 3,
        "subclientName": "string",
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 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": {
    "planEntity": {
      "planName": "string",
      "planId": 0
    },
    "commonProperties": {},
    "contentOperationType": 0,
    "informixSubclientProp": {
      "backupMode": "string",
      "incrementalLevel": 0,
      "maxBarStreams": 0
    },
    "content": [
      {
        "informixContent": {
          "fileType": 0,
          "tableSpace": "string"
        }
      }
    ]
  },
  "association": {
    "entity": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "_type_": 0,
        "commCellName": "string",
        "instanceId": 0,
        "csGUID": "string",
        "subclientGUID": "string",
        "subclientId": 0,
        "clientId": 0,
        "appName": "Informix",
        "backupsetName": "string",
        "applicationId": 3,
        "subclientName": "string",
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        }
      }
    ]
  }
}'