ProcessStageSetup allows users to manage the stages of a process that apply to a specific entity in Maximizer CRM.

Process Stages are the sequential steps within a Process that represent key milestones required to succesfully manage a specific entity. See below some considerations for ProcessStageSetup:

The ProcessStageSetup object is composed of an autogenerated key and four main fields:
- ProcessSetupKey: The key of the Process Setup this stage belongs to.\
- Name: The name of the stage.\
- TargetAge: The expected number of days for activities in this stage.\
- Sequence: Defines the position (order) of this stage within the process.

HowTo's

Read - Stages from a process

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "ProcessStageSetup": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "ProcessSetupKey": 1,
                "Name": 1,
                "TargetAge": 1,
                "Sequence": 1,
                "TAG": 1,
                "CreationDate": 1,
                "Creator": 1,
                "LastModifyDate": 1,
                "ModifiedBy": 1
            }
        },
        "Criteria": {
            "SearchQuery": {
                "ProcessSetupKey": {
                    "$EQ": "UHJvY2Vzc1NldHVwCUAqL0NBU0UJMA==" // Key of the process you want to read the detail of the stages
                }
            }
        }
    }
}

MetaData

Read ProcessStageSetup metadata (simple)

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

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

ProcessStageSetup CRUD

Create - ProcessStageSetup

// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
    "ProcessStageSetup": {
        "Data": {
            "Key": null, // Will be generated automatically
            "ProcessSetupKey": "UHJvY2Vzc1NldHVwCTIyMDUzMDAwMDAxMDc3MjIzODE2OVBTCTA=", // Mandatory
            "Name": "ProcessStageSetup For Test", // Mandatory
            // Number of days that user expect the activities in that stage to take.
            "TargetAge": 0,
            // Used to order the stage within the process
            "Sequence": 1
        }
    }
}

Read - ProcessStageSetup

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

Update - ProcessStageSetup

// POST https://api.maximizer.com/octopus/Update
// Authorization: Bearer <token>
{
    "ProcessStageSetup": {
        "Data": {
            "Key": "UHJvY2Vzc1N0YWdlU2V0dXAJMjUwMTAyMDAwMDAwMDE4NTg0Njg0UFMJMg==", // Mandatory
            "Name": "ProcessStageSetup updated name",
            "TargetAge": 15,
            "Sequence": 3
        }
    }
}

Delete - ProcessStageSetup

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