API Reference for device/exchange/CmdletExtensionAgent

Model ref.: device/exchange/CmdletExtensionAgent

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

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

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

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/device/exchange/CmdletExtensionAgent/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "AdminDisplayName": {
               "__type_requested": "System.String",
               "readonly": false,
               "__type_mapping_type": "String",
               "name": "AdminDisplayName",
               "title": "AdminDisplayName",
               "required": true,
               "type": "string"
          },
          "OrganizationId": {
               "__type_requested": "System.String",
               "readonly": false,
               "__type_mapping_type": "String",
               "name": "OrganizationId",
               "title": "OrganizationId",
               "required": true,
               "type": "string"
          },
          "Priority": {
               "__type_requested": "Byte",
               "__type_mapping_type": "Unknown",
               "name": "Priority",
               "title": "Priority",
               "description": "The Priority parameter specifies where in the priority order of the cmdlet extension agent list the agent should be placed. The priority must be between 0 and the maximum number of agents. Agents with a priority closest to 0 have a higher priority and are run first.",
               "required": true,
               "readonly": true,
               "type": "string",
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          },
          "WhenCreatedUTC": {
               "__type_requested": "System.DateTime",
               "__type_mapping_type": "DateTime",
               "name": "WhenCreatedUTC",
               "title": "WhenCreatedUTC",
               "format": "date-time",
               "required": true,
               "readonly": false,
               "type": "string"
          },
          "PSShowComputerName": {
               "__type_requested": "System.Boolean",
               "readonly": true,
               "__type_mapping_type": "Boolean",
               "name": "PSShowComputerName",
               "title": "PSShowComputerName",
               "required": false,
               "type": "boolean"
          },
          "ClassFactory": {
               "__type_requested": "System.String",
               "readonly": false,
               "__type_mapping_type": "String",
               "name": "ClassFactory",
               "title": "ClassFactory",
               "required": true,
               "type": "string"
          },
          "Assembly": {
               "__type_requested": "System.String",
               "readonly": false,
               "__type_mapping_type": "String",
               "name": "Assembly",
               "title": "Assembly",
               "required": true,
               "type": "string",
               "description": "The Assembly parameter specifies that only the agents that match the assembly name provided should be listed."
          },
          "ObjectClass": {
               "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,",
               "__type_mapping_type": "String[]",
               "name": "ObjectClass",
               "title": "ObjectClass",
               "items": {
                    "type": "string"
               },
               "required": true,
               "readonly": false,
               "type": "array"
          },
          "PSComputerName": {
               "__type_requested": "System.String",
               "readonly": true,
               "__type_mapping_type": "String",
               "name": "PSComputerName",
               "title": "PSComputerName",
               "required": false,
               "type": "string"
          },
          "Identity": {
               "__type_requested": "System.String",
               "readonly": false,
               "__type_mapping_type": "String",
               "name": "Identity",
               "title": "Identity",
               "required": true,
               "type": "string",
               "description": "The Identity parameter specifies the name of the cmdlet extension agent to disable. If the name contains spaces, enclose the name in quotation marks (\")."
          },
          "DistinguishedName": {
               "__type_requested": "System.String",
               "readonly": false,
               "__type_mapping_type": "String",
               "name": "DistinguishedName",
               "title": "DistinguishedName",
               "required": true,
               "type": "string"
          },
          "OriginatingServer": {
               "__type_requested": "System.String",
               "readonly": false,
               "__type_mapping_type": "String",
               "name": "OriginatingServer",
               "title": "OriginatingServer",
               "required": true,
               "type": "string"
          },
          "Name": {
               "__type_requested": "System.String",
               "readonly": false,
               "__type_mapping_type": "String",
               "name": "Name",
               "title": "Name",
               "required": true,
               "type": "string",
               "description": "The Name parameter specifies the name of the cmdlet extension agent. The maximum length of the agent name is 64 characters. If the name contains spaces, enclose the name in quotation marks (\")."
          },
          "Enabled": {
               "__type_requested": "System.Boolean",
               "readonly": false,
               "__type_mapping_type": "Boolean",
               "name": "Enabled",
               "title": "Enabled",
               "required": true,
               "type": "boolean",
               "description": "The Enabled parameter specifies whether the cmdlet should return a list of enabled agents only, or a list of disabled agents only. Valid values are $true and $false."
          },
          "WhenCreated": {
               "__type_requested": "System.DateTime",
               "__type_mapping_type": "DateTime",
               "name": "WhenCreated",
               "title": "WhenCreated",
               "format": "date-time",
               "required": true,
               "readonly": false,
               "type": "string"
          },
          "ExchangeVersion": {
               "__type_requested": "System.String",
               "readonly": false,
               "__type_mapping_type": "String",
               "name": "ExchangeVersion",
               "title": "ExchangeVersion",
               "required": true,
               "type": "string"
          },
          "Guid": {
               "__type_requested": "System.Guid",
               "readonly": false,
               "__type_mapping_type": "String",
               "name": "Guid",
               "title": "Guid",
               "required": true,
               "type": "string"
          },
          "ObjectCategory": {
               "__type_requested": "System.String",
               "readonly": false,
               "__type_mapping_type": "String",
               "name": "ObjectCategory",
               "title": "ObjectCategory",
               "required": true,
               "type": "string"
          },
          "IsValid": {
               "__type_requested": "System.Boolean",
               "readonly": false,
               "__type_mapping_type": "Boolean",
               "name": "IsValid",
               "title": "IsValid",
               "required": true,
               "type": "boolean"
          },
          "WhenChanged": {
               "__type_requested": "System.DateTime",
               "__type_mapping_type": "DateTime",
               "name": "WhenChanged",
               "title": "WhenChanged",
               "format": "date-time",
               "required": true,
               "readonly": false,
               "type": "string"
          },
          "WhenChangedUTC": {
               "__type_requested": "System.DateTime",
               "__type_mapping_type": "DateTime",
               "name": "WhenChangedUTC",
               "title": "WhenChangedUTC",
               "format": "date-time",
               "required": true,
               "readonly": false,
               "type": "string"
          },
          "ObjectState": {
               "__type_requested": "System.String",
               "readonly": false,
               "__type_mapping_type": "String",
               "name": "ObjectState",
               "title": "ObjectState",
               "required": true,
               "type": "string"
          },
          "RunspaceId": {
               "__type_requested": "System.Guid",
               "readonly": true,
               "__type_mapping_type": "String",
               "name": "RunspaceId",
               "title": "RunspaceId",
               "required": false,
               "type": "string"
          },
          "IsSystem": {
               "__type_requested": "System.Boolean",
               "readonly": false,
               "__type_mapping_type": "Boolean",
               "name": "IsSystem",
               "title": "IsSystem",
               "required": true,
               "type": "boolean",
               "description": "This parameter is reserved for internal Microsoft use."
          }
     },
     "schema_version": "15312"
}

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/exchange/CmdletExtensionAgent/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/CmdletExtensionAgent device/exchange/CmdletExtensionAgent schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/exchange/CmdletExtensionAgent/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchange/CmdletExtensionAgent/[pkid1]", "/api/v0/device/exchange/CmdletExtensionAgent/[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/CmdletExtensionAgent/?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

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/exchange/CmdletExtensionAgent	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/exchange/CmdletExtensionAgent/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/exchange/CmdletExtensionAgent	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/exchange/CmdletExtensionAgent/[pkid1]", "/api/device/exchange/CmdletExtensionAgent/[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/CmdletExtensionAgent/?hierarchy=[hierarchy]&format=json&schema_rules=true

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

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for device/exchange/CmdletExtensionAgent:

 GET http://[host-proxy]/api/device/exchange/CmdletExtensionAgent/?hierarchy=[hierarchy]

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

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/exchange/CmdletExtensionAgent/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]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/exchange/CmdletExtensionAgent/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]

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

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

GET http://[host]/api/device/exchange/CmdletExtensionAgent/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "pagination": {
          "skip": 0,
          "limit": 3,
          "maximum_limit": 2000,
          "total": 0,
          "total_limit": null,
          "order_by": "Name",
          "direction": "asc",
          "current": "/api/device/exchange/CmdletExtensionAgent/?skip=0&limit=3&order_by=Name&direction=asc&traversal=down"
     },
     "operations": [
          "move"
     ],
     "meta": {
          "model_type": "device/exchange/CmdletExtensionAgent",
          "summary_attrs": [
               {
                    "name": "Name",
                    "title": "Name"
               },
               {
                    "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": []
          },
          "model_specific_actions": [
               "powershell_disable",
               "powershell_enable",
               "get",
               "list",
               "update",
               "bulk_update_form",
               "clone",
               "configuration_template",
               "export",
               "export_bulkload_template",
               "field_display_policy",
               "help",
               "move"
          ],
          "schema_version": "15312",
          "actions": [
               {
                    "bulk_update_form": {
                         "method": "GET",
                         "class": "update",
                         "href": "/api/device/exchange/CmdletExtensionAgent/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
                         "support_async": false,
                         "title": "Bulk Modify"
                    }
               },
               {
                    "move": {
                         "method": "POST",
                         "class": "move",
                         "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/exchange/CmdletExtensionAgent",
                         "support_async": true,
                         "title": "Move",
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               },
               {
                    "export": {
                         "method": "POST",
                         "class": "export",
                         "href": "/api/device/exchange/CmdletExtensionAgent/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/device/exchange/CmdletExtensionAgent/export_bulkload_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export Bulk Load Template"
                    }
               },
               {
                    "configuration_template": {
                         "method": "GET",
                         "class": "config",
                         "href": "/api/device/exchange/CmdletExtensionAgent/configuration_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Configuration Template"
                    }
               },
               {
                    "field_display_policy": {
                         "method": "GET",
                         "class": "display_policy",
                         "href": "/api/device/exchange/CmdletExtensionAgent/field_display_policy/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Field Display Policy"
                    }
               },
               {
                    "list": {
                         "method": "GET",
                         "class": "list",
                         "href": "/api/device/exchange/CmdletExtensionAgent/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "List"
                    }
               },
               {
                    "help": {
                         "method": "GET",
                         "class": "help",
                         "href": "/api/device/exchange/CmdletExtensionAgent/help?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Help"
                    }
               },
               {
                    "purge": {
                         "method": "POST",
                         "class": "purge",
                         "href": "/api/device/exchange/CmdletExtensionAgent/purge/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Purge"
                    }
               }
          ]
     },
     "resources": []
}

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

Task	Call	URL	Parameters	Response
Purge	POST	/api/device/exchange/CmdletExtensionAgent/purge/	hierarchy=[hierarchy] format=json

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/device/exchange/CmdletExtensionAgent/[pkid]	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/exchange/CmdletExtensionAgent/[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/CmdletExtensionAgent

GET http://[host-proxy]/api/device/exchange/CmdletExtensionAgent/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

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

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

For Bulk Export, refer to the Bulk Export section.

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

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

Task	Call	URL	Parameters	Payload
Powershell Disable	POST	/api/device/exchange/CmdletExtensionAgent/[pkid]/+powershell_disable	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Powershell Enable	POST	/api/device/exchange/CmdletExtensionAgent/[pkid]/+powershell_enable	hierarchy=[hierarchy]	If payload required:

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

API Reference for device/exchange/CmdletExtensionAgent

GET http://[host-proxy]/api/device/exchange/CmdletExtensionAgent/schema/?hierarchy=[hierarchy]&format=json&schema=1

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

GET http://[host]/api/device/exchange/CmdletExtensionAgent/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Purge

Instance API Reference

Modify

Clone

Move

Export

Get

Help

Powershell Disable

Powershell Enable

Purge