Data
- Default Namespace
- XML Schema File: ns0.xsd
The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.
The following elements are members of this namespace:
The following types are members of this namespace:
- capabilities-list-resource
- capabilitiesListResponseResource
- capabilityFormFieldResource
- capability-property-resource
- capabilityRequestResource
- capability-resource
- capabilityResponseResource
- capabilityStatusResponseResource
- capability-type-resource
- capabilityTypeResourceResponse
- form-field
- nexusResponse
Element capabilities-list
REST Response object for a list of capabilities items, contains the typical 'data' parameter, which is the list of capabilities.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<capabilities-list>
<data>
<capabilities-list-item>
<!--content of type 'capabilities-list-resource'-->
<resourceURI>
<!--content of type 'string'-->
...
</resourceURI>
<id>
<!--content of type 'string'-->
...
</id>
<name>
<!--content of type 'string'-->
...
</name>
<typeId>
<!--content of type 'string'-->
...
</typeId>
<typeName>
<!--content of type 'string'-->
...
</typeName>
</capabilities-list-item>
<capabilities-list-item>
<!--(another 'capabilities-list-resource' type)-->
</capabilities-list-item>
<!--...more "capabilities-list-item" elements...-->
</data>
</capabilities-list>
Example JSON
{
"data" : [ {
"resourceURI" : "...",
"id" : "...",
"name" : "...",
"typeId" : "...",
"typeName" : "..."
}, ... ]
}
Element capability
REST Request object for a capability configuration add/update operation, contains the typical 'data' parameter, which is the capability configuration.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<capability>
<data>
<!--content of type 'capability-resource'-->
<id>
<!--content of type 'string'-->
...
</id>
<name>
<!--content of type 'string'-->
...
</name>
<typeId>
<!--content of type 'string'-->
...
</typeId>
<properties>
<capability-property>
<!--content of type 'capability-property-resource'-->
<key>
<!--content of type 'string'-->
...
</key>
<value>
<!--content of type 'string'-->
...
</value>
</capability-property>
<capability-property>
<!--(another 'capability-property-resource' type)-->
</capability-property>
<!--...more "capability-property" elements...-->
</properties>
</data>
</capability>
Example JSON
{
"data" : {
"id" : "...",
"name" : "...",
"typeId" : "...",
"properties" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
}
Element capability
REST Response object for a capability configuration request, contains the typical 'data' parameter, which is the capability configuration.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<capability>
<data>
<!--content of type 'capability-resource'-->
<id>
<!--content of type 'string'-->
...
</id>
<name>
<!--content of type 'string'-->
...
</name>
<typeId>
<!--content of type 'string'-->
...
</typeId>
<properties>
<capability-property>
<!--content of type 'capability-property-resource'-->
<key>
<!--content of type 'string'-->
...
</key>
<value>
<!--content of type 'string'-->
...
</value>
</capability-property>
<capability-property>
<!--(another 'capability-property-resource' type)-->
</capability-property>
<!--...more "capability-property" elements...-->
</properties>
</data>
</capability>
Example JSON
{
"data" : {
"id" : "...",
"name" : "...",
"typeId" : "...",
"properties" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
}
Element capability-status
REST Response object for a capability configuration add/update operation, contains the typical 'data' parameter, which is the capability configuration.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<capability-status>
<data>
<!--content of type 'capabilities-list-resource'-->
<resourceURI>
<!--content of type 'string'-->
...
</resourceURI>
<id>
<!--content of type 'string'-->
...
</id>
<name>
<!--content of type 'string'-->
...
</name>
<typeId>
<!--content of type 'string'-->
...
</typeId>
<typeName>
<!--content of type 'string'-->
...
</typeName>
</data>
</capability-status>
Example JSON
{
"data" : {
"resourceURI" : "...",
"id" : "...",
"name" : "...",
"typeId" : "...",
"typeName" : "..."
}
}
Element capability-types
REST Response object for a capability type list request, contains the typical 'data' parameter, which is the capability type details.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<capability-types>
<data>
<capability-type>
<!--content of type 'capability-type-resource'-->
<id>
<!--content of type 'string'-->
...
</id>
<name>
<!--content of type 'string'-->
...
</name>
<form-fields>
<form-field>
<!--content of type 'capabilityFormFieldResource'-->
</form-field>
<form-field>
<!--(another 'capabilityFormFieldResource' type)-->
</form-field>
<!--...more "form-field" elements...-->
</form-fields>
</capability-type>
<capability-type>
<!--(another 'capability-type-resource' type)-->
</capability-type>
<!--...more "capability-type" elements...-->
</data>
</capability-types>
Example JSON
{
"data" : [ {
"id" : "...",
"name" : "...",
"form-fields" : [ {
}, ... ]
}, ... ]
}
Type capabilities-list-resource
Capabilities list item details.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
resourceURI (string) | 0/1 | The URL that can be used to manage the capability. |
id (string) | 0/1 | The id of the capability. |
name (string) | 0/1 | The name of the capability. |
typeId (string) | 0/1 | The type id of the capability. |
typeName (string) | 0/1 | The type name of the capability. |
Type capabilitiesListResponseResource
- Extends: nexusResponse
REST Response object for a list of capabilities items, contains the typical 'data' parameter, which is the list of capabilities.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
capabilities-list-item (capabilities-list-resource) | 0/unbounded | Field data. |
Type capability-property-resource
A configuration property for a capability.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
key (string) | 0/1 | The key of the property. |
value (string) | 0/1 | The value of the property. |
Type capabilityRequestResource
- Extends: nexusResponse
REST Request object for a capability configuration add/update operation, contains the typical 'data' parameter, which is the capability configuration.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (capability-resource) | 0/1 | The capability configuration. |
Type capability-resource
The capability configuration.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
id (string) | 0/1 | The id of the capability. |
name (string) | 0/1 | The name of the capability. |
typeId (string) | 0/1 | The type id of the capability. |
capability-property (capability-property-resource) | 0/unbounded | Field properties. |
Type capabilityResponseResource
- Extends: nexusResponse
REST Response object for a capability configuration request, contains the typical 'data' parameter, which is the capability configuration.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (capability-resource) | 0/1 | The capability configuration. |
Type capabilityStatusResponseResource
- Extends: nexusResponse
REST Response object for a capability configuration add/update operation, contains the typical 'data' parameter, which is the capability configuration.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (capabilities-list-resource) | 0/1 | The capability status. |
Type capability-type-resource
Capability type, which you can configure a capability against.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
id (string) | 0/1 | The id of capability type. |
name (string) | 0/1 | The name of capability type. |
form-field (capabilityFormFieldResource) | 0/unbounded | Field formFields. |
Type capabilityTypeResourceResponse
- Extends: nexusResponse
REST Response object for a capability type list request, contains the typical 'data' parameter, which is the capability type details.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
capability-type (capability-type-resource) | 0/unbounded | Field data. |
Type form-field
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
id (string) | 0/1 | (no documentation provided) |
regexValidation (string) | 0/1 | (no documentation provided) |
label (string) | 0/1 | (no documentation provided) |
type (string) | 0/1 | (no documentation provided) |
required (boolean) | 1/1 | (no documentation provided) |
helpText (string) | 0/1 | (no documentation provided) |