[Index]
Model ref.: relation/HcsNbnEventREL
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": {
"title": "Name",
"type": "string",
"maxLength": 1024,
"required": true,
"readonly": false,
"is_password": false,
"displayable": false
},
"destination": {
"title": "Destination",
"description": "The HTTP server destination for the notifications.",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": true,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HcsNbnDestinationDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HcsNbnDestinationDAT",
"choices": []
},
"attribute_selector": {
"title": "Attribute Selector",
"description": "The attribute selector defining the list of attributes to receive in the notification.",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HcsNbnAttributesDAT/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "data/HcsNbnAttributesDAT",
"choices": []
},
"base": {
"title": "Base",
"type": "object",
"properties": {
"name": {
"required": true,
"type": "string",
"description": "Name of event",
"title": "Name"
},
"description": {
"required": false,
"type": "string",
"description": "Description",
"title": "Description"
},
"workflow": {
"target": "/api/data/ProvisioningWorkflow/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"description": "The workflow instance that will be executed.",
"required": true,
"target_attr": "name",
"title": "Workflow",
"type": "string",
"target_model_type": "data/ProvisioningWorkflow",
"choices": []
},
"active": {
"description": "Active",
"title": "Active",
"default": "false",
"required": true,
"type": "boolean"
},
"model_type": {
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"description": "The model type acted on by the transaction for which to trigger the event. This field supports the use of the * wildcard.",
"required": true,
"title": "Model Type",
"type": "string",
"target_model_type": "",
"choices": []
},
"operation": {
"description": "The transaction operation for which to trigger the event. This field supports the use of the * wildcard.",
"title": "Operation",
"required": true,
"choices": [],
"type": "string"
},
"phase": {
"description": "The phase of transaction execution at which the event should be triggered eg. Pre-Execution (before the transaction is performed) or Post-Execution (after the transaction is performed). This field supports the use of the * wildcard.",
"title": "Phase",
"required": true,
"choices": [
{
"value": "preexecution",
"title": "Pre Execution"
},
{
"value": "postexecution",
"title": "Post Execution"
}
],
"type": "string"
},
"synchronous": {
"default": false,
"type": "boolean",
"description": "If selected the event will be executed synchronously, otherwise asynchronously (default).",
"title": "Synchronous"
},
"rollback": {
"default": false,
"type": "boolean",
"description": "If selected the event will only be executed for rollback operations, otherwise it will only be executed for normal non rollback operations (default).",
"title": "Rollback"
},
"api_version": {
"type": "string",
"description": "A version field applicable to North Bound Notifications specifying the version the data must be transformed to.",
"title": "API Version"
}
}
}
},
"schema_version": "2.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsNbnEventREL/add/ |
|
The GUI Add form of relation/HcsNbnEventREL 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/relation/HcsNbnEventREL | 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/relation/HcsNbnEventREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsNbnEventREL/[pkid1]", "/api/relation/HcsNbnEventREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsNbnEventREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsNbnEventREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsNbnEventREL/export/ |
|
{ "hrefs":["/api/relation/HcsNbnEventREL/[pkid1]", "/api/relation/HcsNbnEventREL/[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 relation/HcsNbnEventREL and the JSON format can be used to import instances of relation/HcsNbnEventREL.
GET http://[host-proxy]/api/relation/HcsNbnEventREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsNbnEventREL | POST | /api/relation/HcsNbnEventREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsNbnEventREL/ |
|
The relation/HcsNbnEventREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsNbnEventREL instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/HcsNbnEventREL/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"list",
"help",
"field_display_policy",
"get",
"configuration_template",
"update",
"bulk_update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/HcsNbnEventREL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "destination",
"title": "Destination"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/HcsNbnEventREL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"list",
"help",
"get",
"update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"schema_version": "2.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/HcsNbnEventREL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsNbnEventREL/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/HcsNbnEventREL/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/relation/HcsNbnEventREL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/HcsNbnEventREL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsNbnEventREL/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsNbnEventREL. | GET | /api/relation/HcsNbnEventREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsNbnEventREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsNbnEventREL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsNbnEventREL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsNbnEventREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsNbnEventREL/[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 relation/HcsNbnEventREL and the JSON format can be used to import instances of relation/HcsNbnEventREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsNbnEventREL/[pkid] | hierarchy=[hierarchy] | The relation/HcsNbnEventREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsNbnEventREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsNbnEventREL. |