Task V2 represents an updated version of the Task object and is the recommended standard for future use. To enable Task V2, the API request payload must include a compatibility section specifying TaskObject version 2.0:

"Compatibility": { "TaskObject": "2.0" }

All of the existing properties and operations of Task are compatible with Task V2.

MetaData

Read Task V2 metadata (simple)

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Schema": {
        "Scope": {
            "Fields": 1
        },
        "Criteria": {
            "SearchQuery": {
                "Key": {
                    "$TREE": "/Task"
                }
            }
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0",
        "TaskObject": "2.0"
    }
}

Read Task V2 metadata (more)

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Schema": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "Alias": 1,
                "Type": 1,
                "Name": 1,
                "AppliesTo": 1,
                "Sortable": 1,
                "Queryable": 1,
                "Mandatory": 1,
                "Attributes": 1,
                "DisplayValue": 1
            }
        },
        "Criteria": {
            "SearchQuery": {
                "Key": {
                    "$TREE": "/Task"
                }
            }
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0",
        "TaskObject": "2.0"
    }
}

FieldOptions

Read Task V2 Field Options

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Task": {
        "FieldOptions": {
            "Status": [
                {
                    "Key": 1,
                    "Value": 1,
                    "DisplayValue": 1
                }
            ],
            "Subject": [
                {
                    "Key": 1,
                    "Value": 1,
                    "DisplayValue": 1
                }
            ],
            "CompletedBy": [
                {
                    "Key": 1,
                    "DisplayValue": 1
                }
            ]
        },
        "Options": {
            "IncludeDisabled": false
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0",
        "TaskObject": "2.0"
    }
}

Task V2 CRUD

Create - Task V2

// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
    "Task": {
        "Data": {
            "Key": null,
            "AbEntryKey": "QWJFbnRyeQkyMjA1MDUyNTIyMjczODY2NDAwMjlDCTE=",
            "DateTime": "2019-01-01",
            "Alarm": "2019-01-01",
            "SnoozeUntil": "2019-01-01",
            "Priority": "Hi",
            "Completed": false,
            "IconType": 1,
            "Activity": "Test Task Description",
            "AssignedTo": {
                "Uid": "MASTER"
            },
            "Status": "60002",
            "ActionPlanKey": "QWN0aW9uUGxhbgkyMTAyMjQyNTAxMjQyNDM4MzAwMDlQCTg="
        },
        "Options": {
            "ReadAfterSave": true
        }
    },
    "Compatibility": {
        "AbEntryKey": "2.0",
        "TaskObject": "2.0"
    }
}

Read - Task V2

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Task": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "AssignedTo": {
                    "UID": 1
                },
                "DateTime": 1,
                "Alarm": 1,
                "SnoozeUntil": 1,
                "Priority": 1,
                "Completed": 1,
                "IconType": 1,
                "Activity": 1,
                "Status": 1,
                "AbEntryKey": 1,
                "LeadKey": 1,
                "WorkflowKey": 1,
                "WorkflowTaskTemplateKey": 1,
                "WorkflowInstanceKey": 1
            }
        },
        "Criteria": {
            "SearchQuery": {
                "Key": {
                    "$EQ": "VGFzawkzOA=="
                }
            }
        }
    },
    "Compatibility": {
        "AbEntryKey": "2.0",
        "TaskObject": "2.0"
    }
}

Update - Task V2

// POST https://api.maximizer.com/octopus/Update
// Authorization: Bearer <token>
{
    "Task": {
        "Data": {
            "Key": "Task_v2_key",
            "DateTime": "2019-01-01",
            "SnoozeUntil": "2019-01-01",
            "Priority": "Hi",
            "Completed": true,
            "Activity": "Test Task Description Updated"
        }
    },
    "Compatibility": {
        "TaskObject": "2.0"
    }
}

Delete - Task V2

// POST https://api.maximizer.com/octopus/Delete
// Authorization: Bearer <token>
{
    "Task": {
        "Data": {
            "Key": "Task_v2_key"
        }
    },
    "Compatibility": {
        "TaskObject": "2.0"
    }
}