Net3 API Interface for Customer Portal

<back to all web services

TenantOfferingItemsByEditionSCS

Retrieve list of Tenant SCS Offering Items By Edition

Requires Authentication
The following routes are available for this service:
GET/backup/backupcustomer/offeringItemsByEdition/scs
TenantOfferingItemsByEditionSCS Parameters:
NameParameterData TypeRequiredDescription
locationquerystringYesURL for underlying backup system
uuidquerystringYesUUID of Tenant
editionquerystringYesEdition Filter
environmentqueryN3TEnvironmentYesEnvironment

Allowable Values

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

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.

GET /backup/backupcustomer/offeringItemsByEdition/scs HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		hasError: False,
		message: String,
		result: 
		{
			timestamp: 0001-01-01,
			items: 
			[
				{
					usage_name: String,
					type: String,
					locked: False,
					measurement_unit: String,
					infra_id: String,
					edition: String,
					application_id: String,
					status: 0,
					name: String,
					tenant_id: String,
					quota: 
					{
						version: 0,
						overage: 0,
						value: 0
					},
					deleted_at: {},
					updated_at: 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
		}
	}
}