[Index]
Microsoft Defender Quarantine Message Request Relation
Model ref.: relation/MicrosoftDefenderQuarantineMessageRequest
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": {
"Identity": {
"name": "Identity",
"readonly": true,
"title": "Identity",
"type": "string"
},
"FirstRecipientAddress": {
"name": "FirstRecipientAddress",
"readonly": true,
"title": "First Recipient Address",
"type": "string"
},
"MessageId": {
"name": "MessageId",
"readonly": true,
"title": "Message Id",
"type": "string"
},
"PolicyName": {
"name": "PolicyName",
"readonly": true,
"title": "Policy Name",
"type": "string"
},
"PolicyType": {
"name": "PolicyType",
"readonly": true,
"title": "Policy Type",
"type": "string"
},
"QuarantineTypes": {
"name": "QuarantineTypes",
"readonly": true,
"title": "Quarantine Types",
"type": "string"
},
"ReceivedTime": {
"name": "ReceivedTime",
"readonly": true,
"title": "Received Time",
"type": "string"
},
"receivedtimelc": {
"name": "receivedtimelc",
"readonly": true,
"title": "Received Time Lower Case",
"type": "integer"
},
"RecipientAddress": {
"name": "RecipientAddress",
"readonly": true,
"type": "array",
"title": "Recipient Address",
"items": {
"type": "string"
}
},
"Released": {
"name": "Released",
"readonly": true,
"title": "Released",
"type": "boolean"
},
"ReleaseStatus": {
"name": "ReleaseStatus",
"readonly": true,
"title": "Release Status",
"type": "string",
"choices": [
{
"title": "NOTRELEASED",
"value": "NOTRELEASED"
},
{
"title": "RELEASED",
"value": "RELEASED"
}
]
},
"ReleaseStatusAction": {
"name": "ReleaseStatusAction",
"readonly": false,
"title": "Release Status Action",
"type": "string",
"default": "KEEP",
"choices": [
{
"title": "KEEP",
"value": "KEEP"
},
{
"title": "RELEASE",
"value": "RELEASE"
}
]
},
"SenderAddress": {
"name": "SenderAddress",
"readonly": true,
"title": "Sender Address",
"type": "string"
},
"Size": {
"name": "Size",
"readonly": true,
"title": "Size",
"type": "integer"
},
"Subject": {
"name": "Subject",
"readonly": true,
"title": "Subject",
"type": "string"
},
"SystemReleased": {
"name": "System Released",
"readonly": true,
"title": "System Released",
"type": "boolean"
},
"Type": {
"name": "Type",
"readonly": true,
"title": "Type",
"type": "string"
},
"QuarantineMessageReleaseRequest": {
"title": "Quarantine Message Release Request",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "Justification for the release of Quarantine Message",
"type": "string"
},
"justification": {
"title": "Justification",
"description": "Justification for the release of Quarantine Message",
"type": "string"
}
}
}
}
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/MicrosoftDefenderQuarantineMessageRequest; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/MicrosoftDefenderQuarantineMessageRequest/export/ |
|
{ "hrefs":["/api/relation/MicrosoftDefenderQuarantineMessageRequest/[pkid1]", "/api/relation/MicrosoftDefenderQuarantineMessageRequest/[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/MicrosoftDefenderQuarantineMessageRequest and the JSON format can be used to import instances of relation/MicrosoftDefenderQuarantineMessageRequest.
GET http://[host-proxy]/api/relation/MicrosoftDefenderQuarantineMessageRequest/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/MicrosoftDefenderQuarantineMessageRequest | POST | /api/relation/MicrosoftDefenderQuarantineMessageRequest/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/MicrosoftDefenderQuarantineMessageRequest/ |
|
The relation/MicrosoftDefenderQuarantineMessageRequest schema and all instances as JSON. |
(The list will return 0 to 3 relation/MicrosoftDefenderQuarantineMessageRequest instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "FirstRecipientAddress",
"direction": "asc",
"current": "/api/relation/MicrosoftDefenderQuarantineMessageRequest/?skip=0&limit=3&order_by=FirstRecipientAddress&direction=asc&traversal=down"
},
"operations": [
"help",
"remove",
"get",
"request_release",
"export",
"list",
"field_display_policy",
"update",
"export_bulkload_template",
"bulk_update",
"configuration_template",
"add"
],
"meta": {
"model_type": "relation/MicrosoftDefenderQuarantineMessageRequest",
"summary_attrs": [
{
"name": "FirstRecipientAddress",
"title": "First Recipient Address"
},
{
"name": "SenderAddress",
"title": "Sender Address"
},
{
"name": "Subject",
"title": "Subject"
},
{
"name": "ReleaseStatus",
"title": "Release Status"
},
{
"name": "ReceivedTime",
"title": "Received Time"
},
{
"name": "PolicyName",
"title": "Policy Name"
},
{
"name": "PolicyType",
"title": "Policy Type"
},
{
"name": "QuarantineTypes",
"title": "Quarantine Types"
},
{
"name": "Released",
"title": "Released"
},
{
"name": "Type",
"title": "Type"
},
{
"name": "Size",
"title": "Size"
},
{
"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/MicrosoftDefenderQuarantineMessageRequest/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"help",
"remove",
"get",
"request_release",
"export",
"list",
"update",
"export_bulkload_template",
"add"
],
"schema_version": null,
"actions": [
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/MicrosoftDefenderQuarantineMessageRequest/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/MicrosoftDefenderQuarantineMessageRequest/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/MicrosoftDefenderQuarantineMessageRequest/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/MicrosoftDefenderQuarantineMessageRequest/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/MicrosoftDefenderQuarantineMessageRequest. | GET | /api/relation/MicrosoftDefenderQuarantineMessageRequest/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/MicrosoftDefenderQuarantineMessageRequest as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/MicrosoftDefenderQuarantineMessageRequest/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/MicrosoftDefenderQuarantineMessageRequest; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/MicrosoftDefenderQuarantineMessageRequest/[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/MicrosoftDefenderQuarantineMessageRequest and the JSON format can be used to import instances of relation/MicrosoftDefenderQuarantineMessageRequest.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/MicrosoftDefenderQuarantineMessageRequest/[pkid] | hierarchy=[hierarchy] | The relation/MicrosoftDefenderQuarantineMessageRequest instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/MicrosoftDefenderQuarantineMessageRequest/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/MicrosoftDefenderQuarantineMessageRequest. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Request Release | POST | /api/relation/MicrosoftDefenderQuarantineMessageRequest/[pkid]/+request_release | hierarchy=[hierarchy] | If payload required: |