[Index]
View instances allow data entry based on a schema, but not necessarily with persistence, i.e. just a form.
Model ref.: data/View
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"name": {
"required": true,
"title": "Name",
"type": "string"
},
"doc": {
"title": "Documentation",
"description": "Used for generating reference documentation for the model.",
"type": "string"
},
"attr_props": {
"title": "Attribute Properties",
"type": "array",
"required": false,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"required": true
},
"title": {
"title": "Friendly Name",
"type": "string",
"description": "What to show as the name of the form field."
},
"description": {
"title": "Description",
"type": "string",
"description": "Provides a full description of the of purpose the instance property."
},
"type": {
"title": "Data Type",
"type": "string",
"required": true,
"choices": [
{
"value": "array",
"title": "Array"
},
{
"value": "boolean",
"title": "Boolean"
},
{
"value": "integer",
"title": "Integer"
},
{
"value": "null",
"title": "Null"
},
{
"value": "number",
"title": "Number"
},
{
"value": "object",
"title": "Object"
},
{
"value": "string",
"title": "String"
},
{
"value": "any",
"title": "Anything"
}
]
},
"minItems": {
"title": "Minimum Number of Values",
"type": "integer",
"description": "Defines the minimum number of values in an array when the array is the instance value."
},
"maxItems": {
"title": "Maximum Number of Values",
"type": "integer",
"description": "Defines the maximum number of values in an array when the array is the instance value."
},
"minLength": {
"title": "Minimum Length",
"type": "integer",
"description": "When the instance value is a string, this defines the minimum length of the string."
},
"maxLength": {
"title": "Maximum Length",
"type": "integer",
"description": "When the instance value is a string, this defines the maximum length of the string."
},
"minimum": {
"title": "Minimum",
"type": "number",
"description": "Defines the minimum value of the instance property when the type of the instance value is a number."
},
"maximum": {
"title": "Maximum",
"type": "number",
"description": "Defines the maximum value of the instance property when the type of the instance value is a number."
},
"version": {
"title": "Version",
"type": "string",
"description": "Defines the version of the instance for use by the packaging system."
},
"format": {
"title": "String Format",
"type": "string",
"required": false,
"choices": [
{
"value": "",
"title": ""
},
{
"value": "date",
"title": "Date (\"YYYY-MM-DD\")"
},
{
"value": "date-time",
"title": "Date-timestamp (\"YYYY-MM-DDThh:mm:ssZ\" in UTC)"
},
{
"value": "time",
"title": "Time (\"hh:mm:ss\")"
},
{
"value": "utc-millisec",
"title": "Milliseconds since 1 January 1970 00:00"
},
{
"value": "phone",
"title": "Phone number"
},
{
"value": "uri",
"title": "URI"
},
{
"value": "email",
"title": "E-mail address"
},
{
"value": "ip-address",
"title": "IP version 4 address"
},
{
"value": "ipv6",
"title": "IP version 6 address"
},
{
"value": "host-name",
"title": "Host name"
},
{
"value": "regex",
"title": "Regular expression"
},
{
"value": "link",
"title": "Link"
}
]
},
"is_password": {
"description": "Is the string field a password?",
"title": "Is Password?",
"type": "boolean"
},
"disable_confirmation": {
"description": "Disable confirmation field for password?",
"title": "Disable Password Confirmation",
"type": "boolean"
},
"store_encrypted": {
"description": "Should the field be stored encrypted?",
"title": "Store Encrypted?",
"type": "boolean"
},
"required": {
"title": "Is Mandatory?",
"type": "boolean"
},
"readonly": {
"description": "If a field is marked as read-only it cannot be changed once added.",
"title": "Is Read-Only?",
"type": "boolean"
},
"displayable": {
"title": "Is Displayable?",
"type": "boolean",
"description": "Marks whether the content of this field would be visible and therefore marked for translation."
},
"target": {
"description": "If Format is \"URI\", what is the entity type of the foreign key?",
"title": "Target",
"type": "string",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "",
"choices": []
},
"target_attr": {
"description": "If Format is \"URI\", what is the field name of the referenced resource?",
"title": "Target Field",
"type": "string",
"choices": {
"value": "",
"title": ""
}
},
"items": {
"title": "Items",
"description": "If Format is \"Array\", what are the properties of the items?",
"type": "object",
"properties": {
"type": {
"title": "Data Type",
"type": "string",
"choices": [
{
"value": "array",
"title": "Array"
},
{
"value": "boolean",
"title": "Boolean"
},
{
"value": "integer",
"title": "Integer"
},
{
"value": "null",
"title": "Null"
},
{
"value": "number",
"title": "Number"
},
{
"value": "object",
"title": "Object"
},
{
"value": "string",
"title": "String"
},
{
"value": "any",
"title": "Anything"
}
]
},
"attr_props": {
"title": "Attribute Properties",
"type": "array",
"required": false,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"required": true
},
"title": {
"title": "Friendly Name",
"type": "string",
"description": "What to show as the name of the form field."
},
"description": {
"title": "Description",
"type": "string",
"description": "Provides a full description of the of purpose the instance property."
},
"type": {
"title": "Data Type",
"type": "string",
"required": true,
"choices": [
{
"value": "array",
"title": "Array"
},
{
"value": "boolean",
"title": "Boolean"
},
{
"value": "integer",
"title": "Integer"
},
{
"value": "null",
"title": "Null"
},
{
"value": "number",
"title": "Number"
},
{
"value": "object",
"title": "Object"
},
{
"value": "string",
"title": "String"
},
{
"value": "any",
"title": "Anything"
}
]
},
"minItems": {
"title": "Minimum Number of Values",
"type": "integer",
"description": "Defines the minimum number of values in an array when the array is the instance value."
},
"maxItems": {
"title": "Maximum Number of Values",
"type": "integer",
"description": "Defines the maximum number of values in an array when the array is the instance value."
},
"minLength": {
"title": "Minimum Length",
"type": "integer",
"description": "When the instance value is a string, this defines the minimum length of the string."
},
"maxLength": {
"title": "Maximum Length",
"type": "integer",
"description": "When the instance value is a string, this defines the maximum length of the string."
},
"minimum": {
"title": "Minimum",
"type": "number",
"description": "Defines the minimum value of the instance property when the type of the instance value is a number."
},
"maximum": {
"title": "Maximum",
"type": "number",
"description": "Defines the maximum value of the instance property when the type of the instance value is a number."
},
"version": {
"title": "Version",
"type": "string",
"description": "Defines the version of the instance for use by the packaging system."
},
"format": {
"title": "String Format",
"type": "string",
"required": false,
"choices": [
{
"value": "",
"title": ""
},
{
"value": "date",
"title": "Date (\"YYYY-MM-DD\")"
},
{
"value": "date-time",
"title": "Date-timestamp (\"YYYY-MM-DDThh:mm:ssZ\" in UTC)"
},
{
"value": "time",
"title": "Time (\"hh:mm:ss\")"
},
{
"value": "utc-millisec",
"title": "Milliseconds since 1 January 1970 00:00"
},
{
"value": "phone",
"title": "Phone number"
},
{
"value": "uri",
"title": "URI"
},
{
"value": "email",
"title": "E-mail address"
},
{
"value": "ip-address",
"title": "IP version 4 address"
},
{
"value": "ipv6",
"title": "IP version 6 address"
},
{
"value": "host-name",
"title": "Host name"
},
{
"value": "regex",
"title": "Regular expression"
},
{
"value": "link",
"title": "Link"
}
]
},
"is_password": {
"description": "Is the string field a password?",
"title": "Is Password?",
"type": "boolean"
},
"disable_confirmation": {
"description": "Disable confirmation field for password?",
"title": "Disable Password Confirmation",
"type": "boolean"
},
"store_encrypted": {
"description": "Should the field be stored encrypted?",
"title": "Store Encrypted?",
"type": "boolean"
},
"required": {
"title": "Is Mandatory?",
"type": "boolean"
},
"readonly": {
"description": "If a field is marked as read-only it cannot be changed once added.",
"title": "Is Read-Only?",
"type": "boolean"
},
"displayable": {
"title": "Is Displayable?",
"type": "boolean",
"description": "Marks whether the content of this field would be visible and therefore marked for translation."
},
"target": {
"description": "If Format is \"URI\", what is the entity type of the foreign key?",
"title": "Target",
"type": "string",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "",
"choices": []
},
"target_attr": {
"description": "If Format is \"URI\", what is the field name of the referenced resource?",
"title": "Target Field",
"type": "string",
"choices": {
"value": "",
"title": ""
}
},
"items": {
"title": "Items",
"description": "If Format is \"Array\", what are the properties of the items?",
"type": "object",
"properties": {
"type": {
"title": "Data Type",
"type": "string",
"choices": [
{
"value": "array",
"title": "Array"
},
{
"value": "boolean",
"title": "Boolean"
},
{
"value": "integer",
"title": "Integer"
},
{
"value": "null",
"title": "Null"
},
{
"value": "number",
"title": "Number"
},
{
"value": "object",
"title": "Object"
},
{
"value": "string",
"title": "String"
},
{
"value": "any",
"title": "Anything"
}
]
},
"attr_props": {
"title": "Attribute Properties",
"type": "array",
"required": false,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"required": true
},
"title": {
"title": "Friendly Name",
"type": "string",
"description": "What to show as the name of the form field."
},
"description": {
"title": "Description",
"type": "string",
"description": "Provides a full description of the of purpose the instance property."
},
"type": {
"title": "Data Type",
"type": "string",
"required": true,
"choices": [
{
"value": "array",
"title": "Array"
},
{
"value": "boolean",
"title": "Boolean"
},
{
"value": "integer",
"title": "Integer"
},
{
"value": "null",
"title": "Null"
},
{
"value": "number",
"title": "Number"
},
{
"value": "object",
"title": "Object"
},
{
"value": "string",
"title": "String"
},
{
"value": "any",
"title": "Anything"
}
]
},
"minItems": {
"title": "Minimum Number of Values",
"type": "integer",
"description": "Defines the minimum number of values in an array when the array is the instance value."
},
"maxItems": {
"title": "Maximum Number of Values",
"type": "integer",
"description": "Defines the maximum number of values in an array when the array is the instance value."
},
"minLength": {
"title": "Minimum Length",
"type": "integer",
"description": "When the instance value is a string, this defines the minimum length of the string."
},
"maxLength": {
"title": "Maximum Length",
"type": "integer",
"description": "When the instance value is a string, this defines the maximum length of the string."
},
"minimum": {
"title": "Minimum",
"type": "number",
"description": "Defines the minimum value of the instance property when the type of the instance value is a number."
},
"maximum": {
"title": "Maximum",
"type": "number",
"description": "Defines the maximum value of the instance property when the type of the instance value is a number."
},
"version": {
"title": "Version",
"type": "string",
"description": "Defines the version of the instance for use by the packaging system."
},
"format": {
"title": "String Format",
"type": "string",
"required": false,
"choices": [
{
"value": "",
"title": ""
},
{
"value": "date",
"title": "Date (\"YYYY-MM-DD\")"
},
{
"value": "date-time",
"title": "Date-timestamp (\"YYYY-MM-DDThh:mm:ssZ\" in UTC)"
},
{
"value": "time",
"title": "Time (\"hh:mm:ss\")"
},
{
"value": "utc-millisec",
"title": "Milliseconds since 1 January 1970 00:00"
},
{
"value": "phone",
"title": "Phone number"
},
{
"value": "uri",
"title": "URI"
},
{
"value": "email",
"title": "E-mail address"
},
{
"value": "ip-address",
"title": "IP version 4 address"
},
{
"value": "ipv6",
"title": "IP version 6 address"
},
{
"value": "host-name",
"title": "Host name"
},
{
"value": "regex",
"title": "Regular expression"
},
{
"value": "link",
"title": "Link"
}
]
},
"is_password": {
"description": "Is the string field a password?",
"title": "Is Password?",
"type": "boolean"
},
"disable_confirmation": {
"description": "Disable confirmation field for password?",
"title": "Disable Password Confirmation",
"type": "boolean"
},
"store_encrypted": {
"description": "Should the field be stored encrypted?",
"title": "Store Encrypted?",
"type": "boolean"
},
"required": {
"title": "Is Mandatory?",
"type": "boolean"
},
"readonly": {
"description": "If a field is marked as read-only it cannot be changed once added.",
"title": "Is Read-Only?",
"type": "boolean"
},
"displayable": {
"title": "Is Displayable?",
"type": "boolean",
"description": "Marks whether the content of this field would be visible and therefore marked for translation."
},
"target": {
"description": "If Format is \"URI\", what is the entity type of the foreign key?",
"title": "Target",
"type": "string",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "",
"choices": []
},
"target_attr": {
"description": "If Format is \"URI\", what is the field name of the referenced resource?",
"title": "Target Field",
"type": "string",
"choices": {
"value": "",
"title": ""
}
},
"items": {
"title": "Items",
"description": "If Format is \"Array\", what are the properties of the items?",
"type": "object",
"properties": {
"type": {
"title": "Data Type",
"type": "string",
"choices": [
{
"value": "array",
"title": "Array"
},
{
"value": "boolean",
"title": "Boolean"
},
{
"value": "integer",
"title": "Integer"
},
{
"value": "null",
"title": "Null"
},
{
"value": "number",
"title": "Number"
},
{
"value": "object",
"title": "Object"
},
{
"value": "string",
"title": "String"
},
{
"value": "any",
"title": "Anything"
}
]
}
}
},
"pattern": {
"title": "Validation Regular Expression",
"type": "string"
},
"default": {
"title": "Default Value",
"type": "any",
"description": "Default value for field. Accepts comma-separated values if field type is array."
},
"choices": {
"title": "Choices",
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"title": "Value",
"type": [
"string",
"integer"
]
},
"title": {
"title": "Title",
"type": "string"
}
}
}
}
}
}
},
"choices": {
"title": "Choices",
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"title": "Value",
"type": [
"string",
"integer"
]
},
"title": {
"title": "Title",
"type": "string"
}
}
}
}
}
},
"pattern": {
"title": "Validation Regular Expression",
"type": "string"
},
"default": {
"title": "Default Value",
"type": "any",
"description": "Default value for field. Accepts comma-separated values if field type is array."
},
"choices": {
"title": "Choices",
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"title": "Value",
"type": [
"string",
"integer"
]
},
"title": {
"title": "Title",
"type": "string"
}
}
}
},
"attr_props": {
"title": "Attribute Properties",
"type": "array",
"required": false,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"required": true
},
"title": {
"title": "Friendly Name",
"type": "string",
"description": "What to show as the name of the form field."
},
"description": {
"title": "Description",
"type": "string",
"description": "Provides a full description of the of purpose the instance property."
},
"type": {
"title": "Data Type",
"type": "string",
"required": true,
"choices": [
{
"value": "array",
"title": "Array"
},
{
"value": "boolean",
"title": "Boolean"
},
{
"value": "integer",
"title": "Integer"
},
{
"value": "null",
"title": "Null"
},
{
"value": "number",
"title": "Number"
},
{
"value": "object",
"title": "Object"
},
{
"value": "string",
"title": "String"
},
{
"value": "any",
"title": "Anything"
}
]
},
"minItems": {
"title": "Minimum Number of Values",
"type": "integer",
"description": "Defines the minimum number of values in an array when the array is the instance value."
},
"maxItems": {
"title": "Maximum Number of Values",
"type": "integer",
"description": "Defines the maximum number of values in an array when the array is the instance value."
},
"minLength": {
"title": "Minimum Length",
"type": "integer",
"description": "When the instance value is a string, this defines the minimum length of the string."
},
"maxLength": {
"title": "Maximum Length",
"type": "integer",
"description": "When the instance value is a string, this defines the maximum length of the string."
},
"minimum": {
"title": "Minimum",
"type": "number",
"description": "Defines the minimum value of the instance property when the type of the instance value is a number."
},
"maximum": {
"title": "Maximum",
"type": "number",
"description": "Defines the maximum value of the instance property when the type of the instance value is a number."
},
"version": {
"title": "Version",
"type": "string",
"description": "Defines the version of the instance for use by the packaging system."
},
"format": {
"title": "String Format",
"type": "string",
"required": false,
"choices": [
{
"value": "",
"title": ""
},
{
"value": "date",
"title": "Date (\"YYYY-MM-DD\")"
},
{
"value": "date-time",
"title": "Date-timestamp (\"YYYY-MM-DDThh:mm:ssZ\" in UTC)"
},
{
"value": "time",
"title": "Time (\"hh:mm:ss\")"
},
{
"value": "utc-millisec",
"title": "Milliseconds since 1 January 1970 00:00"
},
{
"value": "phone",
"title": "Phone number"
},
{
"value": "uri",
"title": "URI"
},
{
"value": "email",
"title": "E-mail address"
},
{
"value": "ip-address",
"title": "IP version 4 address"
},
{
"value": "ipv6",
"title": "IP version 6 address"
},
{
"value": "host-name",
"title": "Host name"
},
{
"value": "regex",
"title": "Regular expression"
},
{
"value": "link",
"title": "Link"
}
]
},
"is_password": {
"description": "Is the string field a password?",
"title": "Is Password?",
"type": "boolean"
},
"disable_confirmation": {
"description": "Disable confirmation field for password?",
"title": "Disable Password Confirmation",
"type": "boolean"
},
"store_encrypted": {
"description": "Should the field be stored encrypted?",
"title": "Store Encrypted?",
"type": "boolean"
},
"required": {
"title": "Is Mandatory?",
"type": "boolean"
},
"readonly": {
"description": "If a field is marked as read-only it cannot be changed once added.",
"title": "Is Read-Only?",
"type": "boolean"
},
"displayable": {
"title": "Is Displayable?",
"type": "boolean",
"description": "Marks whether the content of this field would be visible and therefore marked for translation."
},
"target": {
"description": "If Format is \"URI\", what is the entity type of the foreign key?",
"title": "Target",
"type": "string",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "",
"choices": []
},
"target_attr": {
"description": "If Format is \"URI\", what is the field name of the referenced resource?",
"title": "Target Field",
"type": "string",
"choices": {
"value": "",
"title": ""
}
},
"items": {
"title": "Items",
"description": "If Format is \"Array\", what are the properties of the items?",
"type": "object",
"properties": {
"type": {
"title": "Data Type",
"type": "string",
"choices": [
{
"value": "array",
"title": "Array"
},
{
"value": "boolean",
"title": "Boolean"
},
{
"value": "integer",
"title": "Integer"
},
{
"value": "null",
"title": "Null"
},
{
"value": "number",
"title": "Number"
},
{
"value": "object",
"title": "Object"
},
{
"value": "string",
"title": "String"
},
{
"value": "any",
"title": "Anything"
}
]
}
}
},
"pattern": {
"title": "Validation Regular Expression",
"type": "string"
},
"default": {
"title": "Default Value",
"type": "any",
"description": "Default value for field. Accepts comma-separated values if field type is array."
},
"choices": {
"title": "Choices",
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"title": "Value",
"type": [
"string",
"integer"
]
},
"title": {
"title": "Title",
"type": "string"
}
}
}
}
}
}
}
}
}
},
"choices": {
"title": "Choices",
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"title": "Value",
"type": [
"string",
"integer"
]
},
"title": {
"title": "Title",
"type": "string"
}
}
}
}
}
},
"pattern": {
"title": "Validation Regular Expression",
"type": "string"
},
"default": {
"title": "Default Value",
"type": "any",
"description": "Default value for field. Accepts comma-separated values if field type is array."
},
"choices": {
"title": "Choices",
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"title": "Value",
"type": [
"string",
"integer"
]
},
"title": {
"title": "Title",
"type": "string"
}
}
}
},
"attr_props": {
"title": "Attribute Properties",
"type": "array",
"required": false,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"required": true
},
"title": {
"title": "Friendly Name",
"type": "string",
"description": "What to show as the name of the form field."
},
"description": {
"title": "Description",
"type": "string",
"description": "Provides a full description of the of purpose the instance property."
},
"type": {
"title": "Data Type",
"type": "string",
"required": true,
"choices": [
{
"value": "array",
"title": "Array"
},
{
"value": "boolean",
"title": "Boolean"
},
{
"value": "integer",
"title": "Integer"
},
{
"value": "null",
"title": "Null"
},
{
"value": "number",
"title": "Number"
},
{
"value": "object",
"title": "Object"
},
{
"value": "string",
"title": "String"
},
{
"value": "any",
"title": "Anything"
}
]
},
"minItems": {
"title": "Minimum Number of Values",
"type": "integer",
"description": "Defines the minimum number of values in an array when the array is the instance value."
},
"maxItems": {
"title": "Maximum Number of Values",
"type": "integer",
"description": "Defines the maximum number of values in an array when the array is the instance value."
},
"minLength": {
"title": "Minimum Length",
"type": "integer",
"description": "When the instance value is a string, this defines the minimum length of the string."
},
"maxLength": {
"title": "Maximum Length",
"type": "integer",
"description": "When the instance value is a string, this defines the maximum length of the string."
},
"minimum": {
"title": "Minimum",
"type": "number",
"description": "Defines the minimum value of the instance property when the type of the instance value is a number."
},
"maximum": {
"title": "Maximum",
"type": "number",
"description": "Defines the maximum value of the instance property when the type of the instance value is a number."
},
"version": {
"title": "Version",
"type": "string",
"description": "Defines the version of the instance for use by the packaging system."
},
"format": {
"title": "String Format",
"type": "string",
"required": false,
"choices": [
{
"value": "",
"title": ""
},
{
"value": "date",
"title": "Date (\"YYYY-MM-DD\")"
},
{
"value": "date-time",
"title": "Date-timestamp (\"YYYY-MM-DDThh:mm:ssZ\" in UTC)"
},
{
"value": "time",
"title": "Time (\"hh:mm:ss\")"
},
{
"value": "utc-millisec",
"title": "Milliseconds since 1 January 1970 00:00"
},
{
"value": "phone",
"title": "Phone number"
},
{
"value": "uri",
"title": "URI"
},
{
"value": "email",
"title": "E-mail address"
},
{
"value": "ip-address",
"title": "IP version 4 address"
},
{
"value": "ipv6",
"title": "IP version 6 address"
},
{
"value": "host-name",
"title": "Host name"
},
{
"value": "regex",
"title": "Regular expression"
},
{
"value": "link",
"title": "Link"
}
]
},
"is_password": {
"description": "Is the string field a password?",
"title": "Is Password?",
"type": "boolean"
},
"disable_confirmation": {
"description": "Disable confirmation field for password?",
"title": "Disable Password Confirmation",
"type": "boolean"
},
"store_encrypted": {
"description": "Should the field be stored encrypted?",
"title": "Store Encrypted?",
"type": "boolean"
},
"required": {
"title": "Is Mandatory?",
"type": "boolean"
},
"readonly": {
"description": "If a field is marked as read-only it cannot be changed once added.",
"title": "Is Read-Only?",
"type": "boolean"
},
"displayable": {
"title": "Is Displayable?",
"type": "boolean",
"description": "Marks whether the content of this field would be visible and therefore marked for translation."
},
"target": {
"description": "If Format is \"URI\", what is the entity type of the foreign key?",
"title": "Target",
"type": "string",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "",
"choices": []
},
"target_attr": {
"description": "If Format is \"URI\", what is the field name of the referenced resource?",
"title": "Target Field",
"type": "string",
"choices": {
"value": "",
"title": ""
}
},
"items": {
"title": "Items",
"description": "If Format is \"Array\", what are the properties of the items?",
"type": "object",
"properties": {
"type": {
"title": "Data Type",
"type": "string",
"choices": [
{
"value": "array",
"title": "Array"
},
{
"value": "boolean",
"title": "Boolean"
},
{
"value": "integer",
"title": "Integer"
},
{
"value": "null",
"title": "Null"
},
{
"value": "number",
"title": "Number"
},
{
"value": "object",
"title": "Object"
},
{
"value": "string",
"title": "String"
},
{
"value": "any",
"title": "Anything"
}
]
},
"attr_props": {
"title": "Attribute Properties",
"type": "array",
"required": false,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"required": true
},
"title": {
"title": "Friendly Name",
"type": "string",
"description": "What to show as the name of the form field."
},
"description": {
"title": "Description",
"type": "string",
"description": "Provides a full description of the of purpose the instance property."
},
"type": {
"title": "Data Type",
"type": "string",
"required": true,
"choices": [
{
"value": "array",
"title": "Array"
},
{
"value": "boolean",
"title": "Boolean"
},
{
"value": "integer",
"title": "Integer"
},
{
"value": "null",
"title": "Null"
},
{
"value": "number",
"title": "Number"
},
{
"value": "object",
"title": "Object"
},
{
"value": "string",
"title": "String"
},
{
"value": "any",
"title": "Anything"
}
]
},
"minItems": {
"title": "Minimum Number of Values",
"type": "integer",
"description": "Defines the minimum number of values in an array when the array is the instance value."
},
"maxItems": {
"title": "Maximum Number of Values",
"type": "integer",
"description": "Defines the maximum number of values in an array when the array is the instance value."
},
"minLength": {
"title": "Minimum Length",
"type": "integer",
"description": "When the instance value is a string, this defines the minimum length of the string."
},
"maxLength": {
"title": "Maximum Length",
"type": "integer",
"description": "When the instance value is a string, this defines the maximum length of the string."
},
"minimum": {
"title": "Minimum",
"type": "number",
"description": "Defines the minimum value of the instance property when the type of the instance value is a number."
},
"maximum": {
"title": "Maximum",
"type": "number",
"description": "Defines the maximum value of the instance property when the type of the instance value is a number."
},
"version": {
"title": "Version",
"type": "string",
"description": "Defines the version of the instance for use by the packaging system."
},
"format": {
"title": "String Format",
"type": "string",
"required": false,
"choices": [
{
"value": "",
"title": ""
},
{
"value": "date",
"title": "Date (\"YYYY-MM-DD\")"
},
{
"value": "date-time",
"title": "Date-timestamp (\"YYYY-MM-DDThh:mm:ssZ\" in UTC)"
},
{
"value": "time",
"title": "Time (\"hh:mm:ss\")"
},
{
"value": "utc-millisec",
"title": "Milliseconds since 1 January 1970 00:00"
},
{
"value": "phone",
"title": "Phone number"
},
{
"value": "uri",
"title": "URI"
},
{
"value": "email",
"title": "E-mail address"
},
{
"value": "ip-address",
"title": "IP version 4 address"
},
{
"value": "ipv6",
"title": "IP version 6 address"
},
{
"value": "host-name",
"title": "Host name"
},
{
"value": "regex",
"title": "Regular expression"
},
{
"value": "link",
"title": "Link"
}
]
},
"is_password": {
"description": "Is the string field a password?",
"title": "Is Password?",
"type": "boolean"
},
"disable_confirmation": {
"description": "Disable confirmation field for password?",
"title": "Disable Password Confirmation",
"type": "boolean"
},
"store_encrypted": {
"description": "Should the field be stored encrypted?",
"title": "Store Encrypted?",
"type": "boolean"
},
"required": {
"title": "Is Mandatory?",
"type": "boolean"
},
"readonly": {
"description": "If a field is marked as read-only it cannot be changed once added.",
"title": "Is Read-Only?",
"type": "boolean"
},
"displayable": {
"title": "Is Displayable?",
"type": "boolean",
"description": "Marks whether the content of this field would be visible and therefore marked for translation."
},
"target": {
"description": "If Format is \"URI\", what is the entity type of the foreign key?",
"title": "Target",
"type": "string",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "",
"choices": []
},
"target_attr": {
"description": "If Format is \"URI\", what is the field name of the referenced resource?",
"title": "Target Field",
"type": "string",
"choices": {
"value": "",
"title": ""
}
},
"items": {
"title": "Items",
"description": "If Format is \"Array\", what are the properties of the items?",
"type": "object",
"properties": {
"type": {
"title": "Data Type",
"type": "string",
"choices": [
{
"value": "array",
"title": "Array"
},
{
"value": "boolean",
"title": "Boolean"
},
{
"value": "integer",
"title": "Integer"
},
{
"value": "null",
"title": "Null"
},
{
"value": "number",
"title": "Number"
},
{
"value": "object",
"title": "Object"
},
{
"value": "string",
"title": "String"
},
{
"value": "any",
"title": "Anything"
}
]
}
}
},
"pattern": {
"title": "Validation Regular Expression",
"type": "string"
},
"default": {
"title": "Default Value",
"type": "any",
"description": "Default value for field. Accepts comma-separated values if field type is array."
},
"choices": {
"title": "Choices",
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"title": "Value",
"type": [
"string",
"integer"
]
},
"title": {
"title": "Title",
"type": "string"
}
}
}
}
}
}
},
"choices": {
"title": "Choices",
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"title": "Value",
"type": [
"string",
"integer"
]
},
"title": {
"title": "Title",
"type": "string"
}
}
}
}
}
},
"pattern": {
"title": "Validation Regular Expression",
"type": "string"
},
"default": {
"title": "Default Value",
"type": "any",
"description": "Default value for field. Accepts comma-separated values if field type is array."
},
"choices": {
"title": "Choices",
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"title": "Value",
"type": [
"string",
"integer"
]
},
"title": {
"title": "Title",
"type": "string"
}
}
}
},
"attr_props": {
"title": "Attribute Properties",
"type": "array",
"required": false,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"required": true
},
"title": {
"title": "Friendly Name",
"type": "string",
"description": "What to show as the name of the form field."
},
"description": {
"title": "Description",
"type": "string",
"description": "Provides a full description of the of purpose the instance property."
},
"type": {
"title": "Data Type",
"type": "string",
"required": true,
"choices": [
{
"value": "array",
"title": "Array"
},
{
"value": "boolean",
"title": "Boolean"
},
{
"value": "integer",
"title": "Integer"
},
{
"value": "null",
"title": "Null"
},
{
"value": "number",
"title": "Number"
},
{
"value": "object",
"title": "Object"
},
{
"value": "string",
"title": "String"
},
{
"value": "any",
"title": "Anything"
}
]
},
"minItems": {
"title": "Minimum Number of Values",
"type": "integer",
"description": "Defines the minimum number of values in an array when the array is the instance value."
},
"maxItems": {
"title": "Maximum Number of Values",
"type": "integer",
"description": "Defines the maximum number of values in an array when the array is the instance value."
},
"minLength": {
"title": "Minimum Length",
"type": "integer",
"description": "When the instance value is a string, this defines the minimum length of the string."
},
"maxLength": {
"title": "Maximum Length",
"type": "integer",
"description": "When the instance value is a string, this defines the maximum length of the string."
},
"minimum": {
"title": "Minimum",
"type": "number",
"description": "Defines the minimum value of the instance property when the type of the instance value is a number."
},
"maximum": {
"title": "Maximum",
"type": "number",
"description": "Defines the maximum value of the instance property when the type of the instance value is a number."
},
"version": {
"title": "Version",
"type": "string",
"description": "Defines the version of the instance for use by the packaging system."
},
"format": {
"title": "String Format",
"type": "string",
"required": false,
"choices": [
{
"value": "",
"title": ""
},
{
"value": "date",
"title": "Date (\"YYYY-MM-DD\")"
},
{
"value": "date-time",
"title": "Date-timestamp (\"YYYY-MM-DDThh:mm:ssZ\" in UTC)"
},
{
"value": "time",
"title": "Time (\"hh:mm:ss\")"
},
{
"value": "utc-millisec",
"title": "Milliseconds since 1 January 1970 00:00"
},
{
"value": "phone",
"title": "Phone number"
},
{
"value": "uri",
"title": "URI"
},
{
"value": "email",
"title": "E-mail address"
},
{
"value": "ip-address",
"title": "IP version 4 address"
},
{
"value": "ipv6",
"title": "IP version 6 address"
},
{
"value": "host-name",
"title": "Host name"
},
{
"value": "regex",
"title": "Regular expression"
},
{
"value": "link",
"title": "Link"
}
]
},
"is_password": {
"description": "Is the string field a password?",
"title": "Is Password?",
"type": "boolean"
},
"disable_confirmation": {
"description": "Disable confirmation field for password?",
"title": "Disable Password Confirmation",
"type": "boolean"
},
"store_encrypted": {
"description": "Should the field be stored encrypted?",
"title": "Store Encrypted?",
"type": "boolean"
},
"required": {
"title": "Is Mandatory?",
"type": "boolean"
},
"readonly": {
"description": "If a field is marked as read-only it cannot be changed once added.",
"title": "Is Read-Only?",
"type": "boolean"
},
"displayable": {
"title": "Is Displayable?",
"type": "boolean",
"description": "Marks whether the content of this field would be visible and therefore marked for translation."
},
"target": {
"description": "If Format is \"URI\", what is the entity type of the foreign key?",
"title": "Target",
"type": "string",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "",
"choices": []
},
"target_attr": {
"description": "If Format is \"URI\", what is the field name of the referenced resource?",
"title": "Target Field",
"type": "string",
"choices": {
"value": "",
"title": ""
}
},
"items": {
"title": "Items",
"description": "If Format is \"Array\", what are the properties of the items?",
"type": "object",
"properties": {
"type": {
"title": "Data Type",
"type": "string",
"choices": [
{
"value": "array",
"title": "Array"
},
{
"value": "boolean",
"title": "Boolean"
},
{
"value": "integer",
"title": "Integer"
},
{
"value": "null",
"title": "Null"
},
{
"value": "number",
"title": "Number"
},
{
"value": "object",
"title": "Object"
},
{
"value": "string",
"title": "String"
},
{
"value": "any",
"title": "Anything"
}
]
}
}
},
"pattern": {
"title": "Validation Regular Expression",
"type": "string"
},
"default": {
"title": "Default Value",
"type": "any",
"description": "Default value for field. Accepts comma-separated values if field type is array."
},
"choices": {
"title": "Choices",
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"title": "Value",
"type": [
"string",
"integer"
]
},
"title": {
"title": "Title",
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
},
"workflows": {
"title": "Workflows",
"type": "array",
"items": {
"type": "object",
"properties": {
"operation": {
"title": "Operation",
"type": "string",
"required": true,
"pattern": "^[a-z]*$"
},
"tool_workflow": {
"title": "Use a tool or workflow?",
"type": "string",
"required": true,
"choices": [
{
"value": "tool",
"title": "Tool"
},
{
"value": "workflow",
"title": "Provisioning Workflow"
}
],
"default": "workflow"
},
"tool": {
"title": "Tool",
"type": "string",
"required": false
},
"parameters": {
"type": "array",
"required": false,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"view_attr": {
"title": "View attribute",
"type": "string",
"required": true
},
"tool_param": {
"title": "Tool parameter",
"type": "string",
"required": true
}
}
}
},
"workflow": {
"title": "Workflow",
"type": "string",
"required": false,
"format": "uri",
"target": "/api/data/ProvisioningWorkflow/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "data/ProvisioningWorkflow",
"choices": []
},
"workflow_model_types": {
"title": "Workflow Model Types",
"description": "Map View attributes to Workflow model types' attributes.",
"type": "array",
"required": false,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"model_type": {
"type": "string",
"required": true
},
"attributes": {
"type": "array",
"required": true,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"view_attr": {
"title": "View attribute",
"type": "string",
"required": true
},
"model_attr": {
"title": "Model attribute",
"type": "string",
"required": true
}
}
}
}
}
}
},
"return_results": {
"title": "Operation returns results?",
"type": "boolean",
"required": false,
"default": false
},
"result_type": {
"title": "Type of results",
"type": "string",
"choices": [
{
"value": "list",
"title": "List"
},
{
"value": "object",
"title": "Object"
}
]
}
}
}
},
"operations": {
"title": "Operations",
"type": "array",
"items": {
"type": "string",
"choices": [
{
"value": "add",
"title": "Add"
},
{
"value": "clone",
"title": "Clone"
},
{
"value": "configuration_template",
"title": "Configuration Template"
},
{
"value": "field_display_policy",
"title": "Field Display Policy"
},
{
"value": "export_bulkload_template",
"title": "Export Bulk Load Template"
},
{
"value": "get",
"title": "Get"
},
{
"value": "help",
"title": "Help"
},
{
"value": "list",
"title": "List"
},
{
"value": "tag",
"title": "Tag"
},
{
"value": "tag_version",
"title": "Tag Version"
},
{
"value": "transform",
"title": "Transform Template"
}
]
}
}
},
"schema_version": "0.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/View/add/ |
|
The GUI Add form of data/View as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/data/View | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/View/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/View/[pkid1]", "/api/data/View/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/View/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/View/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/View/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/View/[pkid1]", "/api/v0/data/View/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/View/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/View; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/View/export/ |
|
{ "hrefs":["/api/data/View/[pkid1]", "/api/data/View/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of data/View and the JSON format can be used to import instances of data/View.
GET http://[host-proxy]/api/data/View/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/View | POST | /api/data/View/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/data/View/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/data/View/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/View/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/View/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/View/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/View/ |
|
The data/View schema and all instances as JSON. |
(The list will return 0 to 3 data/View instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 333,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/View/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"field_display_policy",
"update",
"help",
"remove",
"move",
"add",
"export",
"list",
"configuration_template",
"get",
"bulk_update_form",
"migration",
"transform",
"export_bulkload_template"
],
"meta": {
"model_type": "data/View",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {
"unique": [
"name"
],
"hierarchy": false
},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"add",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"migration",
"transform",
"remove",
"tag",
"tag_version",
"update"
],
"schema_version": "0.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/View/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/View/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/data/View/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/View/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/data/View/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/View/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/View/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/data/View/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/View/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/data/View/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/View/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/View/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"transform": {
"method": "GET",
"class": "transform",
"href": "/api/data/View/transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Transform Template"
}
}
]
},
"resources": [
{
"data": {
"name": "AboutLicense",
"attr_props": [
{
"name": "platform_uuid",
"title": "Platform UUID",
"description": "Application or platform deployment UUID.",
"type": "string",
"readonly": true
},
{
"name": "status",
"title": "License status",
"description": "Current status of the license for this platform.",
"type": "string",
"readonly": true
},
{
"name": "exp",
"title": "Expiry date",
"description": "Date/time when the current license will expire.",
"type": "string",
"format": "date-time",
"readonly": true
}
],
"operations": [
"add",
"get",
"help"
],
"pkid": "663347e356369e9cff7cb905",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/View",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"VOSS",
"tdk",
"tdk_from_standalone_manifest"
],
"title": "AboutLicense",
"business_key": {
"hierarchy": false,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/View/663347e356369e9cff7cb904/",
"pkid": "663347e356369e9cff7cb904"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"663347e356369e9cff7cb904"
],
"version_tag": "0.0",
"schema_version": "0.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/View/663347e356369e9cff7cb904/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/View/663347e356369e9cff7cb904/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/View/663347e356369e9cff7cb904/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/View/663347e356369e9cff7cb904/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/View/663347e356369e9cff7cb904/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/View/663347e356369e9cff7cb904/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/View/663347e356369e9cff7cb904/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/View/663347e356369e9cff7cb904/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "663347e356369e9cff7cb904"
},
{
"data": {
"doc": "Tool to manage access profiles.",
"operations": [
"add",
"tag",
"help",
"configuration_template",
"export_bulkload_template"
],
"name": "AccessProfileTool",
"attr_props": [
{
"default": "Access Profile Tool",
"readonly": true,
"type": "string",
"name": "description",
"title": " "
},
{
"default": "This view allows you to merge access profile items from one access profile to another.",
"readonly": true,
"type": "string",
"name": "notes",
"title": " "
},
{
"default": "{{ fn.hierarchy_friendly_path }}",
"readonly": true,
"type": "string",
"name": "hierarchy_level",
"title": "Hierarchy level"
},
{
"default": "{{ fn.hierarchy_friendly_path }}",
"type": "string",
"name": "target_hierarchy",
"title": "Target Hierarchy"
},
{
"choices": [
{
"value": "create_snippet",
"title": "Create Snippet"
},
{
"value": "merge",
"title": "Merge"
}
],
"type": "string",
"description": "Access Profile Operation",
"name": "access_profile_operation",
"title": "Access Profile Operation"
},
{
"type": "string",
"description": "The access profile that will be merged or updated from.",
"name": "source_access_profile",
"title": "Source Access Profile"
},
{
"items": {
"type": "string"
},
"type": "array",
"name": "source_access_profile_list",
"title": "Source Access Profile List"
},
{
"type": "string",
"description": "The access profile that will be updated or merged into.",
"name": "target_access_profile",
"title": "Target Access Profile"
},
{
"type": "boolean",
"description": "When selected a backup of the target access profile will be made.",
"name": "backup",
"title": "Backup Access Profile"
},
{
"type": "boolean",
"description": "Create a new access profile with a custom name.",
"name": "new",
"title": "New Access Profile"
},
{
"type": "string",
"description": "Name of the access profile to create.",
"name": "new_access_profile_name",
"title": "New Access Profile Name"
}
],
"workflows": [
{
"operation": "add",
"workflow": "AccessProfileTool_Management",
"tool_workflow": "workflow"
}
],
"pkid": "5c69435faffa9374dfa4a9d8",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/View",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [
{
"pkid": "650fe15e84eaf2a1ce63304c",
"version": "0.0",
"href": "/api/v0/data/View/5c69435faffa9374dfa4a9d7/?cached=650fe15e84eaf2a1ce63304c"
}
],
"tags": [
"accessprofiletool",
"V4UC",
"ba_CommonOverlay"
],
"title": "AccessProfileTool",
"business_key": {
"hierarchy": false,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [
{
"path": "workflows.0.workflow",
"model_type": "data/ProvisioningWorkflow"
}
],
"self": [
{
"href": "/api/data/View/5c69435faffa9374dfa4a9d7/",
"pkid": "5c69435faffa9374dfa4a9d7"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5c69435faffa9374dfa4a9d7"
],
"version_tag": "0.0",
"schema_version": "0.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/View/5c69435faffa9374dfa4a9d7/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/View/5c69435faffa9374dfa4a9d7/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/View/5c69435faffa9374dfa4a9d7/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/View/5c69435faffa9374dfa4a9d7/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/View/5c69435faffa9374dfa4a9d7/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/View/5c69435faffa9374dfa4a9d7/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/View/5c69435faffa9374dfa4a9d7/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/View/5c69435faffa9374dfa4a9d7/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5c69435faffa9374dfa4a9d7"
},
{
"data": {
"operations": [
"export_bulkload_template",
"list",
"help"
],
"name": "AddCsolUserTenantDialPlan",
"attr_props": [
{
"required": false,
"type": "string",
"name": "firstname",
"title": "First Name"
},
{
"required": true,
"type": "string",
"name": "lastname",
"title": "Last Name"
},
{
"required": true,
"type": "string",
"name": "upn",
"title": "User Principal Name"
},
{
"required": true,
"type": "string",
"name": "deskphoneext",
"title": "Desk Phone Extension"
}
],
"workflows": [
{
"operation": "add",
"workflow": "AddCsolUserTenantDialPlanPWF",
"tool_workflow": "workflow"
}
],
"pkid": "650fe15f84eaf2a1ce633060",
"hierarchy_friendly_name": "hcs (Hcs)",
"hierarchy_path": "sys.hcs"
},
"meta": {
"model_type": "data/View",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [
{
"pkid": "650fe16084eaf2a1ce633061",
"version": "1.0",
"href": "/api/v0/data/View/650fe15f84eaf2a1ce63305f/?cached=650fe16084eaf2a1ce633061"
}
],
"tags": [
"msteams",
"V4UC",
"ba_CommonOverlay"
],
"title": "AddCsolUserTenantDialPlan",
"business_key": {
"hierarchy": false,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ad5bacbaffa9343e4d93e01",
"href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01"
}
],
"foreign_key": [
{
"path": "workflows.0.workflow",
"model_type": "data/ProvisioningWorkflow"
}
],
"self": [
{
"href": "/api/data/View/650fe15f84eaf2a1ce63305f/",
"pkid": "650fe15f84eaf2a1ce63305f"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"650fe15f84eaf2a1ce63305f"
],
"version_tag": "1.0",
"schema_version": "0.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/View/650fe15f84eaf2a1ce63305f/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/View/650fe15f84eaf2a1ce63305f/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/View/650fe15f84eaf2a1ce63305f/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/View/650fe15f84eaf2a1ce63305f/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/View/650fe15f84eaf2a1ce63305f/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/View/650fe15f84eaf2a1ce63305f/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/View/650fe15f84eaf2a1ce63305f/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/View/650fe15f84eaf2a1ce63305f/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "650fe15f84eaf2a1ce63305f"
}
]
}
(Show the first instance)
{
"data": {
"name": "AboutLicense",
"attr_props": [
{
"name": "platform_uuid",
"title": "Platform UUID",
"description": "Application or platform deployment UUID.",
"type": "string",
"readonly": true
},
{
"name": "status",
"title": "License status",
"description": "Current status of the license for this platform.",
"type": "string",
"readonly": true
},
{
"name": "exp",
"title": "Expiry date",
"description": "Date/time when the current license will expire.",
"type": "string",
"format": "date-time",
"readonly": true
}
],
"operations": [
"add",
"get",
"help"
],
"pkid": "663347e356369e9cff7cb905"
},
"meta": {
"model_type": "data/View",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"VOSS",
"tdk",
"tdk_from_standalone_manifest"
],
"title": "AboutLicense",
"business_key": {
"unique": [
"name"
],
"hierarchy": false
},
"api_version": "21.2",
"cached": false,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/data/View/663347e356369e9cff7cb904/",
"pkid": "663347e356369e9cff7cb904"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"663347e356369e9cff7cb904"
],
"version_tag": "0.0",
"schema_version": "0.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/View/663347e356369e9cff7cb904/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/View/663347e356369e9cff7cb904/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/View/663347e356369e9cff7cb904/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/View/663347e356369e9cff7cb904/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/View/663347e356369e9cff7cb904/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/View/663347e356369e9cff7cb904/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/View/663347e356369e9cff7cb904/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/View/663347e356369e9cff7cb904/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "663347e356369e9cff7cb904"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/View. | GET | /api/data/View/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/View as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Transform Template | GET | /api/data/View/transform/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/View/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/View/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/View/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/View/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/View; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/View/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of data/View and the JSON format can be used to import instances of data/View.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/View/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/View/[pkid] | hierarchy=[hierarchy] | The data/View instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/View/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/View. |