RelatedEntry allows users to manage the related entries of an AbEntry in Maximizer CRM.

Each Related Entry represents a defined connection between AbEntries, helping users understand how different entities are linked within the system.

HowTo's

Read - Related Entries for specific AbEntry

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "RelatedEntry": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "FromKey": 1,
                "To": {
                    "Key": 1,
                    "Type": 1,
                    "FullName": 1
                },
                "Description": 1,
                "ReverseRelatedEntryKey": 1,
                "DisplayValue": 1,
                "RelationType": 1
            }
        },
        "Criteria": {
            "SearchQuery": {
                "FromKey": {
                    "$EQ": "QWJFbnRyeQkyNTA5MTgyNTE2MTkxMTIzNDAwNTZDCTA=" // Key of the AbEntry for which you want to retrieve related entries
                }
            }
        }
    }
}

MetaData

Read RelatedEntry metadata (simple)

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

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

FieldOptions

Read RelatedEntry FieldOptions - RelationType

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "RelatedEntry": {
        "FieldOptions": {
            "RelationType": [
                {
                    "Key": 1,
                    "DisplayValue": 1
                }
            ]
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

RelatedEntry CRUD

Create - RelatedEntry

// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
    "RelatedEntry": {
        "Data": {
            "Key": null,
            "FromKey": "QWJFbnRyeQkyMjA1MDUyNTIyMjczODY2NDAwMjlDCTA=", // Key of the AbEntry where the relationship starts
            "ToKey": "QWJFbnRyeQkyMjA1MDUyNTE1MzY1OTg0NTAwMDVDCTA=", // Key of the AbEntry that the relationship points to
            "RelationType": "60001", // Type of relationship - Check FieldOptions for possible values
            "Description": "Example of RelatedEntry"
        }
    }
}

Read - RelatedEntry

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "RelatedEntry": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "FromKey": 1, // Key of the AbEntry where the relationship starts
                "ToKey": 1, // Key of the AbEntry that the relationship points to
                "To": { // Object containing basic details of the target AbEntry
                    "Key": 1,
                    "FullName": 1
                },
                "Description": 1,
                "ReverseRelatedEntryKey": 1, // Key of the reverse relationship, if it exists
                "DisplayValue": 1,
                "RelationType": 1 // Type of relationship - Check FieldOptions for possible values
            }
        },
        "Criteria": {
            "SearchQuery": {},
            "Top": 3
        }
    }
}

Update - RelatedEntry

// POST https://api.maximizer.com/octopus/Update
// Authorization: Bearer <token>
{
    "RelatedEntry": {
        "Data": {
            "Key": "UmVsYXRlZEVudHJ5CTI1MTIxNjAwMDAwMDAxNDU0Njc1NjBSCTA=", // Mandatory
            "Description": "Example of updated description for RelatedEntry"
        }
    }
}

Delete - RelatedEntry

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