[Index]

API Reference for device/exchange/Recipient

Model ref.: device/exchange/Recipient

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

Bulk Modify

Task Call URL Parameters Response
Bulk Modify GET /api/device/exchange/Recipient/bulk_update/?schema=&schema_rules=true
  • hierarchy=[hierarchy]
  • format=json
  • pkids=pkid1,pkid2,...
    In JSON format:
  • POST call to update the instances of device/exchange/Recipient
  • device/exchange/Recipient schema to create POST payload.
Task Call URL Parameters Payload
Bulk Modify POST /api/device/exchange/Recipient/bulk_update/
  • hierarchy=[hierarchy]
  • format=json
 For example:
{"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchange/Recipient/[pkid1]", "/api/v0/device/exchange/Recipient/[pkid2]",...]}}
  • To get a list of model instance pkids that are available to Bulk Modify, use the GET call:
    GET http://[host-proxy]/api/device/exchange/Recipient/?hierarchy=[hierarchy]&format=json
  • The POST payload is in JSON format (refer to the Payload example) and contains:
    • data in name-value update pairs according to the returned schema
    • meta (empty - for a valid payload)
    • request_meta with the hrefs list of instances to update

Move

Task Call URL Parameters Payload
Move the instance with [pkid] to [target_hierarchy] POST /api/tool/DataMove/?model_type=device/exchange/Recipient
  • hierarchy=[hierarchy]
  • context_hierarchy=[target_hierarchy]
  • format=json
  • (nowait=true)
 {"hrefs": ["/api/device/exchange/Recipient/[pkid]"]}
Bulk Move POST /api/tool/DataMove/?model_type=device/exchange/Recipient
  • hierarchy==[hierarchy]
  • context_hierarchy=[target_hierarchy]
  • format=json
  • (nowait=true)
 {"hrefs": ["/api/device/exchange/Recipient/[pkid1]", "/api/device/exchange/Recipient/[pkid2]",...]}

  • Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
  • For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
    GET http://[host-proxy]/api/device/exchange/Recipient/?hierarchy=[hierarchy]&format=json&schema_rules=true

Bulk Export

Task Call URL Parameters Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchange/Recipient; optionally with tag_version at [version] and Configuration Template as [configtemplate]. POST /api/device/exchange/Recipient/export/
  • hierarchy=[hierarchy]
  • version=[version]
  • schema=
  • schema_rules=
  • template_name=[configtemplate]
  • export_format=[raw_xlsx|xlsx|json]
 { "hrefs":["/api/device/exchange/Recipient/[pkid1]", "/api/device/exchange/Recipient/[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 device/exchange/Recipient and the JSON format can be used to import instances of device/exchange/Recipient.

  • To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for device/exchange/Recipient: 
  •  GET http://[host-proxy]/api/device/exchange/Recipient/?hierarchy=[hierarchy]

Export Bulk Load Template

Task Call URL Parameters Response
Get a compressed format of the Bulk Load spreadsheet template for device/exchange/Recipient POST /api/device/exchange/Recipient/export_bulkload_template/
  • hierarchy=[hierarchy]
  • modeltype=device/exchange/Recipient
 The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Configuration Template

Task Call URL Parameters Response
Configuration Template GET /api/device/exchange/Recipient/configuration_template/ hierarchy=[hierarchy]
  • POST call to create the Configuration Template
  • Configuration Template schema

  • Use the returned properties to create the POST payload data for the .
  • For a description of the schema that shows properties to add to the POST payload:
    • The POST call is of the format: 
    • POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Field Display Policy

Task Call URL Parameters Response
Field Display Policy GET /api/device/exchange/Recipient/field_display_policy/ hierarchy=[hierarchy]
  • POST call to create the Field Display Policy
  • Field Display Policy schema

  • Use the returned properties to create the POST payload data for the .
  • For a description of the schema that shows properties to add to the POST payload:
  • The POST call is of the format: 
    • POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

List

Task Call URL Parameters Response
List GET /api/device/exchange/Recipient/
  • hierarchy=[hierarchy]
  • format=json
  • schema=true
 The device/exchange/Recipient schema and all instances as JSON.

(The list will return 0 to 3 device/exchange/Recipient instances)

Help

Task Call URL Parameters Response
Get the on-line Help for device/exchange/Recipient. GET /api/device/exchange/Recipient/help hierarchy=[hierarchy] On-line help of Model ref.: device/exchange/Recipient as HTML

Instance API Reference

Clone

Task Call URL Parameters Response
Clone instance with [pkid]. The schema rules are applied. GET /api/device/exchange/Recipient/[pkid]/clone/?schema=&schema_rules=true
  • hierarchy=[hierarchy]
 A JSON payload with:
  • A POST action URL.
  • The unchanged model [pkid] payload to be modified to create a new instance.
  • For the instance pkids that can cloned, refer to the List GET call for device/exchange/Recipient
  • GET http://[host-proxy]/api/device/exchange/Recipient/?hierarchy=[hierarchy]&format=json
  • Use the POST action in the response with a modification of the response payload to create the clone.

Move

Task Call URL Parameters Payload
Move POST /api/tool/DataMove/[pkid]/?model_type=device/exchange/Recipient hierarchy=[hierarchy] If payload required:

Export

Task Call URL Parameters Response
Get a selected [export_format] of the schema and a single instance with [pkid] of device/exchange/Recipient; optionally with tag_version at [version] and Configuration Template as [configtemplate]. GET /api/device/exchange/Recipient/[pkid]/export
  • hierarchy=[hierarchy]
  • version=[version]
  • schema=
  • schema_rules=
  • template_name=[configtemplate]
  • export_format=[raw_xlsx|xlsx|json]
 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 device/exchange/Recipient and the JSON format can be used to import instances of device/exchange/Recipient.

For Bulk Export, refer to the Bulk Export section.

Get

Task Call URL Parameters Response
Get GET /api/device/exchange/Recipient/[pkid] hierarchy=[hierarchy] The device/exchange/Recipient instance with [pkid].

Help

Task Call URL Parameters Response
Help GET /api/device/exchange/Recipient/[pkid]/help hierarchy=[hierarchy] The on-line Help for device/exchange/Recipient.

Powershell Update

Task Call URL Parameters Payload
Powershell Update POST /api/device/exchange/Recipient/[pkid]/+powershell_update hierarchy=[hierarchy] If payload required:

Purge

Task Call URL Parameters Payload
Purge POST /api/device/exchange/Recipient/[pkid]/purge hierarchy=[hierarchy] If payload required: