Net3 API Interface for Customer Portal

<back to all web services

UpdateBackupCustomerApplications

Update Backup Customer Applications Status

Requires Authentication
The following routes are available for this service:
PUT/backup/backupcustomer/applications
UpdateBackupCustomerApplications Parameters:
NameParameterData TypeRequiredDescription
locationbodystringNoURL for underlying backup system
uuidbodystringNoUUID of Backup Customer
tenantapplicationsbodyOfferingItemsNoList of Applications to Update
environmentbodyN3TEnvironmentNoEnvironment

Allowable Values

  • DEV
  • QA
  • UAT
  • PROD
  • DEMO
  • EXT
OfferingItems Parameters:
NameParameterData TypeRequiredDescription
offering_itemsformList<OfferingItem>No
check_usageformboolNo
OfferingItem Parameters:
NameParameterData TypeRequiredDescription
statusformintNo
nameformstringNo
application_idformstringNo
quotaformQuotaNo
Quota Parameters:
NameParameterData TypeRequiredDescription
versionformlongNo
overageformlong?No
valueformlong?No
N3TEnvironment Enum:
DEV
QA
UAT
PROD
DEMO
EXT
UpdateBackupCustomerApplicationsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformExecuteResult<OfferingItemSuccess>No
ResponseStatusformResponseStatusNo
ExecuteResult<T> Parameters:
NameParameterData TypeRequiredDescription
HasErrorformboolNo
MessageformstringNo
ResultformTNo
ExceptionformExceptionNo
OfferingItemSuccess Parameters:
NameParameterData TypeRequiredDescription
itemsformList<SuccessItem>No
timestampformDateTimeNo
SuccessItem Parameters:
NameParameterData TypeRequiredDescription
measurement_unitformstringNo
usage_nameformstringNo
application_idformstringNo
tenant_idformstringNo
updated_atformDateTimeNo
deleted_atformObjectNo
typeformstringNo
editionformstringNo
nameformstringNo
lockedformbool?No
statusformintNo
quotaformQuotaNo
infra_idformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /backup/backupcustomer/applications HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	location: String,
	uuid: String,
	tenantapplications: 
	{
		offering_items: 
		[
			{
				status: 0,
				name: String,
				application_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
		}
	}
}