api_auth

<back to all web services

AppDefinitionRequest

AppDefinitionRequest Parameters:
NameParameterData TypeRequiredDescription
LicenseKeyquerystringNo
AppDefinition Parameters:
NameParameterData TypeRequiredDescription
RootFolderformstringNo
EntryPointformstringNo
ModulesformClientDependency[]No
ClientDependency Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
TypeformstringNo
PlatformDependentformboolNo
LocationformstringNo
VersionRegKeyformVersionKeyNo
DependenciesformClientDependency[]No
VersionKey Parameters:
NameParameterData TypeRequiredDescription
NodeformstringNo
PathformstringNo
KeyformstringNo

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.

POST /jsv/reply/AppDefinitionRequest HTTP/1.1 
Host: 1.hyper.id 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	licenseKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	root: String,
	entry_point: String,
	modules: 
	[
		{
			name: String,
			type: String,
			platform_dependent: False,
			location: String,
			version_reg_key: 
			{
				node: String,
				path: String,
				key: String
			},
			dependencies: 
			[
				{
					name: String,
					type: String,
					platform_dependent: False,
					location: String,
					version_reg_key: 
					{
						node: String,
						path: String,
						key: String
					},
					dependencies: 
					[
						{
							name: String,
							type: String,
							platform_dependent: False,
							location: String,
							version_reg_key: 
							{
								node: String,
								path: String,
								key: String
							}
						}
					]
				}
			]
		}
	]
}