| PUT | /backup/backupcustomer/OfferingItem |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| location | body | string | No | URL for underlying backup system |
| uuid | body | string | No | UUID of Backup Customer |
| updateOfferingItems | body | UpdateOfferingItems | No | Offering Item to Update |
| environment | body | N3TEnvironment | No | EnvironmentAllowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| offering_items | form | List<UpdateOfferingItem> | No | |
| check_usage | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| usage_name | form | string | No | |
| type | form | string | No | |
| locked | form | bool? | No | |
| measurement_unit | form | string | No | |
| infra_id | form | string | No | |
| deleted_at | form | Object | No | |
| edition | form | string | No | |
| application_id | form | string | No | |
| updated_at | form | DateTime? | No | |
| status | form | int | No | |
| name | form | string | No | |
| tenant_id | form | string | No | |
| quota | form | Quota | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| version | form | long | No | |
| overage | form | long? | No | |
| value | form | long? | No |
| DEV | |
| QA | |
| UAT | |
| PROD | |
| DEMO | |
| EXT |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | ExecuteResult<OfferingItemSuccess> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| HasError | form | bool | No | |
| Message | form | string | No | |
| Result | form | T | No | |
| Exception | form | Exception | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| items | form | List<SuccessItem> | No | |
| timestamp | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| measurement_unit | form | string | No | |
| usage_name | form | string | No | |
| application_id | form | string | No | |
| tenant_id | form | string | No | |
| updated_at | form | DateTime | No | |
| deleted_at | form | Object | No | |
| type | form | string | No | |
| edition | form | string | No | |
| name | form | string | No | |
| locked | form | bool? | No | |
| status | form | int | No | |
| quota | form | Quota | No | |
| infra_id | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /backup/backupcustomer/OfferingItem HTTP/1.1
Host: n3tapi.palmettovdc.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
location: String,
uuid: String,
updateOfferingItems:
{
offering_items:
[
{
usage_name: String,
type: String,
locked: False,
measurement_unit: String,
infra_id: String,
deleted_at: {},
edition: String,
application_id: String,
updated_at: 0001-01-01,
status: 0,
name: String,
tenant_id: String,
quota:
{
version: 0,
overage: 0,
value: 0
}
}
],
check_usage: False
},
environment: DEV
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
result:
{
hasError: False,
message: String,
result:
{
items:
[
{
measurement_unit: String,
usage_name: String,
application_id: String,
tenant_id: String,
updated_at: 0001-01-01,
deleted_at: {},
type: String,
edition: String,
name: String,
locked: False,
status: 0,
quota:
{
version: 0,
overage: 0,
value: 0
},
infra_id: String
}
],
timestamp: 0001-01-01
},
exception: Exception of type 'System.Exception' was thrown.
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}