[Index]

API Reference for relation/MicrosoftSubscriber

Microsoft Subscriber Relation

Model ref.: relation/MicrosoftSubscriber

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

Move

Task Call URL Parameters Payload
Move the instance with [pkid] to [target_hierarchy] POST /api/tool/DataMove/?model_type=relation/MicrosoftSubscriber
  • hierarchy=[hierarchy]
  • context_hierarchy=[target_hierarchy]
  • format=json
  • (nowait=true)
 {"hrefs": ["/api/relation/MicrosoftSubscriber/[pkid]"]}
Bulk Move POST /api/tool/DataMove/?model_type=relation/MicrosoftSubscriber
  • hierarchy==[hierarchy]
  • context_hierarchy=[target_hierarchy]
  • format=json
  • (nowait=true)
 {"hrefs": ["/api/relation/MicrosoftSubscriber/[pkid1]", "/api/relation/MicrosoftSubscriber/[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/relation/MicrosoftSubscriber/?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 relation/MicrosoftSubscriber; optionally with tag_version at [version] and Configuration Template as [configtemplate]. POST /api/relation/MicrosoftSubscriber/export/
  • hierarchy=[hierarchy]
  • version=[version]
  • schema=
  • schema_rules=
  • template_name=[configtemplate]
  • export_format=[raw_xlsx|xlsx|json]
 { "hrefs":["/api/relation/MicrosoftSubscriber/[pkid1]", "/api/relation/MicrosoftSubscriber/[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/MicrosoftSubscriber and the JSON format can be used to import instances of relation/MicrosoftSubscriber.

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

Export Bulk Load Template

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

List

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

(The list will return 0 to 3 relation/MicrosoftSubscriber instances)

(Show the first instance)

Help

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

Instance API Reference

Modify

Task Call URL Parameters Payload
Modify PUT /api/relation/MicrosoftSubscriber/[pkid] hierarchy=[hierarchy] (For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Move

Task Call URL Parameters Payload
Move POST /api/tool/DataMove/[pkid]/?model_type=relation/MicrosoftSubscriber 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 relation/MicrosoftSubscriber; optionally with tag_version at [version] and Configuration Template as [configtemplate]. GET /api/relation/MicrosoftSubscriber/[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 relation/MicrosoftSubscriber and the JSON format can be used to import instances of relation/MicrosoftSubscriber.

For Bulk Export, refer to the Bulk Export section.

Get

Task Call URL Parameters Response
Get GET /api/relation/MicrosoftSubscriber/[pkid] hierarchy=[hierarchy] The relation/MicrosoftSubscriber instance with [pkid].

Help

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

Sync Subscriber

Task Call URL Parameters Payload
Sync Subscriber POST /api/relation/MicrosoftSubscriber/[pkid]/+SyncSubscriber hierarchy=[hierarchy] If payload required: