You are here: Home > API Reference > UEM > Automation Rules > Create mdmAutomationRule

Create mdmAutomationRule

Required Permission: mdm.global.automationRule.create

Create mdmAutomationRule

POST
https://api.applivery.io/v1/organizations/{organizationId}/mdm/automation-rules

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^[a-fA-F0-9]{24}$

Body Params application/json
name string required
≤ 128 characters
description string optional
≤ 256 characters
deviceAudienceIds array [string] required
actions array [object] required
actionId string required
Match pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ · Format: uuid
when string required
always enter leave
config object required
type string required
setSmartAttribute
admPolicyId string required
Match pattern: ^[a-fA-F0-9]{24}$
priority integer required
≥ 0 · ≤ 10000
emmPolicyId string required
Match pattern: ^[a-fA-F0-9]{24}$
winPolicyId string required
Match pattern: ^[a-fA-F0-9]{24}$
aosPolicyId string required
Match pattern: ^[a-fA-F0-9]{24}$
smartAttributeId string required
Match pattern: ^[a-fA-F0-9]{24}$
segmentId integer optional
≥ 0 · ≤ 9007199254740991
{
    "name": "string",
    "description": "string",
    "deviceAudienceIds": [
        "string"
    ],
    "actions": [
        {
            "actionId": "550e8400-e29b-41d4-a716-446655440000",
            "when": "always",
            "config": {
                "type": "setAdmPolicy",
                "admPolicyId": "string",
                "priority": 0
            }
        }
    ],
    "segmentId": 0
}

Responses

200 Response application/json
status boolean required
data object required
id string required
Match pattern: ^[a-fA-F0-9]{24}$
name string required
≤ 128 characters
description string optional
≤ 256 characters
organizationId string required
Match pattern: ^[a-fA-F0-9]{24}$
deviceAudienceIds array [string] required
deviceAudiencesInfo array [object] required
id string required
Match pattern: ^[a-fA-F0-9]{24}$
name string required
≤ 256 characters
description string optional
≤ 256 characters
organizationId string required
Match pattern: ^[a-fA-F0-9]{24}$
selectorsNum object required
counts object required
createdAt string required
updatedAt string required
segmentId integer optional
≥ 0 · ≤ 9007199254740991
actions any required
createdAt string required
updatedAt string required
version integer required
≥ 0 · ≤ 9007199254740991
segmentId integer optional
≥ 0 · ≤ 9007199254740991
{
    "status": true,
    "data": {
        "id": "string",
        "name": "string",
        "description": "string",
        "organizationId": "string",
        "deviceAudienceIds": [
            "string"
        ],
        "deviceAudiencesInfo": [
            {
                "id": "string",
                "name": "string",
                "description": "string",
                "organizationId": "string",
                "selectorsNum": {
                    "deviceGroups": 0,
                    "mdmUserGroups": 0,
                    "emmDeviceIds": 0,
                    "admDeviceIds": 0,
                    "winDeviceIds": 0,
                    "aosDeviceIds": 0,
                    "mdmUserIds": 0,
                    "serialNumbers": 0,
                    "smartAttributes": 0
                },
                "counts": {
                    "devices": 0,
                    "emmDevices": 0,
                    "admDevices": 0,
                    "winDevices": 0,
                    "aosDevices": 0,
                    "calculateDate": "string",
                    "mdmAutomationRules": 0,
                    "smartAttributes": 0
                },
                "createdAt": "string",
                "updatedAt": "string",
                "segmentId": 0
            }
        ],
        "actions": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "version": 0,
        "segmentId": 0
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
Was this page helpful?