ProcessSetup allows users to manage the different processes that apply to a specific entity in Maximizer CRM.

A process is a predefined sequence of stages that guides users through managing entities. Below are some key considerations for ProcessSetup:

The ProcessSetup object consists of a key (autogenerated), the entity to which the process applies, and a description of the process.\
The stages for each process can be managed using the ProcessStage object.

MetaData

Read ProcessSetup metadata (simple)

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

Read ProcessSetup 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": "/ProcessSetup"
                }
            }
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

ProcessSetup CRUD

Create - ProcessSetup

// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
    "ProcessSetup": {
        "Data": {
            "Key": null,
            // EntityType for which the Process Setup applies to
            // Supported entities:
            // 19 - Lead
            "EntityType": 19, // Mandatory
            "Name": "Test ProcessSetup",
            "TAG": "New Process Q2"
        }
    }
}

Read - ProcessSetup

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "ProcessSetup": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "EntityType": 1,
                "Name": 1,
                "Inactive": 1,
                "CreationDate": 1,
                "Creator": 1,
                "LastModifyDate": 1,
                "ModifiedBy": 1,
                "TAG": 1
            }
        },
        "Criteria": {
            "SearchQuery": {},
            "Top": 3
        }
    }
}

Update - ProcessSetup

// POST https://api.maximizer.com/octopus/Update
// Authorization: Bearer <token>
{
    "ProcessSetup": {
        "Data": {
            "Key": "UHJvY2Vzc1NldHVwCTI1MDQyOTAwMDAwMDAxODY1MTc4NFBTCTA=", // Mandatory
            "Name": "Test ProcessSetup updated "            
        }
    }
}

Delete - ProcessSetup

// POST https://api.maximizer.com/octopus/Delete
// Authorization: Bearer <token>
{
    "ProcessSetup": {
        "Data": {
            "Key": "UHJvY2Vzc1NldHVwCTIyMDcxMjAwMDAzMDc3MjIzODE2OVBTCTA=" // Mandatory
        }
    }
}