[Index]
GenericPowerShell_powershell_exceptions
Model ref.: data/GenericPowerShell_powershell_exceptions
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,
"type": "string",
"title": "Name"
},
"exceptions": {
"items": {
"type": "object",
"properties": {
"SearchText": {
"required": true,
"type": "string",
"description": "Text to search for in error message",
"title": "Search Text"
},
"FriendlyText": {
"type": "string",
"description": "Message to show in transaction log",
"title": "Friendly Text"
},
"Retryable": {
"type": "boolean",
"description": "Is this error retryable?",
"title": "Retryable"
},
"Delay": {
"type": "integer",
"description": "Seconds to delay before retrying",
"title": "Delay"
},
"ReplaceSession": {
"type": "boolean",
"description": "Start a new session when retrying?",
"title": "Replace Session"
}
}
},
"required": true,
"type": "array",
"title": "Exceptions"
}
},
"schema_version": "0.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/GenericPowerShell_powershell_exceptions/add/ |
|
The GUI Add form of data/GenericPowerShell_powershell_exceptions 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/GenericPowerShell_powershell_exceptions | 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/GenericPowerShell_powershell_exceptions/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/GenericPowerShell_powershell_exceptions/[pkid1]", "/api/data/GenericPowerShell_powershell_exceptions/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/GenericPowerShell_powershell_exceptions/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/GenericPowerShell_powershell_exceptions/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/GenericPowerShell_powershell_exceptions/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/GenericPowerShell_powershell_exceptions/[pkid1]", "/api/v0/data/GenericPowerShell_powershell_exceptions/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/GenericPowerShell_powershell_exceptions/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/GenericPowerShell_powershell_exceptions; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/GenericPowerShell_powershell_exceptions/export/ |
|
{ "hrefs":["/api/data/GenericPowerShell_powershell_exceptions/[pkid1]", "/api/data/GenericPowerShell_powershell_exceptions/[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/GenericPowerShell_powershell_exceptions and the JSON format can be used to import instances of data/GenericPowerShell_powershell_exceptions.
GET http://[host-proxy]/api/data/GenericPowerShell_powershell_exceptions/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/GenericPowerShell_powershell_exceptions | POST | /api/data/GenericPowerShell_powershell_exceptions/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/data/GenericPowerShell_powershell_exceptions/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/data/GenericPowerShell_powershell_exceptions/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/GenericPowerShell_powershell_exceptions/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/GenericPowerShell_powershell_exceptions/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/GenericPowerShell_powershell_exceptions/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/GenericPowerShell_powershell_exceptions/ |
|
The data/GenericPowerShell_powershell_exceptions schema and all instances as JSON. |
(The list will return 0 to 3 data/GenericPowerShell_powershell_exceptions instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 1,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/GenericPowerShell_powershell_exceptions/?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/GenericPowerShell_powershell_exceptions",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"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.0",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/GenericPowerShell_powershell_exceptions/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/GenericPowerShell_powershell_exceptions/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/data/GenericPowerShell_powershell_exceptions/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/GenericPowerShell_powershell_exceptions/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/GenericPowerShell_powershell_exceptions/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/GenericPowerShell_powershell_exceptions/+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/GenericPowerShell_powershell_exceptions/+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/GenericPowerShell_powershell_exceptions/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/GenericPowerShell_powershell_exceptions/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/data/GenericPowerShell_powershell_exceptions/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/GenericPowerShell_powershell_exceptions/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/GenericPowerShell_powershell_exceptions/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"transform": {
"method": "GET",
"class": "transform",
"href": "/api/data/GenericPowerShell_powershell_exceptions/transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Transform Template"
}
}
]
},
"resources": [
{
"data": {
"name": "default",
"exceptions": [
{
"SearchText": "Cannot set the console color",
"FriendlyText": "This session was for manual troubleshooting, start another one",
"Retryable": true,
"Delay": 5,
"ReplaceSession": true
},
{
"SearchText": "Invalid credential",
"FriendlyText": "Invalid credential, retrying once in case session token has expired",
"Retryable": true,
"Delay": 5,
"ReplaceSession": true
},
{
"SearchText": "Tenant Domain is empty",
"FriendlyText": "Tenant Domain is empty, retrying once",
"Retryable": true,
"Delay": 5,
"ReplaceSession": true
},
{
"SearchText": "Session is not established, run Connect-MicrosoftTeams before requesting access token",
"FriendlyText": "Session is not established, run Connect-MicrosoftTeams before requesting access token",
"Retryable": true,
"Delay": 5,
"ReplaceSession": true
},
{
"SearchText": "You must call the Connect-MicrosoftTeams cmdlet before calling any other cmdlets",
"FriendlyText": "You must call the Connect-MicrosoftTeams cmdlet before calling any other cmdlets",
"Retryable": true,
"Delay": 5,
"ReplaceSession": true
},
{
"SearchText": "You must call Connect-ExchangeOnline before calling any other cmdlet",
"FriendlyText": "You must call Connect-ExchangeOnline before calling any other cmdlet",
"Retryable": true,
"Delay": 5,
"ReplaceSession": true
},
{
"SearchText": "[ServiceError] : Unexpected error",
"FriendlyText": "Unexpected error occurred. Retry the command.",
"Retryable": true,
"Delay": 5,
"ReplaceSession": true
},
{
"SearchText": "RemoteException",
"FriendlyText": "RemoteException",
"Retryable": true,
"Delay": 5,
"ReplaceSession": true
},
{
"SearchText": "AdalServiceException",
"FriendlyText": "AdalServiceException",
"Retryable": true,
"Delay": 10,
"ReplaceSession": true
},
{
"SearchText": "Write to AAD Process",
"FriendlyText": "Timed out communicating with Azure Active Directory.",
"Retryable": true,
"Delay": 60,
"ReplaceSession": true
},
{
"SearchText": "403 from the remote WS-Management service",
"FriendlyText": "Is the Skype for Business Administrator role assigned to Microsoft Teams service account?"
},
{
"SearchText": "Management object not found for identity",
"FriendlyText": "The user does not exist in the tenant. Try re-running a datasync."
},
{
"SearchText": "unencrypted traffic is disabled",
"FriendlyText": "unencrypted traffic is disabled",
"Retryable": true,
"Delay": 10,
"ReplaceSession": true
},
{
"SearchText": "AADSTS50034",
"FriendlyText": "Check the Microsoft Teams Admin Username - this account does not exist in the tenant."
},
{
"SearchText": "AADSTS50126",
"FriendlyText": "Check the Microsoft Teams Admin Password - this password is invalid."
},
{
"SearchText": "AADSTS53003",
"FriendlyText": "A conditional access policy is preventing access to the Microsoft tenant from the PowerShell Proxy ."
},
{
"SearchText": "AADSTS50055",
"FriendlyText": "The Microsoft Teams Admin Password has expired. Please reset the password, then update the password in the VOSS Automate tenant settings."
},
{
"SearchText": "AADSTS700027",
"FriendlyText": "The certificate thumbprint does not correspond to a valid certificate. Double-check the thumbprint in the VOSS Automate tenant settings."
},
{
"SearchText": "Access is denied",
"FriendlyText": "VOSS Automate is attempting to access a resource for which it does not have permission. Please check the credentials in the VOSS Automate tenant settings, and then the permissions associated with those credentials."
}
],
"pkid": "650fe43284eaf2a1ce638193",
"hierarchy_friendly_name": "hcs (Hcs)",
"hierarchy_path": "sys.hcs"
},
"meta": {
"model_type": "data/GenericPowerShell_powershell_exceptions",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"V4UC",
"ba_CommonOverlay"
],
"title": "default",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ad5bacbaffa9343e4d93e01",
"href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/GenericPowerShell_powershell_exceptions/650fe43284eaf2a1ce638192/",
"pkid": "650fe43284eaf2a1ce638192"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"650fe43284eaf2a1ce638192"
],
"schema_version": "0.0",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/GenericPowerShell_powershell_exceptions/650fe43284eaf2a1ce638192/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/GenericPowerShell_powershell_exceptions/650fe43284eaf2a1ce638192/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/GenericPowerShell_powershell_exceptions/650fe43284eaf2a1ce638192/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/GenericPowerShell_powershell_exceptions/650fe43284eaf2a1ce638192/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/GenericPowerShell_powershell_exceptions/650fe43284eaf2a1ce638192/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/GenericPowerShell_powershell_exceptions/650fe43284eaf2a1ce638192/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/GenericPowerShell_powershell_exceptions/650fe43284eaf2a1ce638192/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/GenericPowerShell_powershell_exceptions/650fe43284eaf2a1ce638192/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "650fe43284eaf2a1ce638192"
}
]
}
(Show the first instance)
{
"data": {
"name": "default",
"exceptions": [
{
"SearchText": "Cannot set the console color",
"FriendlyText": "This session was for manual troubleshooting, start another one",
"Retryable": true,
"Delay": 5,
"ReplaceSession": true
},
{
"SearchText": "Invalid credential",
"FriendlyText": "Invalid credential, retrying once in case session token has expired",
"Retryable": true,
"Delay": 5,
"ReplaceSession": true
},
{
"SearchText": "Tenant Domain is empty",
"FriendlyText": "Tenant Domain is empty, retrying once",
"Retryable": true,
"Delay": 5,
"ReplaceSession": true
},
{
"SearchText": "Session is not established, run Connect-MicrosoftTeams before requesting access token",
"FriendlyText": "Session is not established, run Connect-MicrosoftTeams before requesting access token",
"Retryable": true,
"Delay": 5,
"ReplaceSession": true
},
{
"SearchText": "You must call the Connect-MicrosoftTeams cmdlet before calling any other cmdlets",
"FriendlyText": "You must call the Connect-MicrosoftTeams cmdlet before calling any other cmdlets",
"Retryable": true,
"Delay": 5,
"ReplaceSession": true
},
{
"SearchText": "You must call Connect-ExchangeOnline before calling any other cmdlet",
"FriendlyText": "You must call Connect-ExchangeOnline before calling any other cmdlet",
"Retryable": true,
"Delay": 5,
"ReplaceSession": true
},
{
"SearchText": "[ServiceError] : Unexpected error",
"FriendlyText": "Unexpected error occurred. Retry the command.",
"Retryable": true,
"Delay": 5,
"ReplaceSession": true
},
{
"SearchText": "RemoteException",
"FriendlyText": "RemoteException",
"Retryable": true,
"Delay": 5,
"ReplaceSession": true
},
{
"SearchText": "AdalServiceException",
"FriendlyText": "AdalServiceException",
"Retryable": true,
"Delay": 10,
"ReplaceSession": true
},
{
"SearchText": "Write to AAD Process",
"FriendlyText": "Timed out communicating with Azure Active Directory.",
"Retryable": true,
"Delay": 60,
"ReplaceSession": true
},
{
"SearchText": "403 from the remote WS-Management service",
"FriendlyText": "Is the Skype for Business Administrator role assigned to Microsoft Teams service account?"
},
{
"SearchText": "Management object not found for identity",
"FriendlyText": "The user does not exist in the tenant. Try re-running a datasync."
},
{
"SearchText": "unencrypted traffic is disabled",
"FriendlyText": "unencrypted traffic is disabled",
"Retryable": true,
"Delay": 10,
"ReplaceSession": true
},
{
"SearchText": "AADSTS50034",
"FriendlyText": "Check the Microsoft Teams Admin Username - this account does not exist in the tenant."
},
{
"SearchText": "AADSTS50126",
"FriendlyText": "Check the Microsoft Teams Admin Password - this password is invalid."
},
{
"SearchText": "AADSTS53003",
"FriendlyText": "A conditional access policy is preventing access to the Microsoft tenant from the PowerShell Proxy ."
},
{
"SearchText": "AADSTS50055",
"FriendlyText": "The Microsoft Teams Admin Password has expired. Please reset the password, then update the password in the VOSS Automate tenant settings."
},
{
"SearchText": "AADSTS700027",
"FriendlyText": "The certificate thumbprint does not correspond to a valid certificate. Double-check the thumbprint in the VOSS Automate tenant settings."
},
{
"SearchText": "Access is denied",
"FriendlyText": "VOSS Automate is attempting to access a resource for which it does not have permission. Please check the credentials in the VOSS Automate tenant settings, and then the permissions associated with those credentials."
}
],
"pkid": "650fe43284eaf2a1ce638193"
},
"meta": {
"model_type": "data/GenericPowerShell_powershell_exceptions",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"V4UC",
"ba_CommonOverlay"
],
"title": "default",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": false,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01",
"pkid": "5ad5bacbaffa9343e4d93e01"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/data/GenericPowerShell_powershell_exceptions/650fe43284eaf2a1ce638192/",
"pkid": "650fe43284eaf2a1ce638192"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"650fe43284eaf2a1ce638192"
],
"schema_version": "0.0",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/GenericPowerShell_powershell_exceptions/650fe43284eaf2a1ce638192/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/GenericPowerShell_powershell_exceptions/650fe43284eaf2a1ce638192/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/GenericPowerShell_powershell_exceptions/650fe43284eaf2a1ce638192/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/GenericPowerShell_powershell_exceptions/650fe43284eaf2a1ce638192/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/GenericPowerShell_powershell_exceptions/650fe43284eaf2a1ce638192/+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/GenericPowerShell_powershell_exceptions/650fe43284eaf2a1ce638192/+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/GenericPowerShell_powershell_exceptions/650fe43284eaf2a1ce638192/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/GenericPowerShell_powershell_exceptions/650fe43284eaf2a1ce638192/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "650fe43284eaf2a1ce638192"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/GenericPowerShell_powershell_exceptions. | GET | /api/data/GenericPowerShell_powershell_exceptions/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/GenericPowerShell_powershell_exceptions as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Transform Template | GET | /api/data/GenericPowerShell_powershell_exceptions/transform/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/GenericPowerShell_powershell_exceptions/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/GenericPowerShell_powershell_exceptions/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/GenericPowerShell_powershell_exceptions/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/GenericPowerShell_powershell_exceptions/?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/GenericPowerShell_powershell_exceptions; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/GenericPowerShell_powershell_exceptions/[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/GenericPowerShell_powershell_exceptions and the JSON format can be used to import instances of data/GenericPowerShell_powershell_exceptions.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/GenericPowerShell_powershell_exceptions/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/GenericPowerShell_powershell_exceptions/[pkid] | hierarchy=[hierarchy] | The data/GenericPowerShell_powershell_exceptions instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/GenericPowerShell_powershell_exceptions/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/GenericPowerShell_powershell_exceptions. |