API Reference

Manage group hierarchies

Create parent-child relationships between groups

Call template

All DataTable calls can be POST or GET.

https://{OrangeLogicURL}/API/DataTable/V2.2/API/Datatable/v2.1/Contact.Group.Link:Create?Contact.CoreField.CG_RecordID:=[Datatable/v2.1/Contact.Group:Read?{group identifier for child group}]&Contact.CoreField.CG_RecordID_Src:=[Datatable/v2.1/Contact.Group:Read?{group identifier for parent group}&Contact.CoreField.LinkType:=ParentGroup

Child groups inherit privileges from parent groups, so when you add a parent group, you are assigning privileges to users in the child group. When you remove a parent group, you are removing privileges from users in the child group.

ℹ️

Note

When you manage groups, you’ll specify the action and then use sub-calls to identify the relevant groups in the database. Sub-calls are enclosed in square brackets.

For example, consider the following call:

/API/Datatable/v2.1/Contact.Group.Link:Create?Contact.CoreField.CG_RecordID:=[Datatable/v2.1/Contact.Group:Read?Contact.CoreField.Title_English=Senior archivists]&Contact.CoreField.CG_RecordID_Src:=[Datatable/v2.1/Contact.Group:Read?Contact.CoreField.Code=Archivists]&Contact.CoreField.LinkType:=ParentGroup

In this call, the sub-calls are:

  • Datatable/v2.1/Contact.Group:Read?Contact.CoreField.Title_English=Senior archivists
  • Datatable/v2.1/Contact.Group:Read?Contact.CoreField.Code=Archivists

These sub-calls read the Contacts DataTable to find the group with the title “Senior archivists” and the group with the code “Archivists.”

Create

Example: Add a parent group to an existing group

This call makes the “Archivists” group a parent of the “Senior Archivists” group.

/API/Datatable/v2.1/Contact.Group.Link:Create?Contact.CoreField.CG_RecordID:=[Datatable/v2.1/Contact.Group:Read?Contact.CoreField.Title_English=Senior archivists]&Contact.CoreField.CG_RecordID_Src:=[Datatable/v2.1/Contact.Group:Read?Contact.CoreField.Code=Archivists]&Contact.CoreField.LinkType:=ParentGroup

Example call 
curl --location --globoff --request POST 'https://mangovations.com/API/Datatable/v2.1/Contact.Group.Link:Create?Contact.CoreField.CG_RecordID%3A=[Datatable%2Fv2.1%2FContact.Group%3ARead%3FContact.CoreField.Title_English%3DSenior%20archivists]&Contact.CoreField.CG_RecordID_Src%3A=[Datatable%2Fv2.1%2FContact.Group%3ARead%3FContact.CoreField.Code%3DArchivists]&Contact.CoreField.LinkType%3A=ParentGroup' \
--header 'Authorization: Bearer pYXtK4jnyan9YEHVnlKDGgqEcmygK@gf@jP3kqK6Knj0YTZlmtDkUQCjgRn26RfrtqMsDFCEfNtO4CCinW2Kq0aYfvIBDJCrvjCIKIuteuuRqsZVRW5Ool5Men.M7Pc0' \
--header 'Cookie: AWSALB=lGTOQPOSCwflRa6/NX0VrLKxzMWYNXa0ka6B2PpMN4fddKGaqINRxDUgJaJW/OMEGE1GLRWj+UFK4fFs4FKy/1jbGGdRezc0O2cZ95+J0UcUx/gtsJv8ej45moss; AWSALBCORS=lGTOQPOSCwflRa6/NX0VrLKxzMWYNXa0ka6B2PpMN4fddKGaqINRxDUgJaJW/OMEGE1GLRWj+UFK4fFs4FKy/1jbGGdRezc0O2cZ95+J0UcUx/gtsJv8ej45moss; AWSALBTG=Z56/luULU4vDOi7Jp7TopwyOfAOKkCCa6APck21tTAUhima/fJe+53kDHrVHFOXC0UF4Acp7wdqvdPB8MXjEEX9cueWoddcMQofi5KKW4HueSJEvLP8Sp2FyxBrk3xtkccWCeAYR7sBDnJi3BYaz6zS3kSMT70x8ZE7/HlLcpzRi; AWSALBTGCORS=Z56/luULU4vDOi7Jp7TopwyOfAOKkCCa6APck21tTAUhima/fJe+53kDHrVHFOXC0UF4Acp7wdqvdPB8MXjEEX9cueWoddcMQofi5KKW4HueSJEvLP8Sp2FyxBrk3xtkccWCeAYR7sBDnJi3BYaz6zS3kSMT70x8ZE7/HlLcpzRi; CortexCID_ZZ1=NK2uiOOw0h7gcj0c; ZZ1-Session__1505=CfDJ8KSkO661hSREsDx7PGb48%2B05oY1CU34Y0rP7qzftlG%2F9w%2FDtGW25eEKa1MVj5MadtcYCxXTILmrbSxGsNPcqLTHCbpTWZa5ximoFMyVF3eYqLisEjsS67AzrHGC8SnbeU5BNslaDWutE4%2FiC9mkL2W8RRhO2Jm8cki9IzOKpMku8; ZZ1-Session__1505-Alt=CfDJ8KSkO661hSREsDx7PGb48%2B05oY1CU34Y0rP7qzftlG%2F9w%2FDtGW25eEKa1MVj5MadtcYCxXTILmrbSxGsNPcqLTHCbpTWZa5ximoFMyVF3eYqLisEjsS67AzrHGC8SnbeU5BNslaDWutE4%2FiC9mkL2W8RRhO2Jm8cki9IzOKpMku8'
Response 
<Result>
  <APIRequestInfo>
    <ProviderVersion>LONDON.R2.2131E.216729</ProviderVersion>
    <ProviderIdentity>OLU-T-USW2-APP</ProviderIdentity>
    <ProviderID>44ddde3ac27a33c394335f249d4007d4</ProviderID>
    <Module>Datatable</Module>
    <APIVersion>v2.1</APIVersion>
    <Resource>Contact.Group.Link:Create</Resource>
    <IsLoggedIn type="Boolean">True</IsLoggedIn>
    <Status>LoggedIn</Status>
    <UserLogin>ZZ1CT12218</UserLogin>
    <Session>No session (production configuration)</Session>
    <TimeoutPeriodMinutes type="Numeric">120</TimeoutPeriodMinutes>
  </APIRequestInfo>
  <RequestInterpretation>
    <Updates type="List">
      <Update>
        <Field>Contact.CoreField.CG_RecordID</Field>
        <Operator>:=</Operator>
        <OperatorDescription>Assign a value to a single-value field</OperatorDescription>
        <Value>K8OECVC3YN</Value>
      </Update>
      <Update>
        <Field>Contact.CoreField.CG_RecordID_Src</Field>
        <Operator>:=</Operator>
        <OperatorDescription>Assign a value to a single-value field</OperatorDescription>
        <Value>K8OECVUOZ0</Value>
      </Update>
      <Update>
        <Field>Contact.CoreField.LinkType</Field>
        <Operator>:=</Operator>
        <OperatorDescription>Assign a value to a single-value field</OperatorDescription>
        <Value>ParentGroup</Value>
      </Update>
    </Updates>
  </RequestInterpretation>
  <Response>
    <RecordID>2QDTMVN9M83</RecordID>
    <Code>SUCCESS</Code>
  </Response>
</Result>