Create Informix Database Group

Select

SaaS

Customer Managed

This operation creates a database group in a Informix Instance

application/json

Request Body

• subClientProperties object

  subClientEntity object

  clientName string required

  Client name

  instanceName string required

  Instance Name

  displayName string

  instanceId integer

  Instance ID

  instanceGUID string

  clientId integer

  Client ID

  appName string required

  Default value: Informix

  Application Name

  applicationId integer

  Default value: 3

  Application ID

  entityInfo object

  companyId integer

  companyName string

  multiCommcellId integer

  backupsetId integer

  subclientId integer

  subclientName string

  Subclient Name

  commonProperties object

  planEntity object

  planId integer

  Plan ID to be associated to the subclient

  contentOperationType integer

  informixSubclientProp object

  backupMode string required

  Backup mode of the subclient

  incrementalLevel integer

  Default value: 1

  Backup level for incremental job

  maxBarStreams integer

  Number of data backup streams to be used for backup

  content object[]

  informixContent object

  Informix content to be part of the subclient

  fileType integer

  tableSpace string

  Name of the DB space. Need to mentioned for selective backup mode.

Responses

• 200
• 400
• 401
• 409
• 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

  entity object

  subclientId integer

  ID of create

  _type_ integer

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

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

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
}

Conflict

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "A subclient by this name already exists as part of this backup set.",
  "errorCode": 3
}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Example
• Example 1

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "Failed to create new subclient.",
  "errorCode": 1
}

{
  "errorMessage": "User does not have [Use Plan] rights on plan(s)-[Invalid PlanId].",
  "errorCode": 1
}

POST /subclient    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

token

Body

• Default
• New subclient with 'Full and Current logical logs' Backup mode
• New subclient with Entire Instance Backup mode
• New subclient with Selective Backup mode

---

{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "instanceId": 0,
      "instanceGUID": "string",
      "clientId": 0,
      "appName": "Informix",
      "applicationId": 3,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      },
      "backupsetId": 0,
      "subclientId": 0,
      "subclientName": "string"
    },
    "commonProperties": {},
    "planEntity": {
      "planId": 0
    },
    "contentOperationType": 0,
    "informixSubclientProp": {
      "backupMode": "string",
      "incrementalLevel": 1,
      "maxBarStreams": 0
    },
    "content": [
      {
        "informixContent": {
          "fileType": 0,
          "tableSpace": "string"
        }
      }
    ]
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "instanceId": 0,
      "instanceGUID": "string",
      "clientId": 0,
      "appName": "Informix",
      "applicationId": 3,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      },
      "backupsetId": 0,
      "subclientId": 0,
      "subclientName": "string"
    },
    "commonProperties": {},
    "planEntity": {
      "planId": 0
    },
    "contentOperationType": 0,
    "informixSubclientProp": {
      "backupMode": "string",
      "incrementalLevel": 1,
      "maxBarStreams": 0
    },
    "content": [
      {
        "informixContent": {
          "fileType": 0,
          "tableSpace": "string"
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "instanceId": 0,
      "instanceGUID": "string",
      "clientId": 0,
      "appName": "Informix",
      "applicationId": 3,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      },
      "backupsetId": 0,
      "subclientId": 0,
      "subclientName": "string"
    },
    "commonProperties": {},
    "planEntity": {
      "planId": 0
    },
    "contentOperationType": 0,
    "informixSubclientProp": {
      "backupMode": "string",
      "incrementalLevel": 1,
      "maxBarStreams": 0
    },
    "content": [
      {
        "informixContent": {
          "fileType": 0,
          "tableSpace": "string"
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "instanceId": 0,
      "instanceGUID": "string",
      "clientId": 0,
      "appName": "Informix",
      "applicationId": 3,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      },
      "backupsetId": 0,
      "subclientId": 0,
      "subclientName": "string"
    },
    "commonProperties": {},
    "planEntity": {
      "planId": 0
    },
    "contentOperationType": 0,
    "informixSubclientProp": {
      "backupMode": "string",
      "incrementalLevel": 1,
      "maxBarStreams": 0
    },
    "content": [
      {
        "informixContent": {
          "fileType": 0,
          "tableSpace": "string"
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "instanceId": 0,
      "instanceGUID": "string",
      "clientId": 0,
      "appName": "Informix",
      "applicationId": 3,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      },
      "backupsetId": 0,
      "subclientId": 0,
      "subclientName": "string"
    },
    "commonProperties": {},
    "planEntity": {
      "planId": 0
    },
    "contentOperationType": 0,
    "informixSubclientProp": {
      "backupMode": "string",
      "incrementalLevel": 1,
      "maxBarStreams": 0
    },
    "content": [
      {
        "informixContent": {
          "fileType": 0,
          "tableSpace": "string"
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "instanceId": 0,
      "instanceGUID": "string",
      "clientId": 0,
      "appName": "Informix",
      "applicationId": 3,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      },
      "backupsetId": 0,
      "subclientId": 0,
      "subclientName": "string"
    },
    "commonProperties": {},
    "planEntity": {
      "planId": 0
    },
    "contentOperationType": 0,
    "informixSubclientProp": {
      "backupMode": "string",
      "incrementalLevel": 1,
      "maxBarStreams": 0
    },
    "content": [
      {
        "informixContent": {
          "fileType": 0,
          "tableSpace": "string"
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "instanceId": 0,
      "instanceGUID": "string",
      "clientId": 0,
      "appName": "Informix",
      "applicationId": 3,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      },
      "backupsetId": 0,
      "subclientId": 0,
      "subclientName": "string"
    },
    "commonProperties": {},
    "planEntity": {
      "planId": 0
    },
    "contentOperationType": 0,
    "informixSubclientProp": {
      "backupMode": "string",
      "incrementalLevel": 1,
      "maxBarStreams": 0
    },
    "content": [
      {
        "informixContent": {
          "fileType": 0,
          "tableSpace": "string"
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "instanceId": 0,
      "instanceGUID": "string",
      "clientId": 0,
      "appName": "Informix",
      "applicationId": 3,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      },
      "backupsetId": 0,
      "subclientId": 0,
      "subclientName": "string"
    },
    "commonProperties": {},
    "planEntity": {
      "planId": 0
    },
    "contentOperationType": 0,
    "informixSubclientProp": {
      "backupMode": "string",
      "incrementalLevel": 1,
      "maxBarStreams": 0
    },
    "content": [
      {
        "informixContent": {
          "fileType": 0,
          "tableSpace": "string"
        }
      }
    ]
  }
}'