[Index]
Microsoft Defender Safe Links Staging Relation
Model ref.: relation/MicrosoftDefenderSafeLinksPolicyStaging
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",
"description": "Name of the Safe Links Policy",
"type": "string",
"required": true
},
"template": {
"title": "Safe Links Policy Template",
"description": "Safe Links Policy Template",
"type": "string",
"required": true
},
"summary": {
"title": "Summary",
"description": "Summary of the Safe Links Policy",
"type": "string"
},
"detail": {
"title": "Detail",
"description": "Detail desription of the Safe Links Policy",
"type": "string"
},
"created_timestamp": {
"title": "Create Timestamp",
"type": "string"
},
"updated_timestamp": {
"title": "Last Updated Timestamp",
"type": "string"
},
"state": {
"title": "State",
"description": "State of the Safe Links Policy",
"type": "string",
"required": true,
"default": "PENDING",
"choices": [
{
"value": "PENDING",
"title": "PENDING"
},
{
"value": "REJECTED",
"title": "REJECTED"
},
{
"value": "APPROVED",
"title": "APPROVED"
},
{
"value": "COMPLETED",
"title": "COMPLETED"
}
]
},
"external_reference_id": {
"title": "External Reference Id",
"description": "External Reference Id from the external system, e.g. ServiceNow",
"type": "string"
},
"requested_by": {
"title": "Requested By User",
"description": "Requested By User",
"type": "string"
},
"approved_by": {
"title": "Approved By User",
"description": "Approved By User",
"type": "string"
},
"rejected_by": {
"title": "Rejected By User",
"description": "Rejected By User",
"type": "string"
},
"NoInstance": {
"title": "No Instance",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"maxItems": 1
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/MicrosoftDefenderSafeLinksPolicyStaging/add/ |
|
The GUI Add form of relation/MicrosoftDefenderSafeLinksPolicyStaging 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/MicrosoftDefenderSafeLinksPolicyStaging | 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/MicrosoftDefenderSafeLinksPolicyStaging/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/MicrosoftDefenderSafeLinksPolicyStaging/[pkid1]", "/api/relation/MicrosoftDefenderSafeLinksPolicyStaging/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/MicrosoftDefenderSafeLinksPolicyStaging/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/MicrosoftDefenderSafeLinksPolicyStaging |
|
{"hrefs": ["/api/relation/MicrosoftDefenderSafeLinksPolicyStaging/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/MicrosoftDefenderSafeLinksPolicyStaging |
|
{"hrefs": ["/api/relation/MicrosoftDefenderSafeLinksPolicyStaging/[pkid1]", "/api/relation/MicrosoftDefenderSafeLinksPolicyStaging/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/MicrosoftDefenderSafeLinksPolicyStaging; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/MicrosoftDefenderSafeLinksPolicyStaging/export/ |
|
{ "hrefs":["/api/relation/MicrosoftDefenderSafeLinksPolicyStaging/[pkid1]", "/api/relation/MicrosoftDefenderSafeLinksPolicyStaging/[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/MicrosoftDefenderSafeLinksPolicyStaging and the JSON format can be used to import instances of relation/MicrosoftDefenderSafeLinksPolicyStaging.
GET http://[host-proxy]/api/relation/MicrosoftDefenderSafeLinksPolicyStaging/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/MicrosoftDefenderSafeLinksPolicyStaging | POST | /api/relation/MicrosoftDefenderSafeLinksPolicyStaging/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/MicrosoftDefenderSafeLinksPolicyStaging/ |
|
The relation/MicrosoftDefenderSafeLinksPolicyStaging schema and all instances as JSON. |
(The list will return 0 to 3 relation/MicrosoftDefenderSafeLinksPolicyStaging instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/MicrosoftDefenderSafeLinksPolicyStaging/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"remove",
"list",
"get",
"add",
"export",
"bulk_update",
"export_bulkload_template",
"configuration_template",
"help",
"update",
"move",
"field_display_policy"
],
"meta": {
"model_type": "relation/MicrosoftDefenderSafeLinksPolicyStaging",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "template",
"title": "Safe Links Policy Template"
},
{
"name": "state",
"title": "State"
},
{
"name": "external_reference_id",
"title": "External Reference Id"
},
{
"name": "approved_by",
"title": "Approved By User"
},
{
"name": "rejected_by",
"title": "Rejected By User"
},
{
"name": "created_timestamp",
"title": "Create Timestamp"
},
{
"name": "updated_timestamp",
"title": "Last Updated Timestamp"
},
{
"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/MicrosoftDefenderSafeLinksPolicyStaging/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"remove",
"get",
"add",
"list",
"export",
"export_bulkload_template",
"help",
"update",
"move"
],
"schema_version": null,
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/MicrosoftDefenderSafeLinksPolicyStaging/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/MicrosoftDefenderSafeLinksPolicyStaging/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/MicrosoftDefenderSafeLinksPolicyStaging",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/MicrosoftDefenderSafeLinksPolicyStaging/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/MicrosoftDefenderSafeLinksPolicyStaging/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/MicrosoftDefenderSafeLinksPolicyStaging/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/MicrosoftDefenderSafeLinksPolicyStaging/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/MicrosoftDefenderSafeLinksPolicyStaging. | GET | /api/relation/MicrosoftDefenderSafeLinksPolicyStaging/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/MicrosoftDefenderSafeLinksPolicyStaging as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/MicrosoftDefenderSafeLinksPolicyStaging/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/MicrosoftDefenderSafeLinksPolicyStaging/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/MicrosoftDefenderSafeLinksPolicyStaging | 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 relation/MicrosoftDefenderSafeLinksPolicyStaging; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/MicrosoftDefenderSafeLinksPolicyStaging/[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/MicrosoftDefenderSafeLinksPolicyStaging and the JSON format can be used to import instances of relation/MicrosoftDefenderSafeLinksPolicyStaging.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/MicrosoftDefenderSafeLinksPolicyStaging/[pkid] | hierarchy=[hierarchy] | The relation/MicrosoftDefenderSafeLinksPolicyStaging instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/MicrosoftDefenderSafeLinksPolicyStaging/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/MicrosoftDefenderSafeLinksPolicyStaging. |