Licensed capabilities service v1.1

Resource: capabilities

A structured set of capability definitions.

http://{device}/api/npm.capabilities/1.1/capabilities{?namespace}

JSON

{
  <prop>: any
}

{
  <prop>: any
}

Property Name	Type	Description	Notes
capabilities	<object>	A structured set of capability definitions.
capabilities.<prop>	<any>		Optional;

Links

capabilities: get

GET http://{device}/api/npm.capabilities/1.1/capabilities{?namespace}

Response Body

Returns a capabilities data object.

Resource: capabilities_event

http://{device}/api/npm.capabilities/1.1/notification_events/items/{id}

JSON

{
  "hdr": event_header,
  <prop>: any
}

{
  "hdr": event_header,
  <prop>: any
}

Property Name	Type	Description	Notes
capabilities_event	<object>		Required properties: [hdr];
capabilities_event.hdr	<event_header>	Common properties for all events
capabilities_event.<prop>	<any>		Optional;

Links

capabilities_event: get

GET http://{device}/api/npm.capabilities/1.1/notification_events/items/{id}

Response Body

Returns a capabilities_event data object.

Relations

capabilities_event: instances

Related resource

capabilities_events

Resource: capabilities_events

http://{device}/api/npm.capabilities/1.1/capabilities_events

JSON

{
  "items": [ capabilities_event ],
  <prop>: any
}

{
  "items": [ capabilities_event ],
  <prop>: any
}

Property Name	Type	Notes
capabilities_events	<object>
capabilities_events.items	<array of <capabilities_event>>	Optional;
capabilities_events.items[items]	<capabilities_event>
capabilities_events.<prop>	<any>	Optional;

Links

capabilities_events: create

POST http://{device}/api/npm.capabilities/1.1/capabilities_events

Request Body

Provide a capabilities_event data object.

Response Body

Returns a capabilities_event data object.

capabilities_events: get

GET http://{device}/api/npm.capabilities/1.1/capabilities_events

Response Body

Returns a capabilities_events data object.

Resource: feature

Reports on the status of a software feature.

http://{device}/api/npm.capabilities/1.1/features/items/{name}

JSON

{
  "beta": boolean,
  "beta_enabled": boolean,
  "beta_expired": any,
  "beta_expires": integer,
  "enabled": any,
  "licensed": any,
  "name": string,
  "valid": boolean,
  <prop>: any
}

{
  "beta": boolean,
  "beta_enabled": boolean,
  "beta_expired": any,
  "beta_expires": integer,
  "enabled": any,
  "licensed": any,
  "name": string,
  "valid": boolean,
  <prop>: any
}

Property Name	Type	Description	Notes
feature	<object>	Reports on the status of a software feature.
feature.beta	<boolean>	True if this is a beta feature.	Read-only; Optional; Default is False;
feature.beta_enabled	<boolean>	Only if 'beta' is true, this may be set to true to enable the beta feature's functionality.	Optional; Default is False;
feature.beta_expired	<any>	True if the beta functionality time period has expired.	Read-only; Optional;
feature.beta_expires	<integer>	Epoch format date/time (in UTC) at which this feature expires if it's a beta feature.	Read-only; Optional;
feature.enabled	<any>	If false, this feature is unavailable.	Read-only; Optional;
feature.licensed	<any>	True if an active license for this feature is installed.	Read-only; Optional;
feature.name	<string>	The abbreviation of a feature tied to a license. One of: framework, mspec, wta, asa, cxa, dba, uca.	Read-only; Optional;
feature.valid	<boolean>	True if use of this feature is permitted by an installed license or as a beta feature.	Read-only; Optional;
feature.<prop>	<any>		Optional;

Links

feature: get

GET http://{device}/api/npm.capabilities/1.1/features/items/{name}

Response Body

Returns a feature data object.

feature: set

PUT http://{device}/api/npm.capabilities/1.1/features/items/{name}

Request Body

Provide a feature data object.

Response Body

Returns a feature data object.

Resource: features

http://{device}/api/npm.capabilities/1.1/features

JSON

{
  "items": [ feature ],
  <prop>: any
}

{
  "items": [ feature ],
  <prop>: any
}

Property Name	Type	Description	Notes
features	<object>
features.items	<array of <feature>>		Optional;
features.items[items]	<feature>	Reports on the status of a software feature.
features.<prop>	<any>		Optional;

Links

features: get

GET http://{device}/api/npm.capabilities/1.1/features

Response Body

Returns a features data object.

Resource: model

http://{device}/api/npm.capabilities/1.1/model

JSON

{
  "platform": string,
  "product_model": string,
  <prop>: any
}

{
  "platform": string,
  "product_model": string,
  <prop>: any
}

Property Name	Type	Notes
model	<object>
model.platform	<string>	Optional;
model.product_model	<string>	Optional;
model.<prop>	<any>	Optional;

Links

model: get

GET http://{device}/api/npm.capabilities/1.1/model

Response Body

Returns a model data object.

Type: capability

A name/value pair describing a limit or capability

JSON

{
  "name": string,
  "value": multiple
}

{
  "name": string,
  "value": multiple
}

Property Name	Type	Description	Notes
capability	<object>	A name/value pair describing a limit or capability
capability.name	<string>	Name of the capability	Optional;
capability.value	<multiple>	Value for the capability.	Optional;
capability.value.oneOf[0]	<null>
capability.value.oneOf[1]	<number>
capability.value.oneOf[2]	<integer>
capability.value.oneOf[3]	<string>
capability.value.oneOf[4]	<object>
capability.value.oneOf[4].<prop>	<any>		Optional;